ssh2.agent

class ssh2.agent.Agent
connect(self)

Connect to agent.

Raises:ssh2.exceptions.AgentConnectionError on errors connecting to agent.
Return type:int
disconnect(self)

Disconnect from agent.

Return type:int
get_identities(self)

List and get identities from agent

Return type:list(ssh2.pkey.PublicKey)
get_identity_path(self)
list_identities(self)

This method is a no-op - use ssh2.agent.Agent.get_identities() to list and retrieve identities.

set_identity_path(self, path)
userauth(self, username, PublicKey pkey)

Perform user authentication with specific public key

Parameters:
  • username (str) – User name to authenticate as
  • pkey (ssh2.pkey.PublicKey) – Public key to authenticate with
Raises:

ssh2.exceptions.AgentAuthenticationError on errors authenticating.

Return type:

int