ssh-add(1)


NAME

     ssh-add --- adds private key identities to the authentication agent

SYNOPSIS

     ssh-add [-cDdkLlXx] [-E fingerprint_hash] [-t life] [file ...]
     ssh-add -s pkcs11
     ssh-add -e pkcs11

DESCRIPTION

     ssh-add adds 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, ~/.ssh/id_ed25519 and
     ~/.ssh/identity.  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, 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:

     -c      Indicates that added identities should be subject to confirmation
         before being used for authentication.  Confirmation is performed
         by ssh-askpass(1).  Successful confirmation is signaled by a zero
         exit status from ssh-askpass(1), rather than text entered into
         the requester.

     -D      Deletes all identities from the agent.

     -d      Instead of adding identities, removes identities from the agent.
         If ssh-add 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, ssh-add will append .pub and retry.

     -E fingerprint_hash
         Specifies the hash algorithm used when displaying key
         fingerprints.  Valid options are: "md5" and "sha256".  The
         default is "sha256".

     -e pkcs11
         Remove keys provided by the PKCS#11 shared library pkcs11.

     -k      When loading keys into or deleting keys from the agent, process
         plain private keys only and skip certificates.

     -L      Lists public key parameters of all identities currently
         represented by the agent.

     -l      Lists fingerprints of all identities currently represented by the
         agent.

     -s pkcs11
         Add keys provided by the PKCS#11 shared library pkcs11.

     -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_config(5).

     -X      Unlock the agent.

     -x      Lock the agent with a password.

ENVIRONMENT

     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 (by default "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.)

     SSH_AUTH_SOCK
         Identifies the path of a UNIX-domain socket used to communicate
         with the agent.

FILES

     ~/.ssh/identity
         Contains the protocol version 1 RSA authentication identity of
         the user.

     ~/.ssh/id_dsa
         Contains the protocol version 2 DSA authentication identity of
         the user.

     ~/.ssh/id_ecdsa
         Contains the protocol version 2 ECDSA authentication identity of
         the user.

     ~/.ssh/id_ed25519
         Contains the protocol version 2 Ed25519 authentication identity
         of the user.

     ~/.ssh/id_rsa
         Contains the protocol version 2 RSA authentication identity of
         the user.

     Identity files should not be readable by anyone but the user.  Note that
     ssh-add ignores identity files if they are accessible by others.

EXIT STATUS

     Exit status is 0 on success, 1 if the specified command fails, and 2 if
     ssh-add is unable to contact the authentication agent.

SEE ALSO

     ssh(1), ssh-agent(1), ssh-askpass(1), ssh-keygen(1), sshd(8)

AUTHORS

     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.


More Linux Commands

manpages/Tcl_DictObjSize.3.html
Tcl_DictObjSize(3) - manipulate Tcl objects as dictionaries
Tcl dictionary objects have an internal representation that supports efficient mapping from keys to values and which guarantees that the particular ordering of

manpages/pbuildid.1.html
pbuildid(1) - print the build id of an ELF executable or cor
pbuildid reads the build id embedded in the process image of a core file or an executable file. The build id note is allocated an can be found in the process im

manpages/gnutls_openpgp_privkey_get_revoked_status.3.html
gnutls_openpgp_privkey_get_revoked_status.3.................
gnutls_openpgp_privkey_get_revoked_status.3 - Get revocation status of key. RETURNS true (1) if the key has been revoked, or false (0) if it has not, or a negat

manpages/git-unpack-file.1.html
git-unpack-file(1) - Creates a temporary file with a blobs c
Creates a file holding the contents of the blob specified by sha1. It returns the name of the temporary file in the following format: .merge_file_XXXXX OPTIONS

manpages/DBM_Filter.3pm.html
DBM_Filter(3pm) - Filter DBM keys/values - Linux man page...
This module provides an interface that allows filters to be applied to tied Hashes associated with DBM files. It builds on the DBM Filter hooks that are present

manpages/tigetstr_sp.3ncurses.html
tigetstr_sp(3ncurses) - curses screen-pointer extension.....
This implementation can be configured to provide a set of functions which improve the ability to manage multiple screens. This feature can be added to any of th

manpages/XrmOptionDescRec.3.html
XrmOptionDescRec(3) - initialize the Resource Manager, Resou
The XrmInitialize function initialize the resource manager. It must be called before any other Xrm functions are used. The XrmParseCommand function parses an (a

manpages/MIME::Head.3pm.html
MIME::Head(3pm) - MIME message header (a subclass of Mail::H
A class for parsing in and manipulating RFC-822 message headers, with some methods geared towards standard (and not so standard) MIME fields as specified in the

manpages/iso_8859-5.7.html
iso_8859-5(7) - ISO 8859-5 character set encoded in octal, d
The ISO 8859 standard includes several 8-bit extensions to the ASCII character set (also known as ISO 646-IRV). ISO 8859-5 encodes the Cyrillic alphabet as used

manpages/ber_first_element.3.html
ber_first_element(3) - OpenLDAP LBER simplified Basic Encodi
ber_first_element.3 - These routines provide a subroutine interface to a simplified implementation of the Basic Encoding Rules of ASN.1. The version of BER thes

manpages/groffer.1.html
groffer(1) - display groff files and man pages on X and tty
The groffer program is the easiest way to use groff(1). It can display arbitrary documents written in the groff language, see groff(7), or other roff languages,

manpages/mkfifoat.3.html
mkfifoat(3) - make a FIFO (named pipe) relative to a directo
mkfifo() makes a FIFO special file with name pathname. mode specifies the FIFOs permissions. It is modified by the processs umask in the usual way: the permissi





We can't live, work or learn in freedom unless the software we use is free.