1.\" $OpenBSD: ssh-add.1,v 1.39 2003/06/10 09:12:11 jmc Exp $ 2.\" 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 September 25, 1999 41.Dt SSH-ADD 1 42.Os 43.Sh NAME 44.Nm ssh-add 45.Nd adds RSA or DSA identities to the authentication agent 46.Sh SYNOPSIS 47.Nm ssh-add 48.Op Fl lLdDxXc 49.Op Fl t Ar life 50.Op Ar 51.Nm ssh-add 52.Fl s Ar reader 53.Nm ssh-add 54.Fl e Ar reader 55.Sh DESCRIPTION 56.Nm 57adds RSA or DSA identities to the authentication agent, 58.Xr ssh-agent 1 . 59When run without arguments, it adds the files 60.Pa $HOME/.ssh/id_rsa , 61.Pa $HOME/.ssh/id_dsa 62and 63.Pa $HOME/.ssh/identity . 64Alternative file names can be given on the command line. 65If any file requires a passphrase, 66.Nm 67asks for the passphrase from the user. 68The passphrase is read from the user's tty. 69.Nm 70retries the last passphrase if multiple identity files are given. 71.Pp 72The authentication agent must be running and must be an ancestor of 73the current process for 74.Nm 75to work. 76.Pp 77The options are as follows: 78.Bl -tag -width Ds 79.It Fl l 80Lists fingerprints of all identities currently represented by the agent. 81.It Fl L 82Lists public key parameters of all identities currently represented by the agent. 83.It Fl d 84Instead of adding the identity, removes the identity from the agent. 85.It Fl D 86Deletes all identities from the agent. 87.It Fl x 88Lock the agent with a password. 89.It Fl X 90Unlock the agent. 91.It Fl t Ar life 92Set a maximum lifetime when adding identities to an agent. 93The lifetime may be specified in seconds or in a time format 94specified in 95.Xr sshd_config 5 . 96.It Fl c 97Indicates that added identities should be subject to confirmation before 98being used for authentication. 99Confirmation is performed by the 100.Ev SSH_ASKPASS 101program mentioned below. 102Successful confirmation is signaled by a zero exit status from the 103.Ev SSH_ASKPASS 104program, rather than text entered into the requester. 105.It Fl s Ar reader 106Add key in smartcard 107.Ar reader . 108.It Fl e Ar reader 109Remove key in smartcard 110.Ar reader . 111.El 112.Sh ENVIRONMENT 113.Bl -tag -width Ds 114.It Ev "DISPLAY" and "SSH_ASKPASS" 115If 116.Nm 117needs a passphrase, it will read the passphrase from the current 118terminal if it was run from a terminal. 119If 120.Nm 121does not have a terminal associated with it but 122.Ev DISPLAY 123and 124.Ev SSH_ASKPASS 125are set, it will execute the program specified by 126.Ev SSH_ASKPASS 127and open an X11 window to read the passphrase. 128This is particularly useful when calling 129.Nm 130from a 131.Pa .Xsession 132or related script. 133(Note that on some machines it 134may be necessary to redirect the input from 135.Pa /dev/null 136to make this work.) 137.It Ev SSH_AUTH_SOCK 138Identifies the path of a unix-domain socket used to communicate with the 139agent. 140.El 141.Sh FILES 142.Bl -tag -width Ds 143.It Pa $HOME/.ssh/identity 144Contains the protocol version 1 RSA authentication identity of the user. 145.It Pa $HOME/.ssh/id_dsa 146Contains the protocol version 2 DSA authentication identity of the user. 147.It Pa $HOME/.ssh/id_rsa 148Contains the protocol version 2 RSA authentication identity of the user. 149.El 150.Pp 151Identity files should not be readable by anyone but the user. 152Note that 153.Nm 154ignores identity files if they are accessible by others. 155.Sh DIAGNOSTICS 156Exit status is 0 on success, 1 if the specified command fails, 157and 2 if 158.Nm 159is unable to contact the authentication agent. 160.Sh SEE ALSO 161.Xr ssh 1 , 162.Xr ssh-agent 1 , 163.Xr ssh-keygen 1 , 164.Xr sshd 8 165.Sh AUTHORS 166OpenSSH is a derivative of the original and free 167ssh 1.2.12 release by Tatu Ylonen. 168Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos, 169Theo de Raadt and Dug Song 170removed many bugs, re-added newer features and 171created OpenSSH. 172Markus Friedl contributed the support for SSH 173protocol versions 1.5 and 2.0. 174