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