ssh-agent.1

   1 .\" $OpenBSD: ssh-agent.1,v 1.59 2015/04/24 06:26:49 jmc 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 24 2015 $
  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 Dd
  47 .Op Fl a Ar bind_address
  48 .Op Fl E Ar fingerprint_hash
  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, Ed25519).
  58 .Nm
  59 is usually started in the beginning of an X-session or a login session, and
  60 all other windows or programs are started as clients to the ssh-agent
  61 program.
  62 Through use of environment variables the agent can be located
  63 and automatically used for authentication when logging in to other
  64 machines using
  65 .Xr ssh 1 .
  66 .Pp
  67 The agent initially does not have any private keys.
  68 Keys are added using
  69 .Xr ssh-add 1 .
  70 Multiple identities may be stored in
  71 .Nm
  72 concurrently and
  73 .Xr ssh 1
  74 will automatically use them if present.
  75 .Xr ssh-add 1
  76 is also used to remove keys from
  77 .Nm
  78 and to query the keys that are held in one.
  79 .Pp
  80 The options are as follows:
  81 .Bl -tag -width Ds
  82 .It Fl a Ar bind_address
  83 Bind the agent to the
  84 .Ux Ns -domain
  85 socket
  86 .Ar bind_address .
  87 The default is
  88 .Pa $TMPDIR/ssh-XXXXXXXXXX/agent.\*(Ltppid\*(Gt .
  89 .It Fl c
  90 Generate C-shell commands on
  91 .Dv stdout .
  92 This is the default if
  93 .Ev SHELL
  94 looks like it's a csh style of shell.
  95 .It Fl D
  96 Foreground mode.
  97 When this option is specified
  98 .Nm
  99 will not fork.
 100 .It Fl d
 101 Debug mode.
 102 When this option is specified
 103 .Nm
 104 will not fork and will write debug information to standard error.
 105 .It Fl E Ar fingerprint_hash
 106 Specifies the hash algorithm used when displaying key fingerprints.
 107 Valid options are:
 108 .Dq md5
 109 and
 110 .Dq sha256 .
 111 The default is
 112 .Dq sha256 .
 113 .It Fl k
 114 Kill the current agent (given by the
 115 .Ev SSH_AGENT_PID
 116 environment variable).
 117 .It Fl s
 118 Generate Bourne shell commands on
 119 .Dv stdout .
 120 This is the default if
 121 .Ev SHELL
 122 does not look like it's a csh style of shell.
 123 .It Fl t Ar life
 124 Set a default value for the maximum lifetime of identities added to the agent.
 125 The lifetime may be specified in seconds or in a time format specified in
 126 .Xr sshd_config 5 .
 127 A lifetime specified for an identity with
 128 .Xr ssh-add 1
 129 overrides this value.
 130 Without this option the default maximum lifetime is forever.
 131 .El
 132 .Pp
 133 If a commandline is given, this is executed as a subprocess of the agent.
 134 When the command dies, so does the agent.
 135 .Pp
 136 The idea is that the agent is run in the user's local PC, laptop, or
 137 terminal.
 138 Authentication data need not be stored on any other
 139 machine, and authentication passphrases never go over the network.
 140 However, the connection to the agent is forwarded over SSH
 141 remote logins, and the user can thus use the privileges given by the
 142 identities anywhere in the network in a secure way.
 143 .Pp
 144 There are two main ways to get an agent set up:
 145 The first is that the agent starts a new subcommand into which some environment
 146 variables are exported, eg
 147 .Cm ssh-agent xterm & .
 148 The second is that the agent prints the needed shell commands (either
 149 .Xr sh 1
 150 or
 151 .Xr csh 1
 152 syntax can be generated) which can be evaluated in the calling shell, eg
 153 .Cm eval `ssh-agent -s`
 154 for Bourne-type shells such as
 155 .Xr sh 1
 156 or
 157 .Xr ksh 1
 158 and
 159 .Cm eval `ssh-agent -c`
 160 for
 161 .Xr csh 1
 162 and derivatives.
 163 .Pp
 164 Later
 165 .Xr ssh 1
 166 looks at these variables and uses them to establish a connection to the agent.
 167 .Pp
 168 The agent will never send a private key over its request channel.
 169 Instead, operations that require a private key will be performed
 170 by the agent, and the result will be returned to the requester.
 171 This way, private keys are not exposed to clients using the agent.
 172 .Pp
 173 A
 174 .Ux Ns -domain
 175 socket is created and the name of this socket is stored in the
 176 .Ev SSH_AUTH_SOCK
 177 environment
 178 variable.
 179 The socket is made accessible only to the current user.
 180 This method is easily abused by root or another instance of the same
 181 user.
 182 .Pp
 183 The
 184 .Ev SSH_AGENT_PID
 185 environment variable holds the agent's process ID.
 186 .Pp
 187 The agent exits automatically when the command given on the command
 188 line terminates.
 189 .Sh FILES
 190 .Bl -tag -width Ds
 191 .It Pa $TMPDIR/ssh-XXXXXXXXXX/agent.\*(Ltppid\*(Gt
 192 .Ux Ns -domain
 193 sockets used to contain the connection to the authentication agent.
 194 These sockets should only be readable by the owner.
 195 The sockets should get automatically removed when the agent exits.
 196 .El
 197 .Sh SEE ALSO
 198 .Xr ssh 1 ,
 199 .Xr ssh-add 1 ,
 200 .Xr ssh-keygen 1 ,
 201 .Xr sshd 8
 202 .Sh AUTHORS
 203 OpenSSH is a derivative of the original and free
 204 ssh 1.2.12 release by Tatu Ylonen.
 205 Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
 206 Theo de Raadt and Dug Song
 207 removed many bugs, re-added newer features and
 208 created OpenSSH.
 209 Markus Friedl contributed the support for SSH
 210 protocol versions 1.5 and 2.0.