[thirdparty/openssl.git] / doc / man1 / srp.pod

=pod

=head1 NAME

openssl-srp,
srp - maintain SRP password file

=head1 SYNOPSIS

B<openssl srp>
[B<-help>]
[B<-verbose>]
[B<-add>]
[B<-modify>]
[B<-delete>]
[B<-list>]
[B<-name section>]
[B<-config file>]
[B<-srpvfile file>]
[B<-gn identifier>]
[B<-userinfo text...>]
[B<-passin arg>]
[B<-passout arg>]
[I<user...>]

=head1 DESCRIPTION

The B<srp> command is used to maintain an SRP (secure remote password)
file.
At most one of the B<-add>, B<-modify>, B<-delete>, and B<-list> options
can be specified.
These options take zero or more usernames as parameters and perform the
appropriate operation on the SRP file.
For B<-list>, if no B<user> is given then all users are displayed.

The configuration file to use, and the section within the file, can be
specified with the B<-config> and B<-name> flags, respectively.
If the config file is not specified, the B<-srpvfile> can be used to
just specify the file to operate on.

The B<-userinfo> option specifies additional information to add when
adding or modifying a user.

The B<-gn> flag specifies the B<g> and B<N> values, using one of
the strengths defined in IETF RFC 5054.

The B<-passin> and B<-passout> arguments are parsed as described in
the L<openssl(1)> command.

=head1 OPTIONS

=over 4

=item [B<-help>]

Display an option summary.

=item [B<-verbose>]

Generate verbose output while processing.

=back

=head1 COPYRIGHT

Copyright 2017-2018 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the OpenSSL license (the "License").  You may not use
this file except in compliance with the License.  You can obtain a copy
in the file LICENSE in the source distribution or at
L<https://www.openssl.org/source/license.html>.

=cut
Commit	Line	Data
e75138ab RS	1	=pod
	2
	3	=head1 NAME
	4
3f2181e6	5	openssl-srp,
e75138ab RS	6	srp - maintain SRP password file
	7
	8	=head1 SYNOPSIS
	9
	10	B<openssl srp>
	11	[B<-help>]
	12	[B<-verbose>]
	13	[B<-add>]
	14	[B<-modify>]
	15	[B<-delete>]
	16	[B<-list>]
	17	[B<-name section>]
	18	[B<-config file>]
	19	[B<-srpvfile file>]
	20	[B<-gn identifier>]
	21	[B<-userinfo text...>]
	22	[B<-passin arg>]
	23	[B<-passout arg>]
	24	[I<user...>]
	25
	26	=head1 DESCRIPTION
	27
495a1e5c	28	The B<srp> command is used to maintain an SRP (secure remote password)
e75138ab RS	29	file.
	30	At most one of the B<-add>, B<-modify>, B<-delete>, and B<-list> options
	31	can be specified.
	32	These options take zero or more usernames as parameters and perform the
	33	appropriate operation on the SRP file.
	34	For B<-list>, if no B<user> is given then all users are displayed.
	35
	36	The configuration file to use, and the section within the file, can be
	37	specified with the B<-config> and B<-name> flags, respectively.
	38	If the config file is not specified, the B<-srpvfile> can be used to
	39	just specify the file to operate on.
	40
	41	The B<-userinfo> option specifies additional information to add when
	42	adding or modifying a user.
	43
	44	The B<-gn> flag specifies the B<g> and B<N> values, using one of
	45	the strengths defined in IETF RFC 5054.
	46
	47	The B<-passin> and B<-passout> arguments are parsed as described in
	48	the L<openssl(1)> command.
	49
	50	=head1 OPTIONS
	51
	52	=over 4
	53
	54	=item [B<-help>]
	55
	56	Display an option summary.
	57
	58	=item [B<-verbose>]
	59
	60	Generate verbose output while processing.
	61
	62	=back
	63
	64	=head1 COPYRIGHT
	65
c486283c	66	Copyright 2017-2018 The OpenSSL Project Authors. All Rights Reserved.
e75138ab RS	67
	68	Licensed under the OpenSSL license (the "License"). You may not use
	69	this file except in compliance with the License. You can obtain a copy
	70	in the file LICENSE in the source distribution or at
	71	L<https://www.openssl.org/source/license.html>.
	72
	73	=cut