Package org.apache.sshd.server.auth.pubkey

Class AuthorizedKeyEntriesPublickeyAuthenticator

java.lang.Object

org.apache.sshd.common.util.logging.AbstractLoggingBean

org.apache.sshd.server.auth.pubkey.AuthorizedKeyEntriesPublickeyAuthenticator

All Implemented Interfaces:

PublickeyAuthenticator

public class AuthorizedKeyEntriesPublickeyAuthenticator
extends AbstractLoggingBean
implements PublickeyAuthenticator

Checks against a Collection of AuthorizedKeyEntrys Records the matched entry under a session attribute.

Field Summary

Fields

Modifier and Type	Field	Description
static AttributeRepository.AttributeKey<AuthorizedKeyEntry>	AUTHORIZED_KEY
private java.lang.Object	id
private java.util.Map<AuthorizedKeyEntry,java.security.PublicKey>	resolvedKeys

Fields inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

log

Constructor Summary

Constructors

Constructor	Description
AuthorizedKeyEntriesPublickeyAuthenticator(java.lang.Object id, ServerSession session, java.util.Collection<? extends AuthorizedKeyEntry> entries, PublicKeyEntryResolver fallbackResolver)

Method Summary

Modifier and Type	Method	Description
boolean	authenticate(java.lang.String username, java.security.PublicKey key, ServerSession session)	Checks whether the given PublicKey is allowed to be used for authenticating user "username" in a session.
java.lang.Object	getId()
protected boolean	matchesExpiryTime(java.lang.String username, ServerSession session, java.lang.String expiryTime)
protected boolean	matchesFrom(java.lang.String username, ServerSession session, java.lang.String from)
protected boolean	matchesLoginOptions(AuthorizedKeyEntry entry, java.lang.String username, ServerSession session)
protected boolean	matchesPrincipals(AuthorizedKeyEntry entry, java.lang.String username, OpenSshCertificate cert, ServerSession session)
protected java.time.Instant	parseExpiryTime(java.lang.String expiryTime)
protected java.net.InetSocketAddress	resolveClientAddress(ServerSession session)
java.lang.String	toString()

Methods inherited from class org.apache.sshd.common.util.logging.AbstractLoggingBean

debug, debug, debug, debug, debug, error, error, error, error, error, getSimplifiedLogger, info, info, warn, warn, warn, warn, warn, warn, warn, warn

Methods inherited from class java.lang.Object

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

Field Detail

AUTHORIZED_KEY

public static final AttributeRepository.AttributeKey<AuthorizedKeyEntry> AUTHORIZED_KEY

resolvedKeys

private java.util.Map<AuthorizedKeyEntry,java.security.PublicKey> resolvedKeys

id

private java.lang.Object id

Constructor Detail

AuthorizedKeyEntriesPublickeyAuthenticator

public AuthorizedKeyEntriesPublickeyAuthenticator(java.lang.Object id,
                                                  ServerSession session,
                                                  java.util.Collection<? extends AuthorizedKeyEntry> entries,
                                                  PublicKeyEntryResolver fallbackResolver)
                                           throws java.io.IOException,
                                                  java.security.GeneralSecurityException

Throws:

java.io.IOException

java.security.GeneralSecurityException

Method Detail

getId

public java.lang.Object getId()

Returns:

Some kind of mnemonic identifier for the authenticator - used also in toString()

authenticate

public boolean authenticate(java.lang.String username,
                            java.security.PublicKey key,
                            ServerSession session)

Description copied from interface: PublickeyAuthenticator

Checks whether the given PublicKey is allowed to be used for authenticating user "username" in a session.

Note that the key may be a OpenSshCertificate. A typical implementation for a certificate would check that the certificate's CA key is known to be trusted as a certificate authority, and that the given user name is listed in the certificate's principals.

Specified by:

authenticate in interface PublickeyAuthenticator

Parameters:

username - the username

key - the key

session - the server session

Returns:

true if the key may be used; false otherwise

matchesLoginOptions

protected boolean matchesLoginOptions(AuthorizedKeyEntry entry,
                                      java.lang.String username,
                                      ServerSession session)

matchesExpiryTime

protected boolean matchesExpiryTime(java.lang.String username,
                                    ServerSession session,
                                    java.lang.String expiryTime)

parseExpiryTime

protected java.time.Instant parseExpiryTime(java.lang.String expiryTime)

matchesFrom

protected boolean matchesFrom(java.lang.String username,
                              ServerSession session,
                              java.lang.String from)

resolveClientAddress

protected java.net.InetSocketAddress resolveClientAddress(ServerSession session)

matchesPrincipals

protected boolean matchesPrincipals(AuthorizedKeyEntry entry,
                                    java.lang.String username,
                                    OpenSshCertificate cert,
                                    ServerSession session)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object