[Synopsis ] [Description ] [Files ] [Authors ] [See also ]

ssh-agent - authentication agent


ssh-agent command


Ssh-agent is a program to hold authentication private keys. The idea is that ssh-agent is started in the beginning of a new session, and all other windows or programs are started as children of the ssh-agent program (the command normally is the user shell cmd.exe or 4os2.exe). Programs started under the agent inherit a connection to the agent, and the agent is automatically used for RSA authentication when logging on to other machines using ssh.

The agent initially does not have any private keys. Keys are added using ssh-add. When executed without arguments, ssh-add adds the %HOME%/.ssh/identity file. If the identity has a passphrase, ssh-add asks for the passphrase. It then sends the identity to the agent. Several identities can be stored in the agent; the agent can automatically use any of these identities. Ssh-add -l displays the identities currently held by the agent.

The idea is that the agent is run in the user's local PC or laptop. Authentication data need not be stored on any other machine, and authentication passphrases never go over the network. However, the connection to the agent is forwarded over ssh remote logins, and the user can thus use the privileges given by the identities anywhere in the network in a secure way.

A connection to the agent is inherited by child programs. Under OS/2, ssh-agent creates an an open file descriptor which is inherited by all child processes. An environment variable (SSH_AUTHENTICATION_FD) defined by ssh-agent contains the number of this descriptor. This restricts access to the authentication agent to only those programs that are siblings of the agent, and it is fairly difficult to get unauthorized access to the agent.

The agent exits automatically when the command given on the command line terminates.


Contains the RSA authentication identity of the user. This file should not be readable by anyone but the user. It is possible to specify a passphrase when generating the key; that passphrase will be used to encrypt the private part of this file. This file is not used by ssh-agent, but is normally added to the agent using ssh-add at login time.


Tatu Ylönen <ylo@cs.hut.fi>;
OS/2 adaptation by Hans-Michael Stahl <hmstahl@berlin.snafu.de>

See also

ssh-add, ssh-keygen, ssh, sshd
Last update: 13 January 1997 by hmstahl@berlin.snafu.de