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