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