ssh-add(1) -- Linux man page
NAMEssh-add - adds RSA or DSA identities to the authentication agent
SYNOPSISssh-add [-lLdDx ] [-t life ] [file ... ]
ssh-add -s reader
ssh-add -e reader
DESCRIPTIONssh-add adds RSA or DSA identities to the authentication agent, ssh-agent1. When run without arguments, it adds the files $HOME/.ssh/id_rsa $HOME/.ssh/id_dsa and $HOME/.ssh/identity Alternative file names can be given on the command line. If any file requires a passphrase, ssh-add asks for the passphrase from the user. The passphrase is read from the user's tty. ssh-add retries the last passphrase if multiple identity files are given.
The authentication agent must be running and the SSH_AUTH_SOCK environment variable must contain the name of its socket for ssh-add to work.
The options are as follows:
- Lists fingerprints of all identities currently represented by the agent.
- Lists public key parameters of all identities currently represented by the agent.
- Instead of adding the identity, removes the identity from the agent.
- Deletes all identities from the agent.
- Lock the agent with a password.
- Unlock the agent.
- -t life
- Set a maximum lifetime when adding identities to an agent. The lifetime may be specified in seconds or in a time format specified in sshd_config5.
- Indicates that added identities should be subject to confirmation before being used for authentication. Confirmation is performed by the SSH_ASKPASS program mentioned below. Successful confirmation is signaled by a zero exit status from the SSH_ASKPASS program, rather than text entered into the requester.
- -s reader
- Add key in smartcard reader
- -e reader
- Remove key in smartcard reader
- DISPLAY and SSH_ASKPASS
- If 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. (Note that on some machines it may be necessary to redirect the input from /dev/null to make this work.)
- Identifies the path of a unix-domain socket used to communicate with the agent.
- Contains the protocol version 1 RSA authentication identity of the user.
- Contains the protocol version 2 DSA authentication identity of the user.
- Contains the protocol version 2 RSA authentication identity of the user.
DIAGNOSTICSExit status is 0 on success, 1 if the specified command fails, and 2 if ssh-add is unable to contact the authentication agent.
SEE ALSOssh(1), ssh-agent1, ssh-keygen1, sshd(8)
AUTHORSOpenSSH is a derivative of the original and free ssh 1.2.12 release by Tatu Ylonen. Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos, Theo de Raadt and Dug Song removed many bugs, re-added newer features and created OpenSSH. Markus Friedl contributed the support for SSH protocol versions 1.5 and 2.0.