summaryrefslogtreecommitdiff
path: root/src/psk2tool.md.in
diff options
context:
space:
mode:
Diffstat (limited to 'src/psk2tool.md.in')
-rw-r--r--src/psk2tool.md.in60
1 files changed, 60 insertions, 0 deletions
diff --git a/src/psk2tool.md.in b/src/psk2tool.md.in
new file mode 100644
index 0000000000..3c2b4317ca
--- /dev/null
+++ b/src/psk2tool.md.in
@@ -0,0 +1,60 @@
+# NAME
+
+ psktool - GnuTLS PSK tool
+
+# SYNOPSIS
+
+ psktool [-flags] [-flag [value]] [--option-name[[=| ]value]]
+
+ All arguments must be options.
+
+# DESCRIPTION
+
+ Program that generates random keys for use with TLS-PSK. The keys are stored in hexadecimal format in a key
+ file.
+
+# OPTIONS
+
+@OPTIONS@
+
+# EXAMPLES
+
+To add a user 'psk_identity' in keys.psk for use with GnuTLS run:
+```
+$ ./psktool -u psk_identity -p keys.psk
+Generating a random key for user 'psk_identity'
+Key stored to keys.psk
+$ cat keys.psk
+psk_identity:88f3824b3e5659f52d00e959bacab954b6540344
+```
+
+This command will create keys.psk if it does not exist and will add user 'psk_identity'.
+
+# EXIT STATUS
+
+One of the following exit values will be returned:
+
+## 0 (EXIT_SUCCESS)
+
+ Successful program execution.
+
+## 1 (EXIT_FAILURE)
+
+ The operation failed or the command syntax was not valid.
+
+# SEE ALSO
+
+gnutls-cli-debug (1), gnutls-serv (1), srptool (1), certtool (1)
+
+# AUTHORS
+
+Nikos Mavrogiannopoulos, Simon Josefsson and others; see /usr/share/doc/gnutls/AUTHORS for a complete list.
+
+# COPYRIGHT
+
+Copyright (C) 2000-2019 Free Software Foundation, and others all rights reserved. This program is released
+under the terms of the GNU General Public License, version 3 or later.
+
+# BUGS
+
+Please send bug reports to: bugs@gnutls.org