|SSH-ADD(1)||General Commands Manual||SSH-ADD(1)|
ssh-add — adds
private key identities to the authentication agent
ssh-add adds private key identities to the
authentication agent, ssh-agent(1).
When run without arguments, it adds the files
~/.ssh/id_ed25519. After loading a private key,
ssh-add will 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-addhas been run without arguments, the keys for the default identities and their corresponding certificates will be removed. Otherwise, the argument list will be interpreted as a list of paths to public key files to specify keys and certificates to be removed from the agent. If no public key is found at a given path,
ssh-addwill append .pub and retry.
SSH_SK_PROVIDERenvironment variable to specify a provider.
ssh-addto print debugging messages about its progress. This is helpful in debugging problems. Multiple
-voptions increase the verbosity. The maximum is 3.
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_ASKPASS(by default “ssh-askpass”) and 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.
Exit status is 0 on success, 1 if the specified command fails, and
ssh-add is unable to contact the authentication
OpenSSH 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.
|November 7, 2019||OpenBSD-current|