doc/man1/openssl-srp.pod.in

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