doc: note that get_params and set_params calls should return true if the param array...
[openssl.git] / doc / man7 / openssl-glossary.pod
1 =pod
2
3 =head1 NAME
4
5 openssl-glossary - An OpenSSL Glossary
6
7 =head1 DESCRIPTION
8
9 =for comment Please keep the items in case-insensitive alphabetical order
10
11 =over 4
12
13 =item ASN.1, ASN1
14
15 ASN.1 ("Abstract Syntax Notation One") is a notation for describing abstract
16 types and values.  It is defined in the ITU-T documents X.680 to X.683:
17
18 L<https://www.itu.int/rec/T-REC-X.680>,
19 L<https://www.itu.int/rec/T-REC-X.681>,
20 L<https://www.itu.int/rec/T-REC-X.682>,
21 L<https://www.itu.int/rec/T-REC-X.683>
22
23 =item DER ("Distinguished Encoding Rules")
24
25 DER is a binary encoding of data, structured according to an ASN.1
26 specification.  This is a common encoding used for cryptographic objects
27 such as private and public keys, certificates, CRLs, ...
28
29 It is defined in ITU-T document X.690:
30
31 L<https://www.itu.int/rec/T-REC-X.690>
32
33 =item MSBLOB
34
35 MSBLOB is a Microsoft specific binary format for RSA and DSA keys, both
36 private and public.  This form is never passphrase protected.
37
38 =item PEM ("Privacy Enhanced Message")
39
40 PEM is a format used for encoding of binary content into a mail and ASCII
41 friendly form.  The content is a series of base64-encoded lines, surrounded
42 by begin/end markers each on their own line.  For example:
43
44  -----BEGIN PRIVATE KEY-----
45  MIICdg....
46  ... bhTQ==
47  -----END PRIVATE KEY-----
48
49 Optional header line(s) may appear after the begin line, and their existence
50 depends on the type of object being written or read.
51
52 For all OpenSSL uses, the binary content is expected to be a DER encoded
53 structure.
54
55 This is defined in IETF RFC 1421:
56
57 L<https://tools.ietf.org/html/rfc1421>
58
59 =item PKCS#8 (also known as "pkcs8" in some parts of OpenSSL)
60
61 PKCS#8 is a specification of an ASN.1 structure that OpenSSL uses for
62 storing or transmitting any private key in a key type agnostic manner, and
63 has both an unencrypted and an encrypted form.
64
65 This is specified in RFC 5208:
66
67 L<https://tools.ietf.org/html/rfc5208>
68
69 =item PVK
70
71 PVK is a Microsoft specific binary format for RSA and DSA private keys.
72 This form may be passphrase protected.
73
74 =item SubjectPublicKeyInfo
75
76 SubjectPublicKeyInfo is an ASN.1 structure that OpenSSL uses for storing and
77 transmitting any public key in a key type agnostic manner.
78
79 This is specified as part of the specification for certificates, RFC 5280:
80
81 L<https://tools.ietf.org/html/rfc5280>
82
83 =back
84
85 =head1 HISTORY
86
87 This glossary was added in OpenSSL 3.0.
88
89 =head1 COPYRIGHT
90
91 Copyright 2020 The OpenSSL Project Authors. All Rights Reserved.
92
93 Licensed under the Apache License 2.0 (the "License").  You may not use
94 this file except in compliance with the License.  You can obtain a copy
95 in the file LICENSE in the source distribution or at
96 L<https://www.openssl.org/source/license.html>.
97
98 =cut