summaryrefslogtreecommitdiff
path: root/ssh-agent.1
diff options
context:
space:
mode:
Diffstat (limited to 'ssh-agent.1')
-rw-r--r--ssh-agent.122
1 files changed, 13 insertions, 9 deletions
diff --git a/ssh-agent.1 b/ssh-agent.1
index 533cd6f6b..f65e8e625 100644
--- a/ssh-agent.1
+++ b/ssh-agent.1
@@ -1,4 +1,4 @@
1.\" $OpenBSD: ssh-agent.1,v 1.47 2009/03/26 08:38:39 sobrado Exp $ 1.\" $OpenBSD: ssh-agent.1,v 1.50 2010/01/17 21:49:09 tedu Exp $
2.\" 2.\"
3.\" Author: Tatu Ylonen <ylo@cs.hut.fi> 3.\" Author: Tatu Ylonen <ylo@cs.hut.fi>
4.\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland 4.\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
@@ -34,7 +34,7 @@
34.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF 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. 35.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
36.\" 36.\"
37.Dd $Mdocdate: March 26 2009 $ 37.Dd $Mdocdate: January 17 2010 $
38.Dt SSH-AGENT 1 38.Dt SSH-AGENT 1
39.Os 39.Os
40.Sh NAME 40.Sh NAME
@@ -67,7 +67,9 @@ machines using
67The options are as follows: 67The options are as follows:
68.Bl -tag -width Ds 68.Bl -tag -width Ds
69.It Fl a Ar bind_address 69.It Fl a Ar bind_address
70Bind the agent to the unix-domain socket 70Bind the agent to the
71.Ux Ns -domain
72socket
71.Ar bind_address . 73.Ar bind_address .
72The default is 74The default is
73.Pa /tmp/ssh-XXXXXXXXXX/agent.\*(Ltppid\*(Gt . 75.Pa /tmp/ssh-XXXXXXXXXX/agent.\*(Ltppid\*(Gt .
@@ -117,8 +119,9 @@ and
117.Pa ~/.ssh/identity . 119.Pa ~/.ssh/identity .
118If the identity has a passphrase, 120If the identity has a passphrase,
119.Xr ssh-add 1 121.Xr ssh-add 1
120asks for the passphrase (using a small X11 application if running 122asks for the passphrase on the terminal if it has one or from a small X11
121under X11, or from the terminal if running without X). 123program if running under X11.
124If neither of these is the case then the authentication will fail.
122It then sends the identity to the agent. 125It then sends the identity to the agent.
123Several identities can be stored in the 126Several identities can be stored in the
124agent; the agent can automatically use any of these identities. 127agent; the agent can automatically use any of these identities.
@@ -162,8 +165,9 @@ Instead, operations that require a private key will be performed
162by the agent, and the result will be returned to the requester. 165by the agent, and the result will be returned to the requester.
163This way, private keys are not exposed to clients using the agent. 166This way, private keys are not exposed to clients using the agent.
164.Pp 167.Pp
165A unix-domain socket is created 168A
166and the name of this socket is stored in the 169.Ux Ns -domain
170socket is created and the name of this socket is stored in the
167.Ev SSH_AUTH_SOCK 171.Ev SSH_AUTH_SOCK
168environment 172environment
169variable. 173variable.
@@ -186,8 +190,8 @@ Contains the protocol version 2 DSA authentication identity of the user.
186.It Pa ~/.ssh/id_rsa 190.It Pa ~/.ssh/id_rsa
187Contains the protocol version 2 RSA authentication identity of the user. 191Contains the protocol version 2 RSA authentication identity of the user.
188.It Pa /tmp/ssh-XXXXXXXXXX/agent.\*(Ltppid\*(Gt 192.It Pa /tmp/ssh-XXXXXXXXXX/agent.\*(Ltppid\*(Gt
189Unix-domain sockets used to contain the connection to the 193.Ux Ns -domain
190authentication agent. 194sockets used to contain the connection to the authentication agent.
191These sockets should only be readable by the owner. 195These sockets should only be readable by the owner.
192The sockets should get automatically removed when the agent exits. 196The sockets should get automatically removed when the agent exits.
193.El 197.El