ssh-add.1

   1 .\"  -*- nroff -*-
   2 .\"
   3 .\" ssh-add.1
   4 .\"
   5 .\" Author: Tatu Ylonen <ylo@cs.hut.fi>
   6 .\"
   7 .\" Copyright (c) 1995 Tatu Ylonen <ylo@cs.hut.fi>, Espoo, Finland
   8 .\"                    All rights reserved
   9 .\"
  10 .\" Created: Sat Apr 22 23:55:14 1995 ylo
  11 .\"
  12 .\" $Id$
  13 .\"
  14 .Dd September 25, 1999
  15 .Dt SSH-ADD 1
  16 .Os
  17 .Sh NAME
  18 .Nm ssh-add
  19 .Nd adds RSA identities for the authentication agent
  20 .Sh SYNOPSIS
  21 .Nm ssh-add
  22 .Op Fl lLdD
  23 .Op Ar
  24 .Sh DESCRIPTION
  25 .Nm
  26 adds RSA identities to the authentication agent,
  27 .Xr ssh-agent 1 .
  28 When run without arguments, it adds the file
  29 .Pa $HOME/.ssh/identity .
  30 Alternative file names can be given on the command line.
  31 If any file requires a passphrase,
  32 .Nm
  33 asks for the passphrase from the user.
  34 The Passphrase it is read from the user's tty.
  35 .Pp
  36 The authentication agent must be running and must be an ancestor of
  37 the current process for
  38 .Nm
  39 to work.
  40 .Pp
  41 The options are as follows:
  42 .Bl -tag -width Ds
  43 .It Fl l
  44 Lists fingerprints of all identities currently represented by the agent.
  45 .It Fl L
  46 Lists public key parameters of all identities currently represented by the agent.
  47 .It Fl d
  48 Instead of adding the identity, removes the identity from the agent.
  49 .It Fl D
  50 Deletes all identities from the agent.
  51 .El
  52 .Sh FILES
  53 .Bl -tag -width Ds
  54 .It Pa $HOME/.ssh/identity
  55 Contains the RSA authentication identity of the user.
  56 This file should not be readable by anyone but the user.
  57 Note that
  58 .Nm
  59 ignores this file if it is accessible by others.
  60 It is possible to
  61 specify a passphrase when generating the key; that passphrase will be
  62 used to encrypt the private part of this file.
  63 This is the default file added by
  64 .Nm
  65 when no other files have been specified.
  66 .Pp
  67 .Sh ENVIRONMENT
  68 .Bl -tag -width Ds
  69 .It Ev "DISPLAY" and "SSH_ASKPASS"
  70 If
  71 .Nm
  72 needs a passphrase, it will read the passphrase from the current
  73 terminal if it was run from a terminal.
  74 If
  75 .Nm
  76 does not have a terminal associated with it but
  77 .Ev DISPLAY
  78 and
  79 .Ev SSH_ASKPASS
  80 are set, it will execute the program specified by
  81 .Ev SSH_ASKPASS
  82 and open an X11 window to read the passphrase.
  83 This is particularly useful when calling
  84 .Nm
  85 from a
  86 .Pa .Xsession
  87 or related script.
  88 (Note that on some machines it
  89 may be necessary to redirect the input from
  90 .Pa /dev/null
  91 to make this work.)
  92 .Sh AUTHOR
  93 Tatu Ylonen <ylo@cs.hut.fi>
  94 .Pp
  95 OpenSSH
  96 is a derivative of the original (free) ssh 1.2.12 release, but with bugs
  97 removed and newer features re-added.
  98 Rapidly after the 1.2.12 release,
  99 newer versions bore successively more restrictive licenses.
 100 This version of OpenSSH
 101 .Bl -bullet
 102 .It
 103 has all components of a restrictive nature (i.e., patents)
 104 directly removed from the source code; any licensed or patented components
 105 are chosen from
 106 external libraries.
 107 .It
 108 has been updated to support ssh protocol 1.5.
 109 .It
 110 contains added support for
 111 .Xr kerberos 8
 112 authentication and ticket passing.
 113 .It
 114 supports one-time password authentication with
 115 .Xr skey 1 .
 116 .El
 117 .Sh SEE ALSO
 118 .Xr ssh 1 ,
 119 .Xr ssh-agent 1 ,
 120 .Xr ssh-keygen 1 ,
 121 .Xr sshd 8 ,