summaryrefslogtreecommitdiffstats
path: root/doc/manpages/srptool.1
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 07:33:12 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 07:33:12 +0000
commit36082a2fe36ecd800d784ae44c14f1f18c66a7e9 (patch)
tree6c68e0c0097987aff85a01dabddd34b862309a7c /doc/manpages/srptool.1
parentInitial commit. (diff)
downloadgnutls28-upstream.tar.xz
gnutls28-upstream.zip
Adding upstream version 3.7.9.upstream/3.7.9upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'doc/manpages/srptool.1')
-rw-r--r--doc/manpages/srptool.1143
1 files changed, 143 insertions, 0 deletions
diff --git a/doc/manpages/srptool.1 b/doc/manpages/srptool.1
new file mode 100644
index 0000000..e76102e
--- /dev/null
+++ b/doc/manpages/srptool.1
@@ -0,0 +1,143 @@
+.de1 NOP
+. it 1 an-trap
+. if \\n[.$] \,\\$*\/
+..
+.ie t \
+.ds B-Font [CB]
+.ds I-Font [CI]
+.ds R-Font [CR]
+.el \
+.ds B-Font B
+.ds I-Font I
+.ds R-Font R
+.TH srptool 1 "09 Feb 2023" "3.7.9" "User Commands"
+.SH NAME
+\f\*[B-Font]srptool\fP
+\- GnuTLS SRP tool
+.SH SYNOPSIS
+\f\*[B-Font]srptool\fP
+.\" Mixture of short (flag) options and long options
+[\f\*[B-Font]\-flags\f[]]
+[\f\*[B-Font]\-flag\f[] [\f\*[I-Font]value\f[]]]
+[\f\*[B-Font]\-\-option-name\f[][[=| ]\f\*[I-Font]value\f[]]]
+.sp \n(Ppu
+.ne 2
+
+All arguments must be options.
+.sp \n(Ppu
+.ne 2
+.SH "DESCRIPTION"
+Simple program that emulates the programs in the Stanford SRP (Secure
+Remote Password) libraries using GnuTLS. It is intended for use in places
+where you don't expect SRP authentication to be the used for system users.
+.sp
+In brief, to use SRP you need to create two files. These are the password
+file that holds the users and the verifiers associated with them and the
+configuration file to hold the group parameters (called tpasswd.conf).
+.sp
+.SH "OPTIONS"
+.TP
+.NOP \f\*[B-Font]\-d\f[] \f\*[I-Font]num\f[], \f\*[B-Font]\-\-debug\f[]=\f\*[I-Font]num\f[]
+Enable debugging.
+This option takes an integer number as its argument.
+The value of
+\f\*[I-Font]num\f[]
+is constrained to being:
+.in +4
+.nf
+.na
+in the range 0 through 9999
+.fi
+.in -4
+.sp
+Specifies the debug level.
+.TP
+.NOP \f\*[B-Font]\-i\f[] \f\*[I-Font]num\f[], \f\*[B-Font]\-\-index\f[]=\f\*[I-Font]num\f[]
+This option takes an integer number as its argument.
+The default
+\f\*[I-Font]number\f[]
+for this option is:
+.ti +4
+ 3
+.sp
+.TP
+.NOP \f\*[B-Font]\-u\f[] \f\*[I-Font]str\f[], \f\*[B-Font]\-\-username\f[]=\f\*[I-Font]str\f[]
+.TP
+.NOP \f\*[B-Font]\-p\f[] \f\*[I-Font]str\f[], \f\*[B-Font]\-\-passwd\f[]=\f\*[I-Font]str\f[]
+.TP
+.NOP \f\*[B-Font]\-s\f[] \f\*[I-Font]num\f[], \f\*[B-Font]\-\-salt\f[]=\f\*[I-Font]num\f[]
+This option takes an integer number as its argument.
+.TP
+.NOP \f\*[B-Font]\-\-verify\f[]
+Verifies the password provided against the password file.
+.TP
+.NOP \f\*[B-Font]\-v\f[] \f\*[I-Font]str\f[], \f\*[B-Font]\-\-passwd\-conf\f[]=\f\*[I-Font]str\f[]
+Specify a filename or a PKCS #11 URL to read the CAs from.
+.TP
+.NOP \f\*[B-Font]\-\-create\-conf\f[]=\f\*[I-Font]str\f[]
+Generate a password configuration file.
+.sp
+This generates a password configuration file (tpasswd.conf)
+containing the required for TLS parameters.
+.TP
+.NOP \f\*[B-Font]\-v\f[] \f\*[I-Font]arg\f[], \f\*[B-Font]\-\-version\f[]=\f\*[I-Font]arg\f[]
+Output version of program and exit. The default mode is `v', a simple
+version. The `c' mode will print copyright information and `n' will
+print the full copyright notice.
+.TP
+.NOP \f\*[B-Font]\-h\f[], \f\*[B-Font]\-\-help\f[]
+Display usage information and exit.
+.TP
+.NOP \f\*[B-Font]\-!\f[], \f\*[B-Font]\-\-more\-help\f[]
+Pass the extended usage information through a pager.
+
+.sp
+.SH EXAMPLES
+To create \fItpasswd.conf\fP which holds the g and n values for SRP protocol
+(generator and a large prime), run:
+.br
+.in +4
+.nf
+$ srptool \-\-create\-conf /etc/tpasswd.conf
+.in -4
+.fi
+.sp
+This command will create \fI/etc/tpasswd\fP and will add user 'test' (you
+will also be prompted for a password). Verifiers are stored by default
+in the way libsrp expects.
+.br
+.in +4
+.nf
+$ srptool \-\-passwd /etc/tpasswd \-\-passwd\-conf /etc/tpasswd.conf \-u test
+.in -4
+.fi
+.sp
+.sp
+This command will check against a password. If the password matches
+the one in \fI/etc/tpasswd\fP you will get an ok.
+.br
+.in +4
+.nf
+$ srptool \-\-passwd /etc/tpasswd \-\-passwd\\-conf /etc/tpasswd.conf \-\-verify \-u test
+.in -4
+.fi
+.SH "EXIT STATUS"
+One of the following exit values will be returned:
+.TP
+.NOP 0 " (EXIT_SUCCESS)"
+Successful program execution.
+.TP
+.NOP 1 " (EXIT_FAILURE)"
+The operation failed or the command syntax was not valid.
+.PP
+.SH "SEE ALSO"
+gnutls\-cli\-debug (1), gnutls\-serv (1), srptool (1), psktool (1), certtool (1)
+.SH "AUTHORS"
+
+.SH "COPYRIGHT"
+Copyright (C) 2020-2021 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
+.
+.SH "BUGS"
+Please send bug reports to: bugs@gnutls.org