xref: /freebsd/secure/lib/libcrypto/man/man3/ASN1_item_d2i_bio.3 (revision 7fdf597e96a02165cfe22ff357b857d5fa15ed8a)
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 "ASN1_ITEM_D2I_BIO 3ossl"
ASN1_ITEM_D2I_BIO 3ossl "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"
ASN1_item_d2i_ex, ASN1_item_d2i, ASN1_item_d2i_bio_ex, ASN1_item_d2i_bio, ASN1_item_d2i_fp_ex, ASN1_item_d2i_fp, ASN1_item_i2d_mem_bio \- decode and encode DER-encoded ASN.1 structures
"SYNOPSIS"
Header "SYNOPSIS" .Vb 1 #include <openssl/asn1.h> \& ASN1_VALUE *ASN1_item_d2i_ex(ASN1_VALUE **pval, const unsigned char **in, long len, const ASN1_ITEM *it, OSSL_LIB_CTX *libctx, const char *propq); ASN1_VALUE *ASN1_item_d2i(ASN1_VALUE **pval, const unsigned char **in, long len, const ASN1_ITEM *it); \& void *ASN1_item_d2i_bio_ex(const ASN1_ITEM *it, BIO *in, void *x, OSSL_LIB_CTX *libctx, const char *propq); void *ASN1_item_d2i_bio(const ASN1_ITEM *it, BIO *in, void *x); \& void *ASN1_item_d2i_fp_ex(const ASN1_ITEM *it, FILE *in, void *x, OSSL_LIB_CTX *libctx, const char *propq); void *ASN1_item_d2i_fp(const ASN1_ITEM *it, FILE *in, void *x); \& BIO *ASN1_item_i2d_mem_bio(const ASN1_ITEM *it, const ASN1_VALUE *val); .Ve
"DESCRIPTION"
Header "DESCRIPTION" \fBASN1_item_d2i_ex() decodes the contents of the data stored in *in of length \fIlen which must be a DER-encoded \s-1ASN.1\s0 structure, using the \s-1ASN.1\s0 template \fIit. It places the result in *pval unless pval is \s-1NULL.\s0 If *pval is non-NULL on entry then the \s-1ASN1_VALUE\s0 present there will be reused. Otherwise a new \s-1ASN1_VALUE\s0 will be allocated. If any algorithm fetches are required during the process then they will use the \s-1OSSL_LIB_CTX\s0provided in the \fIlibctx parameter and the property query string in propq. See \*(L"\s-1ALGORITHM FETCHING\*(R"\s0 in crypto\|(7) for more information about algorithm fetching. On exit *in will be updated to point to the next byte in the buffer after the decoded structure.

\fBASN1_item_d2i() is the same as ASN1_item_d2i_ex() except that the default \s-1OSSL_LIB_CTX\s0 is used (i.e. \s-1NULL\s0) and with a \s-1NULL\s0 property query string.

\fBASN1_item_d2i_bio_ex() decodes the contents of its input \s-1BIO\s0 in, which must be a DER-encoded \s-1ASN.1\s0 structure, using the \s-1ASN.1\s0 template it and places the result in *pval unless pval is \s-1NULL.\s0 If in is \s-1NULL\s0 it returns \s-1NULL,\s0 else a pointer to the parsed structure. If any algorithm fetches are required during the process then they will use the \fB\s-1OSSL_LIB_CTX\s0 provided in the libctx parameter and the property query string in propq. See \*(L"\s-1ALGORITHM FETCHING\*(R"\s0 in crypto\|(7) for more information about algorithm fetching.

\fBASN1_item_d2i_bio() is the same as ASN1_item_d2i_bio_ex() except that the default \s-1OSSL_LIB_CTX\s0 is used (i.e. \s-1NULL\s0) and with a \s-1NULL\s0 property query string.

\fBASN1_item_d2i_fp_ex() is the same as ASN1_item_d2i_bio_ex() except that a \s-1FILE\s0 pointer is provided instead of a \s-1BIO.\s0

\fBASN1_item_d2i_fp() is the same as ASN1_item_d2i_fp_ex() except that the default \s-1OSSL_LIB_CTX\s0 is used (i.e. \s-1NULL\s0) and with a \s-1NULL\s0 property query string.

\fBASN1_item_i2d_mem_bio() encodes the given \s-1ASN.1\s0 value val using the \s-1ASN.1\s0 template it and returns the result in a memory \s-1BIO.\s0

"RETURN VALUES"
Header "RETURN VALUES" \fBASN1_item_d2i_bio() returns a pointer to an \s-1ASN1_VALUE\s0 or \s-1NULL.\s0

\fBASN1_item_i2d_mem_bio() returns a pointer to a memory \s-1BIO\s0 or \s-1NULL\s0 on error.

"HISTORY"
Header "HISTORY" The functions ASN1_item_d2i_ex(), ASN1_item_d2i_bio_ex(), ASN1_item_d2i_fp_ex() and ASN1_item_i2d_mem_bio() were added in OpenSSL 3.0.
"COPYRIGHT"
Header "COPYRIGHT" Copyright 2021 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>.