doc/invoke-srptool.texi

   1 @node srptool Invocation
   2 @subsection Invoking srptool
   3 @pindex srptool
   4 @cindex GnuTLS SRP tool
   5 @ignore
   6 #  -*- buffer-read-only: t -*- vi: set ro:
   7 #
   8 # DO NOT EDIT THIS FILE   (invoke-srptool.texi)
   9 #
  10 # It has been AutoGen-ed  May  9, 2012 at 08:06:13 PM by AutoGen 5.16
  11 # From the definitions    ../src/srptool-args.def
  12 # and the template file   agtexi-cmd.tpl
  13 @end ignore
  14
  15
  16 Simple program that emulates the programs in the Stanford SRP (Secure
  17 Remote Password) libraries using GnuTLS.  It is intended for use in  places
  18 where you don't expect SRP authentication to be the used for system users.
  19
  20 In  brief,  to use SRP you need to create two files. These are the password
  21 file that holds the users and the verifiers associated with  them  and  the
  22 configuration file to hold the group parameters (called tpasswd.conf).
  23
  24 This section was generated by @strong{AutoGen},
  25 using the @code{agtexi-cmd} template and the option descriptions for the @code{srptool} program.
  26 This software is released under the GNU General Public License, version 3 or later.
  27
  28
  29 @anchor{srptool usage}
  30 @subsubheading srptool help/usage (-h)
  31 @cindex srptool help
  32
  33 This is the automatically generated usage text for srptool.
  34 The text printed is the same whether for the @code{help} option (-h) or the @code{more-help} option (-!).  @code{more-help} will print
  35 the usage text by passing it through a pager program.
  36 @code{more-help} is disabled on platforms without a working
  37 @code{fork(2)} function.  The @code{PAGER} environment variable is
  38 used to select the program, defaulting to @file{more}.  Both will exit
  39 with a status code of 0.
  40
  41 @exampleindent 0
  42 @example
  43 srptool - GnuTLS SRP tool - Ver. @@VERSION@@
  44 USAGE:  srptool [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]...
  45
  46    -d, --debug=num            Enable debugging.
  47                                 - It must be in the range:
  48                                   0 to 9999
  49    -i, --index                specify the index of the group parameters in tpasswd.conf to use.
  50    -u, --username=str         specify a username
  51    -p, --passwd=str           specify a password file.
  52    -s, --salt=num             specify salt size.
  53        --verify               just verify the password.
  54    -v, --passwd-conf=str      specify a password conf file.
  55        --create-conf=str      Generate a password configuration file.
  56    -v, --version[=arg]        Output version information and exit
  57    -h, --help                 Display extended usage information and exit
  58    -!, --more-help            Extended usage information passed thru pager
  59
  60 Options are specified by doubled hyphens and their name or by a single
  61 hyphen and the flag character.
  62
  63
  64
  65 Simple program that emulates the programs in the Stanford SRP (Secure
  66 Remote Password) libraries using GnuTLS.  It is intended for use in places
  67 where you don't expect SRP authentication to be the used for system users.
  68
  69 In brief, to use SRP you need to create two files.  These are the password
  70 file that holds the users and the verifiers associated with them and the
  71 configuration file to hold the group parameters (called tpasswd.conf).
  72
  73 please send bug reports to:  bug-gnutls@@gnu.org
  74 @end example
  75 @exampleindent 4
  76
  77 @anchor{srptool debug}
  78 @subsubheading debug option (-d)
  79 @cindex srptool-debug
  80
  81 This is the ``enable debugging.'' option.
  82 This option takes an argument number.
  83 Specifies the debug level.
  84 @anchor{srptool verify}
  85 @subsubheading verify option
  86 @cindex srptool-verify
  87
  88 This is the ``just verify the password.'' option.
  89 Verifies the password provided against the password file.
  90 @anchor{srptool passwd-conf}
  91 @subsubheading passwd-conf option (-v)
  92 @cindex srptool-passwd-conf
  93
  94 This is the ``specify a password conf file.'' option.
  95 This option takes an argument string.
  96 Specify a filename or a PKCS #11 URL to read the CAs from.
  97 @anchor{srptool create-conf}
  98 @subsubheading create-conf option
  99 @cindex srptool-create-conf
 100
 101 This is the ``generate a password configuration file.'' option.
 102 This option takes an argument string.
 103 This generates a password configuration file (tpasswd.conf)
 104 containing the required for TLS parameters.
 105 @anchor{srptool exit status}
 106 @subsubheading srptool exit status
 107
 108 One of the following exit values will be returned:
 109 @table @samp
 110 @item 0 (EXIT_SUCCESS)
 111 Successful program execution.
 112 @item 1 (EXIT_FAILURE)
 113 The operation failed or the command syntax was not valid.
 114 @end table
 115 @anchor{srptool See Also}
 116 @subsubheading srptool See Also
 117     gnutls-cli-debug (1), gnutls-serv (1), srptool (1), psktool (1), certtool (1)
 118
 119 @anchor{srptool Examples}
 120 @subsubheading srptool Examples
 121 To create @file{tpasswd.conf} which holds the g and n values for SRP protocol
 122 (generator and a large prime), run:
 123 @example
 124 $ srptool --create-conf /etc/tpasswd.conf
 125 @end example
 126
 127 This command will create @file{/etc/tpasswd} and will add user 'test' (you
 128 will also be prompted for a password). Verifiers are stored by default
 129 in the way libsrp expects.
 130 @example
 131 $ srptool --passwd /etc/tpasswd --passwd-conf /etc/tpasswd.conf -u test
 132 @end example
 133
 134
 135 This command will check against a password. If the password matches
 136 the one in @file{/etc/tpasswd} you will get an ok.
 137 @example
 138 $ srptool --passwd /etc/tpasswd --passwd\-conf /etc/tpasswd.conf --verify -u test
 139 @end example
 140