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