Package ghidra.framework.client

Class PasswordClientAuthenticator

  • All Implemented Interfaces:
    ClientAuthenticator, KeyStorePasswordProvider
    public class PasswordClientAuthenticator
extends java.lang.Object
implements ClientAuthenticator
    PasswordClientAuthenticator provides a fixed username/password authentication response when connecting to any Ghidra Server or accessing a protected PKI keystore. The use of this authenticator is intended for headless applications in which the user is unable to respond to such prompts. SSH authentication is not currently supported. Anonymous user access is not supported.

    If a PKI certificate has been installed, a password may be required to access the certificate keystore independent of any other password which may be required for accessing SSH keys or server password authentication. In such headless situations, the PKI certificate path/password should be specified via a property since it is unlikely that the same password will apply.

    See Also:
    ApplicationKeyManagerFactory

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.net.Authenticator getAuthenticator()
      Get a standard Java authenticator for HTTP and other standard network connections
      char[] getKeyStorePassword​(java.lang.String keystorePath, boolean passwordError)
      Requests password for keystore file
      char[] getNewPassword​(java.awt.Component parent, java.lang.String serverInfo, java.lang.String user)
      Get new user password
      boolean isSSHKeyAvailable()  
      boolean processPasswordCallbacks​(java.lang.String title, java.lang.String serverType, java.lang.String serverName, javax.security.auth.callback.NameCallback nameCb, javax.security.auth.callback.PasswordCallback passCb, javax.security.auth.callback.ChoiceCallback choiceCb, AnonymousCallback anonymousCb, java.lang.String loginError)
      Process Ghidra Server password authentication callbacks.
      boolean processSSHSignatureCallbacks​(java.lang.String serverName, javax.security.auth.callback.NameCallback nameCb, SSHSignatureCallback sshCb)
      Process Ghidra Server SSH authentication callbacks.
      boolean promptForReconnect​(java.awt.Component parent, java.lang.String message)
      Prompt user for reconnect

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • PasswordClientAuthenticator

        public PasswordClientAuthenticator​(java.lang.String password)

      • PasswordClientAuthenticator

        public PasswordClientAuthenticator​(java.lang.String username,
                                   java.lang.String password)

    • Method Detail

      • getAuthenticator

        public java.net.Authenticator getAuthenticator()
        Description copied from interface: ClientAuthenticator
        Get a standard Java authenticator for HTTP and other standard network connections
        Specified by:
        getAuthenticator in interface ClientAuthenticator
        Returns:
        authenticator object

      • isSSHKeyAvailable

        public boolean isSSHKeyAvailable()
        Specified by:
        isSSHKeyAvailable in interface ClientAuthenticator
        Returns:
        true if SSH private key is available for authentication

      • processSSHSignatureCallbacks

        public boolean processSSHSignatureCallbacks​(java.lang.String serverName,
                                            javax.security.auth.callback.NameCallback nameCb,
                                            SSHSignatureCallback sshCb)
        Description copied from interface: ClientAuthenticator
        Process Ghidra Server SSH authentication callbacks.
        Specified by:
        processSSHSignatureCallbacks in interface ClientAuthenticator
        Parameters:
        serverName - name of server
        nameCb - provides storage for user login name. A null indicates that the default user name will be used, @see ClientUtil#getUserName().
        sshCb - provides authentication token to be signed with private key, @see SSHAuthenticationCallback#sign(SSHPrivateKey)
        Returns:

      • getNewPassword

        public char[] getNewPassword​(java.awt.Component parent,
                             java.lang.String serverInfo,
                             java.lang.String user)
        Description copied from interface: ClientAuthenticator
        Get new user password
        Specified by:
        getNewPassword in interface ClientAuthenticator
        Parameters:
        parent - dialog parent component or null if not applicable
        serverInfo - server host info
        Returns:
        new password or null if password should not be changed, if not null array will be cleared by caller

      • processPasswordCallbacks

        public boolean processPasswordCallbacks​(java.lang.String title,
                                        java.lang.String serverType,
                                        java.lang.String serverName,
                                        javax.security.auth.callback.NameCallback nameCb,
                                        javax.security.auth.callback.PasswordCallback passCb,
                                        javax.security.auth.callback.ChoiceCallback choiceCb,
                                        AnonymousCallback anonymousCb,
                                        java.lang.String loginError)
        Description copied from interface: ClientAuthenticator
        Process Ghidra Server password authentication callbacks.
        Specified by:
        processPasswordCallbacks in interface ClientAuthenticator
        Parameters:
        title - password prompt title if GUI is used
        serverType - type of server (label associated with serverName)
        serverName - name of server
        nameCb - provides storage for user login name. A null indicates that the default user name will be used, @see ClientUtil#getUserName().
        passCb - provides storage for user password, @see PasswordCallback#setPassword(char[])
        choiceCb - specifies choice between NT Domain authentication (index=0) and local password file authentication (index=1). Set selected index to specify authenticator to be used,
        anonymousCb - may be used to request anonymous read-only access to the server. A null is specified if anonymous access has not been enabed on the server.
        loginError - previous login error message or null for first attempt
        Returns:
        See Also:
        AnonymousCallback.setAnonymousAccessRequested(boolean)

      • promptForReconnect

        public boolean promptForReconnect​(java.awt.Component parent,
                                  java.lang.String message)
        Description copied from interface: ClientAuthenticator
        Prompt user for reconnect
        Specified by:
        promptForReconnect in interface ClientAuthenticator
        Parameters:
        parent - dialog parent component or null if not applicable
        Returns:
        return true if reconnect should be attempted

      • getKeyStorePassword

        public char[] getKeyStorePassword​(java.lang.String keystorePath,
                                  boolean passwordError)
        Description copied from interface: KeyStorePasswordProvider
        Requests password for keystore file
        Specified by:
        getKeyStorePassword in interface KeyStorePasswordProvider
        Parameters:
        keystorePath - keystore file path
        passwordError - if true this is a repeated prompt due to a password use failure
        Returns:
        password or null, if not null caller will clear array when no longer needed.