xref: /freebsd/crypto/openssl/doc/man1/openssl-srp.pod.in (revision b077aed33b7b6aefca7b17ddb250cf521f938613)
1*b077aed3SPierre Pronchery=pod
2*b077aed3SPierre Pronchery{- OpenSSL::safe::output_do_not_edit_headers(); -}
3*b077aed3SPierre Pronchery
4*b077aed3SPierre Pronchery=head1 NAME
5*b077aed3SPierre Pronchery
6*b077aed3SPierre Proncheryopenssl-srp - maintain SRP password file
7*b077aed3SPierre Pronchery
8*b077aed3SPierre Pronchery=head1 SYNOPSIS
9*b077aed3SPierre Pronchery
10*b077aed3SPierre ProncheryB<openssl srp>
11*b077aed3SPierre Pronchery[B<-help>]
12*b077aed3SPierre Pronchery[B<-verbose>]
13*b077aed3SPierre Pronchery[B<-add>]
14*b077aed3SPierre Pronchery[B<-modify>]
15*b077aed3SPierre Pronchery[B<-delete>]
16*b077aed3SPierre Pronchery[B<-list>]
17*b077aed3SPierre Pronchery[B<-name> I<section>]
18*b077aed3SPierre Pronchery[B<-srpvfile> I<file>]
19*b077aed3SPierre Pronchery[B<-gn> I<identifier>]
20*b077aed3SPierre Pronchery[B<-userinfo> I<text>]
21*b077aed3SPierre Pronchery[B<-passin> I<arg>]
22*b077aed3SPierre Pronchery[B<-passout> I<arg>]
23*b077aed3SPierre Pronchery{- $OpenSSL::safe::opt_engine_synopsis -}{- $OpenSSL::safe::opt_r_synopsis -}
24*b077aed3SPierre Pronchery{- $OpenSSL::safe::opt_provider_synopsis -}
25*b077aed3SPierre Pronchery{- $OpenSSL::safe::opt_config_synopsis -}
26*b077aed3SPierre Pronchery[I<user> ...]
27*b077aed3SPierre Pronchery
28*b077aed3SPierre Pronchery=head1 DESCRIPTION
29*b077aed3SPierre Pronchery
30*b077aed3SPierre ProncheryThis command is deprecated. It is used to maintain an SRP (secure remote
31*b077aed3SPierre Proncherypassword) file. At most one of the B<-add>, B<-modify>, B<-delete>, and B<-list>
32*b077aed3SPierre Proncheryoptions can be specified.
33*b077aed3SPierre ProncheryThese options take zero or more usernames as parameters and perform the
34*b077aed3SPierre Proncheryappropriate operation on the SRP file.
35*b077aed3SPierre ProncheryFor B<-list>, if no I<user> is given then all users are displayed.
36*b077aed3SPierre Pronchery
37*b077aed3SPierre ProncheryThe configuration file to use, and the section within the file, can be
38*b077aed3SPierre Proncheryspecified with the B<-config> and B<-name> flags, respectively.
39*b077aed3SPierre Pronchery
40*b077aed3SPierre Pronchery=head1 OPTIONS
41*b077aed3SPierre Pronchery
42*b077aed3SPierre Pronchery=over 4
43*b077aed3SPierre Pronchery
44*b077aed3SPierre Pronchery=item B<-help>
45*b077aed3SPierre Pronchery
46*b077aed3SPierre ProncheryDisplay an option summary.
47*b077aed3SPierre Pronchery
48*b077aed3SPierre Pronchery=item B<-verbose>
49*b077aed3SPierre Pronchery
50*b077aed3SPierre ProncheryGenerate verbose output while processing.
51*b077aed3SPierre Pronchery
52*b077aed3SPierre Pronchery=item B<-add>
53*b077aed3SPierre Pronchery
54*b077aed3SPierre ProncheryAdd a user and SRP verifier.
55*b077aed3SPierre Pronchery
56*b077aed3SPierre Pronchery=item B<-modify>
57*b077aed3SPierre Pronchery
58*b077aed3SPierre ProncheryModify the SRP verifier of an existing user.
59*b077aed3SPierre Pronchery
60*b077aed3SPierre Pronchery=item B<-delete>
61*b077aed3SPierre Pronchery
62*b077aed3SPierre ProncheryDelete user from verifier file.
63*b077aed3SPierre Pronchery
64*b077aed3SPierre Pronchery=item B<-list>
65*b077aed3SPierre Pronchery
66*b077aed3SPierre ProncheryList users.
67*b077aed3SPierre Pronchery
68*b077aed3SPierre Pronchery=item B<-name>
69*b077aed3SPierre Pronchery
70*b077aed3SPierre ProncheryThe particular SRP definition to use.
71*b077aed3SPierre Pronchery
72*b077aed3SPierre Pronchery=item B<-srpvfile> I<file>
73*b077aed3SPierre Pronchery
74*b077aed3SPierre ProncheryIf the config file is not specified,
75*b077aed3SPierre ProncheryB<-srpvfile> can be used to specify the file to operate on.
76*b077aed3SPierre Pronchery
77*b077aed3SPierre Pronchery=item B<-gn>
78*b077aed3SPierre Pronchery
79*b077aed3SPierre ProncherySpecifies the B<g> and B<N> values, using one of
80*b077aed3SPierre Proncherythe strengths defined in IETF RFC 5054.
81*b077aed3SPierre Pronchery
82*b077aed3SPierre Pronchery=item B<-userinfo>
83*b077aed3SPierre Pronchery
84*b077aed3SPierre Proncheryspecifies additional information to add when
85*b077aed3SPierre Proncheryadding or modifying a user.
86*b077aed3SPierre Pronchery
87*b077aed3SPierre Pronchery=item B<-passin> I<arg>, B<-passout> I<arg>
88*b077aed3SPierre Pronchery
89*b077aed3SPierre ProncheryThe password source for the input and output file.
90*b077aed3SPierre ProncheryFor more information about the format of B<arg>
91*b077aed3SPierre Proncherysee L<openssl-passphrase-options(1)>.
92*b077aed3SPierre Pronchery
93*b077aed3SPierre Pronchery{- $OpenSSL::safe::opt_engine_item -}
94*b077aed3SPierre Pronchery
95*b077aed3SPierre Pronchery{- $OpenSSL::safe::opt_r_item -}
96*b077aed3SPierre Pronchery
97*b077aed3SPierre Pronchery{- $OpenSSL::safe::opt_provider_item -}
98*b077aed3SPierre Pronchery
99*b077aed3SPierre Pronchery{- $OpenSSL::safe::opt_config_item -}
100*b077aed3SPierre Pronchery
101*b077aed3SPierre Pronchery{- $OpenSSL::safe::opt_r_synopsis -}
102*b077aed3SPierre Pronchery
103*b077aed3SPierre Pronchery=back
104*b077aed3SPierre Pronchery
105*b077aed3SPierre Pronchery=head1 HISTORY
106*b077aed3SPierre Pronchery
107*b077aed3SPierre ProncheryThe B<-engine> option was deprecated in OpenSSL 3.0.
108*b077aed3SPierre Pronchery
109*b077aed3SPierre Pronchery=head1 COPYRIGHT
110*b077aed3SPierre Pronchery
111*b077aed3SPierre ProncheryCopyright 2017-2021 The OpenSSL Project Authors. All Rights Reserved.
112*b077aed3SPierre Pronchery
113*b077aed3SPierre ProncheryLicensed under the Apache License 2.0 (the "License").  You may not use
114*b077aed3SPierre Proncherythis file except in compliance with the License.  You can obtain a copy
115*b077aed3SPierre Proncheryin the file LICENSE in the source distribution or at
116*b077aed3SPierre ProncheryL<https://www.openssl.org/source/license.html>.
117*b077aed3SPierre Pronchery
118*b077aed3SPierre Pronchery=cut
119