1.\" $OpenBSD: ssh-add.1,v 1.58 2012/12/03 08:33:02 jmc Exp $ 2.\" 3.\" Author: Tatu Ylonen <ylo@cs.hut.fi> 4.\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland 5.\" All rights reserved 6.\" 7.\" As far as I am concerned, the code I have written for this software 8.\" can be used freely for any purpose. Any derived versions of this 9.\" software must be clearly marked as such, and if the derived work is 10.\" incompatible with the protocol description in the RFC file, it must be 11.\" called by a name other than "ssh" or "Secure Shell". 12.\" 13.\" 14.\" Copyright (c) 1999,2000 Markus Friedl. All rights reserved. 15.\" Copyright (c) 1999 Aaron Campbell. All rights reserved. 16.\" Copyright (c) 1999 Theo de Raadt. All rights reserved. 17.\" 18.\" Redistribution and use in source and binary forms, with or without 19.\" modification, are permitted provided that the following conditions 20.\" are met: 21.\" 1. Redistributions of source code must retain the above copyright 22.\" notice, this list of conditions and the following disclaimer. 23.\" 2. Redistributions in binary form must reproduce the above copyright 24.\" notice, this list of conditions and the following disclaimer in the 25.\" documentation and/or other materials provided with the distribution. 26.\" 27.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR 28.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES 29.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. 30.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT, 31.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT 32.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, 33.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY 34.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT 35.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 36.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. 37.\" 38.Dd December 3, 2012 39.Dt SSH-ADD 1 40.Os 41.Sh NAME 42.Nm ssh-add 43.Nd adds private key identities to the authentication agent 44.Sh SYNOPSIS 45.Nm ssh-add 46.Op Fl cDdkLlXx 47.Op Fl t Ar life 48.Op Ar 49.Nm ssh-add 50.Fl s Ar pkcs11 51.Nm ssh-add 52.Fl e Ar pkcs11 53.Sh DESCRIPTION 54.Nm 55adds private key identities to the authentication agent, 56.Xr ssh-agent 1 . 57When run without arguments, it adds the files 58.Pa ~/.ssh/id_rsa , 59.Pa ~/.ssh/id_dsa , 60.Pa ~/.ssh/id_ecdsa 61and 62.Pa ~/.ssh/identity . 63After loading a private key, 64.Nm 65will try to load corresponding certificate information from the 66filename obtained by appending 67.Pa -cert.pub 68to the name of the private key file. 69Alternative file names can be given on the command line. 70.Pp 71If any file requires a passphrase, 72.Nm 73asks for the passphrase from the user. 74The passphrase is read from the user's tty. 75.Nm 76retries the last passphrase if multiple identity files are given. 77.Pp 78The authentication agent must be running and the 79.Ev SSH_AUTH_SOCK 80environment variable must contain the name of its socket for 81.Nm 82to work. 83.Pp 84The options are as follows: 85.Bl -tag -width Ds 86.It Fl c 87Indicates that added identities should be subject to confirmation before 88being used for authentication. 89Confirmation is performed by the 90.Ev SSH_ASKPASS 91program mentioned below. 92Successful confirmation is signaled by a zero exit status from the 93.Ev SSH_ASKPASS 94program, rather than text entered into the requester. 95.It Fl D 96Deletes all identities from the agent. 97.It Fl d 98Instead of adding identities, removes identities from the agent. 99If 100.Nm 101has been run without arguments, the keys for the default identities and 102their corresponding certificates will be removed. 103Otherwise, the argument list will be interpreted as a list of paths to 104public key files to specify keys and certificates to be removed from the agent. 105If no public key is found at a given path, 106.Nm 107will append 108.Pa .pub 109and retry. 110.It Fl e Ar pkcs11 111Remove keys provided by the PKCS#11 shared library 112.Ar pkcs11 . 113.It Fl k 114When loading keys into or deleting keys from the agent, process plain private 115keys only and skip certificates. 116.It Fl L 117Lists public key parameters of all identities currently represented 118by the agent. 119.It Fl l 120Lists fingerprints of all identities currently represented by the agent. 121.It Fl s Ar pkcs11 122Add keys provided by the PKCS#11 shared library 123.Ar pkcs11 . 124.It Fl t Ar life 125Set a maximum lifetime when adding identities to an agent. 126The lifetime may be specified in seconds or in a time format 127specified in 128.Xr sshd_config 5 . 129.It Fl X 130Unlock the agent. 131.It Fl x 132Lock the agent with a password. 133.El 134.Sh ENVIRONMENT 135.Bl -tag -width Ds 136.It Ev "DISPLAY" and "SSH_ASKPASS" 137If 138.Nm 139needs a passphrase, it will read the passphrase from the current 140terminal if it was run from a terminal. 141If 142.Nm 143does not have a terminal associated with it but 144.Ev DISPLAY 145and 146.Ev SSH_ASKPASS 147are set, it will execute the program specified by 148.Ev SSH_ASKPASS 149and open an X11 window to read the passphrase. 150This is particularly useful when calling 151.Nm 152from a 153.Pa .xsession 154or related script. 155(Note that on some machines it 156may be necessary to redirect the input from 157.Pa /dev/null 158to make this work.) 159.It Ev SSH_AUTH_SOCK 160Identifies the path of a 161.Ux Ns -domain 162socket used to communicate with the agent. 163.El 164.Sh FILES 165.Bl -tag -width Ds 166.It Pa ~/.ssh/identity 167Contains the protocol version 1 RSA authentication identity of the user. 168.It Pa ~/.ssh/id_dsa 169Contains the protocol version 2 DSA authentication identity of the user. 170.It Pa ~/.ssh/id_ecdsa 171Contains the protocol version 2 ECDSA authentication identity of the user. 172.It Pa ~/.ssh/id_rsa 173Contains the protocol version 2 RSA authentication identity of the user. 174.El 175.Pp 176Identity files should not be readable by anyone but the user. 177Note that 178.Nm 179ignores identity files if they are accessible by others. 180.Sh EXIT STATUS 181Exit status is 0 on success, 1 if the specified command fails, 182and 2 if 183.Nm 184is unable to contact the authentication agent. 185.Sh SEE ALSO 186.Xr ssh 1 , 187.Xr ssh-agent 1 , 188.Xr ssh-keygen 1 , 189.Xr sshd 8 190.Sh AUTHORS 191OpenSSH is a derivative of the original and free 192ssh 1.2.12 release by Tatu Ylonen. 193Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos, 194Theo de Raadt and Dug Song 195removed many bugs, re-added newer features and 196created OpenSSH. 197Markus Friedl contributed the support for SSH 198protocol versions 1.5 and 2.0. 199