xref: /freebsd/secure/lib/libcrypto/man/man7/OSSL_PROVIDER-default.7 (revision fe75646a0234a261c0013bf1840fdac4acaf0cec)
Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42)

Standard preamble:
========================================================================
..
..
.. Set up some character translations and predefined strings. \*(-- will
give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
double quote, and \*(R" will give a right double quote. \*(C+ will
give a nicer C++. Capital omega is used to do unbreakable dashes and
therefore won't be available. \*(C` and \*(C' expand to `' in nroff,
nothing in troff, for use with C<>.
.tr \(*W- . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\}
Escape single quotes in literal strings from groff's Unicode transform.

If the F register is >0, we'll generate index entries on stderr for
titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
entries marked with X<> in POD. Of course, you'll have to process the
output yourself in some meaningful fashion.

Avoid warning from groff about undefined register 'F'.
.. .nr rF 0 . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF Fear. Run. Save yourself. No user-serviceable parts.
. \" fudge factors for nroff and troff . ds #H 0 . ds #V .8m . ds #F .3m . ds #[ \f1 . ds #] .\} . ds #H ((1u-(\\\\n(.fu%2u))*.13m) . ds #V .6m . ds #F 0 . ds #[ \& . ds #] \& .\} . \" simple accents for nroff and troff . ds ' \& . ds ` \& . ds ^ \& . ds , \& . ds ~ ~ . ds / .\} . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u" . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u' . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u' . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u' . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u' . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u' .\} . \" troff and (daisy-wheel) nroff accents . \" corrections for vroff . \" for low resolution devices (crt and lpr) \{\ . ds : e . ds 8 ss . ds o a . ds d- d\h'-1'\(ga . ds D- D\h'-1'\(hy . ds th \o'bp' . ds Th \o'LP' . ds ae ae . ds Ae AE .\} ========================================================================

Title "OSSL_PROVIDER-DEFAULT 7ossl"
OSSL_PROVIDER-DEFAULT 7ossl "2023-09-19" "3.0.11" "OpenSSL"
For nroff, turn off justification. Always turn off hyphenation; it makes
way too many mistakes in technical documents.
"NAME"
OSSL_PROVIDER-default - OpenSSL default provider
"DESCRIPTION"
Header "DESCRIPTION" The OpenSSL default provider supplies the majority of OpenSSL's diverse algorithm implementations. If an application doesn't specify anything else explicitly (e.g. in the application or via config), then this is the provider that will be used as fallback: It is loaded automatically the first time that an algorithm is fetched from a provider or a function acting on providers is called and no other provider has been loaded yet.

If an attempt to load a provider has already been made (whether successful or not) then the default provider won't be loaded automatically. Therefore if the default provider is to be used in conjunction with other providers then it must be loaded explicitly. Automatic loading of the default provider only occurs a maximum of once; if the default provider is explicitly unloaded then the default provider will not be automatically loaded again.

"Properties"
Subsection "Properties" The implementations in this provider specifically have this property defined: Item "provider=default"

It may be used in a property query string with fetching functions such as \fBEVP_MD_fetch\|(3) or EVP_CIPHER_fetch\|(3), as well as with other functions that take a property query string, such as \fBEVP_PKEY_CTX_new_from_name\|(3).

It isn't mandatory to query for this property, except to make sure to get implementations of this provider and none other.

Some implementations may define additional properties. Exact information is listed below

"OPERATIONS AND ALGORITHMS"
Header "OPERATIONS AND ALGORITHMS" The OpenSSL default provider supports these operations and algorithms:
"Hashing Algorithms / Message Digests"
Subsection "Hashing Algorithms / Message Digests"
"\s-1SHA1,\s0 see \s-1EVP_MD-SHA1\s0\|(7)" 4
Item "SHA1, see EVP_MD-SHA1"

0

"\s-1SHA2,\s0 see \s-1EVP_MD-SHA2\s0\|(7)" 4
Item "SHA2, see EVP_MD-SHA2"
"\s-1SHA3,\s0 see \s-1EVP_MD-SHA3\s0\|(7)" 4
Item "SHA3, see EVP_MD-SHA3"
"KECCAK-KMAC, see \s-1EVP_MD-KECCAK-KMAC\s0\|(7)" 4
Item "KECCAK-KMAC, see EVP_MD-KECCAK-KMAC"
"\s-1SHAKE,\s0 see \s-1EVP_MD-SHAKE\s0\|(7)" 4
Item "SHAKE, see EVP_MD-SHAKE"
"\s-1BLAKE2,\s0 see \s-1EVP_MD-BLAKE2\s0\|(7)" 4
Item "BLAKE2, see EVP_MD-BLAKE2"
"\s-1SM3,\s0 see \s-1EVP_MD-SM3\s0\|(7)" 4
Item "SM3, see EVP_MD-SM3"
"\s-1MD5,\s0 see \s-1EVP_MD-MD5\s0\|(7)" 4
Item "MD5, see EVP_MD-MD5"
"\s-1MD5-SHA1,\s0 see \s-1EVP_MD-MD5-SHA1\s0\|(7)" 4
Item "MD5-SHA1, see EVP_MD-MD5-SHA1"
"\s-1RIPEMD160,\s0 see \s-1EVP_MD-RIPEMD160\s0\|(7)" 4
Item "RIPEMD160, see EVP_MD-RIPEMD160"
"\s-1NULL,\s0 see \s-1EVP_MD-NULL\s0\|(7)" 4
Item "NULL, see EVP_MD-NULL"

"Symmetric Ciphers"
Subsection "Symmetric Ciphers"
"\s-1AES,\s0 see \s-1EVP_CIPHER-AES\s0\|(7)" 4
Item "AES, see EVP_CIPHER-AES"

0

"\s-1ARIA,\s0 see \s-1EVP_CIPHER-ARIA\s0\|(7)" 4
Item "ARIA, see EVP_CIPHER-ARIA"
"\s-1CAMELLIA,\s0 see \s-1EVP_CIPHER-CAMELLIA\s0\|(7)" 4
Item "CAMELLIA, see EVP_CIPHER-CAMELLIA"
"3DES, see \s-1EVP_CIPHER-DES\s0\|(7)" 4
Item "3DES, see EVP_CIPHER-DES"
"\s-1SEED,\s0 see \s-1EVP_CIPHER-SEED\s0\|(7)" 4
Item "SEED, see EVP_CIPHER-SEED"
"\s-1SM4,\s0 see \s-1EVP_CIPHER-SM4\s0\|(7)" 4
Item "SM4, see EVP_CIPHER-SM4"
"ChaCha20, see \s-1EVP_CIPHER-CHACHA\s0\|(7)" 4
Item "ChaCha20, see EVP_CIPHER-CHACHA"
"ChaCha20-Poly1305, see \s-1EVP_CIPHER-CHACHA\s0\|(7)" 4
Item "ChaCha20-Poly1305, see EVP_CIPHER-CHACHA"
"\s-1NULL,\s0 see \s-1EVP_CIPHER-NULL\s0\|(7)" 4
Item "NULL, see EVP_CIPHER-NULL"

"Message Authentication Code (\s-1MAC\s0)"
Subsection "Message Authentication Code (MAC)"
"\s-1BLAKE2,\s0 see \s-1EVP_MAC-BLAKE2\s0\|(7)" 4
Item "BLAKE2, see EVP_MAC-BLAKE2"

0

"\s-1CMAC,\s0 see \s-1EVP_MAC-CMAC\s0\|(7)" 4
Item "CMAC, see EVP_MAC-CMAC"
"\s-1GMAC,\s0 see \s-1EVP_MAC-GMAC\s0\|(7)" 4
Item "GMAC, see EVP_MAC-GMAC"
"\s-1HMAC,\s0 see \s-1EVP_MAC-HMAC\s0\|(7)" 4
Item "HMAC, see EVP_MAC-HMAC"
"\s-1KMAC,\s0 see \s-1EVP_MAC-KMAC\s0\|(7)" 4
Item "KMAC, see EVP_MAC-KMAC"
"\s-1SIPHASH,\s0 see EVP_MAC-Siphash\|(7)" 4
Item "SIPHASH, see EVP_MAC-Siphash"
"\s-1POLY1305,\s0 see EVP_MAC-Poly1305\|(7)" 4
Item "POLY1305, see EVP_MAC-Poly1305"

"Key Derivation Function (\s-1KDF\s0)"
Subsection "Key Derivation Function (KDF)"
"\s-1HKDF,\s0 see \s-1EVP_KDF-HKDF\s0\|(7)" 4
Item "HKDF, see EVP_KDF-HKDF"

0

"\s-1SSKDF,\s0 see \s-1EVP_KDF-SS\s0\|(7)" 4
Item "SSKDF, see EVP_KDF-SS"
"\s-1PBKDF2,\s0 see \s-1EVP_KDF-PBKDF2\s0\|(7)" 4
Item "PBKDF2, see EVP_KDF-PBKDF2"
"\s-1PKCS12KDF,\s0 see \s-1EVP_KDF-PKCS12KDF\s0\|(7)" 4
Item "PKCS12KDF, see EVP_KDF-PKCS12KDF"
"\s-1SSHKDF,\s0 see \s-1EVP_KDF-SSHKDF\s0\|(7)" 4
Item "SSHKDF, see EVP_KDF-SSHKDF"
"\s-1TLS1-PRF,\s0 see \s-1EVP_KDF-TLS1_PRF\s0\|(7)" 4
Item "TLS1-PRF, see EVP_KDF-TLS1_PRF"
"\s-1KBKDF,\s0 see \s-1EVP_KDF-KB\s0\|(7)" 4
Item "KBKDF, see EVP_KDF-KB"
"X942KDF-ASN1, see \s-1EVP_KDF-X942-ASN1\s0\|(7)" 4
Item "X942KDF-ASN1, see EVP_KDF-X942-ASN1"
"X942KDF-CONCAT, see \s-1EVP_KDF-X942-CONCAT\s0\|(7)" 4
Item "X942KDF-CONCAT, see EVP_KDF-X942-CONCAT"
"X963KDF, see \s-1EVP_KDF-X963\s0\|(7)" 4
Item "X963KDF, see EVP_KDF-X963"
"\s-1SCRYPT,\s0 see \s-1EVP_KDF-SCRYPT\s0\|(7)" 4
Item "SCRYPT, see EVP_KDF-SCRYPT"
"\s-1KRB5KDF,\s0 see \s-1EVP_KDF-KRB5KDF\s0\|(7)" 4
Item "KRB5KDF, see EVP_KDF-KRB5KDF"

"Key Exchange"
Subsection "Key Exchange"
"\s-1DH,\s0 see \s-1EVP_KEYEXCH-DH\s0\|(7)" 4
Item "DH, see EVP_KEYEXCH-DH"

0

"\s-1ECDH,\s0 see \s-1EVP_KEYEXCH-ECDH\s0\|(7)" 4
Item "ECDH, see EVP_KEYEXCH-ECDH"
"X25519, see \s-1EVP_KEYEXCH-X25519\s0\|(7)" 4
Item "X25519, see EVP_KEYEXCH-X25519"
"X448, see \s-1EVP_KEYEXCH-X448\s0\|(7)" 4
Item "X448, see EVP_KEYEXCH-X448"

"Asymmetric Signature"
Subsection "Asymmetric Signature"
"\s-1DSA,\s0 see \s-1EVP_SIGNATURE-DSA\s0\|(7)" 4
Item "DSA, see EVP_SIGNATURE-DSA"

0

"\s-1RSA,\s0 see \s-1EVP_SIGNATURE-RSA\s0\|(7)" 4
Item "RSA, see EVP_SIGNATURE-RSA"
"\s-1HMAC,\s0 see \s-1EVP_SIGNATURE-HMAC\s0\|(7)" 4
Item "HMAC, see EVP_SIGNATURE-HMAC"
"\s-1SIPHASH,\s0 see EVP_SIGNATURE-Siphash\|(7)" 4
Item "SIPHASH, see EVP_SIGNATURE-Siphash"
"\s-1POLY1305,\s0 see EVP_SIGNATURE-Poly1305\|(7)" 4
Item "POLY1305, see EVP_SIGNATURE-Poly1305"
"\s-1CMAC,\s0 see \s-1EVP_SIGNATURE-CMAC\s0\|(7)" 4
Item "CMAC, see EVP_SIGNATURE-CMAC"

"Asymmetric Cipher"
Subsection "Asymmetric Cipher"
"\s-1RSA,\s0 see \s-1EVP_ASYM_CIPHER-RSA\s0\|(7)" 4
Item "RSA, see EVP_ASYM_CIPHER-RSA"

0

"\s-1SM2,\s0 see \s-1EVP_ASYM_CIPHER-SM2\s0\|(7)" 4
Item "SM2, see EVP_ASYM_CIPHER-SM2"

"Asymmetric Key Encapsulation"
Subsection "Asymmetric Key Encapsulation"
"\s-1RSA,\s0 see \s-1EVP_KEM-RSA\s0\|(7)" 4
Item "RSA, see EVP_KEM-RSA"
"Asymmetric Key Management"
Subsection "Asymmetric Key Management"

0

"\s-1DH,\s0 see \s-1EVP_KEYMGMT-DH\s0\|(7)" 4
Item "DH, see EVP_KEYMGMT-DH"
"\s-1DHX,\s0 see \s-1EVP_KEYMGMT-DHX\s0\|(7)" 4
Item "DHX, see EVP_KEYMGMT-DHX"
"\s-1DSA,\s0 see \s-1EVP_KEYMGMT-DSA\s0\|(7)" 4
Item "DSA, see EVP_KEYMGMT-DSA"
"\s-1RSA,\s0 see \s-1EVP_KEYMGMT-RSA\s0\|(7)" 4
Item "RSA, see EVP_KEYMGMT-RSA"
"\s-1EC,\s0 see \s-1EVP_KEYMGMT-EC\s0\|(7)" 4
Item "EC, see EVP_KEYMGMT-EC"
"X25519, see \s-1EVP_KEYMGMT-X25519\s0\|(7)" 4
Item "X25519, see EVP_KEYMGMT-X25519"
"X448, see \s-1EVP_KEYMGMT-X448\s0\|(7)" 4
Item "X448, see EVP_KEYMGMT-X448"

"Random Number Generation"
Subsection "Random Number Generation"
"CTR-DRBG, see \s-1EVP_RAND-CTR-DRBG\s0\|(7)" 4
Item "CTR-DRBG, see EVP_RAND-CTR-DRBG"

0

"HASH-DRBG, see \s-1EVP_RAND-HASH-DRBG\s0\|(7)" 4
Item "HASH-DRBG, see EVP_RAND-HASH-DRBG"
"HMAC-DRBG, see \s-1EVP_RAND-HMAC-DRBG\s0\|(7)" 4
Item "HMAC-DRBG, see EVP_RAND-HMAC-DRBG"
"SEED-SRC, see \s-1EVP_RAND-SEED-SRC\s0\|(7)" 4
Item "SEED-SRC, see EVP_RAND-SEED-SRC"
"TEST-RAND, see \s-1EVP_RAND-TEST-RAND\s0\|(7)" 4
Item "TEST-RAND, see EVP_RAND-TEST-RAND"

"Asymmetric Key Encoder"
Subsection "Asymmetric Key Encoder" The default provider also includes all of the encoding algorithms present in the base provider. Some of these have the property \*(L"fips=yes\*(R", to allow them to be used together with the \s-1FIPS\s0 provider.
"\s-1RSA,\s0 see \s-1OSSL_ENCODER-RSA\s0\|(7)" 4
Item "RSA, see OSSL_ENCODER-RSA"

0

"\s-1DH,\s0 see \s-1OSSL_ENCODER-DH\s0\|(7)" 4
Item "DH, see OSSL_ENCODER-DH"
"\s-1DSA,\s0 see \s-1OSSL_ENCODER-DSA\s0\|(7)" 4
Item "DSA, see OSSL_ENCODER-DSA"
"\s-1EC,\s0 see \s-1OSSL_ENCODER-EC\s0\|(7)" 4
Item "EC, see OSSL_ENCODER-EC"
"X25519, see \s-1OSSL_ENCODER-X25519\s0\|(7)" 4
Item "X25519, see OSSL_ENCODER-X25519"
"X448, see \s-1OSSL_ENCODER-X448\s0\|(7)" 4
Item "X448, see OSSL_ENCODER-X448"

"SEE ALSO"
Header "SEE ALSO" \fBopenssl-core.h\|(7), openssl-core_dispatch.h\|(7), provider\|(7), \fBOSSL_PROVIDER-base\|(7)
"HISTORY"
Header "HISTORY" The \s-1RIPEMD160\s0 digest was added to the default provider in OpenSSL 3.0.7.

All other functionality was added in OpenSSL 3.0.

"COPYRIGHT"
Header "COPYRIGHT" Copyright 2020-2023 The OpenSSL Project Authors. All Rights Reserved.

Licensed under the Apache License 2.0 (the \*(L"License\*(R"). You may not use this file except in compliance with the License. You can obtain a copy in the file \s-1LICENSE\s0 in the source distribution or at <https://www.openssl.org/source/license.html>.