doc/invoke-srptool.texi

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