Package org.apache.kerby.kerberos.kerb.admin.kadmin

Interface Kadmin

All Known Subinterfaces:
LocalKadmin
All Known Implementing Classes:
LocalKadminImpl, RemoteKadminImpl
public interface Kadmin
Server side admin facilities from remote, similar to MIT kadmin remote mode.

  • Method Details

    • getKadminPrincipal

      String getKadminPrincipal()
      Get the kadmin principal name.
      Returns:
      The kadmin principal name.

    • addPrincipal

      void addPrincipal(String principal) throws org.apache.kerby.kerberos.kerb.KrbException
      Add principal to backend.
      Parameters:
      principal - The principal to be added into backend
      Throws:
      org.apache.kerby.kerberos.kerb.KrbException - e

    • addPrincipal

      void addPrincipal(String principal, org.apache.kerby.KOptions kOptions) throws org.apache.kerby.kerberos.kerb.KrbException
      Add principal to backend.
      Parameters:
      principal - The principal to be added into backend
      kOptions - The KOptions with principal info
      Throws:
      org.apache.kerby.kerberos.kerb.KrbException - e

    • addPrincipal

      void addPrincipal(String principal, String password) throws org.apache.kerby.kerberos.kerb.KrbException
      Add principal to backend.
      Parameters:
      principal - The principal to be added into backend
      password - The password to create encryption key
      Throws:
      org.apache.kerby.kerberos.kerb.KrbException - e

    • addPrincipal

      void addPrincipal(String principal, String password, org.apache.kerby.KOptions kOptions) throws org.apache.kerby.kerberos.kerb.KrbException
      Add principal to backend.
      Parameters:
      principal - The principal to be added into backend
      password - The password to create encryption key
      kOptions - The KOptions with principal info
      Throws:
      org.apache.kerby.kerberos.kerb.KrbException - e

    • exportKeytab

      void exportKeytab(File keytabFile, String principal) throws org.apache.kerby.kerberos.kerb.KrbException
      Export all the keys of the specified principal into the specified keytab file.
      Parameters:
      keytabFile - The keytab file
      principal - The principal name
      Throws:
      org.apache.kerby.kerberos.kerb.KrbException - e

    • exportKeytab

      void exportKeytab(File keytabFile, List<String> principals) throws org.apache.kerby.kerberos.kerb.KrbException
      Export all the keys of the specified principals into the specified keytab file.
      Parameters:
      keytabFile - The keytab file
      principals - The principal names
      Throws:
      org.apache.kerby.kerberos.kerb.KrbException - e

    • exportKeytab

      void exportKeytab(File keytabFile) throws org.apache.kerby.kerberos.kerb.KrbException
      Export all identity keys to the specified keytab file.
      Parameters:
      keytabFile - The keytab file
      Throws:
      org.apache.kerby.kerberos.kerb.KrbException - e

    • removeKeytabEntriesOf

      void removeKeytabEntriesOf(File keytabFile, String principal) throws org.apache.kerby.kerberos.kerb.KrbException
      Remove all the keys of the specified principal in the specified keytab file.
      Parameters:
      keytabFile - The keytab file
      principal - The principal name
      Throws:
      org.apache.kerby.kerberos.kerb.KrbException - e

    • removeKeytabEntriesOf

      void removeKeytabEntriesOf(File keytabFile, String principal, int kvno) throws org.apache.kerby.kerberos.kerb.KrbException
      Remove all the keys of the specified principal with specified kvno in the specified keytab file.
      Parameters:
      keytabFile - The keytab file
      principal - The principal name
      kvno - The kvno
      Throws:
      org.apache.kerby.kerberos.kerb.KrbException - e

    • removeOldKeytabEntriesOf

      void removeOldKeytabEntriesOf(File keytabFile, String principal) throws org.apache.kerby.kerberos.kerb.KrbException
      Remove all the old keys of the specified principal in the specified keytab file.
      Parameters:
      keytabFile - The keytab file
      principal - The principal name
      Throws:
      org.apache.kerby.kerberos.kerb.KrbException - e

    • deletePrincipal

      void deletePrincipal(String principal) throws org.apache.kerby.kerberos.kerb.KrbException
      Delete the principal in backend.
      Parameters:
      principal - The principal to be deleted from backend
      Throws:
      org.apache.kerby.kerberos.kerb.KrbException - e

    • modifyPrincipal

      void modifyPrincipal(String principal, org.apache.kerby.KOptions kOptions) throws org.apache.kerby.kerberos.kerb.KrbException
      Modify the principal with KOptions.
      Parameters:
      principal - The principal to be modified
      kOptions - The KOptions with changed principal info
      Throws:
      org.apache.kerby.kerberos.kerb.KrbException - e

    • renamePrincipal

      void renamePrincipal(String oldPrincipalName, String newPrincipalName) throws org.apache.kerby.kerberos.kerb.KrbException
      Rename the principal.
      Parameters:
      oldPrincipalName - The original principal name
      newPrincipalName - The new principal name
      Throws:
      org.apache.kerby.kerberos.kerb.KrbException - e

    • getPrincipals

      List<String> getPrincipals() throws org.apache.kerby.kerberos.kerb.KrbException
      Get all the principal names from backend.
      Returns:
      principal list
      Throws:
      org.apache.kerby.kerberos.kerb.KrbException - e

    • getPrincipals

      List<String> getPrincipals(String globString) throws org.apache.kerby.kerberos.kerb.KrbException
      Get all the principal names that meets the pattern
      Parameters:
      globString - The glob string for matching
      Returns:
      Principal names
      Throws:
      org.apache.kerby.kerberos.kerb.KrbException - e

    • changePassword

      void changePassword(String principal, String newPassword) throws org.apache.kerby.kerberos.kerb.KrbException
      Change the password of specified principal.
      Parameters:
      principal - The principal to be updated password
      newPassword - The new password
      Throws:
      org.apache.kerby.kerberos.kerb.KrbException - e

    • updateKeys

      void updateKeys(String principal) throws org.apache.kerby.kerberos.kerb.KrbException
      Update the random keys of specified principal.
      Parameters:
      principal - The principal to be updated keys
      Throws:
      org.apache.kerby.kerberos.kerb.KrbException - e

    • release

      void release() throws org.apache.kerby.kerberos.kerb.KrbException
      Release any resources associated.
      Throws:
      org.apache.kerby.kerberos.kerb.KrbException - e