Blame src/psktool-args.def

Packit 549fdc
AutoGen Definitions options;
Packit 549fdc
prog-name     = psktool;
Packit 549fdc
prog-title    = "GnuTLS PSK tool";
Packit 549fdc
prog-desc     = "Program to create PSK parameters.\n";
Packit 549fdc
detail    = "Program  that generates random keys for use with TLS-PSK. The
Packit 549fdc
keys are stored in hexadecimal format in a key file.";
Packit 549fdc
short-usage   = "psktool [options]\npsktool --help for usage instructions.\n";
Packit 549fdc
explain       = "";
Packit 549fdc
Packit 549fdc
#include args-std.def
Packit 549fdc
Packit 549fdc
flag = {
Packit 549fdc
    name      = keysize;
Packit 549fdc
    value     = s;
Packit 549fdc
    arg-type  = number;
Packit 549fdc
    arg-range = "0 -> 512";
Packit 549fdc
    descrip   = "Specify the key size in bytes (default is 32-bytes or 256-bits)";
Packit 549fdc
    doc = "";
Packit 549fdc
};
Packit 549fdc
Packit 549fdc
flag = {
Packit 549fdc
    name      = username;
Packit 549fdc
    value     = u;
Packit 549fdc
    arg-type  = string;
Packit 549fdc
    descrip   = "Specify the username to use";
Packit 549fdc
    doc = "";
Packit 549fdc
};
Packit 549fdc
Packit 549fdc
flag = {
Packit 549fdc
    name      = pskfile;
Packit 549fdc
    value     = p;
Packit 549fdc
    arg-type  = string;
Packit 549fdc
    descrip   = "Specify a pre-shared key file";
Packit 549fdc
    doc       = "This option will specify the pre-shared key file to store the generated keys.";
Packit 549fdc
};
Packit 549fdc
Packit 549fdc
flag = {
Packit 549fdc
    name      = passwd;
Packit 549fdc
    aliases   = pskfile;
Packit 549fdc
    descrip   = "Specify a pre-shared key file";
Packit 549fdc
    deprecated;
Packit 549fdc
};
Packit 549fdc
Packit 549fdc
doc-section = {
Packit 549fdc
  ds-type = 'SEE ALSO';
Packit 549fdc
  ds-format = 'texi';
Packit 549fdc
  ds-text   = <<-_EOT_
Packit 549fdc
    gnutls-cli-debug (1), gnutls-serv (1), srptool (1), certtool (1)
Packit 549fdc
_EOT_;
Packit 549fdc
};
Packit 549fdc
Packit 549fdc
doc-section = {
Packit 549fdc
  ds-type = 'EXAMPLES';
Packit 549fdc
  ds-format = 'texi';
Packit 549fdc
  ds-text   = <<-_EOT_
Packit 549fdc
To add a user 'psk_identity' in @file{keys.psk} for use with GnuTLS run:
Packit 549fdc
@example
Packit 549fdc
$ ./psktool -u psk_identity -p keys.psk
Packit 549fdc
Generating a random key for user 'psk_identity'
Packit 549fdc
Key stored to keys.psk
Packit 549fdc
$ cat keys.psk
Packit 549fdc
psk_identity:88f3824b3e5659f52d00e959bacab954b6540344
Packit 549fdc
$
Packit 549fdc
@end example
Packit 549fdc
Packit 549fdc
This command will create @file{keys.psk} if it does not exist
Packit 549fdc
and will add user 'psk_identity'.
Packit 549fdc
_EOT_;
Packit 549fdc
};
Packit 549fdc