srp.pod 1.7 KB

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