xref: /freebsd/secure/usr.bin/openssl/man/openssl-spkac.1 (revision 59c8e88e72633afbc47a4ace0d2170d00d51f7dc)
Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)

Standard preamble:
========================================================================
..
..
.. Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================

Title "OPENSSL-SPKAC 1ossl"
OPENSSL-SPKAC 1ossl "2023-09-22" "3.0.11" "OpenSSL"
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
"NAME"
openssl-spkac - SPKAC printing and generating command
"SYNOPSIS"
Header "SYNOPSIS" \fBopenssl spkac [-help] [-in filename] [-out filename] [-digest digest] [-key filename|uri] [-keyform \s-1DER\s0|\s-1PEM\s0|P12|\s-1ENGINE\s0] [-passin arg] [-challenge string] [-pubkey] [-spkac spkacname] [-spksect section] [-noout] [-verify] [-engine id] [-provider name] [-provider-path path] [-propquery propq]
"DESCRIPTION"
Header "DESCRIPTION" This command processes Netscape signed public key and challenge (\s-1SPKAC\s0) files. It can print out their contents, verify the signature and produce its own SPKACs from a supplied private key.
"OPTIONS"
Header "OPTIONS"
"-help" 4
Item "-help" Print out a usage message.
"-in filename" 4
Item "-in filename" This specifies the input filename to read from or standard input if this option is not specified. Ignored if the -key option is used.
"-out filename" 4
Item "-out filename" Specifies the output filename to write to or standard output by default.
"-digest digest" 4
Item "-digest digest" Use the specified digest to sign a created \s-1SPKAC\s0 file. The default digest algorithm is \s-1MD5.\s0
"-key filename|uri" 4
Item "-key filename|uri" Create an \s-1SPKAC\s0 file using the private key specified by filename or uri. The -in, -noout, -spksect and -verify options are ignored if present.
"-keyform \s-1DER\s0|\s-1PEM\s0|P12|\s-1ENGINE\s0" 4
Item "-keyform DER|PEM|P12|ENGINE" The key format; unspecified by default. See openssl-format-options\|(1) for details.
"-passin arg" 4
Item "-passin arg" The input file password source. For more information about the format of arg see openssl-passphrase-options\|(1).
"-challenge string" 4
Item "-challenge string" Specifies the challenge string if an \s-1SPKAC\s0 is being created.
"-spkac spkacname" 4
Item "-spkac spkacname" Allows an alternative name form the variable containing the \s-1SPKAC.\s0 The default is \*(L"\s-1SPKAC\*(R".\s0 This option affects both generated and input \s-1SPKAC\s0 files.
"-spksect section" 4
Item "-spksect section" Allows an alternative name form the section containing the \s-1SPKAC.\s0 The default is the default section.
"-noout" 4
Item "-noout" Don't output the text version of the \s-1SPKAC\s0 (not used if an \s-1SPKAC\s0 is being created).
"-pubkey" 4
Item "-pubkey" Output the public key of an \s-1SPKAC\s0 (not used if an \s-1SPKAC\s0 is being created).
"-verify" 4
Item "-verify" Verifies the digital signature on the supplied \s-1SPKAC.\s0
"-engine id" 4
Item "-engine id" See \*(L"Engine Options\*(R" in openssl\|(1). This option is deprecated.
"-provider name" 4
Item "-provider name"

0

"-provider-path path" 4
Item "-provider-path path"
"-propquery propq" 4
Item "-propquery propq"

See \*(L"Provider Options\*(R" in openssl\|(1), provider\|(7), and property\|(7).

"EXAMPLES"
Header "EXAMPLES" Print out the contents of an \s-1SPKAC:\s0

.Vb 1 openssl spkac -in spkac.cnf .Ve

Verify the signature of an \s-1SPKAC:\s0

.Vb 1 openssl spkac -in spkac.cnf -noout -verify .Ve

Create an \s-1SPKAC\s0 using the challenge string \*(L"hello\*(R":

.Vb 1 openssl spkac -key key.pem -challenge hello -out spkac.cnf .Ve

Example of an \s-1SPKAC,\s0 (long lines split up for clarity):

.Vb 6 SPKAC=MIG5MGUwXDANBgkqhkiG9w0BAQEFAANLADBIAkEA\e 1cCoq2Wa3Ixs47uI7FPVwHVIPDx5yso105Y6zpozam135a\e 8R0CpoRvkkigIyXfcCjiVi5oWk+6FfPaD03uPFoQIDAQAB\e FgVoZWxsbzANBgkqhkiG9w0BAQQFAANBAFpQtY/FojdwkJ\e h1bEIYuc2EeM2KHTWPEepWYeawvHD0gQ3DngSC75YCWnnD\e dq+NQ3F+X4deMx9AaEglZtULwV4= .Ve

"NOTES"
Header "NOTES" A created \s-1SPKAC\s0 with suitable \s-1DN\s0 components appended can be fed to \fBopenssl-ca\|(1).

SPKACs are typically generated by Netscape when a form is submitted containing the \s-1KEYGEN\s0 tag as part of the certificate enrollment process.

The challenge string permits a primitive form of proof of possession of private key. By checking the \s-1SPKAC\s0 signature and a random challenge string some guarantee is given that the user knows the private key corresponding to the public key being certified. This is important in some applications. Without this it is possible for a previous \s-1SPKAC\s0 to be used in a \*(L"replay attack\*(R".

"SEE ALSO"
Header "SEE ALSO" \fBopenssl\|(1), \fBopenssl-ca\|(1)
"HISTORY"
Header "HISTORY" The -engine option was deprecated in OpenSSL 3.0.

The -digest option was added in OpenSSL 3.0.

"COPYRIGHT"
Header "COPYRIGHT" Copyright 2000-2021 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use this file except in compliance with the License. You can obtain a copy in the file \s-1LICENSE\s0 in the source distribution or at <https://www.openssl.org/source/license.html>.