xref: /freebsd/crypto/openssl/doc/man3/OSSL_PARAM_dup.pod (revision ba3c1f5972d7b90feb6e6da47905ff2757e0fe57)
1=pod
2
3=head1 NAME
4
5OSSL_PARAM_dup, OSSL_PARAM_merge, OSSL_PARAM_free
6- OSSL_PARAM array copy functions
7
8=head1 SYNOPSIS
9
10 #include <openssl/params.h>
11
12 OSSL_PARAM *OSSL_PARAM_dup(const OSSL_PARAM *params);
13 OSSL_PARAM *OSSL_PARAM_merge(const OSSL_PARAM *params, const OSSL_PARAM *params1);
14 void OSSL_PARAM_free(OSSL_PARAM *params);
15
16=head1 DESCRIPTION
17
18Algorithm parameters can be exported/imported from/to providers using arrays of
19L<OSSL_PARAM(3)>. The following utility functions allow the parameters to be
20duplicated and merged with other L<OSSL_PARAM(3)> to assist in this process.
21
22OSSL_PARAM_dup() duplicates the parameter array I<params>. This function does a
23deep copy of the data.
24
25OSSL_PARAM_merge() merges the parameter arrays I<params> and I<params1> into a
26new parameter array. If I<params> and I<params1> contain values with the same
27'key' then the value from I<params1> will replace the I<param> value. This
28function does a shallow copy of the parameters. Either I<params> or I<params1>
29may be NULL. The behaviour of the merge is unpredictable if I<params> and
30I<params1> contain the same key, and there are multiple entries within either
31array that have the same key.
32
33OSSL_PARAM_free() frees the parameter array I<params> that was created using
34OSSL_PARAM_dup(), OSSL_PARAM_merge() or OSSL_PARAM_BLD_to_param().
35
36=head1 RETURN VALUES
37
38The functions OSSL_PARAM_dup() and OSSL_PARAM_merge() return a newly allocated
39L<OSSL_PARAM(3)> array, or NULL if there was an error. If both parameters are NULL
40 then NULL is returned.
41
42=head1 SEE ALSO
43
44L<OSSL_PARAM(3)>, L<OSSL_PARAM_BLD(3)>
45
46=head1 HISTORY
47
48The functions were added in OpenSSL 3.0.
49
50=head1 COPYRIGHT
51
52Copyright 2021 The OpenSSL Project Authors. All Rights Reserved.
53
54Licensed under the Apache License 2.0 (the "License").  You may not use
55this file except in compliance with the License.  You can obtain a copy
56in the file LICENSE in the source distribution or at
57L<https://www.openssl.org/source/license.html>.
58
59=cut
60