Package org.apache.sshd.agent
Interface SshAgent
-
- All Superinterfaces:
java.lang.AutoCloseable
,java.nio.channels.Channel
,java.io.Closeable
- All Known Implementing Classes:
AbstractAgentProxy
,AgentDelegate
,AgentImpl
public interface SshAgent extends java.nio.channels.Channel
SSH key agent server
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
SSH_AUTHSOCKET_ENV_NAME
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description void
addIdentity(java.security.KeyPair key, java.lang.String comment)
java.lang.Iterable<? extends java.util.Map.Entry<java.security.PublicKey,java.lang.String>>
getIdentities()
void
removeAllIdentities()
void
removeIdentity(java.security.PublicKey key)
java.util.Map.Entry<java.lang.String,byte[]>
sign(SessionContext session, java.security.PublicKey key, java.lang.String algo, byte[] data)
-
-
-
Field Detail
-
SSH_AUTHSOCKET_ENV_NAME
static final java.lang.String SSH_AUTHSOCKET_ENV_NAME
- See Also:
- Constant Field Values
-
-
Method Detail
-
getIdentities
java.lang.Iterable<? extends java.util.Map.Entry<java.security.PublicKey,java.lang.String>> getIdentities() throws java.io.IOException
- Throws:
java.io.IOException
-
sign
java.util.Map.Entry<java.lang.String,byte[]> sign(SessionContext session, java.security.PublicKey key, java.lang.String algo, byte[] data) throws java.io.IOException
- Parameters:
session
- The currentSessionContext
key
- ThePublicKey
to use for signingalgo
- Recommended signature algorithm - ifnull
/empty then one will be selected based on the key type and/or signature factories. Note: even if specific algorithm specified, the implementation may disregard and choose anotherdata
- Data to sign- Returns:
- used algorithm + signed data - using the identity
- Throws:
java.io.IOException
- If failed to sign
-
addIdentity
void addIdentity(java.security.KeyPair key, java.lang.String comment) throws java.io.IOException
- Throws:
java.io.IOException
-
removeIdentity
void removeIdentity(java.security.PublicKey key) throws java.io.IOException
- Throws:
java.io.IOException
-
removeAllIdentities
void removeAllIdentities() throws java.io.IOException
- Throws:
java.io.IOException
-
-