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