ssh-add - add RSA or DSA identities to the authentication agent
ssh-add [-lLdDxX] [-t life] [ file ]...
The ssh-add utility adds RSA or DSA identities to the authentication agent, ssh-agent(1). When run without arguments, it attempts to add all of the files $HOME/.ssh/identity (RSA v1), $HOME/.ssh/id_rsa (RSA v2), and $HOME/.ssh/id_dsa (DSA v2) that exist. If more than one of the private keys exists, an attempt to decrypt each with the same passphrase will be made before reprompting for a different passphrase. The passphrase is read from the users tty or by running the program defined in SSH_ASKPASS (see below).
The authentication agent must be running.
The following options are supported:
-dInstead of adding the identity, this option removes the identity from the agent.
-DDeletes all identities from the agent.
-lLists fingerprints of all identities currently represented by the agent.
-LLists public key parameters of all identities currently represented by the agent.
-t lifeSets a maximum lifetime when adding identities to an agent. The lifetime may be specified in seconds or in a time format specified in sshd(1M).
-xLocks the agent with a password.
-XUnlocks the agent.
SSH_ASKPASSIf ssh-add needs a passphrase, it will read the passphrase from the current terminal if it was run from a terminal. If ssh-add does not have a terminal associated with it but DISPLAY and SSH_ASKPASS are set, it will execute the program specified by SSH_ASKPASS and open an X11 window to read the passphrase. This is particularly useful when calling ssh-add from a .Xsession or related script.
SSH_AUTH_SOCKIdentifies the path of a unix-domain socket used to communicate with the agent.
The following exit values are returned:
1An error occurred.
These files should not be readable by anyone but the user. Notice that ssh-add ignores a file if it is accessible by others. It is possible to specify a passphrase when generating the key; that passphrase will be used to encrypt the private part of this file.
If these files are stored on a network file system it is assumed that either the protection provided in the file themselves or the transport layer of the network file system provides sufficient protection for the site policy. If this is not the case, then it is recommended the key files are stored on removable media or locally on the relevant hosts.
Recommended names for the DSA and RSA key files:
$HOME/.ssh/identityContains the RSA authentication identity of the user for protocol version 1.
$HOME/.ssh/identity.pubContains the public part of the RSA authentication identity of the user for protocol version 1.
$HOME/.ssh/id_dsaContains the private DSA authentication identity of the user.
$HOME/.ssh/id_dsa.pubContains the public part of the DSA authentication identity of the user.
$HOME/.ssh/id_rsaContains the private RSA authentication identity of the user.
$HOME/.ssh/id_rsa.pubContains the public part of the RSA authentication identity of the user.
See attributes(5) for descriptions of the following attributes:
ATTRIBUTE TYPE ATTRIBUTE VALUE Availability SUNWsshu
ssh(1), ssh-agent(1), ssh-keygen(1), sshd(1M), attributes(5)
|SunOS 5.11||ssh-add (1)||9 Jan 2004|