.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 "03 Jun 2020" "3.6.14" "User Commands"

.\"

.\" DO NOT EDIT THIS FILE (in-mem file)

.\"

.\" It has been AutoGen-ed

.\" From the definitions ../../src/srptool-args.def.tmp

.\" and the template file agman-cmd.tpl

.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).

.SH "OPTIONS"

.TP

.NOP \f\*[B-Font]\-d\f[] \f\*[I-Font]number\f[], \f\*[B-Font]\-\-debug\f[]=\f\*[I-Font]number\f[]

Enable debugging.

This option takes an integer number as its argument.

The value of

\f\*[I-Font]number\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]number\f[], \f\*[B-Font]\-\-index\f[]=\f\*[I-Font]number\f[]

specify the index of the group parameters in tpasswd.conf to use.

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]string\f[], \f\*[B-Font]\-\-username\f[]=\f\*[I-Font]string\f[]

specify a username.

.sp

.TP

.NOP \f\*[B-Font]\-p\f[] \f\*[I-Font]string\f[], \f\*[B-Font]\-\-passwd\f[]=\f\*[I-Font]string\f[]

specify a password file.

.sp

.TP

.NOP \f\*[B-Font]\-s\f[] \f\*[I-Font]number\f[], \f\*[B-Font]\-\-salt\f[]=\f\*[I-Font]number\f[]

specify salt size.

This option takes an integer number as its argument.

.sp

.TP

.NOP \f\*[B-Font]\-\-verify\f[]

just verify the password..

.sp

Verifies the password provided against the password file.

.TP

.NOP \f\*[B-Font]\-v\f[] \f\*[I-Font]string\f[], \f\*[B-Font]\-\-passwd\-conf\f[]=\f\*[I-Font]string\f[]

specify a password conf file..

.sp

Specify a filename or a PKCS #11 URL to read the CAs from.

.TP

.NOP \f\*[B-Font]\-\-create\-conf\f[]=\f\*[I-Font]string\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]\-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.

.TP

.NOP \f\*[B-Font]\-v\f[] [{\f\*[I-Font]v|c|n\f[] \f\*[B-Font]\-\-version\f[] [{\f\*[I-Font]v|c|n\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.

.PP

.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.

.TP

.NOP 70 " (EX_SOFTWARE)"

libopts had an internal operational error.  Please report

it to autogen-users@lists.sourceforge.net.  Thank you.

.PP

.SH "SEE ALSO"

    gnutls\-cli\-debug (1), gnutls\-serv (1), srptool (1), psktool (1), certtool (1)

.SH "AUTHORS"

Nikos Mavrogiannopoulos, Simon Josefsson and others; see /usr/share/doc/gnutls/AUTHORS for a complete list.

.SH "COPYRIGHT"

Copyright (C) 2000-2020 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

.SH "NOTES"

This manual page was \fIAutoGen\fP-erated from the \fBsrptool\fP

option definitions.