Debian Codegraph @

upstream/debian-unstable/man3/OSSL_PARAM_dup.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_PARAM_DUP 3SSL"
58 .TH OSSL_PARAM_DUP 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_PARAM_dup, OSSL_PARAM_merge, OSSL_PARAM_free
65 \&\- OSSL_PARAM array copy functions
66 .SH SYNOPSIS
67 .IX Header "SYNOPSIS"
68 .Vb 1
69 \& #include <openssl/params.h>
70 \&
71 \& OSSL_PARAM *OSSL_PARAM_dup(const OSSL_PARAM *params);
72 \& OSSL_PARAM *OSSL_PARAM_merge(const OSSL_PARAM *params, const OSSL_PARAM *params1);
73 \& void OSSL_PARAM_free(OSSL_PARAM *params);
74 .Ve
75 .SH DESCRIPTION
76 .IX Header "DESCRIPTION"
77 Algorithm parameters can be exported/imported from/to providers using arrays of
78 \&\fBOSSL_PARAM\fR\|(3). The following utility functions allow the parameters to be
79 duplicated and merged with other \fBOSSL_PARAM\fR\|(3) to assist in this process.
80 .PP
81 \&\fBOSSL_PARAM_dup()\fR duplicates the parameter array \fIparams\fR. This function does a
82 deep copy of the data.
83 .PP
84 \&\fBOSSL_PARAM_merge()\fR merges the parameter arrays \fIparams\fR and \fIparams1\fR into a
85 new parameter array. If \fIparams\fR and \fIparams1\fR contain values with the same
86 \&'key' then the value from \fIparams1\fR will replace the \fIparam\fR value. This
87 function does a shallow copy of the parameters. Either \fIparams\fR or \fIparams1\fR
88 may be NULL. The behaviour of the merge is unpredictable if \fIparams\fR and
89 \&\fIparams1\fR contain the same key, and there are multiple entries within either
90 array that have the same key.
91 .PP
92 \&\fBOSSL_PARAM_free()\fR frees the parameter array \fIparams\fR that was created using
93 \&\fBOSSL_PARAM_dup()\fR, \fBOSSL_PARAM_merge()\fR or \fBOSSL_PARAM_BLD_to_param()\fR.
94 If the argument to \fBOSSL_PARAM_free()\fR is NULL, nothing is done.
95 .SH "RETURN VALUES"
96 .IX Header "RETURN VALUES"
97 The functions \fBOSSL_PARAM_dup()\fR and \fBOSSL_PARAM_merge()\fR return a newly allocated
98 \&\fBOSSL_PARAM\fR\|(3) array, or NULL if there was an error. If both parameters are NULL
99 then NULL is returned.
100 .SH "SEE ALSO"
101 .IX Header "SEE ALSO"
102 \&\fBOSSL_PARAM\fR\|(3), \fBOSSL_PARAM_BLD\fR\|(3)
103 .SH HISTORY
104 .IX Header "HISTORY"
105 The functions were added in OpenSSL 3.0.
106 .SH COPYRIGHT
107 .IX Header "COPYRIGHT"
108 Copyright 2021\-2024 The OpenSSL Project Authors. All Rights Reserved.
109 .PP
110 Licensed under the Apache License 2.0 (the "License"). You may not use
111 this file except in compliance with the License. You can obtain a copy
112 in the file LICENSE in the source distribution or at
113 <https://www.openssl.org/source/license.html>.