Import OpenSSH-6.7p1.
[dragonfly.git] / crypto / openssh / ssh-agent.1
1 .\" $OpenBSD: ssh-agent.1,v 1.55 2014/04/16 23:28:12 djm Exp $
2 .\"
3 .\" Author: Tatu Ylonen <ylo@cs.hut.fi>
4 .\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
5 .\"                    All rights reserved
6 .\"
7 .\" As far as I am concerned, the code I have written for this software
8 .\" can be used freely for any purpose.  Any derived versions of this
9 .\" software must be clearly marked as such, and if the derived work is
10 .\" incompatible with the protocol description in the RFC file, it must be
11 .\" called by a name other than "ssh" or "Secure Shell".
12 .\"
13 .\" Copyright (c) 1999,2000 Markus Friedl.  All rights reserved.
14 .\" Copyright (c) 1999 Aaron Campbell.  All rights reserved.
15 .\" Copyright (c) 1999 Theo de Raadt.  All rights reserved.
16 .\"
17 .\" Redistribution and use in source and binary forms, with or without
18 .\" modification, are permitted provided that the following conditions
19 .\" are met:
20 .\" 1. Redistributions of source code must retain the above copyright
21 .\"    notice, this list of conditions and the following disclaimer.
22 .\" 2. Redistributions in binary form must reproduce the above copyright
23 .\"    notice, this list of conditions and the following disclaimer in the
24 .\"    documentation and/or other materials provided with the distribution.
25 .\"
26 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
27 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
28 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
29 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
30 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
31 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
32 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
33 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
34 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
35 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36 .\"
37 .Dd $Mdocdate: April 16 2014 $
38 .Dt SSH-AGENT 1
39 .Os
40 .Sh NAME
41 .Nm ssh-agent
42 .Nd authentication agent
43 .Sh SYNOPSIS
44 .Nm ssh-agent
45 .Op Fl c | s
46 .Op Fl d
47 .Op Fl a Ar bind_address
48 .Op Fl t Ar life
49 .Op Ar command Op Ar arg ...
50 .Nm ssh-agent
51 .Op Fl c | s
52 .Fl k
53 .Sh DESCRIPTION
54 .Nm
55 is a program to hold private keys used for public key authentication
56 (RSA, DSA, ECDSA, ED25519).
57 .Nm
58 is usually started in the beginning of an X-session or a login session, and
59 all other windows or programs are started as clients to the ssh-agent
60 program.
61 Through use of environment variables the agent can be located
62 and automatically used for authentication when logging in to other
63 machines using
64 .Xr ssh 1 .
65 .Pp
66 The agent initially does not have any private keys.
67 Keys are added using
68 .Xr ssh-add 1 .
69 Multiple identities may be stored in
70 .Nm
71 concurrently and
72 .Xr ssh 1
73 will automatically use them if present.
74 .Xr ssh-add 1
75 is also used to remove keys from
76 .Nm
77 and to query the keys that are held in one.
78 .Pp
79 The options are as follows:
80 .Bl -tag -width Ds
81 .It Fl a Ar bind_address
82 Bind the agent to the
83 .Ux Ns -domain
84 socket
85 .Ar bind_address .
86 The default is
87 .Pa $TMPDIR/ssh-XXXXXXXXXX/agent.\*(Ltppid\*(Gt .
88 .It Fl c
89 Generate C-shell commands on
90 .Dv stdout .
91 This is the default if
92 .Ev SHELL
93 looks like it's a csh style of shell.
94 .It Fl d
95 Debug mode.
96 When this option is specified
97 .Nm
98 will not fork.
99 .It Fl k
100 Kill the current agent (given by the
101 .Ev SSH_AGENT_PID
102 environment variable).
103 .It Fl s
104 Generate Bourne shell commands on
105 .Dv stdout .
106 This is the default if
107 .Ev SHELL
108 does not look like it's a csh style of shell.
109 .It Fl t Ar life
110 Set a default value for the maximum lifetime of identities added to the agent.
111 The lifetime may be specified in seconds or in a time format specified in
112 .Xr sshd_config 5 .
113 A lifetime specified for an identity with
114 .Xr ssh-add 1
115 overrides this value.
116 Without this option the default maximum lifetime is forever.
117 .El
118 .Pp
119 If a commandline is given, this is executed as a subprocess of the agent.
120 When the command dies, so does the agent.
121 .Pp
122 The idea is that the agent is run in the user's local PC, laptop, or
123 terminal.
124 Authentication data need not be stored on any other
125 machine, and authentication passphrases never go over the network.
126 However, the connection to the agent is forwarded over SSH
127 remote logins, and the user can thus use the privileges given by the
128 identities anywhere in the network in a secure way.
129 .Pp
130 There are two main ways to get an agent set up:
131 The first is that the agent starts a new subcommand into which some environment
132 variables are exported, eg
133 .Cm ssh-agent xterm & .
134 The second is that the agent prints the needed shell commands (either
135 .Xr sh 1
136 or
137 .Xr csh 1
138 syntax can be generated) which can be evaluated in the calling shell, eg
139 .Cm eval `ssh-agent -s`
140 for Bourne-type shells such as
141 .Xr sh 1
142 or
143 .Xr ksh 1
144 and
145 .Cm eval `ssh-agent -c`
146 for
147 .Xr csh 1
148 and derivatives.
149 .Pp
150 Later
151 .Xr ssh 1
152 looks at these variables and uses them to establish a connection to the agent.
153 .Pp
154 The agent will never send a private key over its request channel.
155 Instead, operations that require a private key will be performed
156 by the agent, and the result will be returned to the requester.
157 This way, private keys are not exposed to clients using the agent.
158 .Pp
159 A
160 .Ux Ns -domain
161 socket is created and the name of this socket is stored in the
162 .Ev SSH_AUTH_SOCK
163 environment
164 variable.
165 The socket is made accessible only to the current user.
166 This method is easily abused by root or another instance of the same
167 user.
168 .Pp
169 The
170 .Ev SSH_AGENT_PID
171 environment variable holds the agent's process ID.
172 .Pp
173 The agent exits automatically when the command given on the command
174 line terminates.
175 .Sh FILES
176 .Bl -tag -width Ds
177 .It Pa $TMPDIR/ssh-XXXXXXXXXX/agent.\*(Ltppid\*(Gt
178 .Ux Ns -domain
179 sockets used to contain the connection to the authentication agent.
180 These sockets should only be readable by the owner.
181 The sockets should get automatically removed when the agent exits.
182 .El
183 .Sh SEE ALSO
184 .Xr ssh 1 ,
185 .Xr ssh-add 1 ,
186 .Xr ssh-keygen 1 ,
187 .Xr sshd 8
188 .Sh AUTHORS
189 OpenSSH is a derivative of the original and free
190 ssh 1.2.12 release by Tatu Ylonen.
191 Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
192 Theo de Raadt and Dug Song
193 removed many bugs, re-added newer features and
194 created OpenSSH.
195 Markus Friedl contributed the support for SSH
196 protocol versions 1.5 and 2.0.