2
0

openssl-spkac.pod.in 4.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169
  1. =pod
  2. =begin comment
  3. {- join("\n", @autowarntext) -}
  4. =end comment
  5. =head1 NAME
  6. openssl-spkac - SPKAC printing and generating command
  7. =head1 SYNOPSIS
  8. B<openssl> B<spkac>
  9. [B<-help>]
  10. [B<-in> I<filename>]
  11. [B<-out> I<filename>]
  12. [B<-digest> I<digest>]
  13. [B<-key> I<filename>|I<uri>]
  14. [B<-keyform> B<DER>|B<PEM>|B<P12>|B<ENGINE>]
  15. [B<-passin> I<arg>]
  16. [B<-challenge> I<string>]
  17. [B<-pubkey>]
  18. [B<-spkac> I<spkacname>]
  19. [B<-spksect> I<section>]
  20. [B<-noout>]
  21. [B<-verify>]
  22. {- $OpenSSL::safe::opt_engine_synopsis -}{- $OpenSSL::safe::opt_provider_synopsis -}
  23. =head1 DESCRIPTION
  24. This command processes Netscape signed public key and challenge
  25. (SPKAC) files. It can print out their contents, verify the signature and
  26. produce its own SPKACs from a supplied private key.
  27. =head1 OPTIONS
  28. =over 4
  29. =item B<-help>
  30. Print out a usage message.
  31. =item B<-in> I<filename>
  32. This specifies the input filename to read from or standard input if this
  33. option is not specified. Ignored if the B<-key> option is used.
  34. =item B<-out> I<filename>
  35. Specifies the output filename to write to or standard output by
  36. default.
  37. =item B<-digest> I<digest>
  38. Use the specified I<digest> to sign a created SPKAC file.
  39. The default digest algorithm is MD5.
  40. =item B<-key> I<filename>|I<uri>
  41. Create an SPKAC file using the private key specified by I<filename> or I<uri>.
  42. The B<-in>, B<-noout>, B<-spksect> and B<-verify> options are ignored if
  43. present.
  44. =item B<-keyform> B<DER>|B<PEM>|B<P12>|B<ENGINE>
  45. The key format; unspecified by default.
  46. See L<openssl-format-options(1)> for details.
  47. =item B<-passin> I<arg>
  48. The input file password source. For more information about the format of I<arg>
  49. see L<openssl-passphrase-options(1)>.
  50. =item B<-challenge> I<string>
  51. Specifies the challenge string if an SPKAC is being created.
  52. =item B<-spkac> I<spkacname>
  53. Allows an alternative name form the variable containing the
  54. SPKAC. The default is "SPKAC". This option affects both
  55. generated and input SPKAC files.
  56. =item B<-spksect> I<section>
  57. Allows an alternative name form the section containing the
  58. SPKAC. The default is the default section.
  59. =item B<-noout>
  60. Don't output the text version of the SPKAC (not used if an
  61. SPKAC is being created).
  62. =item B<-pubkey>
  63. Output the public key of an SPKAC (not used if an SPKAC is
  64. being created).
  65. =item B<-verify>
  66. Verifies the digital signature on the supplied SPKAC.
  67. {- $OpenSSL::safe::opt_engine_item -}
  68. {- $OpenSSL::safe::opt_provider_item -}
  69. =back
  70. =head1 EXAMPLES
  71. Print out the contents of an SPKAC:
  72. openssl spkac -in spkac.cnf
  73. Verify the signature of an SPKAC:
  74. openssl spkac -in spkac.cnf -noout -verify
  75. Create an SPKAC using the challenge string "hello":
  76. openssl spkac -key key.pem -challenge hello -out spkac.cnf
  77. Example of an SPKAC, (long lines split up for clarity):
  78. SPKAC=MIG5MGUwXDANBgkqhkiG9w0BAQEFAANLADBIAkEA\
  79. 1cCoq2Wa3Ixs47uI7FPVwHVIPDx5yso105Y6zpozam135a\
  80. 8R0CpoRvkkigIyXfcCjiVi5oWk+6FfPaD03uPFoQIDAQAB\
  81. FgVoZWxsbzANBgkqhkiG9w0BAQQFAANBAFpQtY/FojdwkJ\
  82. h1bEIYuc2EeM2KHTWPEepWYeawvHD0gQ3DngSC75YCWnnD\
  83. dq+NQ3F+X4deMx9AaEglZtULwV4=
  84. =head1 NOTES
  85. A created SPKAC with suitable DN components appended can be fed to
  86. L<openssl-ca(1)>.
  87. SPKACs are typically generated by Netscape when a form is submitted
  88. containing the B<KEYGEN> tag as part of the certificate enrollment
  89. process.
  90. The challenge string permits a primitive form of proof of possession
  91. of private key. By checking the SPKAC signature and a random challenge
  92. string some guarantee is given that the user knows the private key
  93. corresponding to the public key being certified. This is important in
  94. some applications. Without this it is possible for a previous SPKAC
  95. to be used in a "replay attack".
  96. =head1 SEE ALSO
  97. L<openssl(1)>,
  98. L<openssl-ca(1)>
  99. =head1 HISTORY
  100. The B<-engine> option was deprecated in OpenSSL 3.0.
  101. The B<-digest> option was added in OpenSSL 3.0.
  102. =head1 COPYRIGHT
  103. Copyright 2000-2021 The OpenSSL Project Authors. All Rights Reserved.
  104. Licensed under the Apache License 2.0 (the "License"). You may not use
  105. this file except in compliance with the License. You can obtain a copy
  106. in the file LICENSE in the source distribution or at
  107. L<https://www.openssl.org/source/license.html>.
  108. =cut