2017-08-14 09:32:07 -04:00
|
|
|
=pod
|
2019-10-30 23:35:08 -04:00
|
|
|
{- OpenSSL::safe::output_do_not_edit_headers(); -}
|
2019-10-12 17:45:56 -04:00
|
|
|
|
2017-08-14 09:32:07 -04:00
|
|
|
=head1 NAME
|
|
|
|
|
2019-08-22 01:04:41 +02:00
|
|
|
openssl-srp - maintain SRP password file
|
2017-08-14 09:32:07 -04:00
|
|
|
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
|
|
|
|
B<openssl srp>
|
|
|
|
[B<-help>]
|
|
|
|
[B<-verbose>]
|
|
|
|
[B<-add>]
|
|
|
|
[B<-modify>]
|
|
|
|
[B<-delete>]
|
|
|
|
[B<-list>]
|
2019-09-25 15:20:11 -04:00
|
|
|
[B<-name> I<section>]
|
|
|
|
[B<-config> I<file>]
|
|
|
|
[B<-srpvfile> I<file>]
|
|
|
|
[B<-gn> I<identifier>]
|
2019-10-01 10:00:14 +02:00
|
|
|
[B<-userinfo> I<text>]
|
2019-09-25 15:20:11 -04:00
|
|
|
[B<-passin> I<arg>]
|
|
|
|
[B<-passout> I<arg>]
|
2020-09-21 11:56:01 +02:00
|
|
|
{- $OpenSSL::safe::opt_engine_synopsis -}{- $OpenSSL::safe::opt_r_synopsis -}
|
2020-02-25 14:29:30 +10:00
|
|
|
{- $OpenSSL::safe::opt_provider_synopsis -}
|
2019-10-01 09:57:37 +02:00
|
|
|
[I<user> ...]
|
2017-08-14 09:32:07 -04:00
|
|
|
|
2019-10-11 11:52:12 -04:00
|
|
|
=for openssl ifdef engine
|
2019-09-22 19:49:25 -04:00
|
|
|
|
2017-08-14 09:32:07 -04:00
|
|
|
=head1 DESCRIPTION
|
|
|
|
|
Command docs: fix up command references
Almost all OpenSSL commands are in reality 'openssl cmd', so make sure
they are refered to like that and not just as the sub-command.
Self-references are avoided as much as is possible, and replaced with
"this command". In some cases, we even avoid that with a slight
rewrite of the sentence or paragrah they were in. However, in the few
cases where a self-reference is still admissible, they are done in
bold, i.e. openssl-speed.pod references itself like this:
B<openssl speed>
References to other commands are done as manual links, i.e. CA.pl.pod
references 'openssl req' like this: L<openssl-req(1)>
Some commands are examples rather than references; we enclose those in
C<>.
While we are it, we abolish "utility", replacing it with "command", or
remove it entirely in some cases.
Reviewed-by: Tomas Mraz <tmraz@fedoraproject.org>
(Merged from https://github.com/openssl/openssl/pull/10065)
2019-10-01 19:43:36 +02:00
|
|
|
This command is used to maintain an SRP (secure remote password) file.
|
2017-08-14 09:32:07 -04:00
|
|
|
At most one of the B<-add>, B<-modify>, B<-delete>, and B<-list> options
|
|
|
|
can be specified.
|
|
|
|
These options take zero or more usernames as parameters and perform the
|
|
|
|
appropriate operation on the SRP file.
|
2019-10-01 18:16:29 +02:00
|
|
|
For B<-list>, if no I<user> is given then all users are displayed.
|
2017-08-14 09:32:07 -04:00
|
|
|
|
|
|
|
The configuration file to use, and the section within the file, can be
|
|
|
|
specified with the B<-config> and B<-name> flags, respectively.
|
|
|
|
|
|
|
|
=head1 OPTIONS
|
|
|
|
|
|
|
|
=over 4
|
|
|
|
|
2019-09-25 15:20:11 -04:00
|
|
|
=item B<-help>
|
2017-08-14 09:32:07 -04:00
|
|
|
|
|
|
|
Display an option summary.
|
|
|
|
|
2019-09-25 15:20:11 -04:00
|
|
|
=item B<-verbose>
|
2017-08-14 09:32:07 -04:00
|
|
|
|
|
|
|
Generate verbose output while processing.
|
|
|
|
|
2019-10-08 13:10:04 -04:00
|
|
|
=item B<-srpvfile> I<file>
|
|
|
|
|
|
|
|
If the config file is not specified,
|
|
|
|
B<-srpvfile> can be used to specify the file to operate on.
|
|
|
|
|
|
|
|
=item B<-gn>
|
|
|
|
|
|
|
|
Specifies the B<g> and B<N> values, using one of
|
|
|
|
the strengths defined in IETF RFC 5054.
|
|
|
|
|
|
|
|
=item B<-userinfo>
|
|
|
|
|
|
|
|
specifies additional information to add when
|
|
|
|
adding or modifying a user.
|
|
|
|
|
|
|
|
=item B<-passin> I<arg>, B<-passout> I<arg>
|
|
|
|
|
|
|
|
The password source for the input and output file.
|
|
|
|
For more information about the format of B<arg>
|
2020-12-09 21:56:51 +01:00
|
|
|
see L<openssl-passphrase-options(1)>.
|
2019-10-08 13:10:04 -04:00
|
|
|
|
Document most missing options
Add cmd-nits make target.
Listing options should stop when it hits the "parameters" separator.
Add missing .pod.in files to doc/man1/build.info
Tweak find-doc-nits to try openssl-XXX before XXX for POD files and
change an error messavge to be more useful.
Fix the following pages: ca, cms, crl, dgst, enc,
engine, errstr, gendsa, genrsa, list, ocsp, passwd, pkcs7, pkcs12, rand,
rehash, req, rsautil, s_server, speed, s_time,
sess_id, smime, srp, ts, x509.
Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Dmitry Belyavskiy <beldmit@gmail.com>
Reviewed-by: Matthias St. Pierre <Matthias.St.Pierre@ncp-e.com>
(Merged from https://github.com/openssl/openssl/pull/10873)
2020-01-16 13:40:52 -05:00
|
|
|
{- $OpenSSL::safe::opt_engine_item -}
|
|
|
|
|
2020-02-25 14:29:30 +10:00
|
|
|
{- $OpenSSL::safe::opt_provider_item -}
|
|
|
|
|
2019-10-12 17:45:56 -04:00
|
|
|
{- $OpenSSL::safe::opt_r_synopsis -}
|
2019-10-03 22:28:40 -04:00
|
|
|
|
2017-08-14 09:32:07 -04:00
|
|
|
=back
|
|
|
|
|
2020-06-25 11:27:51 +10:00
|
|
|
=head1 HISTORY
|
|
|
|
|
|
|
|
The B<-engine> option was deprecated in OpenSSL 3.0.
|
|
|
|
|
2017-08-14 09:32:07 -04:00
|
|
|
=head1 COPYRIGHT
|
|
|
|
|
2020-04-23 13:55:52 +01:00
|
|
|
Copyright 2017-2020 The OpenSSL Project Authors. All Rights Reserved.
|
2017-08-14 09:32:07 -04:00
|
|
|
|
2018-12-06 14:04:11 +01:00
|
|
|
Licensed under the Apache License 2.0 (the "License"). You may not use
|
2017-08-14 09:32:07 -04:00
|
|
|
this file except in compliance with the License. You can obtain a copy
|
|
|
|
in the file LICENSE in the source distribution or at
|
|
|
|
L<https://www.openssl.org/source/license.html>.
|
|
|
|
|
|
|
|
=cut
|