xref: /freebsd/crypto/openssl/doc/man3/PKCS7_get_octet_string.pod (revision b077aed33b7b6aefca7b17ddb250cf521f938613)
1*b077aed3SPierre Pronchery=pod
2*b077aed3SPierre Pronchery
3*b077aed3SPierre Pronchery=head1 NAME
4*b077aed3SPierre Pronchery
5*b077aed3SPierre ProncheryPKCS7_get_octet_string - return octet string from a PKCS#7 envelopedData structure
6*b077aed3SPierre Pronchery
7*b077aed3SPierre Pronchery=head1 SYNOPSIS
8*b077aed3SPierre Pronchery
9*b077aed3SPierre Pronchery #include <openssl/pkcs7.h>
10*b077aed3SPierre Pronchery
11*b077aed3SPierre Pronchery ASN1_OCTET_STRING *PKCS7_get_octet_string(PKCS7 *p7);
12*b077aed3SPierre Pronchery
13*b077aed3SPierre Pronchery=head1 DESCRIPTION
14*b077aed3SPierre Pronchery
15*b077aed3SPierre ProncheryPKCS7_get_octet_string() returns a pointer to an ASN1 octet string from a
16*b077aed3SPierre ProncheryPKCS#7 envelopedData structure or B<NULL> if the structure cannot be parsed.
17*b077aed3SPierre Pronchery
18*b077aed3SPierre Pronchery=head1 NOTES
19*b077aed3SPierre Pronchery
20*b077aed3SPierre ProncheryAs the B<0> implies, PKCS7_get_octet_string() returns internal pointers which
21*b077aed3SPierre Proncheryshould not be freed by the caller.
22*b077aed3SPierre Pronchery
23*b077aed3SPierre Pronchery=head1 RETURN VALUES
24*b077aed3SPierre Pronchery
25*b077aed3SPierre ProncheryPKCS7_get_octet_string() returns an ASN1_OCTET_STRING pointer.
26*b077aed3SPierre Pronchery
27*b077aed3SPierre Pronchery=head1 SEE ALSO
28*b077aed3SPierre Pronchery
29*b077aed3SPierre ProncheryL<PKCS7_type_is_data(3)>
30*b077aed3SPierre Pronchery
31*b077aed3SPierre Pronchery=head1 COPYRIGHT
32*b077aed3SPierre Pronchery
33*b077aed3SPierre ProncheryCopyright 2002-2020 The OpenSSL Project Authors. All Rights Reserved.
34*b077aed3SPierre Pronchery
35*b077aed3SPierre ProncheryLicensed under the Apache License 2.0 (the "License").  You may not use
36*b077aed3SPierre Proncherythis file except in compliance with the License.  You can obtain a copy
37*b077aed3SPierre Proncheryin the file LICENSE in the source distribution or at
38*b077aed3SPierre ProncheryL<https://www.openssl.org/source/license.html>.
39*b077aed3SPierre Pronchery
40*b077aed3SPierre Pronchery=cut
41