Section: User Commands (1)
- adds private key identities to the OpenSSH authentication agent
adds private key identities to the authentication agent,
When run without arguments, it adds the files
After loading a private key,
will try to load corresponding certificate information from the
filename obtained by appending
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 user's tty.
retries the last passphrase if multiple identity files are given.
The authentication agent must be running and the
environment variable must contain the name of its socket for
The options are as follows:
Indicates that added identities should be subject to confirmation before
being used for authentication.
Confirmation is performed by
Successful confirmation is signaled by a zero exit status from
rather than text entered into the requester.
Deletes all identities from the agent.
Instead of adding identities, removes identities from the agent.
has 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,
If the argument list consists of
will read public keys to be removed from standard input.
- -E fingerprint_hash
Specifies the hash algorithm used when displaying key fingerprints.
Valid options are:
The default is
- -e pkcs11
Remove keys provided by the PKCS#11 shared library
Load resident keys from a FIDO authenticator.
When loading keys into or deleting keys from the agent, process plain private
keys only and skip certificates.
Lists public key parameters of all identities currently represented
by the agent.
Lists fingerprints of all identities currently represented by the agent.
Be quiet after a successful operation.
- -S provider
Specifies a path to a library that will be used when adding
FIDO authenticator-hosted keys, overriding the default of using the
internal USB HID support.
- -s pkcs11
Add keys provided by the PKCS#11 shared library
- -T pubkey ...
Tests whether the private keys that correspond to the specified
files are usable by performing sign and verify operations on each.
- -t life
Set a maximum lifetime when adding identities to an agent.
The lifetime may be specified in seconds or in a time format
to print debugging messages about its progress.
This is helpful in debugging problems.
options increase the verbosity.
The maximum is 3.
Unlock the agent.
Lock the agent with a password.
- DISPLAY, SSH_ASKPASS and SSH_ASKPASS_REQUIRE
needs a passphrase, it will read the passphrase from the current
terminal if it was run from a terminal.
does not have a terminal associated with it but
are set, it will execute the program specified by
and open an X11 window to read the passphrase.
This is particularly useful when calling
or related script.
allows further control over the use of an askpass program.
If this variable is set to
will never attempt to use one.
If it is set to
will prefer to use the askpass program instead of the TTY when requesting
Finally, if the variable is set to
then the askpass program will be used for all passphrase input regardless
Identifies the path of a
socket used to communicate with the agent.
Specifies a path to a library that will be used when loading any
FIDO authenticator-hosted keys, overriding the default of using
the built-in USB HID support.
Contains the DSA, ECDSA, authenticator-hosted ECDSA, Ed25519,
authenticator-hosted Ed25519 or RSA authentication identity of the user.
Identity files should not be readable by anyone but the user.
ignores identity files if they are accessible by others.
Exit status is 0 on success, 1 if the specified command fails,
and 2 if
is unable to contact the authentication agent.
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
Markus Friedl contributed the support for SSH
protocol versions 1.5 and 2.0.