openssl-srp.pod.in 2.2 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596
  1. =pod
  2. {- OpenSSL::safe::output_do_not_edit_headers(); -}
  3. =head1 NAME
  4. openssl-srp - maintain SRP password file
  5. =head1 SYNOPSIS
  6. B<openssl srp>
  7. [B<-help>]
  8. [B<-verbose>]
  9. [B<-add>]
  10. [B<-modify>]
  11. [B<-delete>]
  12. [B<-list>]
  13. [B<-name> I<section>]
  14. [B<-config> I<file>]
  15. [B<-srpvfile> I<file>]
  16. [B<-gn> I<identifier>]
  17. [B<-userinfo> I<text>]
  18. [B<-passin> I<arg>]
  19. [B<-passout> I<arg>]
  20. {- $OpenSSL::safe::opt_engine_synopsis -}{- $OpenSSL::safe::opt_r_synopsis -}
  21. {- $OpenSSL::safe::opt_provider_synopsis -}
  22. [I<user> ...]
  23. =for openssl ifdef engine
  24. =head1 DESCRIPTION
  25. This command is used to maintain an SRP (secure remote password) file.
  26. At most one of the B<-add>, B<-modify>, B<-delete>, and B<-list> options
  27. can be specified.
  28. These options take zero or more usernames as parameters and perform the
  29. appropriate operation on the SRP file.
  30. For B<-list>, if no I<user> is given then all users are displayed.
  31. The configuration file to use, and the section within the file, can be
  32. specified with the B<-config> and B<-name> flags, respectively.
  33. =head1 OPTIONS
  34. =over 4
  35. =item B<-help>
  36. Display an option summary.
  37. =item B<-verbose>
  38. Generate verbose output while processing.
  39. =item B<-srpvfile> I<file>
  40. If the config file is not specified,
  41. B<-srpvfile> can be used to specify the file to operate on.
  42. =item B<-gn>
  43. Specifies the B<g> and B<N> values, using one of
  44. the strengths defined in IETF RFC 5054.
  45. =item B<-userinfo>
  46. specifies additional information to add when
  47. adding or modifying a user.
  48. =item B<-passin> I<arg>, B<-passout> I<arg>
  49. The password source for the input and output file.
  50. For more information about the format of B<arg>
  51. see L<openssl-passphrase-options(1)>.
  52. {- $OpenSSL::safe::opt_engine_item -}
  53. {- $OpenSSL::safe::opt_provider_item -}
  54. {- $OpenSSL::safe::opt_r_synopsis -}
  55. =back
  56. =head1 HISTORY
  57. The B<-engine> option was deprecated in OpenSSL 3.0.
  58. =head1 COPYRIGHT
  59. Copyright 2017-2020 The OpenSSL Project Authors. All Rights Reserved.
  60. Licensed under the Apache License 2.0 (the "License"). You may not use
  61. this file except in compliance with the License. You can obtain a copy
  62. in the file LICENSE in the source distribution or at
  63. L<https://www.openssl.org/source/license.html>.
  64. =cut