public class AuthorizedKeyEntry extends PublicKeyEntry
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 equalityModifier and Type | Field and Description |
---|---|
static String |
STD_AUTHORIZED_KEYS_FILENAME
Standard OpenSSH authorized keys file name
|
COMMENT_CHAR, STD_KEYFILE_FOLDER_NAME
Constructor and Description |
---|
AuthorizedKeyEntry() |
appendPublicKeyEntry, equals, getDefaultKeysFolderPath, getKeyData, getKeyType, hashCode, isEquivalent, parsePublicKeyEntry, parsePublicKeyEntry, resolvePublicKey, setKeyData, setKeyType, toString
public static final String STD_AUTHORIZED_KEYS_FILENAME
public String getComment()
public void setComment(String value)
public PublicKey appendPublicKey(Appendable sb, PublicKeyEntryResolver fallbackResolver) throws IOException, GeneralSecurityException
appendPublicKey
in class PublicKeyEntry
sb
- The Appendable
instance to encode the data intofallbackResolver
- The PublicKeyEntryResolver
to consult if
none of the built-in ones can be used. If null
and no built-in
resolver can be used then an InvalidKeySpecException
is thrown.PublicKey
or null
if could not resolve itIOException
- If failed to decode/encode the keyGeneralSecurityException
- If failed to generate the keyPublicKeyEntry.resolvePublicKey(PublicKeyEntryResolver)
public String toString()
toString
in class PublicKeyEntry
public static PublickeyAuthenticator fromAuthorizedEntries(PublicKeyEntryResolver fallbackResolver, Collection<? extends AuthorizedKeyEntry> entries) throws IOException, GeneralSecurityException
IOException
GeneralSecurityException
public static List<PublicKey> resolveAuthorizedKeys(PublicKeyEntryResolver fallbackResolver, Collection<? extends AuthorizedKeyEntry> entries) throws IOException, GeneralSecurityException
IOException
GeneralSecurityException
public static Path getDefaultAuthorizedKeysFile()
Path
location of the OpenSSH authorized keys filepublic static List<AuthorizedKeyEntry> readDefaultAuthorizedKeys(OpenOption... options) throws IOException
authorized_keys
fileoptions
- The OpenOption
s to use when reading the fileList
of all the AuthorizedKeyEntry
-ies found there -
or empty if file does not existIOException
- If failed to read keys from filepublic static List<AuthorizedKeyEntry> readAuthorizedKeys(URL url) throws IOException
authorized_keys
fileurl
- The URL
to read fromList
of all the AuthorizedKeyEntry
-ies found thereIOException
- If failed to read or parse the entriesreadAuthorizedKeys(InputStream, boolean)
public static List<AuthorizedKeyEntry> readAuthorizedKeys(File file) throws IOException
authorized_keys
filefile
- The File
to read fromList
of all the AuthorizedKeyEntry
-ies found thereIOException
- If failed to read or parse the entriesreadAuthorizedKeys(InputStream, boolean)
public static List<AuthorizedKeyEntry> readAuthorizedKeys(Path path, OpenOption... options) throws IOException
authorized_keys
filepath
- Path
to read fromoptions
- The OpenOption
s to use - if unspecified then appropriate
defaults assumedList
of all the AuthorizedKeyEntry
-ies found thereIOException
- If failed to read or parse the entriesreadAuthorizedKeys(InputStream, boolean)
,
Files.newInputStream(Path, OpenOption...)
public static List<AuthorizedKeyEntry> readAuthorizedKeys(String filePath) throws IOException
authorized_keys
filefilePath
- The file path to read fromList
of all the AuthorizedKeyEntry
-ies found thereIOException
- If failed to read or parse the entriesreadAuthorizedKeys(InputStream, boolean)
public static List<AuthorizedKeyEntry> readAuthorizedKeys(InputStream in, boolean okToClose) throws IOException
authorized_keys
filein
- The InputStream
okToClose
- true
if method may close the input stream
regardless of whether successful or failedList
of all the AuthorizedKeyEntry
-ies found thereIOException
- If failed to read or parse the entriesreadAuthorizedKeys(Reader, boolean)
public static List<AuthorizedKeyEntry> readAuthorizedKeys(Reader rdr, boolean okToClose) throws IOException
authorized_keys
filerdr
- The Reader
okToClose
- true
if method may close the input stream
regardless of whether successful or failedList
of all the AuthorizedKeyEntry
-ies found thereIOException
- If failed to read or parse the entriesreadAuthorizedKeys(BufferedReader)
public static List<AuthorizedKeyEntry> readAuthorizedKeys(BufferedReader rdr) throws IOException
rdr
- The BufferedReader
to use to read the contents of
an authorized_keys
fileList
of all the AuthorizedKeyEntry
-ies found thereIOException
- If failed to read or parse the entriesparseAuthorizedKeyEntry(String)
public static AuthorizedKeyEntry parseAuthorizedKeyEntry(String line) throws IllegalArgumentException
line
- Original line from an authorized_keys
fileAuthorizedKeyEntry
or null
if the line is
null
/empty or a comment lineIllegalArgumentException
- If failed to parse/decode the linePublicKeyEntry.COMMENT_CHAR
Copyright © 2008–2016 The Apache Software Foundation. All rights reserved.