1.\" $OpenBSD: ssh-add.1,v 1.24 2001/04/10 09:13:21 itojun 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 for the authentication agent 46.Sh SYNOPSIS 47.Nm ssh-add 48.Op Fl lLdD 49.Op Ar 50.Sh DESCRIPTION 51.Nm 52adds RSA or DSA identities to the authentication agent, 53.Xr ssh-agent 1 . 54When run without arguments, it adds the file 55.Pa $HOME/.ssh/identity . 56Alternative file names can be given on the command line. 57If any file requires a passphrase, 58.Nm 59asks for the passphrase from the user. 60The Passphrase it is read from the user's tty. 61.Nm 62retries the last passphrase if multiple identity files are given. 63.Pp 64The authentication agent must be running and must be an ancestor of 65the current process for 66.Nm 67to work. 68.Pp 69The options are as follows: 70.Bl -tag -width Ds 71.It Fl l 72Lists fingerprints of all identities currently represented by the agent. 73.It Fl L 74Lists public key parameters of all identities currently represented by the agent. 75.It Fl d 76Instead of adding the identity, removes the identity from the agent. 77.It Fl D 78Deletes all identities from the agent. 79.El 80.Sh FILES 81.Bl -tag -width Ds 82.It Pa $HOME/.ssh/identity 83Contains the protocol version 1 RSA authentication identity of the user. 84This file should not be readable by anyone but the user. 85Note that 86.Nm 87ignores this file if it is accessible by others. 88It is possible to 89specify a passphrase when generating the key; that passphrase will be 90used to encrypt the private part of this file. 91This is the default file added by 92.Nm 93when no other files have been specified. 94.It Pa $HOME/.ssh/id_dsa 95Contains the protocol version 2 DSA authentication identity of the user. 96.It Pa $HOME/.ssh/id_rsa 97Contains the protocol version 2 RSA authentication identity of the user. 98.El 99.Sh ENVIRONMENT 100.Bl -tag -width Ds 101.It Ev "DISPLAY" and "SSH_ASKPASS" 102If 103.Nm 104needs a passphrase, it will read the passphrase from the current 105terminal if it was run from a terminal. 106If 107.Nm 108does not have a terminal associated with it but 109.Ev DISPLAY 110and 111.Ev SSH_ASKPASS 112are set, it will execute the program specified by 113.Ev SSH_ASKPASS 114and open an X11 window to read the passphrase. 115This is particularly useful when calling 116.Nm 117from a 118.Pa .Xsession 119or related script. 120(Note that on some machines it 121may be necessary to redirect the input from 122.Pa /dev/null 123to make this work.) 124.El 125.Sh AUTHORS 126OpenSSH is a derivative of the original and free 127ssh 1.2.12 release by Tatu Ylonen. 128Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos, 129Theo de Raadt and Dug Song 130removed many bugs, re-added newer features and 131created OpenSSH. 132Markus Friedl contributed the support for SSH 133protocol versions 1.5 and 2.0. 134.Sh SEE ALSO 135.Xr ssh 1 , 136.Xr ssh-agent 1 , 137.Xr ssh-keygen 1 , 138.Xr sshd 8 139