|SSH-ADD(1)||General Commands Manual||SSH-ADD(1)|
ssh-addadds private key identities to the authentication agent, ssh-agent(1). When run without arguments, it adds the files ~/.ssh/id_rsa, ~/.ssh/id_dsa, ~/.ssh/id_ecdsa and ~/.ssh/identity. After loading a private key,
ssh-addwill try to load corresponding certificate information from the filename obtained by appending -cert.pub to the name of the private key file. Alternative file names can be given on the command line.
If any file requires a passphrase,
asks for the passphrase from the user. The passphrase is read from the
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:
SSH_ASKPASSprogram mentioned below. Successful confirmation is signaled by a zero exit status from the
SSH_ASKPASSprogram, rather than text entered into the requester.
ssh-addhas been run without arguments, the keys for the default identities will be removed. Otherwise, the argument list will be interpreted as a list of paths to public key files and matching keys will be removed from the agent. If no public key is found at a given path,
ssh-addwill append .pub and retry.
DISPLAY and SSH_ASKPASS
ssh-addneeds a passphrase, it will read the passphrase from the current terminal if it was run from a terminal. If
ssh-adddoes not have a terminal associated with it but
SSH_ASKPASSare set, it will execute the program specified by
SSH_ASKPASSand open an X11 window to read the passphrase. This is particularly useful when calling
ssh-addfrom 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.)
Identity files should not be readable by anyone but the user. Note
ssh-add ignores identity files if they are
accessible by others.
ssh-addis unable to contact the authentication agent. ssh(1), ssh-agent(1), ssh-keygen(1), sshd(8)
|October 18, 2011||OpenBSD-5.1|