xref: /freebsd/crypto/openssl/doc/man7/OSSL_PROVIDER-base.pod (revision b077aed33b7b6aefca7b17ddb250cf521f938613)
1*b077aed3SPierre Pronchery=pod
2*b077aed3SPierre Pronchery
3*b077aed3SPierre Pronchery=head1 NAME
4*b077aed3SPierre Pronchery
5*b077aed3SPierre ProncheryOSSL_PROVIDER-base - OpenSSL base provider
6*b077aed3SPierre Pronchery
7*b077aed3SPierre Pronchery=head1 DESCRIPTION
8*b077aed3SPierre Pronchery
9*b077aed3SPierre ProncheryThe OpenSSL base provider supplies the encoding for OpenSSL's
10*b077aed3SPierre Proncheryasymmetric cryptography.
11*b077aed3SPierre Pronchery
12*b077aed3SPierre Pronchery=head2 Properties
13*b077aed3SPierre Pronchery
14*b077aed3SPierre ProncheryThe implementations in this provider specifically have this property
15*b077aed3SPierre Proncherydefined:
16*b077aed3SPierre Pronchery
17*b077aed3SPierre Pronchery=over 4
18*b077aed3SPierre Pronchery
19*b077aed3SPierre Pronchery=item "provider=base"
20*b077aed3SPierre Pronchery
21*b077aed3SPierre Pronchery=back
22*b077aed3SPierre Pronchery
23*b077aed3SPierre ProncheryIt may be used in a property query string with fetching functions.
24*b077aed3SPierre Pronchery
25*b077aed3SPierre ProncheryIt isn't mandatory to query for this property, except to make sure to get
26*b077aed3SPierre Proncheryimplementations of this provider and none other.
27*b077aed3SPierre Pronchery
28*b077aed3SPierre Pronchery=over 4
29*b077aed3SPierre Pronchery
30*b077aed3SPierre Pronchery=item "type=parameters"
31*b077aed3SPierre Pronchery
32*b077aed3SPierre Pronchery=item "type=private"
33*b077aed3SPierre Pronchery
34*b077aed3SPierre Pronchery=item "type=public"
35*b077aed3SPierre Pronchery
36*b077aed3SPierre Pronchery=back
37*b077aed3SPierre Pronchery
38*b077aed3SPierre ProncheryThese may be used in a property query string with fetching functions to select
39*b077aed3SPierre Proncherywhich data are to be encoded.  Either the private key material, the public
40*b077aed3SPierre Proncherykey material or the domain parameters can be selected.
41*b077aed3SPierre Pronchery
42*b077aed3SPierre Pronchery=over 4
43*b077aed3SPierre Pronchery
44*b077aed3SPierre Pronchery=item "format=der"
45*b077aed3SPierre Pronchery
46*b077aed3SPierre Pronchery=item "format=pem"
47*b077aed3SPierre Pronchery
48*b077aed3SPierre Pronchery=item "format=text"
49*b077aed3SPierre Pronchery
50*b077aed3SPierre Pronchery=back
51*b077aed3SPierre Pronchery
52*b077aed3SPierre ProncheryThese may be used in a property query string with fetching functions to select
53*b077aed3SPierre Proncherythe encoding output format.  Either the DER, PEM and plaintext are
54*b077aed3SPierre Proncherycurrently permitted.
55*b077aed3SPierre Pronchery
56*b077aed3SPierre Pronchery=head1 OPERATIONS AND ALGORITHMS
57*b077aed3SPierre Pronchery
58*b077aed3SPierre ProncheryThe OpenSSL base provider supports these operations and algorithms:
59*b077aed3SPierre Pronchery
60*b077aed3SPierre Pronchery=head2 Asymmetric Key Encoder
61*b077aed3SPierre Pronchery
62*b077aed3SPierre ProncheryIn addition to "provider=base", some of these encoders define the
63*b077aed3SPierre Proncheryproperty "fips=yes", to allow them to be used together with the FIPS
64*b077aed3SPierre Proncheryprovider.
65*b077aed3SPierre Pronchery
66*b077aed3SPierre Pronchery=over 4
67*b077aed3SPierre Pronchery
68*b077aed3SPierre Pronchery=item RSA, see L<OSSL_ENCODER-RSA(7)>
69*b077aed3SPierre Pronchery
70*b077aed3SPierre Pronchery=item DH, see L<OSSL_ENCODER-DH(7)>
71*b077aed3SPierre Pronchery
72*b077aed3SPierre Pronchery=item DSA, see L<OSSL_ENCODER-DSA(7)>
73*b077aed3SPierre Pronchery
74*b077aed3SPierre Pronchery=item EC, see L<OSSL_ENCODER-EC(7)>
75*b077aed3SPierre Pronchery
76*b077aed3SPierre Pronchery=item X25519, see L<OSSL_ENCODER-X25519(7)>
77*b077aed3SPierre Pronchery
78*b077aed3SPierre Pronchery=item X448, see L<OSSL_ENCODER-X448(7)>
79*b077aed3SPierre Pronchery
80*b077aed3SPierre Pronchery=back
81*b077aed3SPierre Pronchery
82*b077aed3SPierre Pronchery=head1 SEE ALSO
83*b077aed3SPierre Pronchery
84*b077aed3SPierre ProncheryL<OSSL_PROVIDER-default(7)>, L<openssl-core.h(7)>,
85*b077aed3SPierre ProncheryL<openssl-core_dispatch.h(7)>, L<provider(7)>
86*b077aed3SPierre Pronchery
87*b077aed3SPierre Pronchery=head1 HISTORY
88*b077aed3SPierre Pronchery
89*b077aed3SPierre ProncheryThis functionality was added in OpenSSL 3.0.
90*b077aed3SPierre Pronchery
91*b077aed3SPierre Pronchery=head1 COPYRIGHT
92*b077aed3SPierre Pronchery
93*b077aed3SPierre ProncheryCopyright 2020 The OpenSSL Project Authors. All Rights Reserved.
94*b077aed3SPierre Pronchery
95*b077aed3SPierre ProncheryLicensed under the Apache License 2.0 (the "License").  You may not use
96*b077aed3SPierre Proncherythis file except in compliance with the License.  You can obtain a copy
97*b077aed3SPierre Proncheryin the file LICENSE in the source distribution or at
98*b077aed3SPierre ProncheryL<https://www.openssl.org/source/license.html>.
99*b077aed3SPierre Pronchery
100*b077aed3SPierre Pronchery=cut
101