Package ghidra.framework.client

Class HeadlessClientAuthenticator

java.lang.Object
ghidra.framework.client.HeadlessClientAuthenticator
All Implemented Interfaces:
ClientAuthenticator, KeyStorePasswordProvider
public class HeadlessClientAuthenticator extends Object implements ClientAuthenticator
HeadlessClientAuthenticator provides the ability to install a Ghidra Server authenticator needed when operating in a headless mode.

  • Method Details

    • getAuthenticator

      public 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

    • installHeadlessClientAuthenticator

      public static void installHeadlessClientAuthenticator(String username, String keystorePath, boolean allowPasswordPrompt) throws IOException
      Install headless client authenticator for Ghidra Server and when http/https connections require authentication and have not specified user information.
      Parameters:
      username - optional username to be used with a Ghidra Server which allows username to be specified. If null, ClientUtil.getUserName() will be used.
      keystorePath - optional PKI or SSH keystore path. May also be specified as resource path for SSH key.
      allowPasswordPrompt - if true the user may be prompted for passwords via the console (stdin). Please note that the Java console will echo the password entry to the terminal which may be undesirable.
      Throws:
      IOException - if error occurs while opening specified keystorePath

    • getNewPassword

      public char[] getNewPassword(Component parent, String serverInfo, String username)
      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
      username -
      Returns:
      new password or null if password should not be changed, if not null array will be cleared by caller

    • processPasswordCallbacks

      public boolean processPasswordCallbacks(String title, String serverType, String serverName, boolean allowUserNameEntry, NameCallback nameCb, PasswordCallback passCb, ChoiceCallback choiceCb, AnonymousCallback anonymousCb, String loginError)
      Description copied from interface: ClientAuthenticator
      Process 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
      allowUserNameEntry - if true user ID entry will be supported if nameCb is not null.
      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:
      true if password provided, false if entry cancelled
      See Also:

    • promptForReconnect

      public boolean promptForReconnect(Component parent, 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
      message -
      Returns:
      return true if reconnect should be attempted

    • getKeyStorePassword

      public char[] getKeyStorePassword(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.

    • processSSHSignatureCallbacks

      public boolean processSSHSignatureCallbacks(String serverName, 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:

    • isSSHKeyAvailable

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