projects / thirdparty / openssl.git / blame
| Commit | Line | Data |
|---|---|---|
| dfc0857d P |
1 | =pod |
| 2 | ||
| 3 | =head1 NAME | |
| 4 | ||
| 5 | OSSL_PROVIDER-base - OpenSSL base provider | |
| 6 | ||
| 7 | =head1 DESCRIPTION | |
| 8 | ||
| ece9304c | 9 | The OpenSSL base provider supplies the encoding for OpenSSL's |
| dfc0857d P |
10 | asymmetric cryptography. |
| 11 | ||
| 12 | =head2 Properties | |
| 13 | ||
| 14 | The implementations in this provider specifically have this property | |
| 15 | defined: | |
| 16 | ||
| 17 | =over 4 | |
| 18 | ||
| 19 | =item "provider=base" | |
| 20 | ||
| 21 | =back | |
| 22 | ||
| 23 | It may be used in a property query string with fetching functions. | |
| 24 | ||
| 25 | It isn't mandatory to query for this property, except to make sure to get | |
| 26 | implementations 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 | ||
| 38 | These may be used in a property query string with fetching functions to select | |
| ece9304c | 39 | which data are to be encoded. Either the private key material, the public |
| dfc0857d P |
40 | key 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 | ||
| 52 | These may be used in a property query string with fetching functions to select | |
| ece9304c | 53 | the encoding output format. Either the DER, PEM and plaintext are |
| dfc0857d P |
54 | currently permitted. |
| 55 | ||
| 56 | =head1 OPERATIONS AND ALGORITHMS | |
| 57 | ||
| 58 | The OpenSSL base provider supports these operations and algorithms: | |
| 59 | ||
| ece9304c | 60 | =head2 Asymmetric Key Encoder |
| dfc0857d | 61 | |
| ece9304c | 62 | In addition to "provider=base", some of these encoders define the |
| dfc0857d P |
63 | property "fips=yes", to allow them to be used together with the FIPS |
| 64 | provider. | |
| 65 | ||
| 66 | =over 4 | |
| 67 | ||
| ece9304c | 68 | =item RSA, see L<OSSL_ENCODER-RSA(7)> |
| dfc0857d | 69 | |
| ece9304c | 70 | =item DH, see L<OSSL_ENCODER-DH(7)> |
| dfc0857d | 71 | |
| ece9304c | 72 | =item DSA, see L<OSSL_ENCODER-DSA(7)> |
| dfc0857d | 73 | |
| ece9304c | 74 | =item EC, see L<OSSL_ENCODER-EC(7)> |
| dfc0857d | 75 | |
| ece9304c | 76 | =item X25519, see L<OSSL_ENCODER-X25519(7)> |
| dfc0857d | 77 | |
| ece9304c | 78 | =item X448, see L<OSSL_ENCODER-X448(7)> |
| dfc0857d P |
79 | |
| 80 | =back | |
| 81 | ||
| 82 | =head1 SEE ALSO | |
| 83 | ||
| 84 | L<OSSL_PROVIDER-default(7)>, L<openssl-core.h(7)>, | |
| 85 | L<openssl-core_dispatch.h(7)>, L<provider(7)> | |
| 86 | ||
| 4741c80c | 87 | =head1 HISTORY |
| 88 | ||
| 89 | This functionality was added in OpenSSL 3.0. | |
| 90 | ||
| dfc0857d P |
91 | =head1 COPYRIGHT |
| 92 | ||
| 93 | Copyright 2020 The OpenSSL Project Authors. All Rights Reserved. | |
| 94 | ||
| 95 | Licensed under the Apache License 2.0 (the "License"). You may not use | |
| 96 | this file except in compliance with the License. You can obtain a copy | |
| 97 | in the file LICENSE in the source distribution or at | |
| 98 | L<https://www.openssl.org/source/license.html>. | |
| 99 | ||
| 100 | =cut |