Debian Codegraph @

upstream/debian-unstable/man3/PKCS7_get_octet_string.3ssl

raw
1 .\" -*- mode: troff; coding: utf-8 -*-
2 .\" Automatically generated by Pod::Man 5.0102 (Pod::Simple 3.45)
3 .\"
4 .\" Standard preamble:
5 .\" ========================================================================
6 .de Sp \" Vertical space (when we can't use .PP)
7 .if t .sp .5v
8 .if n .sp
9 ..
10 .de Vb \" Begin verbatim text
11 .ft CW
12 .nf
13 .ne \\$1
14 ..
15 .de Ve \" End verbatim text
16 .ft R
17 .fi
18 ..
19 .\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
20 .ie n \{\
21 . ds C` ""
22 . ds C' ""
23 'br\}
24 .el\{\
25 . ds C`
26 . ds C'
27 'br\}
28 .\"
29 .\" Escape single quotes in literal strings from groff's Unicode transform.
30 .ie \n(.g .ds Aq \(aq
31 .el .ds Aq '
32 .\"
33 .\" If the F register is >0, we'll generate index entries on stderr for
34 .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
35 .\" entries marked with X<> in POD. Of course, you'll have to process the
36 .\" output yourself in some meaningful fashion.
37 .\"
38 .\" Avoid warning from groff about undefined register 'F'.
39 .de IX
40 ..
41 .nr rF 0
42 .if \n(.g .if rF .nr rF 1
43 .if (\n(rF:(\n(.g==0)) \{\
44 . if \nF \{\
45 . de IX
46 . tm Index:\\$1\t\\n%\t"\\$2"
47 ..
48 . if !\nF==2 \{\
49 . nr % 0
50 . nr F 2
51 . \}
52 . \}
53 .\}
54 .rr rF
55 .\" ========================================================================
56 .\"
57 .IX Title "PKCS7_GET_OCTET_STRING 3SSL"
58 .TH PKCS7_GET_OCTET_STRING 3SSL 2026-04-07 3.6.2 OpenSSL
59 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
60 .\" way too many mistakes in technical documents.
61 .if n .ad l
62 .nh
63 .SH NAME
64 PKCS7_get_octet_string \- return octet string from a PKCS#7 envelopedData structure
65 .SH SYNOPSIS
66 .IX Header "SYNOPSIS"
67 .Vb 1
68 \& #include <openssl/pkcs7.h>
69 \&
70 \& ASN1_OCTET_STRING *PKCS7_get_octet_string(PKCS7 *p7);
71 .Ve
72 .SH DESCRIPTION
73 .IX Header "DESCRIPTION"
74 \&\fBPKCS7_get_octet_string()\fR returns a pointer to an ASN1 octet string from a
75 PKCS#7 envelopedData structure or \fBNULL\fR if the structure cannot be parsed.
76 .SH NOTES
77 .IX Header "NOTES"
78 As the \fB0\fR implies, \fBPKCS7_get_octet_string()\fR returns internal pointers which
79 should not be freed by the caller.
80 .SH "RETURN VALUES"
81 .IX Header "RETURN VALUES"
82 \&\fBPKCS7_get_octet_string()\fR returns an ASN1_OCTET_STRING pointer.
83 .SH "SEE ALSO"
84 .IX Header "SEE ALSO"
85 \&\fBPKCS7_type_is_data\fR\|(3)
86 .SH COPYRIGHT
87 .IX Header "COPYRIGHT"
88 Copyright 2002\-2020 The OpenSSL Project Authors. All Rights Reserved.
89 .PP
90 Licensed under the Apache License 2.0 (the "License"). You may not use
91 this file except in compliance with the License. You can obtain a copy
92 in the file LICENSE in the source distribution or at
93 <https://www.openssl.org/source/license.html>.