|
Packit |
aea12f |
@node psktool Invocation
|
|
Packit |
aea12f |
@subsubsection Invoking psktool
|
|
Packit |
aea12f |
@pindex psktool
|
|
Packit |
aea12f |
@ignore
|
|
Packit |
aea12f |
# -*- buffer-read-only: t -*- vi: set ro:
|
|
Packit |
aea12f |
#
|
|
Packit |
aea12f |
# DO NOT EDIT THIS FILE (invoke-psktool.texi)
|
|
Packit |
aea12f |
#
|
|
Packit |
aea12f |
# It has been AutoGen-ed
|
|
Packit |
aea12f |
# From the definitions ../src/psktool-args.def
|
|
Packit |
aea12f |
# and the template file agtexi-cmd.tpl
|
|
Packit |
aea12f |
@end ignore
|
|
Packit |
aea12f |
|
|
Packit |
aea12f |
|
|
Packit |
aea12f |
Program that generates random keys for use with TLS-PSK. The
|
|
Packit |
aea12f |
keys are stored in hexadecimal format in a key file.
|
|
Packit |
aea12f |
|
|
Packit |
aea12f |
This section was generated by @strong{AutoGen},
|
|
Packit |
aea12f |
using the @code{agtexi-cmd} template and the option descriptions for the @code{psktool} program.
|
|
Packit |
aea12f |
This software is released under the GNU General Public License, version 3 or later.
|
|
Packit |
aea12f |
|
|
Packit |
aea12f |
|
|
Packit |
aea12f |
@anchor{psktool usage}
|
|
Packit |
aea12f |
@subsubheading psktool help/usage (@option{--help})
|
|
Packit |
aea12f |
@cindex psktool help
|
|
Packit |
aea12f |
|
|
Packit |
aea12f |
This is the automatically generated usage text for psktool.
|
|
Packit |
aea12f |
|
|
Packit |
aea12f |
The text printed is the same whether selected with the @code{help} option
|
|
Packit |
aea12f |
(@option{--help}) or the @code{more-help} option (@option{--more-help}). @code{more-help} will print
|
|
Packit |
aea12f |
the usage text by passing it through a pager program.
|
|
Packit |
aea12f |
@code{more-help} is disabled on platforms without a working
|
|
Packit |
aea12f |
@code{fork(2)} function. The @code{PAGER} environment variable is
|
|
Packit |
aea12f |
used to select the program, defaulting to @file{more}. Both will exit
|
|
Packit |
aea12f |
with a status code of 0.
|
|
Packit |
aea12f |
|
|
Packit |
aea12f |
@exampleindent 0
|
|
Packit |
aea12f |
@example
|
|
Packit |
aea12f |
psktool - GnuTLS PSK tool
|
|
Packit |
aea12f |
Usage: psktool [ -<flag> [<val>] | --<name>[@{=| @}<val>] ]...
|
|
Packit |
aea12f |
|
|
Packit |
aea12f |
-d, --debug=num Enable debugging
|
|
Packit |
aea12f |
- it must be in the range:
|
|
Packit |
aea12f |
0 to 9999
|
|
Packit |
aea12f |
-s, --keysize=num Specify the key size in bytes (default is 32-bytes or 256-bits)
|
|
Packit |
aea12f |
- it must be in the range:
|
|
Packit |
aea12f |
0 to 512
|
|
Packit |
aea12f |
-u, --username=str Specify the username to use
|
|
Packit |
aea12f |
-p, --pskfile=str Specify a pre-shared key file
|
|
Packit |
aea12f |
-v, --version[=arg] output version information and exit
|
|
Packit |
aea12f |
-h, --help display extended usage information and exit
|
|
Packit |
aea12f |
-!, --more-help extended usage information passed thru pager
|
|
Packit |
aea12f |
|
|
Packit |
aea12f |
Options are specified by doubled hyphens and their name or by a single
|
|
Packit |
aea12f |
hyphen and the flag character.
|
|
Packit |
aea12f |
|
|
Packit |
aea12f |
Program that generates random keys for use with TLS-PSK. The keys are
|
|
Packit |
aea12f |
stored in hexadecimal format in a key file.
|
|
Packit |
aea12f |
|
|
Packit |
aea12f |
@end example
|
|
Packit |
aea12f |
@exampleindent 4
|
|
Packit |
aea12f |
|
|
Packit |
aea12f |
@anchor{psktool debug}
|
|
Packit |
aea12f |
@subsubheading debug option (-d)
|
|
Packit |
aea12f |
|
|
Packit |
aea12f |
This is the ``enable debugging'' option.
|
|
Packit |
aea12f |
This option takes a number argument.
|
|
Packit |
aea12f |
Specifies the debug level.
|
|
Packit |
aea12f |
@anchor{psktool pskfile}
|
|
Packit |
aea12f |
@subsubheading pskfile option (-p)
|
|
Packit |
aea12f |
|
|
Packit |
aea12f |
This is the ``specify a pre-shared key file'' option.
|
|
Packit |
aea12f |
This option takes a string argument.
|
|
Packit |
aea12f |
This option will specify the pre-shared key file to store the generated keys.
|
|
Packit |
aea12f |
@anchor{psktool passwd}
|
|
Packit |
aea12f |
@subsubheading passwd option
|
|
Packit |
aea12f |
|
|
Packit |
aea12f |
This is an alias for the @code{pskfile} option,
|
|
Packit |
aea12f |
@pxref{psktool pskfile, the pskfile option documentation}.
|
|
Packit |
aea12f |
|
|
Packit |
aea12f |
@anchor{psktool exit status}
|
|
Packit |
aea12f |
@subsubheading psktool exit status
|
|
Packit |
aea12f |
|
|
Packit |
aea12f |
One of the following exit values will be returned:
|
|
Packit |
aea12f |
@table @samp
|
|
Packit |
aea12f |
@item 0 (EXIT_SUCCESS)
|
|
Packit |
aea12f |
Successful program execution.
|
|
Packit |
aea12f |
@item 1 (EXIT_FAILURE)
|
|
Packit |
aea12f |
The operation failed or the command syntax was not valid.
|
|
Packit |
aea12f |
@end table
|
|
Packit |
aea12f |
@anchor{psktool See Also}
|
|
Packit |
aea12f |
@subsubheading psktool See Also
|
|
Packit |
aea12f |
gnutls-cli-debug (1), gnutls-serv (1), srptool (1), certtool (1)
|
|
Packit |
aea12f |
@anchor{psktool Examples}
|
|
Packit |
aea12f |
@subsubheading psktool Examples
|
|
Packit |
aea12f |
To add a user 'psk_identity' in @file{keys.psk} for use with GnuTLS run:
|
|
Packit |
aea12f |
@example
|
|
Packit |
aea12f |
$ ./psktool -u psk_identity -p keys.psk
|
|
Packit |
aea12f |
Generating a random key for user 'psk_identity'
|
|
Packit |
aea12f |
Key stored to keys.psk
|
|
Packit |
aea12f |
$ cat keys.psk
|
|
Packit |
aea12f |
psk_identity:88f3824b3e5659f52d00e959bacab954b6540344
|
|
Packit |
aea12f |
$
|
|
Packit |
aea12f |
@end example
|
|
Packit |
aea12f |
|
|
Packit |
aea12f |
This command will create @file{keys.psk} if it does not exist
|
|
Packit |
aea12f |
and will add user 'psk_identity'.
|