Package org.apache.sshd.server

Interface ServerAuthenticationManager

    • Field Detail

      • MAX_AUTH_REQUESTS

        static final java.lang.String MAX_AUTH_REQUESTS
        Key used to retrieve the value in the configuration properties map of the maximum number of failed authentication requests before the server closes the connection.
        See Also:
        DEFAULT_MAX_AUTH_REQUESTS, Constant Field Values

      • WELCOME_BANNER

        static final java.lang.String WELCOME_BANNER
        Key used to retrieve the value of welcome banner that will be displayed when a user connects to the server. If null/empty then no banner will be sent. The value can be one of the following:

        • A File or Path, in which case its contents will be transmitted. Note: if the file is empty or does not exits, no banner will be transmitted.

        • A URI or a string starting with "file:/", in which case it will be converted to a Path and handled accordingly.

        • A string containing a special value indicator - e.g., AUTO_WELCOME_BANNER_VALUE, in which case the relevant banner content will be generated.

        • Any other object whose toString() value yields a non empty string will be used as the banner contents.

        See Also:
        RFC-4252 section 5.4, Constant Field Values

      • AUTO_WELCOME_BANNER_VALUE

        static final java.lang.String AUTO_WELCOME_BANNER_VALUE
        Special value that can be set for the WELCOME_BANNER property indicating that the server should generate a banner consisting of the random art of the server's keys (if any are provided). If no server keys are available, then no banner will be sent
        See Also:
        Constant Field Values

      • WELCOME_BANNER_LANGUAGE

        static final java.lang.String WELCOME_BANNER_LANGUAGE
        Key used to denote the language code for the welcome banner (if such a banner is configured). If not set, then DEFAULT_WELCOME_BANNER_LANGUAGE is used
        See Also:
        Constant Field Values

      • WELCOME_BANNER_CHARSET

        static final java.lang.String WELCOME_BANNER_CHARSET
        The charset to use if the configured welcome banner points to a file - if not specified (either as a string or a Charset then the local default is used.
        See Also:
        Constant Field Values

      • AUTH_METHODS

        static final java.lang.String AUTH_METHODS
        This key is used when configuring multi-step authentications. The value needs to be a blank separated list of comma separated list of authentication method names. For example, an argument of publickey,password publickey,keyboard-interactive would require the user to complete public key authentication, followed by either password or keyboard interactive authentication. Only methods that are next in one or more lists are offered at each stage, so for this example, it would not be possible to attempt password or keyboard-interactive authentication before public key.
        See Also:
        Constant Field Values

      • DEFAULT_USER_AUTH_GSS_FACTORY

        static final UserAuthGSSFactory DEFAULT_USER_AUTH_GSS_FACTORY

    • Method Detail

      • getPublickeyAuthenticator

        PublickeyAuthenticator getPublickeyAuthenticator()
        Retrieve the PublickeyAuthenticator to be used by SSH server. If no authenticator has been configured (i.e. this method returns null), then client authentication requests based on keys will be rejected.
        Returns:
        the PublickeyAuthenticator or null

      • setPasswordAuthenticator

        void setPasswordAuthenticator​(PasswordAuthenticator passwordAuthenticator)

      • getPasswordAuthenticator

        PasswordAuthenticator getPasswordAuthenticator()
        Retrieve the PasswordAuthenticator to be used by the SSH server. If no authenticator has been configured (i.e. this method returns null), then client authentication requests based on passwords will be rejected.
        Returns:
        the PasswordAuthenticator or null

      • setPublickeyAuthenticator

        void setPublickeyAuthenticator​(PublickeyAuthenticator publickeyAuthenticator)

      • getKeyboardInteractiveAuthenticator

        KeyboardInteractiveAuthenticator getKeyboardInteractiveAuthenticator()
        Retrieve the KeyboardInteractiveAuthenticator to be used by the SSH server. If no authenticator has been configured (i.e. this method returns null), then client authentication requests based on this method will be rejected.
        Returns:
        The KeyboardInteractiveAuthenticator or null

      • getGSSAuthenticator

        GSSAuthenticator getGSSAuthenticator()
        Retrieve the GSSAuthenticator to be used by the SSH server. If no authenticator has been configured (i.e. this method returns null), then client authentication requests based on gssapi will be rejected.
        Returns:
        the GSSAuthenticator or null

      • setGSSAuthenticator

        void setGSSAuthenticator​(GSSAuthenticator gssAuthenticator)

      • getHostBasedAuthenticator

        HostBasedAuthenticator getHostBasedAuthenticator()
        Retrieve the HostBasedAuthenticator to be used by the SSH server. If no authenticator has been configured (i.e. this method returns null), then client authentication requests based on this method will be rejected.
        Returns:
        the HostBasedAuthenticator or null

      • setHostBasedAuthenticator

        void setHostBasedAuthenticator​(HostBasedAuthenticator hostBasedAuthenticator)

      • resolveUserAuthFactories

        static java.util.List<UserAuthFactory> resolveUserAuthFactories​(ServerAuthenticationManager manager,
                                                                java.util.List<UserAuthFactory> userFactories)
        If user authentication factories already set, then simply returns them. Otherwise, builds the factories list from the individual authenticators available for the manager - password public key, keyboard-interactive, GSS, etc...
        Parameters:
        manager - The ServerAuthenticationManager - ignored if null
        userFactories - The currently available UserAuth factories - if not null/empty then they are used as-is.
        Returns:
        The resolved List of NamedFactory for the UserAuths