org.apache.sshd.server.config.keys

Class AuthorizedKeyEntry

java.lang.Object

org.apache.sshd.common.config.keys.PublicKeyEntry

org.apache.sshd.server.config.keys.AuthorizedKeyEntry

All Implemented Interfaces:

Serializable

public class AuthorizedKeyEntry
extends PublicKeyEntry

Represents an entry in the user's authorized_keys file according to the OpenSSH format. Note: equals/hashCode check only the key type and data - the comment and/or login options are not considered part of equality

Author:

Apache MINA SSHD Project

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	STD_AUTHORIZED_KEYS_FILENAME Standard OpenSSH authorized keys file name

Fields inherited from class org.apache.sshd.common.config.keys.PublicKeyEntry

COMMENT_CHAR, STD_KEYFILE_FOLDER_NAME

Constructor Summary

Constructors

Constructor and Description
AuthorizedKeyEntry()

Method Summary

Modifier and Type	Method and Description
PublicKey	appendPublicKey(Appendable sb)
static PublickeyAuthenticator	fromAuthorizedEntries(Collection<? extends AuthorizedKeyEntry> entries)
String	getComment()
static File	getDefaultAuthorizedKeysFile()
Map<String,String>	getLoginOptions()
static AuthorizedKeyEntry	parseAuthorizedKeyEntry(String line)
static Map<String,String>	parseLoginOptions(String options)
static List<AuthorizedKeyEntry>	readAuthorizedKeys(BufferedReader rdr)
static List<AuthorizedKeyEntry>	readAuthorizedKeys(File file) Reads read the contents of an authorized_keys file
static List<AuthorizedKeyEntry>	readAuthorizedKeys(InputStream in, boolean okToClose) Reads read the contents of an authorized_keys file
static List<AuthorizedKeyEntry>	readAuthorizedKeys(Path path, OpenOption... options) Reads read the contents of an authorized_keys file
static List<AuthorizedKeyEntry>	readAuthorizedKeys(Reader rdr, boolean okToClose) Reads read the contents of an authorized_keys file
static List<AuthorizedKeyEntry>	readAuthorizedKeys(String filePath) Reads read the contents of an authorized_keys file
static List<AuthorizedKeyEntry>	readAuthorizedKeys(URL url) Reads read the contents of an authorized_keys file
static List<AuthorizedKeyEntry>	readDefaultAuthorizedKeys() Reads read the contents of the default OpenSSH authorized_keys file
static List<PublicKey>	resolveAuthorizedKeys(Collection<? extends AuthorizedKeyEntry> entries)
void	setComment(String value)
void	setLoginOptions(Map<String,String> value)
String	toString()

Methods inherited from class org.apache.sshd.common.config.keys.PublicKeyEntry

appendPublicKeyEntry, equals, getDefaultKeysFolder, getKeyData, getKeyType, hashCode, isEquivalent, parsePublicKeyEntry, parsePublicKeyEntry, resolvePublicKey, setKeyData, setKeyType, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

STD_AUTHORIZED_KEYS_FILENAME

public static final String STD_AUTHORIZED_KEYS_FILENAME

Standard OpenSSH authorized keys file name

See Also:

Constant Field Values

Constructor Detail

AuthorizedKeyEntry

public AuthorizedKeyEntry()

Method Detail

getComment

public String getComment()

setComment

public void setComment(String value)

getLoginOptions

public Map<String,String> getLoginOptions()

setLoginOptions

public void setLoginOptions(Map<String,String> value)

appendPublicKey

public PublicKey appendPublicKey(Appendable sb)
                          throws IOException,
                                 GeneralSecurityException

Overrides:

appendPublicKey in class PublicKeyEntry

Parameters:

sb - The Appendable instance to encode the data into

Returns:

The PublicKey

Throws:

IOException - If failed to decode/encode the key

GeneralSecurityException - If failed to generate the key

See Also:

PublicKeyEntry.resolvePublicKey()

toString

public String toString()

Overrides:

toString in class PublicKeyEntry

fromAuthorizedEntries

public static PublickeyAuthenticator fromAuthorizedEntries(Collection<? extends AuthorizedKeyEntry> entries)
                                                    throws IOException,
                                                           GeneralSecurityException

Throws:

IOException

GeneralSecurityException

resolveAuthorizedKeys

