xref: /netbsd-src/crypto/external/bsd/openssl/lib/libcrypto/man/openssl-dsa.1 (revision a19d5caa4f855f23a141a0208d8a8ad40b58864e)
$NetBSD: openssl-dsa.1,v 1.1 2024/07/12 21:01:07 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-DSA 1"
OPENSSL-DSA 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-dsa - DSA key processing
SYNOPSIS
Header "SYNOPSIS" \fBopenssl dsa [-help] [-inform DER|PEM] [-outform DER|PEM] [-in filename] [-passin arg] [-out filename] [-passout arg] [-aes128] [-aes192] [-aes256] [-aria128] [-aria192] [-aria256] [-camellia128] [-camellia192] [-camellia256] [-des] [-des3] [-idea] [-text] [-noout] [-modulus] [-pubin] [-pubout] [-pvk-strong] [-pvk-weak] [-pvk-none] [-engine id] [-provider name] [-provider-path path] [-propquery propq]
DESCRIPTION
Header "DESCRIPTION" This command processes DSA keys. They can be converted between various forms and their components printed out. Note This command uses the traditional SSLeay compatible format for private key encryption: newer applications should use the more secure PKCS#8 format using the pkcs8
OPTIONS
Header "OPTIONS"
-help 4
Item "-help" Print out a usage message.
"-inform DER|PEM" 4
Item "-inform DER|PEM" The key input format; unspecified by default. See openssl-format-options\|(1) for details.
"-outform DER|PEM" 4
Item "-outform DER|PEM" The key output format; the default is PEM. See openssl-format-options\|(1) for details. .Sp Private keys are a sequence of ASN.1 INTEGERS: the version (zero), p, \fBq, g, and the public and private key components. Public keys are a SubjectPublicKeyInfo structure with the DSA type. .Sp The PEM format also accepts PKCS#8 data.
"-in filename" 4
Item "-in filename" This specifies the input filename to read a key from or standard input if this option is not specified. If the key is encrypted a pass phrase will be prompted for.
"-out filename" 4
Item "-out filename" This specifies the output filename to write a key to or standard output by is not specified. If any encryption options are set then a pass phrase will be prompted for. The output filename should not be the same as the input filename.
"-passin arg, -passout arg" 4
Item "-passin arg, -passout arg" The password source for the input and output file. For more information about the format of arg see openssl-passphrase-options\|(1).
"-aes128, -aes192, -aes256, -aria128, -aria192, -aria256, -camellia128, -camellia192, -camellia256, -des, -des3, -idea" 4
Item "-aes128, -aes192, -aes256, -aria128, -aria192, -aria256, -camellia128, -camellia192, -camellia256, -des, -des3, -idea" These options encrypt the private key with the specified cipher before outputting it. A pass phrase is prompted for. If none of these options is specified the key is written in plain text. This means that this command can be used to remove the pass phrase from a key by not giving any encryption option is given, or to add or change the pass phrase by setting them. These options can only be used with PEM format output files.
-text 4
Item "-text" Prints out the public, private key components and parameters.
-noout 4
Item "-noout" This option prevents output of the encoded version of the key.
-modulus 4
Item "-modulus" This option prints out the value of the public key component of the key.
-pubin 4
Item "-pubin" By default, a private key is read from the input file. With this option a public key is read instead.
-pubout 4
Item "-pubout" By default, a private key is output. With this option a public key will be output instead. This option is automatically set if the input is a public key.
-pvk-strong 4
Item "-pvk-strong" Enable 'Strong' PVK encoding level (default).
-pvk-weak 4
Item "-pvk-weak" Enable 'Weak' PVK encoding level.
-pvk-none 4
Item "-pvk-none" Don't enforce PVK encoding.
"-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).

The openssl-pkey\|(1) command is capable of performing all the operations this command can, as well as supporting other public key types.

EXAMPLES
Header "EXAMPLES" The documentation for the openssl-pkey\|(1) command contains examples equivalent to the ones listed here.

To remove the pass phrase on a DSA private key:

.Vb 1 openssl dsa -in key.pem -out keyout.pem .Ve

To encrypt a private key using triple DES:

.Vb 1 openssl dsa -in key.pem -des3 -out keyout.pem .Ve

To convert a private key from PEM to DER format:

.Vb 1 openssl dsa -in key.pem -outform DER -out keyout.der .Ve

To print out the components of a private key to standard output:

.Vb 1 openssl dsa -in key.pem -text -noout .Ve

To just output the public part of a private key:

.Vb 1 openssl dsa -in key.pem -pubout -out pubkey.pem .Ve

"SEE ALSO"
Header "SEE ALSO" \fBopenssl\|(1), \fBopenssl-pkey\|(1), \fBopenssl-dsaparam\|(1), \fBopenssl-gendsa\|(1), \fBopenssl-rsa\|(1), \fBopenssl-genrsa\|(1)
HISTORY
Header "HISTORY" The -engine option was deprecated 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>.