Debian Codegraph @

upstream/debian-unstable/man3/EVP_CIPHER_CTX_get_original_iv.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 "EVP_CIPHER_CTX_GET_ORIGINAL_IV 3SSL"
58 .TH EVP_CIPHER_CTX_GET_ORIGINAL_IV 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 EVP_CIPHER_CTX_get_original_iv, EVP_CIPHER_CTX_get_updated_iv,
65 EVP_CIPHER_CTX_iv, EVP_CIPHER_CTX_original_iv,
66 EVP_CIPHER_CTX_iv_noconst \- Routines to inspect EVP_CIPHER_CTX IV data
67 .SH SYNOPSIS
68 .IX Header "SYNOPSIS"
69 .Vb 1
70 \& #include <openssl/evp.h>
71 \&
72 \& int EVP_CIPHER_CTX_get_original_iv(EVP_CIPHER_CTX *ctx, void *buf, size_t len);
73 \& int EVP_CIPHER_CTX_get_updated_iv(EVP_CIPHER_CTX *ctx, void *buf, size_t len);
74 .Ve
75 .PP
76 The following functions have been deprecated since OpenSSL 3.0, and can be
77 hidden entirely by defining \fBOPENSSL_API_COMPAT\fR with a suitable version value,
78 see \fBopenssl_user_macros\fR\|(7):
79 .PP
80 .Vb 3
81 \& const unsigned char *EVP_CIPHER_CTX_iv(const EVP_CIPHER_CTX *ctx);
82 \& const unsigned char *EVP_CIPHER_CTX_original_iv(const EVP_CIPHER_CTX *ctx);
83 \& unsigned char *EVP_CIPHER_CTX_iv_noconst(EVP_CIPHER_CTX *ctx);
84 .Ve
85 .SH DESCRIPTION
86 .IX Header "DESCRIPTION"
87 \&\fBEVP_CIPHER_CTX_get_original_iv()\fR and \fBEVP_CIPHER_CTX_get_updated_iv()\fR copy
88 initialization vector (IV) information from the \fBEVP_CIPHER_CTX\fR into the
89 caller-supplied buffer. \fBEVP_CIPHER_CTX_get_iv_length\fR\|(3) can be used to
90 determine an appropriate buffer size, and if the supplied buffer is too small,
91 an error will be returned (and no data copied).
92 \&\fBEVP_CIPHER_CTX_get_original_iv()\fR accesses the ("original") IV that was
93 supplied when the \fBEVP_CIPHER_CTX\fR was initialized, and
94 \&\fBEVP_CIPHER_CTX_get_updated_iv()\fR accesses the current "IV state"
95 of the cipher, which is updated during cipher operation for certain cipher modes
96 (e.g., CBC and OFB).
97 .PP
98 The functions \fBEVP_CIPHER_CTX_iv()\fR, \fBEVP_CIPHER_CTX_original_iv()\fR, and
99 \&\fBEVP_CIPHER_CTX_iv_noconst()\fR are deprecated functions that provide similar (at
100 a conceptual level) functionality. \fBEVP_CIPHER_CTX_iv()\fR returns a pointer to
101 the beginning of the "IV state" as maintained internally in the
102 \&\fBEVP_CIPHER_CTX\fR; \fBEVP_CIPHER_CTX_original_iv()\fR returns a pointer to the
103 beginning of the ("original") IV, as maintained by the \fBEVP_CIPHER_CTX\fR, that
104 was provided when the \fBEVP_CIPHER_CTX\fR was initialized; and
105 \&\fBEVP_CIPHER_CTX_get_iv_noconst()\fR is the same as \fBEVP_CIPHER_CTX_iv()\fR but has a
106 different return type for the pointer.
107 .SH "RETURN VALUES"
108 .IX Header "RETURN VALUES"
109 \&\fBEVP_CIPHER_CTX_get_original_iv()\fR and \fBEVP_CIPHER_CTX_get_updated_iv()\fR return 1
110 on success and 0 on failure.
111 .PP
112 The functions \fBEVP_CIPHER_CTX_iv()\fR, \fBEVP_CIPHER_CTX_original_iv()\fR, and
113 \&\fBEVP_CIPHER_CTX_iv_noconst()\fR return a pointer to an IV as an array of bytes on
114 success, and NULL on failure.
115 .SH HISTORY
116 .IX Header "HISTORY"
117 \&\fBEVP_CIPHER_CTX_get_original_iv()\fR and \fBEVP_CIPHER_CTX_get_updated_iv()\fR were added
118 in OpenSSL 3.0.0.
119 .PP
120 \&\fBEVP_CIPHER_CTX_iv()\fR, \fBEVP_CIPHER_CTX_original_iv()\fR, and
121 \&\fBEVP_CIPHER_CTX_iv_noconst()\fR were added in OpenSSL 1.1.0, and were deprecated
122 in OpenSSL 3.0.0.
123 .SH COPYRIGHT
124 .IX Header "COPYRIGHT"
125 Copyright 2020\-2021 The OpenSSL Project Authors. All Rights Reserved.
126 .PP
127 Licensed under the Apache License 2.0 (the "License"). You may not use
128 this file except in compliance with the License. You can obtain a copy
129 in the file LICENSE in the source distribution or at
130 <https://www.openssl.org/source/license.html>.