Annotation of src/usr.bin/ssh/ssh-add.1, Revision 1.39
1.39 ! jmc 1: .\" $OpenBSD: ssh-add.1,v 1.38 2003/03/28 10:11:43 jmc 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.36 markus 48: .Op Fl lLdDxXc
1.33 markus 49: .Op Fl t Ar life
1.2 deraadt 50: .Op Ar
1.26 jakob 51: .Nm ssh-add
52: .Fl s Ar reader
53: .Nm ssh-add
54: .Fl e Ar reader
1.12 aaron 55: .Sh DESCRIPTION
1.2 deraadt 56: .Nm
1.14 markus 57: adds RSA or DSA identities to the authentication agent,
1.2 deraadt 58: .Xr ssh-agent 1 .
1.28 djm 59: When run without arguments, it adds the files
60: .Pa $HOME/.ssh/id_rsa ,
1.35 deraadt 61: .Pa $HOME/.ssh/id_dsa
1.28 djm 62: and
1.2 deraadt 63: .Pa $HOME/.ssh/identity .
1.11 aaron 64: Alternative file names can be given on the command line.
65: If any file requires a passphrase,
1.2 deraadt 66: .Nm
1.12 aaron 67: asks for the passphrase from the user.
1.25 stevesk 68: The passphrase is read from the user's tty.
1.23 markus 69: .Nm
70: retries the last passphrase if multiple identity files are given.
1.2 deraadt 71: .Pp
1.1 deraadt 72: The authentication agent must be running and must be an ancestor of
73: the current process for
1.2 deraadt 74: .Nm
1.1 deraadt 75: to work.
1.2 deraadt 76: .Pp
77: The options are as follows:
78: .Bl -tag -width Ds
79: .It Fl l
1.7 markus 80: Lists fingerprints of all identities currently represented by the agent.
81: .It Fl L
82: Lists public key parameters of all identities currently represented by the agent.
1.2 deraadt 83: .It Fl d
1.1 deraadt 84: Instead of adding the identity, removes the identity from the agent.
1.2 deraadt 85: .It Fl D
1.1 deraadt 86: Deletes all identities from the agent.
1.32 markus 87: .It Fl x
88: Lock the agent with a password.
89: .It Fl X
90: Unlock the agent.
1.33 markus 91: .It Fl t Ar life
92: Set a maximum lifetime when adding identities to an agent.
1.34 stevesk 93: The lifetime may be specified in seconds or in a time format
94: specified in
1.37 markus 95: .Xr sshd_config 5 .
1.36 markus 96: .It Fl c
97: Indicates that added identities should be subject to confirmation before
1.38 jmc 98: being used for authentication.
99: Confirmation is performed by the
1.36 markus 100: .Ev SSH_ASKPASS
1.38 jmc 101: program mentioned below.
102: Successful confirmation is signaled by a zero exit status from the
1.36 markus 103: .Ev SSH_ASKPASS
104: program, rather than text entered into the requester.
1.26 jakob 105: .It Fl s Ar reader
106: Add key in smartcard
107: .Ar reader .
108: .It Fl e Ar reader
109: Remove key in smartcard
110: .Ar reader .
1.2 deraadt 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.31 markus 137: .It Ev SSH_AUTH_SOCK
138: Identifies the path of a unix-domain socket used to communicate with the
139: agent.
1.16 itojun 140: .El
1.39 ! jmc 141: .Sh FILES
! 142: .Bl -tag -width Ds
! 143: .It Pa $HOME/.ssh/identity
! 144: Contains the protocol version 1 RSA authentication identity of the user.
! 145: .It Pa $HOME/.ssh/id_dsa
! 146: Contains the protocol version 2 DSA authentication identity of the user.
! 147: .It Pa $HOME/.ssh/id_rsa
! 148: Contains the protocol version 2 RSA authentication identity of the user.
! 149: .El
! 150: .Pp
! 151: Identity files should not be readable by anyone but the user.
! 152: Note that
! 153: .Nm
! 154: ignores identity files if they are accessible by others.
1.29 markus 155: .Sh DIAGNOSTICS
156: Exit status is 0 on success, 1 if the specified command fails,
157: and 2 if
158: .Nm
159: is unable to contact the authentication agent.
1.39 ! jmc 160: .Sh SEE ALSO
! 161: .Xr ssh 1 ,
! 162: .Xr ssh-agent 1 ,
! 163: .Xr ssh-keygen 1 ,
! 164: .Xr sshd 8
1.18 aaron 165: .Sh AUTHORS
1.19 markus 166: OpenSSH is a derivative of the original and free
167: ssh 1.2.12 release by Tatu Ylonen.
168: Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
169: Theo de Raadt and Dug Song
170: removed many bugs, re-added newer features and
171: created OpenSSH.
172: Markus Friedl contributed the support for SSH
173: protocol versions 1.5 and 2.0.
![[BACK]](/icons/back.gif){kind=icon}
Return to ssh-add.1 CVS log ![[TXT]](/icons/text.gif){kind=icon}
![[DIR]](/icons/dir.gif){kind=icon}
Up to [local] / src / usr.bin / ssh