1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 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 Jul 2025" "3.8.10" "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-2023 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
|