xref: /netbsd-src/crypto/external/bsd/openssl/lib/libcrypto/man/openssl-spkac.1 (revision a19d5caa4f855f23a141a0208d8a8ad40b58864e)
$NetBSD: openssl-spkac.1,v 1.1 2024/07/12 21:01:09 christos Exp $

-*- mode: troff; coding: utf-8 -*-
Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)

Standard preamble:
========================================================================
..
..
.. \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . 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 ========================================================================

Title "OPENSSL-SPKAC 1"
OPENSSL-SPKAC 1 2024-07-11 3.0.14 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 DER|PEM|P12|ENGINE] [-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 (SPKAC) 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 SPKAC file. The default digest algorithm is MD5.
"-key filename|uri" 4
Item "-key filename|uri" Create an SPKAC file using the private key specified by filename or uri. The -in, -noout, -spksect and -verify options are ignored if present.
"-keyform DER|PEM|P12|ENGINE" 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 SPKAC is being created.
"-spkac spkacname" 4
Item "-spkac spkacname" Allows an alternative name form the variable containing the SPKAC. The default is "SPKAC". This option affects both generated and input SPKAC files.
"-spksect section" 4
Item "-spksect section" Allows an alternative name form the section containing the SPKAC. The default is the default section.
-noout 4
Item "-noout" Don't output the text version of the SPKAC (not used if an SPKAC is being created).
-pubkey 4
Item "-pubkey" Output the public key of an SPKAC (not used if an SPKAC is being created).
-verify 4
Item "-verify" Verifies the digital signature on the supplied SPKAC.
"-engine id" 4
Item "-engine id" See "Engine Options" 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 "Provider Options" in openssl\|(1), provider\|(7), and property\|(7).

EXAMPLES
Header "EXAMPLES" Print out the contents of an SPKAC:

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

Verify the signature of an SPKAC:

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

Create an SPKAC using the challenge string "hello":

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

Example of an SPKAC, (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 SPKAC with suitable DN components appended can be fed to \fBopenssl-ca\|(1).

SPKACs are typically generated by Netscape when a form is submitted containing the KEYGEN 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 SPKAC 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 SPKAC to be used in a "replay attack".

"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 "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.