xref: /openssl/doc/man7/OSSL_PROVIDER-base.pod (revision 8f3ebb7d)
1=pod
2
3=head1 NAME
4
5OSSL_PROVIDER-base - OpenSSL base provider
6
7=head1 DESCRIPTION
8
9The OpenSSL base provider supplies the encoding for OpenSSL's
10asymmetric cryptography.
11
12=head2 Properties
13
14The implementations in this provider specifically have this property
15defined:
16
17=over 4
18
19=item "provider=base"
20
21=back
22
23It may be used in a property query string with fetching functions.
24
25It isn't mandatory to query for this property, except to make sure to get
26implementations of this provider and none other.
27
28=over 4
29
30=item "type=parameters"
31
32=item "type=private"
33
34=item "type=public"
35
36=back
37
38These may be used in a property query string with fetching functions to select
39which data are to be encoded.  Either the private key material, the public
40key material or the domain parameters can be selected.
41
42=over 4
43
44=item "format=der"
45
46=item "format=pem"
47
48=item "format=text"
49
50=back
51
52These may be used in a property query string with fetching functions to select
53the encoding output format.  Either the DER, PEM and plaintext are
54currently permitted.
55
56=head1 OPERATIONS AND ALGORITHMS
57
58The OpenSSL base provider supports these operations and algorithms:
59
60=head2 Random Number Generation
61
62=over 4
63
64=item SEED-SRC,  see L<EVP_RAND-SEED-SRC(7)>
65
66=item JITTER,  see L<EVP_RAND-JITTER(7)>
67
68=back
69
70In addition to this provider, the "SEED-SRC" and "JITTER" algorithms
71are also available in the default provider.
72
73=head2 Asymmetric Key Encoder
74
75=over 4
76
77=item RSA
78
79=item RSA-PSS
80
81=item DH
82
83=item DHX
84
85=item DSA
86
87=item EC
88
89=item ED25519
90
91=item ED448
92
93=item X25519
94
95=item X448
96
97=item SM2
98
99=back
100
101In addition to this provider, all of these encoding algorithms are also
102available in the default provider. Some of these algorithms may be used in
103combination with the FIPS provider.
104
105=head2 Asymmetric Key Decoder
106
107=over 4
108
109=item RSA
110
111=item RSA-PSS
112
113=item DH
114
115=item DHX
116
117=item DSA
118
119=item EC
120
121=item ED25519
122
123=item ED448
124
125=item X25519
126
127=item X448
128
129=item SM2
130
131=item DER
132
133=back
134
135In addition to this provider, all of these decoding algorithms are also
136available in the default provider. Some of these algorithms may be used in
137combination with the FIPS provider.
138
139=head2 Stores
140
141=over 4
142
143=item file
144
145=item org.openssl.winstore, see L<OSSL_STORE-winstore(7)>
146
147=back
148
149In addition to this provider, all of these store algorithms are also
150available in the default provider.
151
152=head1 SEE ALSO
153
154L<OSSL_PROVIDER-default(7)>, L<openssl-core.h(7)>,
155L<openssl-core_dispatch.h(7)>, L<provider(7)>
156
157=head1 HISTORY
158
159This functionality was added in OpenSSL 3.0.
160
161=head1 COPYRIGHT
162
163Copyright 2020-2024 The OpenSSL Project Authors. All Rights Reserved.
164
165Licensed under the Apache License 2.0 (the "License").  You may not use
166this file except in compliance with the License.  You can obtain a copy
167in the file LICENSE in the source distribution or at
168L<https://www.openssl.org/source/license.html>.
169
170=cut
171