]> git.ipfire.org Git - thirdparty/openssl.git/blame - doc/man1/openssl-srp.pod.in
Remove '=for openssl ifdef'
[thirdparty/openssl.git] / doc / man1 / openssl-srp.pod.in
CommitLineData
e75138ab 1=pod
625c781d 2{- OpenSSL::safe::output_do_not_edit_headers(); -}
9fcb9702 3
e75138ab
RS
4=head1 NAME
5
b6b66573 6openssl-srp - maintain SRP password file
e75138ab
RS
7
8=head1 SYNOPSIS
9
10B<openssl srp>
11[B<-help>]
12[B<-verbose>]
13[B<-add>]
14[B<-modify>]
15[B<-delete>]
16[B<-list>]
e8769719
RS
17[B<-name> I<section>]
18[B<-config> I<file>]
19[B<-srpvfile> I<file>]
20[B<-gn> I<identifier>]
fed8bd90 21[B<-userinfo> I<text>]
e8769719
RS
22[B<-passin> I<arg>]
23[B<-passout> I<arg>]
d55e4487 24{- $OpenSSL::safe::opt_engine_synopsis -}{- $OpenSSL::safe::opt_r_synopsis -}
6bd4e3f2 25{- $OpenSSL::safe::opt_provider_synopsis -}
b1c0cc24 26[I<user> ...]
e75138ab
RS
27
28=head1 DESCRIPTION
29
13888e79
MC
30This command is deprecated. It is used to maintain an SRP (secure remote
31password) file. At most one of the B<-add>, B<-modify>, B<-delete>, and B<-list>
32options can be specified.
e75138ab
RS
33These options take zero or more usernames as parameters and perform the
34appropriate operation on the SRP file.
2f0ea936 35For B<-list>, if no I<user> is given then all users are displayed.
e75138ab
RS
36
37The configuration file to use, and the section within the file, can be
38specified with the B<-config> and B<-name> flags, respectively.
e75138ab
RS
39
40=head1 OPTIONS
41
42=over 4
43
e8769719 44=item B<-help>
e75138ab
RS
45
46Display an option summary.
47
e8769719 48=item B<-verbose>
e75138ab
RS
49
50Generate verbose output while processing.
51
3a4e43de
RS
52=item B<-srpvfile> I<file>
53
54If the config file is not specified,
55B<-srpvfile> can be used to specify the file to operate on.
56
57=item B<-gn>
58
59Specifies the B<g> and B<N> values, using one of
60the strengths defined in IETF RFC 5054.
61
62=item B<-userinfo>
63
64specifies additional information to add when
65adding or modifying a user.
66
67=item B<-passin> I<arg>, B<-passout> I<arg>
68
69The password source for the input and output file.
70For more information about the format of B<arg>
46949153 71see L<openssl-passphrase-options(1)>.
3a4e43de 72
65718c51
RS
73{- $OpenSSL::safe::opt_engine_item -}
74
6bd4e3f2
P
75{- $OpenSSL::safe::opt_provider_item -}
76
9fcb9702 77{- $OpenSSL::safe::opt_r_synopsis -}
a397aca4 78
e75138ab
RS
79=back
80
0f221d9c
P
81=head1 HISTORY
82
83The B<-engine> option was deprecated in OpenSSL 3.0.
84
e75138ab
RS
85=head1 COPYRIGHT
86
a28d06f3 87Copyright 2017-2021 The OpenSSL Project Authors. All Rights Reserved.
e75138ab 88
449040b4 89Licensed under the Apache License 2.0 (the "License"). You may not use
e75138ab
RS
90this file except in compliance with the License. You can obtain a copy
91in the file LICENSE in the source distribution or at
92L<https://www.openssl.org/source/license.html>.
93
94=cut