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