mirror of https://github.com/openssl/openssl
116 lines
4.9 KiB
Plaintext
116 lines
4.9 KiB
Plaintext
=pod
|
|
|
|
=head1 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,
|
|
ASN1_item_pack, ASN1_item_unpack_ex, ASN1_item_unpack
|
|
- decode and encode DER-encoded ASN.1 structures
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
#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);
|
|
|
|
ASN1_STRING *ASN1_item_pack(void *obj, const ASN1_ITEM *it, ASN1_STRING **oct);
|
|
|
|
void *ASN1_item_unpack(const ASN1_STRING *oct, const ASN1_ITEM *it);
|
|
|
|
void *ASN1_item_unpack_ex(const ASN1_STRING *oct, const ASN1_ITEM *it,
|
|
OSSL_LIB_CTX *libctx, const char *propq);
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
ASN1_item_d2i_ex() decodes the contents of the data stored in I<*in> of length
|
|
I<len> which must be a DER-encoded ASN.1 structure, using the ASN.1 template
|
|
I<it>. It places the result in I<*pval> unless I<pval> is NULL. If I<*pval> is
|
|
non-NULL on entry then the B<ASN1_VALUE> present there will be reused. Otherwise
|
|
a new B<ASN1_VALUE> will be allocated. If any algorithm fetches are required
|
|
during the process then they will use the B<OSSL_LIB_CTX>provided in the
|
|
I<libctx> parameter and the property query string in I<propq>. See
|
|
L<crypto(7)/ALGORITHM FETCHING> for more information about algorithm fetching.
|
|
On exit I<*in> will be updated to point to the next byte in the buffer after the
|
|
decoded structure.
|
|
|
|
ASN1_item_d2i() is the same as ASN1_item_d2i_ex() except that the default
|
|
OSSL_LIB_CTX is used (i.e. NULL) and with a NULL property query string.
|
|
|
|
ASN1_item_d2i_bio_ex() decodes the contents of its input BIO I<in>,
|
|
which must be a DER-encoded ASN.1 structure, using the ASN.1 template I<it>
|
|
and places the result in I<*pval> unless I<pval> is NULL.
|
|
If I<in> is NULL it returns NULL, else a pointer to the parsed structure. If any
|
|
algorithm fetches are required during the process then they will use the
|
|
B<OSSL_LIB_CTX> provided in the I<libctx> parameter and the property query
|
|
string in I<propq>. See L<crypto(7)/ALGORITHM FETCHING> for more information
|
|
about algorithm fetching.
|
|
|
|
ASN1_item_d2i_bio() is the same as ASN1_item_d2i_bio_ex() except that the
|
|
default B<OSSL_LIB_CTX> is used (i.e. NULL) and with a NULL property query
|
|
string.
|
|
|
|
ASN1_item_d2i_fp_ex() is the same as ASN1_item_d2i_bio_ex() except that a FILE
|
|
pointer is provided instead of a BIO.
|
|
|
|
ASN1_item_d2i_fp() is the same as ASN1_item_d2i_fp_ex() except that the
|
|
default B<OSSL_LIB_CTX> is used (i.e. NULL) and with a NULL property query
|
|
string.
|
|
|
|
ASN1_item_i2d_mem_bio() encodes the given ASN.1 value I<val>
|
|
using the ASN.1 template I<it> and returns the result in a memory BIO.
|
|
|
|
ASN1_item_pack() encodes the given ASN.1 value in I<obj> using the
|
|
ASN.1 template I<it> and returns an B<ASN1_STRING> object. If the passed in
|
|
I<*oct> is not NULL then this is used to store the returned result, otherwise
|
|
a new B<ASN1_STRING> object is created. If I<oct> is not NULL and I<*oct> is NULL
|
|
then the returned return is also set into I<*oct>. If there is an error the optional
|
|
passed in B<ASN1_STRING> will not be freed, but the previous value may be cleared when
|
|
ASN1_STRING_set0(*oct, NULL, 0) is called internally.
|
|
|
|
ASN1_item_unpack() uses ASN1_item_d2i() to decode the DER-encoded B<ASN1_STRING>
|
|
I<oct> using the ASN.1 template I<it>.
|
|
|
|
ASN1_item_unpack_ex() is similar to ASN1_item_unpack(), but uses ASN1_item_d2i_ex() so
|
|
that the I<libctx> and I<propq> can be used when doing algorithm fetching.
|
|
|
|
=head1 RETURN VALUES
|
|
|
|
ASN1_item_d2i_bio(), ASN1_item_unpack_ex() and ASN1_item_unpack() return a pointer to
|
|
an B<ASN1_VALUE> or NULL on error.
|
|
|
|
ASN1_item_i2d_mem_bio() returns a pointer to a memory BIO or NULL on error.
|
|
|
|
ASN1_item_pack() returns a pointer to an B<ASN1_STRING> or NULL on error.
|
|
|
|
=head1 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.
|
|
|
|
The function ASN1_item_unpack_ex() was added in OpenSSL 3.2.
|
|
|
|
=head1 COPYRIGHT
|
|
|
|
Copyright 2021-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
|
|
L<https://www.openssl.org/source/license.html>.
|
|
|
|
=cut
|