Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
Standard preamble:
========================================================================
..
.... \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
. ds C` "" . ds C' "" 'br\} . 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 ========================================================================
Title "OSSL_ENCODER_CTX_NEW_FOR_PKEY 3ossl"
way too many mistakes in technical documents.
Internally, OSSL_ENCODER_CTX_new_for_pkey() uses the names from the \fBEVP_KEYMGMT\|(3) implementation associated with pkey to build a list of applicable encoder implementations that are used to process the pkey into the encoding named by output_type, with the outermost structure named by \fIoutput_structure if that's relevant. All these implementations are implicitly fetched, with propquery for finer selection.
If no suitable encoder implementation is found, \fBOSSL_ENCODER_CTX_new_for_pkey() still creates a OSSL_ENCODER_CTX, but with no associated encoder (OSSL_ENCODER_CTX_get_num_encoders\|(3) returns zero). This helps the caller to distinguish between an error when creating the OSSL_ENCODER_CTX and missing encoder implementation, and allows it to act accordingly.
\fBOSSL_ENCODER_CTX_set_cipher() tells the implementation what cipher should be used to encrypt encoded keys. The cipher is given by name cipher_name. The interpretation of that cipher_name is implementation dependent. The implementation may implement the cipher directly itself or by other implementations, or it may choose to fetch it. If the implementation supports fetching the cipher, then it may use propquery as properties to be queried for when fetching. \fIcipher_name may also be NULL, which will result in unencrypted encoding.
\fBOSSL_ENCODER_CTX_set_passphrase() gives the implementation a pass phrase to use when encrypting the encoded private key. Alternatively, a pass phrase callback may be specified with the following functions.
\fBOSSL_ENCODER_CTX_set_pem_password_cb(), OSSL_ENCODER_CTX_set_passphrase_ui() and OSSL_ENCODER_CTX_set_passphrase_cb() sets up a callback method that the implementation can use to prompt for a pass phrase, giving the caller the choice of preferred pass phrase callback form. These are called indirectly, through an internal OSSL_PASSPHRASE_CALLBACK\|(3) function.
OpenSSL has built in implementations for the following output types: Item "TEXT" The output is a human readable description of the key. \fBEVP_PKEY_print_private\|(3), EVP_PKEY_print_public\|(3) and \fBEVP_PKEY_print_params\|(3) use this for their output. Item "DER" The output is the DER encoding of the selection of the pkey. Item "PEM" The output is the selection of the pkey in PEM format.
These are only 'hints' since the encoder implementations are free to determine what makes sense to include in the output, and this may depend on the desired output. For example, an EC key in a PKCS#8 structure doesn't usually include the public key.
\fBOSSL_ENCODER_CTX_set_cipher(), OSSL_ENCODER_CTX_set_passphrase(), \fBOSSL_ENCODER_CTX_set_pem_password_cb(), OSSL_ENCODER_CTX_set_passphrase_ui() and OSSL_ENCODER_CTX_set_passphrase_cb() all return 1 on success, or 0 on failure.
Licensed under the Apache License 2.0 (the "License"). You may not use this file except in compliance with the License. You can obtain a copy in the file LICENSE in the source distribution or at <https://www.openssl.org/source/license.html>.