| lh | 9ed821d | 2023-04-07 01:36:19 -0700 | [diff] [blame] | 1 | =pod |
| 2 | |
| 3 | =head1 NAME |
| 4 | |
| 5 | openssl-srp, |
| 6 | 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 section>] |
| 18 | [B<-config file>] |
| 19 | [B<-srpvfile file>] |
| 20 | [B<-gn identifier>] |
| 21 | [B<-userinfo text...>] |
| 22 | [B<-passin arg>] |
| 23 | [B<-passout arg>] |
| 24 | [I<user...>] |
| 25 | |
| 26 | =head1 DESCRIPTION |
| 27 | |
| 28 | The B<srp> command is user to maintain an SRP (secure remote password) |
| 29 | file. |
| 30 | At most one of the B<-add>, B<-modify>, B<-delete>, and B<-list> options |
| 31 | can be specified. |
| 32 | These options take zero or more usernames as parameters and perform the |
| 33 | appropriate operation on the SRP file. |
| 34 | For B<-list>, if no B<user> is given then all users are displayed. |
| 35 | |
| 36 | The configuration file to use, and the section within the file, can be |
| 37 | specified with the B<-config> and B<-name> flags, respectively. |
| 38 | If the config file is not specified, the B<-srpvfile> can be used to |
| 39 | just specify the file to operate on. |
| 40 | |
| 41 | The B<-userinfo> option specifies additional information to add when |
| 42 | adding or modifying a user. |
| 43 | |
| 44 | The B<-gn> flag specifies the B<g> and B<N> values, using one of |
| 45 | the strengths defined in IETF RFC 5054. |
| 46 | |
| 47 | The B<-passin> and B<-passout> arguments are parsed as described in |
| 48 | the L<openssl(1)> command. |
| 49 | |
| 50 | =head1 OPTIONS |
| 51 | |
| 52 | =over 4 |
| 53 | |
| 54 | =item [B<-help>] |
| 55 | |
| 56 | Display an option summary. |
| 57 | |
| 58 | =item [B<-verbose>] |
| 59 | |
| 60 | Generate verbose output while processing. |
| 61 | |
| 62 | =back |
| 63 | |
| 64 | =head1 COPYRIGHT |
| 65 | |
| 66 | Copyright 2017 The OpenSSL Project Authors. All Rights Reserved. |
| 67 | |
| 68 | Licensed under the OpenSSL license (the "License"). You may not use |
| 69 | this file except in compliance with the License. You can obtain a copy |
| 70 | in the file LICENSE in the source distribution or at |
| 71 | L<https://www.openssl.org/source/license.html>. |
| 72 | |
| 73 | =cut |