src/srptool-args.def

   1 AutoGen Definitions options;
   2 prog-name     = srptool;
   3 prog-title    = "GnuTLS SRP tool";
   4 prog-desc     = "Simple program to create SRP parameters.\n";
   5 explain       = "";
   6 detail    = "Simple program that emulates the programs in the Stanford SRP (Secure
   7 Remote Password) libraries using GnuTLS.  It is intended for use in  places
   8 where you don't expect SRP authentication to be the used for system users.
   9
  10 In  brief,  to use SRP you need to create two files. These are the password
  11 file that holds the users and the verifiers associated with  them  and  the
  12 configuration file to hold the group parameters (called tpasswd.conf).";
  13
  14 short-usage   = "srptool [options]\nsrptool --help for usage instructions.\n";
  15
  16 #include args-std.def
  17
  18 flag = {
  19     name      = index;
  20     value     = i;
  21     arg-type  = number;
  22     arg-default = 1;
  23     descrip   = "specify the index of the group parameters in tpasswd.conf to use";
  24     doc = "";
  25 };
  26
  27 flag = {
  28     name      = username;
  29     value     = u;
  30     arg-type  = string;
  31     descrip   = "specify a username";
  32     doc = "";
  33 };
  34
  35 flag = {
  36     name      = passwd;
  37     value     = p;
  38     arg-type  = string;
  39     descrip   = "specify a password file";
  40     doc       = "";
  41 };
  42
  43 flag = {
  44     name      = salt;
  45     value     = s;
  46     arg-type  = number;
  47     descrip   = "specify salt size";
  48     doc = "";
  49 };
  50
  51 flag = {
  52     name      = verify;
  53     descrip   = "just verify the password.";
  54     doc       = "Verifies the password provided against the password file.";
  55 };
  56
  57 flag = {
  58     name      = passwd-conf;
  59     value     = v;
  60     arg-type  = string;
  61     descrip   = "specify a password conf file.";
  62     doc   = "Specify a filename or a PKCS #11 URL to read the CAs from.";
  63 };
  64
  65 flag = {
  66     name      = create-conf;
  67     arg-type  = string;
  68     descrip   = "Generate a password configuration file.";
  69     doc   = "This generates a password configuration file (tpasswd.conf)
  70 containing the required for TLS parameters.";
  71 };
  72
  73 doc-section = {
  74   ds-type = 'SEE ALSO';
  75   ds-format = 'texi';
  76   ds-text   = <<-_EOT_
  77     gnutls-cli-debug (1), gnutls-serv (1), srptool (1), psktool (1), certtool (1)
  78 _EOT_;
  79 };
  80
  81 doc-section = {
  82   ds-type = 'EXAMPLES';
  83   ds-format = 'texi';
  84   ds-text   = <<-_EOT_
  85 To create @file{tpasswd.conf} which holds the g and n values for SRP protocol
  86 (generator and a large prime), run:
  87 @example
  88 $ srptool --create-conf /etc/tpasswd.conf
  89 @end example
  90
  91 This command will create @file{/etc/tpasswd} and will add user 'test' (you
  92 will also be prompted for a password). Verifiers are stored by default
  93 in the way libsrp expects.
  94 @example
  95 $ srptool --passwd /etc/tpasswd --passwd-conf /etc/tpasswd.conf -u test
  96 @end example
  97
  98
  99 This command will check against a password. If the password matches
 100 the one in @file{/etc/tpasswd} you will get an ok.
 101 @example
 102 $ srptool --passwd /etc/tpasswd --passwd\-conf /etc/tpasswd.conf --verify -u test
 103 @end example
 104 _EOT_;
 105 };
 106