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