|SSH-ADD(1)||General Commands Manual||SSH-ADD(1)|
ssh-add — adds
private key identities to the OpenSSH 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_sk. 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. If the argument list consists of “-” then
ssh-addwill read public keys to be removed from standard input.
ssh-addto print debugging messages about its progress. This is helpful in debugging problems. Multiple
-voptions increase the verbosity. The maximum is 3.
SSH_ASKPASS and SSH_ASKPASS_REQUIRE
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.
SSH_ASKPASS_REQUIRE allows further
control over the use of an askpass program. If this variable is set to
ssh-add will never
attempt to use one. If it is set to “prefer”, then
ssh-add will prefer to use the askpass program
instead of the TTY when requesting passwords. Finally, if the variable
is set to “force”, then the askpass program will be used
for all passphrase input regardless of whether
DISPLAY is set.
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.
|July 14, 2020||OpenBSD-current|