crypto/openssh/ssh-add.1

   1 .\"     $OpenBSD: ssh-add.1,v 1.52 2010/03/05 10:28:21 djm Exp $
   2 .\"
   3 .\"  -*- nroff -*-
   4 .\"
   5 .\" Author: Tatu Ylonen <ylo@cs.hut.fi>
   6 .\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
   7 .\"                    All rights reserved
   8 .\"
   9 .\" As far as I am concerned, the code I have written for this software
  10 .\" can be used freely for any purpose.  Any derived versions of this
  11 .\" software must be clearly marked as such, and if the derived work is
  12 .\" incompatible with the protocol description in the RFC file, it must be
  13 .\" called by a name other than "ssh" or "Secure Shell".
  14 .\"
  15 .\"
  16 .\" Copyright (c) 1999,2000 Markus Friedl.  All rights reserved.
  17 .\" Copyright (c) 1999 Aaron Campbell.  All rights reserved.
  18 .\" Copyright (c) 1999 Theo de Raadt.  All rights reserved.
  19 .\"
  20 .\" Redistribution and use in source and binary forms, with or without
  21 .\" modification, are permitted provided that the following conditions
  22 .\" are met:
  23 .\" 1. Redistributions of source code must retain the above copyright
  24 .\"    notice, this list of conditions and the following disclaimer.
  25 .\" 2. Redistributions in binary form must reproduce the above copyright
  26 .\"    notice, this list of conditions and the following disclaimer in the
  27 .\"    documentation and/or other materials provided with the distribution.
  28 .\"
  29 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  30 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  31 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  32 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  33 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  34 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  35 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  36 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  37 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  38 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  39 .\"
  40 .Dd March 5, 2010
  41 .Dt SSH-ADD 1
  42 .Os
  43 .Sh NAME
  44 .Nm ssh-add
  45 .Nd adds RSA or DSA identities to the authentication agent
  46 .Sh SYNOPSIS
  47 .Nm ssh-add
  48 .Op Fl cDdLlXx
  49 .Op Fl t Ar life
  50 .Op Ar
  51 .Nm ssh-add
  52 .Fl s Ar pkcs11
  53 .Nm ssh-add
  54 .Fl e Ar pkcs11
  55 .Sh DESCRIPTION
  56 .Nm
  57 adds RSA or DSA identities to the authentication agent,
  58 .Xr ssh-agent 1 .
  59 When run without arguments, it adds the files
  60 .Pa ~/.ssh/id_rsa ,
  61 .Pa ~/.ssh/id_dsa
  62 and
  63 .Pa ~/.ssh/identity .
  64 After loading a private key,
  65 .Nm
  66 will try to load corresponding certificate information from the
  67 filename obtained by appending
  68 .Pa -cert.pub
  69 to the name of the private key file.
  70 Alternative file names can be given on the command line.
  71 .Pp
  72 If any file requires a passphrase,
  73 .Nm
  74 asks for the passphrase from the user.
  75 The passphrase is read from the user's tty.
  76 .Nm
  77 retries the last passphrase if multiple identity files are given.
  78 .Pp
  79 The authentication agent must be running and the
  80 .Ev SSH_AUTH_SOCK
  81 environment variable must contain the name of its socket for
  82 .Nm
  83 to work.
  84 .Pp
  85 The options are as follows:
  86 .Bl -tag -width Ds
  87 .It Fl c
  88 Indicates that added identities should be subject to confirmation before
  89 being used for authentication.
  90 Confirmation is performed by the
  91 .Ev SSH_ASKPASS
  92 program mentioned below.
  93 Successful confirmation is signaled by a zero exit status from the
  94 .Ev SSH_ASKPASS
  95 program, rather than text entered into the requester.
  96 .It Fl D
  97 Deletes all identities from the agent.
  98 .It Fl d
  99 Instead of adding identities, removes identities from the agent.
 100 If
 101 .Nm
 102 has been run without arguments, the keys for the default identities will
 103 be removed.
 104 Otherwise, the argument list will be interpreted as a list of paths to
 105 public key files and matching keys will be removed from the agent.
 106 If no public key is found at a given path,
 107 .Nm
 108 will append
 109 .Pa .pub
 110 and retry.
 111 .It Fl e Ar pkcs11
 112 Remove keys provided by the PKCS#11 shared library
 113 .Ar pkcs11 .
 114 .It Fl L
 115 Lists public key parameters of all identities currently represented
 116 by the agent.
 117 .It Fl l
 118 Lists fingerprints of all identities currently represented by the agent.
 119 .It Fl s Ar pkcs11
 120 Add keys provided by the PKCS#11 shared library
 121 .Ar pkcs11 .
 122 .It Fl t Ar life
 123 Set a maximum lifetime when adding identities to an agent.
 124 The lifetime may be specified in seconds or in a time format
 125 specified in
 126 .Xr sshd_config 5 .
 127 .It Fl X
 128 Unlock the agent.
 129 .It Fl x
 130 Lock the agent with a password.
 131 .El
 132 .Sh ENVIRONMENT
 133 .Bl -tag -width Ds
 134 .It Ev "DISPLAY" and "SSH_ASKPASS"
 135 If
 136 .Nm
 137 needs a passphrase, it will read the passphrase from the current
 138 terminal if it was run from a terminal.
 139 If
 140 .Nm
 141 does not have a terminal associated with it but
 142 .Ev DISPLAY
 143 and
 144 .Ev SSH_ASKPASS
 145 are set, it will execute the program specified by
 146 .Ev SSH_ASKPASS
 147 and open an X11 window to read the passphrase.
 148 This is particularly useful when calling
 149 .Nm
 150 from a
 151 .Pa .xsession
 152 or related script.
 153 (Note that on some machines it
 154 may be necessary to redirect the input from
 155 .Pa /dev/null
 156 to make this work.)
 157 .It Ev SSH_AUTH_SOCK
 158 Identifies the path of a
 159 .Ux Ns -domain
 160 socket used to communicate with the agent.
 161 .El
 162 .Sh FILES
 163 .Bl -tag -width Ds
 164 .It Pa ~/.ssh/identity
 165 Contains the protocol version 1 RSA authentication identity of the user.
 166 .It Pa ~/.ssh/id_dsa
 167 Contains the protocol version 2 DSA authentication identity of the user.
 168 .It Pa ~/.ssh/id_rsa
 169 Contains the protocol version 2 RSA authentication identity of the user.
 170 .El
 171 .Pp
 172 Identity files should not be readable by anyone but the user.
 173 Note that
 174 .Nm
 175 ignores identity files if they are accessible by others.
 176 .Sh DIAGNOSTICS
 177 Exit status is 0 on success, 1 if the specified command fails,
 178 and 2 if
 179 .Nm
 180 is unable to contact the authentication agent.
 181 .Sh SEE ALSO
 182 .Xr ssh 1 ,
 183 .Xr ssh-agent 1 ,
 184 .Xr ssh-keygen 1 ,
 185 .Xr sshd 8
 186 .Sh AUTHORS
 187 OpenSSH is a derivative of the original and free
 188 ssh 1.2.12 release by Tatu Ylonen.
 189 Aaron Campbell, Bob Beck, Markus Friedl, Niels Provos,
 190 Theo de Raadt and Dug Song
 191 removed many bugs, re-added newer features and
 192 created OpenSSH.
 193 Markus Friedl contributed the support for SSH
 194 protocol versions 1.5 and 2.0.