summaryrefslogtreecommitdiff
path: root/ssh-agent.1
diff options
context:
space:
mode:
authorDamien Miller <djm@mindrot.org>2000-03-26 13:04:51 +1000
committerDamien Miller <djm@mindrot.org>2000-03-26 13:04:51 +1000
commit450a7a1ff40fe7c2d84c93b83cf2df53445d807d (patch)
treedb6d08bdea65edd34ba2e323a31e2b1ca5e5fbd4 /ssh-agent.1
parent2c9279fa667827384fceb243f890cba1dbe480de (diff)
- OpenBSD CVS update
- [auth-krb4.c] -Wall - [auth-rh-rsa.c auth-rsa.c hostfile.c hostfile.h key.c key.h match.c] [match.h ssh.c ssh.h sshconnect.c sshd.c] initial support for DSA keys. ok deraadt@, niels@ - [cipher.c cipher.h] remove unused cipher_attack_detected code - [scp.1 ssh-add.1 ssh-agent.1 ssh-keygen.1 ssh.1 sshd.8] Fix some formatting problems I missed before. - [ssh.1 sshd.8] fix spelling errors, From: FreeBSD - [ssh.c] switch to raw mode only if he _get_ a pty (not if we _want_ a pty).
Diffstat (limited to 'ssh-agent.1')
-rw-r--r--ssh-agent.152
1 files changed, 30 insertions, 22 deletions
diff --git a/ssh-agent.1 b/ssh-agent.1
index b98775d90..7029b60dc 100644
--- a/ssh-agent.1
+++ b/ssh-agent.1
@@ -1,4 +1,4 @@
1.\" $OpenBSD: ssh-agent.1,v 1.9 2000/01/22 02:17:50 aaron Exp $ 1.\" $OpenBSD: ssh-agent.1,v 1.10 2000/03/23 21:10:10 aaron Exp $
2.\" 2.\"
3.\" -*- nroff -*- 3.\" -*- nroff -*-
4.\" 4.\"
@@ -27,12 +27,13 @@
27.Oc 27.Oc
28.Sh DESCRIPTION 28.Sh DESCRIPTION
29.Nm 29.Nm
30is a program to hold authentication private keys. The 30is a program to hold authentication private keys.
31idea is that 31The idea is that
32.Nm 32.Nm
33is started in the beginning of an X-session or a login session, and 33is started in the beginning of an X-session or a login session, and
34all other windows or programs are started as clients to the ssh-agent 34all other windows or programs are started as clients to the ssh-agent
35program. Through use of environment variables the agent can be located 35program.
36Through use of environment variables the agent can be located
36and automatically used for RSA authentication when logging in to other 37and automatically used for RSA authentication when logging in to other
37machines using 38machines using
38.Xr ssh 1 . 39.Xr ssh 1 .
@@ -60,30 +61,34 @@ environment variable).
60If a commandline is given, this is executed as a subprocess of the agent. 61If a commandline is given, this is executed as a subprocess of the agent.
61When the command dies, so does the agent. 62When the command dies, so does the agent.
62.Pp 63.Pp
63The agent initially does not have any private keys. Keys are added 64The agent initially does not have any private keys.
64using 65Keys are added using
65.Xr ssh-add 1 . 66.Xr ssh-add 1 .
66When executed without arguments, 67When executed without arguments,
67.Xr ssh-add 1 68.Xr ssh-add 1
68adds the 69adds the
69.Pa $HOME/.ssh/identity 70.Pa $HOME/.ssh/identity
70file. If the identity has a passphrase, 71file.
72If the identity has a passphrase,
71.Xr ssh-add 1 73.Xr ssh-add 1
72asks for the passphrase (using a small X11 application if running 74asks for the passphrase (using a small X11 application if running
73under X11, or from the terminal if running without X). It then sends 75under X11, or from the terminal if running without X).
74the identity to the agent. Several identities can be stored in the 76It then sends the identity to the agent.
77Several identities can be stored in the
75agent; the agent can automatically use any of these identities. 78agent; the agent can automatically use any of these identities.
76.Ic ssh-add -l 79.Ic ssh-add -l
77displays the identities currently held by the agent. 80displays the identities currently held by the agent.
78.Pp 81.Pp
79The idea is that the agent is run in the user's local PC, laptop, or 82The idea is that the agent is run in the user's local PC, laptop, or
80terminal. Authentication data need not be stored on any other 83terminal.
84Authentication data need not be stored on any other
81machine, and authentication passphrases never go over the network. 85machine, and authentication passphrases never go over the network.
82However, the connection to the agent is forwarded over SSH 86However, the connection to the agent is forwarded over SSH
83remote logins, and the user can thus use the privileges given by the 87remote logins, and the user can thus use the privileges given by the
84identities anywhere in the network in a secure way. 88identities anywhere in the network in a secure way.
85.Pp 89.Pp
86There are two main ways to get an agent setup: Either you let the agent 90There are two main ways to get an agent setup:
91Either you let the agent
87start a new subcommand into which some environment variables are exported, or 92start a new subcommand into which some environment variables are exported, or
88you let the agent print the needed shell commands (either 93you let the agent print the needed shell commands (either
89.Xr sh 1 94.Xr sh 1
@@ -99,7 +104,8 @@ A unix-domain socket is created
99and the name of this socket is stored in the 104and the name of this socket is stored in the
100.Ev SSH_AUTH_SOCK 105.Ev SSH_AUTH_SOCK
101environment 106environment
102variable. The socket is made accessible only to the current user. 107variable.
108The socket is made accessible only to the current user.
103This method is easily abused by root or another instance of the same 109This method is easily abused by root or another instance of the same
104user. 110user.
105.Pp 111.Pp
@@ -112,28 +118,30 @@ line terminates.
112.Sh FILES 118.Sh FILES
113.Bl -tag -width Ds 119.Bl -tag -width Ds
114.It Pa $HOME/.ssh/identity 120.It Pa $HOME/.ssh/identity
115Contains the RSA authentication identity of the user. This file 121Contains the RSA authentication identity of the user.
116should not be readable by anyone but the user. It is possible to 122This file should not be readable by anyone but the user.
123It is possible to
117specify a passphrase when generating the key; that passphrase will be 124specify a passphrase when generating the key; that passphrase will be
118used to encrypt the private part of this file. This file 125used to encrypt the private part of this file.
119is not used by 126This file is not used by
120.Nm 127.Nm
121but is normally added to the agent using 128but is normally added to the agent using
122.Xr ssh-add 1 129.Xr ssh-add 1
123at login time. 130at login time.
124.It Pa /tmp/ssh-XXXX/agent.<pid> , 131.It Pa /tmp/ssh-XXXX/agent.<pid> ,
125Unix-domain sockets used to contain the connection to the 132Unix-domain sockets used to contain the connection to the
126authentication agent. These sockets should only be readable by the 133authentication agent.
127owner. The sockets should get automatically removed when the agent 134These sockets should only be readable by the owner.
128exits. 135The sockets should get automatically removed when the agent exits.
129.Sh AUTHOR 136.Sh AUTHOR
130Tatu Ylonen <ylo@cs.hut.fi> 137Tatu Ylonen <ylo@cs.hut.fi>
131.Pp 138.Pp
132OpenSSH 139OpenSSH
133is a derivative of the original (free) ssh 1.2.12 release, but with bugs 140is a derivative of the original (free) ssh 1.2.12 release, but with bugs
134removed and newer features re-added. Rapidly after the 1.2.12 release, 141removed and newer features re-added.
135newer versions bore successively more restrictive licenses. This version 142Rapidly after the 1.2.12 release,
136of OpenSSH 143newer versions bore successively more restrictive licenses.
144This version of OpenSSH
137.Bl -bullet 145.Bl -bullet
138.It 146.It
139has all components of a restrictive nature (i.e., patents, see 147has all components of a restrictive nature (i.e., patents, see