crypto/openssh/ssh-agent.1

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