Debian Codegraph @

upstream/debian-unstable/man1/openssl-srp.1ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "OPENSSL-SRP 1SSL"
58 .TH OPENSSL-SRP 1SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 openssl\-srp \- maintain SRP password file
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 \&\fBopenssl srp\fR
68 [\fB\-help\fR]
69 [\fB\-verbose\fR]
70 [\fB\-add\fR]
71 [\fB\-modify\fR]
72 [\fB\-delete\fR]
73 [\fB\-list\fR]
74 [\fB\-name\fR \fIsection\fR]
75 [\fB\-srpvfile\fR \fIfile\fR]
76 [\fB\-gn\fR \fIidentifier\fR]
77 [\fB\-userinfo\fR \fItext\fR]
78 [\fB\-passin\fR \fIarg\fR]
79 [\fB\-passout\fR \fIarg\fR]
80 [\fB\-engine\fR \fIid\fR]
81 [\fB\-rand\fR \fIfiles\fR]
82 [\fB\-writerand\fR \fIfile\fR]
83 [\fB\-provider\fR \fIname\fR]
84 [\fB\-provider\-path\fR \fIpath\fR]
85 [\fB\-provparam\fR \fI[name:]key=value\fR]
86 [\fB\-propquery\fR \fIpropq\fR]
87 [\fB\-config\fR \fIconfigfile\fR]
88 [\fIuser\fR ...]
89 .SH DESCRIPTION
90 .IX Header "DESCRIPTION"
91 This command is deprecated. It is used to maintain an SRP (secure remote
92 password) file. At most one of the \fB\-add\fR, \fB\-modify\fR, \fB\-delete\fR, and \fB\-list\fR
93 options can be specified.
94 These options take zero or more usernames as parameters and perform the
95 appropriate operation on the SRP file.
96 For \fB\-list\fR, if no \fIuser\fR is given then all users are displayed.
97 .PP
98 The configuration file to use, and the section within the file, can be
99 specified with the \fB\-config\fR and \fB\-name\fR flags, respectively.
100 .SH OPTIONS
101 .IX Header "OPTIONS"
102 .IP \fB\-help\fR 4
103 .IX Item "-help"
104 Display an option summary.
105 .IP \fB\-verbose\fR 4
106 .IX Item "-verbose"
107 Generate verbose output while processing.
108 .IP \fB\-add\fR 4
109 .IX Item "-add"
110 Add a user and SRP verifier.
111 .IP \fB\-modify\fR 4
112 .IX Item "-modify"
113 Modify the SRP verifier of an existing user.
114 .IP \fB\-delete\fR 4
115 .IX Item "-delete"
116 Delete user from verifier file.
117 .IP \fB\-list\fR 4
118 .IX Item "-list"
119 List users.
120 .IP \fB\-name\fR 4
121 .IX Item "-name"
122 The particular SRP definition to use.
123 .IP "\fB\-srpvfile\fR \fIfile\fR" 4
124 .IX Item "-srpvfile file"
125 If the config file is not specified,
126 \&\fB\-srpvfile\fR can be used to specify the file to operate on.
127 .IP \fB\-gn\fR 4
128 .IX Item "-gn"
129 Specifies the \fBg\fR and \fBN\fR values, using one of
130 the strengths defined in IETF RFC 5054.
131 .IP \fB\-userinfo\fR 4
132 .IX Item "-userinfo"
133 specifies additional information to add when
134 adding or modifying a user.
135 .IP "\fB\-passin\fR \fIarg\fR, \fB\-passout\fR \fIarg\fR" 4
136 .IX Item "-passin arg, -passout arg"
137 The password source for the input and output file.
138 For more information about the format of \fBarg\fR
139 see \fBopenssl\-passphrase\-options\fR\|(1).
140 .IP "\fB\-engine\fR \fIid\fR" 4
141 .IX Item "-engine id"
142 See "Engine Options" in \fBopenssl\fR\|(1).
143 This option is deprecated.
144 .IP "\fB\-rand\fR \fIfiles\fR, \fB\-writerand\fR \fIfile\fR" 4
145 .IX Item "-rand files, -writerand file"
146 See "Random State Options" in \fBopenssl\fR\|(1) for details.
147 .IP "\fB\-provider\fR \fIname\fR" 4
148 .IX Item "-provider name"
149 .PD 0
150 .IP "\fB\-provider\-path\fR \fIpath\fR" 4
151 .IX Item "-provider-path path"
152 .IP "\fB\-provparam\fR \fI[name:]key=value\fR" 4
153 .IX Item "-provparam [name:]key=value"
154 .IP "\fB\-propquery\fR \fIpropq\fR" 4
155 .IX Item "-propquery propq"
156 .PD
157 See "Provider Options" in \fBopenssl\fR\|(1), \fBprovider\fR\|(7), and \fBproperty\fR\|(7).
158 .IP "\fB\-config\fR \fIconfigfile\fR" 4
159 .IX Item "-config configfile"
160 See "Configuration Option" in \fBopenssl\fR\|(1).
161 .Sp
162 [\fB\-rand\fR \fIfiles\fR]
163 [\fB\-writerand\fR \fIfile\fR]
164 .SH HISTORY
165 .IX Header "HISTORY"
166 The \fB\-engine\fR option was deprecated in OpenSSL 3.0.
167 .SH COPYRIGHT
168 .IX Header "COPYRIGHT"
169 Copyright 2017\-2021 The OpenSSL Project Authors. All Rights Reserved.
170 .PP
171 Licensed under the Apache License 2.0 (the "License"). You may not use
172 this file except in compliance with the License. You can obtain a copy
173 in the file LICENSE in the source distribution or at
174 <https://www.openssl.org/source/license.html>.