public static List<PublicKey> resolveAuthorizedKeys(Collection<? extends AuthorizedKeyEntry> entries)
                                             throws IOException,
                                                    GeneralSecurityException

Throws:

IOException

GeneralSecurityException

getDefaultAuthorizedKeysFile

public static File getDefaultAuthorizedKeysFile()

Returns:

The default File location of the OpenSSH authorized keys file

readDefaultAuthorizedKeys

public static List<AuthorizedKeyEntry> readDefaultAuthorizedKeys()
                                                          throws IOException

Reads read the contents of the default OpenSSH authorized_keys file

Returns:

A List of all the AuthorizedKeyEntry-ies found there - or empty if file does not exist

Throws:

IOException - If failed to read keys from file

readAuthorizedKeys

public static List<AuthorizedKeyEntry> readAuthorizedKeys(URL url)
                                                   throws IOException

Reads read the contents of an authorized_keys file

Parameters:

url - The URL to read from

Returns:

A List of all the AuthorizedKeyEntry-ies found there

Throws:

IOException - If failed to read or parse the entries

See Also:

readAuthorizedKeys(InputStream, boolean)

readAuthorizedKeys

public static List<AuthorizedKeyEntry> readAuthorizedKeys(File file)
                                                   throws IOException

Reads read the contents of an authorized_keys file

Parameters:

file - The File to read from

Returns:

A List of all the AuthorizedKeyEntry-ies found there

Throws:

IOException - If failed to read or parse the entries

See Also:

readAuthorizedKeys(InputStream, boolean)

readAuthorizedKeys

public static List<AuthorizedKeyEntry> readAuthorizedKeys(Path path,
                                                          OpenOption... options)
                                                   throws IOException

Reads read the contents of an authorized_keys file

Parameters:

path - Path to read from

options - The OpenOptions to use - if unspecified then appropriate defaults assumed

Returns:

A List of all the AuthorizedKeyEntry-ies found there

Throws:

IOException - If failed to read or parse the entries

See Also:

readAuthorizedKeys(InputStream, boolean), Files.newInputStream(Path, OpenOption...)

readAuthorizedKeys

public static List<AuthorizedKeyEntry> readAuthorizedKeys(String filePath)
                                                   throws IOException

Reads read the contents of an authorized_keys file

Parameters:

filePath - The file path to read from

Returns:

A List of all the AuthorizedKeyEntry-ies found there

Throws:

IOException - If failed to read or parse the entries

See Also:

readAuthorizedKeys(InputStream, boolean)

readAuthorizedKeys

public static List<AuthorizedKeyEntry> readAuthorizedKeys(InputStream in,
                                                          boolean okToClose)
                                                   throws IOException

Reads read the contents of an authorized_keys file

Parameters:

in - The InputStream

okToClose - true if method may close the input stream regardless of whether successful or failed

Returns:

A List of all the AuthorizedKeyEntry-ies found there

Throws:

IOException - If failed to read or parse the entries

See Also:

readAuthorizedKeys(Reader, boolean)

readAuthorizedKeys

public static List<AuthorizedKeyEntry> readAuthorizedKeys(Reader rdr,
                                                          boolean okToClose)
                                                   throws IOException

Reads read the contents of an authorized_keys file

Parameters:

rdr - The Reader

okToClose - true if method may close the input stream regardless of whether successful or failed

Returns:

A List of all the AuthorizedKeyEntry-ies found there

Throws:

IOException - If failed to read or parse the entries

See Also:

readAuthorizedKeys(BufferedReader)

readAuthorizedKeys

public static List<AuthorizedKeyEntry> readAuthorizedKeys(BufferedReader rdr)
                                                   throws IOException

Parameters:

rdr - The BufferedReader to use to read the contents of an authorized_keys file

Returns:

A List of all the AuthorizedKeyEntry-ies found there

Throws:

IOException - If failed to read or parse the entries

See Also:

parseAuthorizedKeyEntry(String)

parseAuthorizedKeyEntry

public static AuthorizedKeyEntry parseAuthorizedKeyEntry(String line)
                                                  throws IllegalArgumentException

Parameters:

line - Original line from an authorized_keys file

Returns:

AuthorizedKeyEntry or null if the line is null/empty or a comment line

Throws:

IllegalArgumentException - If failed to parse/decode the line

See Also:

PublicKeyEntry.COMMENT_CHAR

parseLoginOptions

public static Map<String,String> parseLoginOptions(String options)