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     descrip   = "specify the index of the group parameters in tpasswd.conf to use.";
  22     doc = "";
  23 };
  24
  25 flag = {
  26     name      = username;
  27     value     = u;
  28     arg-type  = string;
  29     descrip   = "specify a username";
  30     doc = "";
  31 };
  32
  33 flag = {
  34     name      = passwd;
  35     value     = p;
  36     arg-type  = string;
  37     descrip   = "specify a password file.";
  38     doc       = "";
  39 };
  40
  41 flag = {
  42     name      = salt;
  43     value     = s;
  44     arg-type  = number;
  45     descrip   = "specify salt size.";
  46     doc = "";
  47 };
  48
  49 flag = {
  50     name      = verify;
  51     descrip   = "just verify the password.";
  52     doc       = "Verifies the password provided against the password file.";
  53 };
  54
  55 flag = {
  56     name      = passwd-conf;
  57     value     = v;
  58     arg-type  = string;
  59     descrip   = "specify a password conf file.";
  60     doc   = "Specify a filename or a PKCS #11 URL to read the CAs from.";
  61 };
  62
  63 flag = {
  64     name      = create-conf;
  65     arg-type  = string;
  66     descrip   = "Generate a password configuration file.";
  67     doc   = "This generates a password configuration file (tpasswd.conf)
  68 containing the required for TLS parameters.";
  69 };
  70
  71 doc-section = {
  72   ds-type = 'SEE ALSO';
  73   ds-format = 'texi';
  74   ds-text   = <<-_EOT_
  75     gnutls-cli-debug (1), gnutls-serv (1), srptool (1), psktool (1), certtool (1)
  76 _EOT_;
  77 };
  78
  79 doc-section = {
  80   ds-type = 'EXAMPLES';
  81   ds-format = 'texi';
  82   ds-text   = <<-_EOT_
  83 To create @file{tpasswd.conf} which holds the g and n values for SRP protocol
  84 (generator and a large prime), run:
  85 @example
  86 $ srptool --create-conf /etc/tpasswd.conf
  87 @end example
  88
  89 This command will create @file{/etc/tpasswd} and will add user 'test' (you
  90 will also be prompted for a password). Verifiers are stored by default
  91 in the way libsrp expects.
  92 @example
  93 $ srptool --passwd /etc/tpasswd --passwd-conf /etc/tpasswd.conf -u test
  94 @end example
  95
  96
  97 This command will check against a password. If the password matches
  98 the one in @file{/etc/tpasswd} you will get an ok.
  99 @example
 100 $ srptool --passwd /etc/tpasswd --passwd\-conf /etc/tpasswd.conf --verify -u test
 101 @end example
 102 _EOT_;
 103 };
 104