| 1 |
.\" -*- mode: troff; coding: utf-8 -*- |
| 2 |
.\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45) |
| 3 |
.\" |
| 4 |
.\" Standard preamble: |
| 5 |
.\" ======================================================================== |
| 6 |
.de Sp \" Vertical space (when we can't use .PP) |
| 7 |
.if t .sp .5v |
| 8 |
.if n .sp |
| 9 |
.. |
| 10 |
.de Vb \" Begin verbatim text |
| 11 |
.ft CW |
| 12 |
.nf |
| 13 |
.ne \\$1 |
| 14 |
.. |
| 15 |
.de Ve \" End verbatim text |
| 16 |
.ft R |
| 17 |
.fi |
| 18 |
.. |
| 19 |
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. |
| 20 |
.ie n \{\ |
| 21 |
. ds C` "" |
| 22 |
. ds C' "" |
| 23 |
'br\} |
| 24 |
.el\{\ |
| 25 |
. ds C` |
| 26 |
. ds C' |
| 27 |
'br\} |
| 28 |
.\" |
| 29 |
.\" Escape single quotes in literal strings from groff's Unicode transform. |
| 30 |
.ie \n(.g .ds Aq \(aq |
| 31 |
.el .ds Aq ' |
| 32 |
.\" |
| 33 |
.\" If the F register is >0, we'll generate index entries on stderr for |
| 34 |
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index |
| 35 |
.\" entries marked with X<> in POD. Of course, you'll have to process the |
| 36 |
.\" output yourself in some meaningful fashion. |
| 37 |
.\" |
| 38 |
.\" Avoid warning from groff about undefined register 'F'. |
| 39 |
.de IX |
| 40 |
.. |
| 41 |
.nr rF 0 |
| 42 |
.if \n(.g .if rF .nr rF 1 |
| 43 |
.if (\n(rF:(\n(.g==0)) \{\ |
| 44 |
. if \nF \{\ |
| 45 |
. de IX |
| 46 |
. tm Index:\\$1\t\\n%\t"\\$2" |
| 47 |
.. |
| 48 |
. if !\nF==2 \{\ |
| 49 |
. nr % 0 |
| 50 |
. nr F 2 |
| 51 |
. \} |
| 52 |
. \} |
| 53 |
.\} |
| 54 |
.rr rF |
| 55 |
.\" ======================================================================== |
| 56 |
.\" |
| 57 |
.IX Title "OPENSSL-GLOSSARY 7SSL" |
| 58 |
.TH OPENSSL-GLOSSARY 7SSL 2026-04-07 3.6.2 OpenSSL |
| 59 |
.\" For nroff, turn off justification. Always turn off hyphenation; it makes |
| 60 |
.\" way too many mistakes in technical documents. |
| 61 |
.if n .ad l |
| 62 |
.nh |
| 63 |
.SH NAME |
| 64 |
openssl\-glossary \- An OpenSSL Glossary |
| 65 |
.SH DESCRIPTION |
| 66 |
.IX Header "DESCRIPTION" |
| 67 |
.IP Algorithm 4 |
| 68 |
.IX Item "Algorithm" |
| 69 |
Cryptographic primitives such as the SHA256 digest, or AES encryption are |
| 70 |
referred to in OpenSSL as "algorithms". There can be more than one |
| 71 |
implementation for any given algorithm available for use. |
| 72 |
.Sp |
| 73 |
\&\fBcrypto\fR\|(7) |
| 74 |
.IP "ASN.1, ASN1" 4 |
| 75 |
.IX Item "ASN.1, ASN1" |
| 76 |
ASN.1 ("Abstract Syntax Notation One") is a notation for describing abstract |
| 77 |
types and values. It is defined in the ITU-T documents X.680 to X.683: |
| 78 |
.Sp |
| 79 |
<https://www.itu.int/rec/T\-REC\-X.680>, |
| 80 |
<https://www.itu.int/rec/T\-REC\-X.681>, |
| 81 |
<https://www.itu.int/rec/T\-REC\-X.682>, |
| 82 |
<https://www.itu.int/rec/T\-REC\-X.683> |
| 83 |
.IP "Base Provider" 4 |
| 84 |
.IX Item "Base Provider" |
| 85 |
An OpenSSL Provider that contains encoders and decoders for OpenSSL keys. All |
| 86 |
the algorithm implementations in the Base Provider are also available in the |
| 87 |
Default Provider. |
| 88 |
.Sp |
| 89 |
\&\fBOSSL_PROVIDER\-base\fR\|(7) |
| 90 |
.IP Decoder 4 |
| 91 |
.IX Item "Decoder" |
| 92 |
A decoder is a type of algorithm used for decoding keys and parameters from some |
| 93 |
external format such as PEM or DER. |
| 94 |
.Sp |
| 95 |
\&\fBOSSL_DECODER_CTX_new_for_pkey\fR\|(3) |
| 96 |
.IP "Default Provider" 4 |
| 97 |
.IX Item "Default Provider" |
| 98 |
An OpenSSL Provider that contains the most common OpenSSL algorithm |
| 99 |
implementations. It is loaded by default if no other provider is available. All |
| 100 |
the algorithm implementations in the Base Provider are also available in the |
| 101 |
Default Provider. |
| 102 |
.Sp |
| 103 |
\&\fBOSSL_PROVIDER\-default\fR\|(7) |
| 104 |
.IP "DER (""Distinguished Encoding Rules"")" 4 |
| 105 |
.IX Item "DER (""Distinguished Encoding Rules"")" |
| 106 |
DER is a binary encoding of data, structured according to an ASN.1 |
| 107 |
specification. This is a common encoding used for cryptographic objects |
| 108 |
such as private and public keys, certificates, CRLs, ... |
| 109 |
.Sp |
| 110 |
It is defined in ITU-T document X.690: |
| 111 |
.Sp |
| 112 |
<https://www.itu.int/rec/T\-REC\-X.690> |
| 113 |
.IP Encoder 4 |
| 114 |
.IX Item "Encoder" |
| 115 |
An encoder is a type of algorithm used for encoding keys and parameters to some |
| 116 |
external format such as PEM or DER. |
| 117 |
.Sp |
| 118 |
\&\fBOSSL_ENCODER_CTX_new_for_pkey\fR\|(3) |
| 119 |
.IP "Explicit Fetching" 4 |
| 120 |
.IX Item "Explicit Fetching" |
| 121 |
Explicit Fetching is a type of Fetching (see Fetching). Explicit Fetching is |
| 122 |
where a function call is made to obtain an algorithm object representing an |
| 123 |
implementation such as \fBEVP_MD_fetch\fR\|(3) or \fBEVP_CIPHER_fetch\fR\|(3) |
| 124 |
.IP Fetching 4 |
| 125 |
.IX Item "Fetching" |
| 126 |
Fetching is the process of looking through the available algorithm |
| 127 |
implementations, applying selection criteria (via a property query string), and |
| 128 |
finally choosing the implementation that will be used. |
| 129 |
.Sp |
| 130 |
Also see Explicit Fetching and Implicit Fetching. |
| 131 |
.Sp |
| 132 |
\&\fBcrypto\fR\|(7) |
| 133 |
.IP "FIPS Provider" 4 |
| 134 |
.IX Item "FIPS Provider" |
| 135 |
An OpenSSL Provider that contains OpenSSL algorithm implementations that have |
| 136 |
been validated according to the FIPS 140\-2 standard. |
| 137 |
.Sp |
| 138 |
\&\fBOSSL_PROVIDER\-FIPS\fR\|(7) |
| 139 |
.IP "Implicit Fetching" 4 |
| 140 |
.IX Item "Implicit Fetching" |
| 141 |
Implicit Fetching is a type of Fetching (see Fetching). Implicit Fetching is |
| 142 |
where an algorithm object with no associated implementation is used such as the |
| 143 |
return value from \fBEVP_sha256\fR\|(3) or \fBEVP_aes_128_cbc\fR\|(3). With implicit |
| 144 |
fetching an implementation is fetched automatically using default selection |
| 145 |
criteria the first time the algorithm is used. |
| 146 |
.IP "Legacy Provider" 4 |
| 147 |
.IX Item "Legacy Provider" |
| 148 |
An OpenSSL Provider that contains algorithm implementations that are considered |
| 149 |
insecure or are no longer in common use. |
| 150 |
.Sp |
| 151 |
\&\fBOSSL_PROVIDER\-legacy\fR\|(7) |
| 152 |
.IP "Library Context" 4 |
| 153 |
.IX Item "Library Context" |
| 154 |
A Library Context in OpenSSL is represented by the type \fBOSSL_LIB_CTX\fR. It can |
| 155 |
be thought of as a scope within which configuration options apply. If an |
| 156 |
application does not explicitly create a library context then the "default" |
| 157 |
one is used. Many OpenSSL functions can take a library context as an argument. |
| 158 |
A NULL value can always be passed to indicate the default library context. |
| 159 |
.Sp |
| 160 |
\&\fBOSSL_LIB_CTX\fR\|(3) |
| 161 |
.IP MSBLOB 4 |
| 162 |
.IX Item "MSBLOB" |
| 163 |
MSBLOB is a Microsoft specific binary format for RSA and DSA keys, both |
| 164 |
private and public. This form is never passphrase protected. |
| 165 |
.IP "Null Provider" 4 |
| 166 |
.IX Item "Null Provider" |
| 167 |
An OpenSSL Provider that contains no algorithm implementations. This can be |
| 168 |
useful to prevent the default provider from being automatically loaded in a |
| 169 |
library context. |
| 170 |
.Sp |
| 171 |
\&\fBOSSL_PROVIDER\-null\fR\|(7) |
| 172 |
.IP Operation 4 |
| 173 |
.IX Item "Operation" |
| 174 |
An operation is a group of OpenSSL functions with a common purpose such as |
| 175 |
encryption, or digesting. |
| 176 |
.Sp |
| 177 |
\&\fBcrypto\fR\|(7) |
| 178 |
.IP "PEM (""Privacy Enhanced Message"")" 4 |
| 179 |
.IX Item "PEM (""Privacy Enhanced Message"")" |
| 180 |
PEM is a format used for encoding of binary content into a mail and ASCII |
| 181 |
friendly form. The content is a series of base64\-encoded lines, surrounded |
| 182 |
by begin/end markers each on their own line. For example: |
| 183 |
.Sp |
| 184 |
.Vb 4 |
| 185 |
\& \-\-\-\-\-BEGIN PRIVATE KEY\-\-\-\-\- |
| 186 |
\& MIICdg.... |
| 187 |
\& ... bhTQ== |
| 188 |
\& \-\-\-\-\-END PRIVATE KEY\-\-\-\-\- |
| 189 |
.Ve |
| 190 |
.Sp |
| 191 |
Optional header line(s) may appear after the begin line, and their existence |
| 192 |
depends on the type of object being written or read. |
| 193 |
.Sp |
| 194 |
For all OpenSSL uses, the binary content is expected to be a DER encoded |
| 195 |
structure. |
| 196 |
.Sp |
| 197 |
This is defined in IETF RFC 1421: |
| 198 |
.Sp |
| 199 |
<https://tools.ietf.org/html/rfc1421> |
| 200 |
.IP PKCS#8 4 |
| 201 |
.IX Item "PKCS#8" |
| 202 |
PKCS#8 is a specification of ASN.1 structures that OpenSSL uses for storing |
| 203 |
or transmitting any private key in a key type agnostic manner. |
| 204 |
There are two structures worth noting for OpenSSL use, one that contains the |
| 205 |
key data in unencrypted form (known as "PrivateKeyInfo") and an encrypted |
| 206 |
wrapper structure (known as "EncryptedPrivateKeyInfo"). |
| 207 |
.Sp |
| 208 |
This is specified in RFC 5208: |
| 209 |
.Sp |
| 210 |
<https://tools.ietf.org/html/rfc5208> |
| 211 |
.IP Property 4 |
| 212 |
.IX Item "Property" |
| 213 |
A property is a way of classifying and selecting algorithm implementations. |
| 214 |
A property is a key/value pair expressed as a string. For example all algorithm |
| 215 |
implementations in the default provider have the property "provider=default". |
| 216 |
An algorithm implementation can have multiple properties defined against it. |
| 217 |
.Sp |
| 218 |
Also see Property Query String. |
| 219 |
.Sp |
| 220 |
\&\fBproperty\fR\|(7) |
| 221 |
.IP "Property Query String" 4 |
| 222 |
.IX Item "Property Query String" |
| 223 |
A property query string is a string containing a sequence of properties that |
| 224 |
can be used to select an algorithm implementation. For example the query string |
| 225 |
"provider=example,foo=bar" will select algorithms from the "example" provider |
| 226 |
that have a "foo" property defined for them with a value of "bar". |
| 227 |
.Sp |
| 228 |
Property Query Strings are used during fetching. See Fetching. |
| 229 |
.Sp |
| 230 |
\&\fBproperty\fR\|(7) |
| 231 |
.IP Provider 4 |
| 232 |
.IX Item "Provider" |
| 233 |
A provider in OpenSSL is a component that groups together algorithm |
| 234 |
implementations. Providers can come from OpenSSL itself or from third parties. |
| 235 |
.Sp |
| 236 |
\&\fBprovider\fR\|(7) |
| 237 |
.IP PVK 4 |
| 238 |
.IX Item "PVK" |
| 239 |
PVK is a Microsoft specific binary format for RSA and DSA private keys. |
| 240 |
This form may be passphrase protected. |
| 241 |
.IP SubjectPublicKeyInfo 4 |
| 242 |
.IX Item "SubjectPublicKeyInfo" |
| 243 |
SubjectPublicKeyInfo is an ASN.1 structure that OpenSSL uses for storing and |
| 244 |
transmitting any public key in a key type agnostic manner. |
| 245 |
.Sp |
| 246 |
This is specified as part of the specification for certificates, RFC 5280: |
| 247 |
.Sp |
| 248 |
<https://tools.ietf.org/html/rfc5280> |
| 249 |
.SH HISTORY |
| 250 |
.IX Header "HISTORY" |
| 251 |
This glossary was added in OpenSSL 3.0. |
| 252 |
.SH COPYRIGHT |
| 253 |
.IX Header "COPYRIGHT" |
| 254 |
Copyright 2020\-2022 The OpenSSL Project Authors. All Rights Reserved. |
| 255 |
.PP |
| 256 |
Licensed under the Apache License 2.0 (the "License"). You may not use |
| 257 |
this file except in compliance with the License. You can obtain a copy |
| 258 |
in the file LICENSE in the source distribution or at |
| 259 |
<https://www.openssl.org/source/license.html>. |