Class IdentityUtils

java.lang.Object
org.apache.sshd.common.config.keys.IdentityUtils

public final class IdentityUtils extends Object
  • Constructor Details

    • IdentityUtils

      private IdentityUtils()
  • Method Details

    • getIdentityFileName

      public static String getIdentityFileName(String prefix, String type, String suffix)
      Parameters:
      prefix - The file name prefix - ignored if null/empty
      type - The identity type - ignored if null/empty
      suffix - The file name suffix - ignored if null/empty
      Returns:
      The identity file name or null if no name
    • createKeyPairProvider

      public static KeyPairProvider createKeyPairProvider(Map<String,KeyPair> ids, boolean supportedOnly)
      Parameters:
      ids - A Map of the loaded identities where key=the identity type, value=the matching KeyPair - ignored if null/empty
      supportedOnly - If true then ignore identities that are not supported internally
      Returns:
      A KeyPair for the identities - null if no identities available (e.g., after filtering unsupported ones)
      See Also:
    • loadIdentities

      public static NavigableMap<String,KeyPair> loadIdentities(SessionContext session, Map<String,? extends Path> paths, FilePasswordProvider provider, OpenOption... options) throws IOException, GeneralSecurityException
      Parameters:
      session - The SessionContext for invoking this load command - may be null if not invoked within a session context (e.g., offline tool or session unknown).
      paths - A Map of the identities where key=identity type (case insensitive), value=the Path of file with the identity key
      provider - A FilePasswordProvider - may be null if the loaded keys are guaranteed not to be encrypted. The argument to FilePasswordProvider#getPassword is the path of the file whose key is to be loaded
      options - The OpenOptions to use when reading the key data
      Returns:
      A NavigableMap of the identities where key=identity type (case insensitive), value=the KeyPair of the identity
      Throws:
      IOException - If failed to access the file system
      GeneralSecurityException - If failed to load the keys