Debian Codegraph @

upstream/debian-unstable/man3/OSSL_CMP_HDR_get0_transactionID.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 "OSSL_CMP_HDR_GET0_TRANSACTIONID 3SSL"
58 .TH OSSL_CMP_HDR_GET0_TRANSACTIONID 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 OSSL_CMP_HDR_get0_transactionID,
65 OSSL_CMP_HDR_get0_recipNonce,
66 OSSL_CMP_HDR_get0_geninfo_ITAVs
67 \&\- functions manipulating CMP message headers
68 .SH SYNOPSIS
69 .IX Header "SYNOPSIS"
70 .Vb 1
71 \& #include <openssl/cmp.h>
72 \&
73 \& ASN1_OCTET_STRING *OSSL_CMP_HDR_get0_transactionID(const
74 \& OSSL_CMP_PKIHEADER *hdr);
75 \& ASN1_OCTET_STRING *OSSL_CMP_HDR_get0_recipNonce(const
76 \& OSSL_CMP_PKIHEADER *hdr);
77 \& STACK_OF(OSSL_CMP_ITAV)
78 \& *OSSL_CMP_HDR_get0_geninfo_ITAVs(const OSSL_CMP_PKIHEADER *hdr);
79 .Ve
80 .SH DESCRIPTION
81 .IX Header "DESCRIPTION"
82 OSSL_CMP_HDR_get0_transactionID returns the transaction ID of the given
83 PKIHeader.
84 .PP
85 OSSL_CMP_HDR_get0_recipNonce returns the recipient nonce of the given PKIHeader.
86 .PP
87 \&\fBOSSL_CMP_HDR_get0_geninfo_ITAVs()\fR returns the list of ITAVs
88 in the generalInfo field of the given PKIHeader.
89 .SH NOTES
90 .IX Header "NOTES"
91 CMP is defined in RFC 9810.
92 .SH "RETURN VALUES"
93 .IX Header "RETURN VALUES"
94 The functions return the intended pointer value as described above
95 or NULL if the respective entry does not exist and on error.
96 .SH HISTORY
97 .IX Header "HISTORY"
98 The OpenSSL CMP support was added in OpenSSL 3.0.
99 .PP
100 \&\fBOSSL_CMP_HDR_get0_geninfo_ITAVs()\fR was added in OpenSSL 3.3.
101 .SH COPYRIGHT
102 .IX Header "COPYRIGHT"
103 Copyright 2007\-2019 The OpenSSL Project Authors. All Rights Reserved.
104 .PP
105 Licensed under the Apache License 2.0 (the "License"). You may not use
106 this file except in compliance with the License. You can obtain a copy
107 in the file LICENSE in the source distribution or at
108 <https://www.openssl.org/source/license.html>.