diff options
Diffstat (limited to 'ssh-agent.0')
-rw-r--r-- | ssh-agent.0 | 56 |
1 files changed, 28 insertions, 28 deletions
diff --git a/ssh-agent.0 b/ssh-agent.0 index 536eac756..dfc82a966 100644 --- a/ssh-agent.0 +++ b/ssh-agent.0 | |||
@@ -8,18 +8,18 @@ SYNOPSIS | |||
8 | ssh-agent [-c | -s] -k | 8 | ssh-agent [-c | -s] -k |
9 | 9 | ||
10 | DESCRIPTION | 10 | DESCRIPTION |
11 | ssh-agent is a program to hold private keys used for public key authenti- | 11 | ssh-agent is a program to hold private keys used for public key |
12 | cation (RSA, DSA). The idea is that ssh-agent is started in the begin- | 12 | authentication (RSA, DSA). The idea is that ssh-agent is started in the |
13 | ning of an X-session or a login session, and all other windows or pro- | 13 | beginning of an X-session or a login session, and all other windows or |
14 | grams are started as clients to the ssh-agent program. Through use of | 14 | programs are started as clients to the ssh-agent program. Through use of |
15 | environment variables the agent can be located and automatically used for | 15 | environment variables the agent can be located and automatically used for |
16 | authentication when logging in to other machines using ssh(1). | 16 | authentication when logging in to other machines using ssh(1). |
17 | 17 | ||
18 | The options are as follows: | 18 | The options are as follows: |
19 | 19 | ||
20 | -a bind_address | 20 | -a bind_address |
21 | Bind the agent to the UNIX-domain socket bind_address. The de- | 21 | Bind the agent to the UNIX-domain socket bind_address. The |
22 | fault is /tmp/ssh-XXXXXXXXXX/agent.<ppid>. | 22 | default is /tmp/ssh-XXXXXXXXXX/agent.<ppid>. |
23 | 23 | ||
24 | -c Generate C-shell commands on stdout. This is the default if | 24 | -c Generate C-shell commands on stdout. This is the default if |
25 | SHELL looks like it's a csh style of shell. | 25 | SHELL looks like it's a csh style of shell. |
@@ -50,15 +50,15 @@ DESCRIPTION | |||
50 | one or from a small X11 program if running under X11. If neither of | 50 | one or from a small X11 program if running under X11. If neither of |
51 | these is the case then the authentication will fail. It then sends the | 51 | these is the case then the authentication will fail. It then sends the |
52 | identity to the agent. Several identities can be stored in the agent; | 52 | identity to the agent. Several identities can be stored in the agent; |
53 | the agent can automatically use any of these identities. ssh-add -l dis- | 53 | the agent can automatically use any of these identities. ssh-add -l |
54 | plays the identities currently held by the agent. | 54 | displays the identities currently held by the agent. |
55 | 55 | ||
56 | The idea is that the agent is run in the user's local PC, laptop, or ter- | 56 | The idea is that the agent is run in the user's local PC, laptop, or |
57 | minal. Authentication data need not be stored on any other machine, and | 57 | terminal. Authentication data need not be stored on any other machine, |
58 | authentication passphrases never go over the network. However, the con- | 58 | and authentication passphrases never go over the network. However, the |
59 | nection to the agent is forwarded over SSH remote logins, and the user | 59 | connection to the agent is forwarded over SSH remote logins, and the user |
60 | can thus use the privileges given by the identities anywhere in the net- | 60 | can thus use the privileges given by the identities anywhere in the |
61 | work in a secure way. | 61 | network in a secure way. |
62 | 62 | ||
63 | There are two main ways to get an agent set up: The first is that the | 63 | There are two main ways to get an agent set up: The first is that the |
64 | agent starts a new subcommand into which some environment variables are | 64 | agent starts a new subcommand into which some environment variables are |
@@ -68,18 +68,18 @@ DESCRIPTION | |||
68 | Bourne-type shells such as sh(1) or ksh(1) and eval `ssh-agent -c` for | 68 | Bourne-type shells such as sh(1) or ksh(1) and eval `ssh-agent -c` for |
69 | csh(1) and derivatives. | 69 | csh(1) and derivatives. |
70 | 70 | ||
71 | Later ssh(1) looks at these variables and uses them to establish a con- | 71 | Later ssh(1) looks at these variables and uses them to establish a |
72 | nection to the agent. | 72 | connection to the agent. |
73 | 73 | ||
74 | The agent will never send a private key over its request channel. In- | 74 | The agent will never send a private key over its request channel. |
75 | stead, operations that require a private key will be performed by the | 75 | Instead, operations that require a private key will be performed by the |
76 | agent, and the result will be returned to the requester. This way, pri- | 76 | agent, and the result will be returned to the requester. This way, |
77 | vate keys are not exposed to clients using the agent. | 77 | private keys are not exposed to clients using the agent. |
78 | 78 | ||
79 | A UNIX-domain socket is created and the name of this socket is stored in | 79 | A UNIX-domain socket is created and the name of this socket is stored in |
80 | the SSH_AUTH_SOCK environment variable. The socket is made accessible | 80 | the SSH_AUTH_SOCK environment variable. The socket is made accessible |
81 | only to the current user. This method is easily abused by root or anoth- | 81 | only to the current user. This method is easily abused by root or |
82 | er instance of the same user. | 82 | another instance of the same user. |
83 | 83 | ||
84 | The SSH_AGENT_PID environment variable holds the agent's process ID. | 84 | The SSH_AGENT_PID environment variable holds the agent's process ID. |
85 | 85 | ||
@@ -100,9 +100,9 @@ FILES | |||
100 | the user. | 100 | the user. |
101 | 101 | ||
102 | /tmp/ssh-XXXXXXXXXX/agent.<ppid> | 102 | /tmp/ssh-XXXXXXXXXX/agent.<ppid> |
103 | UNIX-domain sockets used to contain the connection to the authen- | 103 | UNIX-domain sockets used to contain the connection to the |
104 | tication agent. These sockets should only be readable by the | 104 | authentication agent. These sockets should only be readable by |
105 | owner. The sockets should get automatically removed when the | 105 | the owner. The sockets should get automatically removed when the |
106 | agent exits. | 106 | agent exits. |
107 | 107 | ||
108 | SEE ALSO | 108 | SEE ALSO |
@@ -111,8 +111,8 @@ SEE ALSO | |||
111 | AUTHORS | 111 | AUTHORS |
112 | OpenSSH is a derivative of the original and free ssh 1.2.12 release by | 112 | OpenSSH is a derivative of the original and free ssh 1.2.12 release by |
113 | Tatu Ylonen. Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos, Theo | 113 | Tatu Ylonen. Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos, Theo |
114 | de Raadt and Dug Song removed many bugs, re-added newer features and cre- | 114 | de Raadt and Dug Song removed many bugs, re-added newer features and |
115 | ated OpenSSH. Markus Friedl contributed the support for SSH protocol | 115 | created OpenSSH. Markus Friedl contributed the support for SSH protocol |
116 | versions 1.5 and 2.0. | 116 | versions 1.5 and 2.0. |
117 | 117 | ||
118 | OpenBSD 4.7 January 17, 2010 2 | 118 | OpenBSD 4.8 January 17, 2010 OpenBSD 4.8 |