Expose PKCS7_get_octet_string and PKCS7_type_is_other
[openssl.git] / doc / man3 / PKCS7_get_octet_string.pod
1 =pod
2
3 =head1 NAME
4
5 PKCS7_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
15 PKCS7_get_octet_string() returns a pointer to an ASN1 octet string from a
16 PKCS#7 envelopedData structure or B<NULL> if the structure cannot be parsed.
17
18 =head1 NOTES
19
20 As the B<0> implies, PKCS7_get_octet_string() returns internal pointers which
21 should not be freed by the caller.
22
23 =head1 RETURN VALUES
24
25 PKCS7_get_octet_string() returns an ASN1_OCTET_STRING pointer.
26
27 =head1 SEE ALSO
28
29 L<PKCS7_type_is_data(3)>
30
31 =head1 COPYRIGHT
32
33 Copyright 2002-2020 The OpenSSL Project Authors. All Rights Reserved.
34
35 Licensed under the Apache License 2.0 (the "License").  You may not use
36 this file except in compliance with the License.  You can obtain a copy
37 in the file LICENSE in the source distribution or at
38 L<https://www.openssl.org/source/license.html>.
39
40 =cut