libcrypto/man/OSSL_DECODER_from_bio.3

         $NetBSD: OSSL_DECODER_from_bio.3,v 1.5 2024/09/08 13:08:26 christos Exp $

 -*- mode: troff; coding: utf-8 -*-
 Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)

 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_DECODER_from_bio 3"  OSSL_DECODER_from_bio 3 2024-09-03 3.0.15 OpenSSL
 For nroff, turn off justification. Always turn off hyphenation; it makes
 way too many mistakes in technical documents.
 NAME
OSSL_DECODER_from_data,
OSSL_DECODER_from_bio,
OSSL_DECODER_from_fp
\- Routines to perform a decoding
 SYNOPSIS
 Header "SYNOPSIS" .Vb 1
 #include <openssl/decoder.h>
\&
 int OSSL_DECODER_from_bio(OSSL_DECODER_CTX *ctx, BIO *in);
 int OSSL_DECODER_from_fp(OSSL_DECODER_CTX *ctx, FILE *fp);
 int OSSL_DECODER_from_data(OSSL_DECODER_CTX *ctx, const unsigned char **pdata,
  size_t *pdata_len);
.Ve

Feature availability macros:
 "OSSL_DECODER_from_fp() is only available when OPENSSL_NO_STDIO is undefined." 4
 Item "OSSL_DECODER_from_fp() is only available when OPENSSL_NO_STDIO is undefined."  DESCRIPTION
 Header "DESCRIPTION" \fBOSSL_DECODER_from_data() runs the decoding process for the context ctx,
with input coming from *pdata, *pdata_len bytes long. Both *pdata
and *pdata_len must be non-NULL. When OSSL_DECODER_from_data() returns,
\fI*pdata is updated to point at the location after what has been decoded,
and *pdata_len to have the number of remaining bytes.

\fBOSSL_DECODER_from_bio() runs the decoding process for the context ctx,
with the input coming from the BIO in. Should it make a difference,
it's recommended to have the BIO set in binary mode rather than text mode.

\fBOSSL_DECODER_from_fp() does the same thing as OSSL_DECODER_from_bio(),
except that the input is coming from the FILE fp.
 "RETURN VALUES"
 Header "RETURN VALUES" \fBOSSL_DECODER_from_bio(), OSSL_DECODER_from_data() and OSSL_DECODER_from_fp()
return 1 on success, or 0 on failure.
 EXAMPLES
 Header "EXAMPLES" To decode an RSA key encoded with PEM from a bio:

.Vb 6
 OSSL_DECODER_CTX *dctx;
 EVP_PKEY *pkey = NULL;
 const char *format = "PEM"; /* NULL for any format */
 const char *structure = NULL; /* any structure */
 const char *keytype = "RSA"; /* NULL for any key */
 const unsigned char *pass = "my password";
\&
 dctx = OSSL_DECODER_CTX_new_for_pkey(&pkey, format, structure,
  keytype,
  OSSL_KEYMGMT_SELECT_KEYPAIR,
  NULL, NULL);
 if (dctx == NULL) {
  /* error: no suitable potential decoders found */
 }
 if (pass != NULL)
  OSSL_DECODER_CTX_set_passphrase(dctx, pass, strlen(pass));
 if (OSSL_DECODER_from_bio(dctx, bio)) {
  /* pkey is created with the decoded data from the bio */
 } else {
  /* decoding failure */
 }
 OSSL_DECODER_CTX_free(dctx);
.Ve

To decode an EC key encoded with DER from a buffer:

.Vb 8
 OSSL_DECODER_CTX *dctx;
 EVP_PKEY *pkey = NULL;
 const char *format = "DER"; /* NULL for any format */
 const char *structure = NULL; /* any structure */
 const char *keytype = "EC"; /* NULL for any key */
 const unsigned char *pass = NULL
 const unsigned char *data = buffer;
 size_t datalen = sizeof(buffer);
\&
 dctx = OSSL_DECODER_CTX_new_for_pkey(&pkey, format, structure,
  keytype,
  OSSL_KEYMGMT_SELECT_KEYPAIR
  | OSSL_KEYMGMT_SELECT_DOMAIN_PARAMETERS,
  NULL, NULL);
 if (dctx == NULL) {
  /* error: no suitable potential decoders found */
 }
 if (pass != NULL)
  OSSL_DECODER_CTX_set_passphrase(dctx, pass, strlen(pass));
 if (OSSL_DECODER_from_data(dctx, &data, &datalen)) {
  /* pkey is created with the decoded data from the buffer */
 } else {
  /* decoding failure */
 }
 OSSL_DECODER_CTX_free(dctx);
.Ve
 "SEE ALSO"
 Header "SEE ALSO" \fBprovider\|(7), OSSL_DECODER_CTX\|(3)
 HISTORY
 Header "HISTORY" The functions described here were 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 "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>.