1EVP_PKEY_SETTABLE_PARAMS(3ossl)     OpenSSL    EVP_PKEY_SETTABLE_PARAMS(3ossl)
2
3
4

NAME

6       EVP_PKEY_settable_params, EVP_PKEY_set_params, EVP_PKEY_set_int_param,
7       EVP_PKEY_set_size_t_param, EVP_PKEY_set_bn_param,
8       EVP_PKEY_set_utf8_string_param, EVP_PKEY_set_octet_string_param - set
9       key parameters into a key
10

SYNOPSIS

12        #include <openssl/evp.h>
13
14        const OSSL_PARAM *EVP_PKEY_settable_params(const EVP_PKEY *pkey);
15        int EVP_PKEY_set_params(EVP_PKEY *pkey, OSSL_PARAM params[]);
16        int EVP_PKEY_set_int_param(EVP_PKEY *pkey, const char *key_name, int in);
17        int EVP_PKEY_set_size_t_param(EVP_PKEY *pkey, const char *key_name, size_t in);
18        int EVP_PKEY_set_bn_param(EVP_PKEY *pkey, const char *key_name,
19                                  const BIGNUM *bn);
20        int EVP_PKEY_set_utf8_string_param(EVP_PKEY *pkey, const char *key_name,
21                                           const char *str);
22        int EVP_PKEY_set_octet_string_param(EVP_PKEY *pkey, const char *key_name,
23                                            const unsigned char *buf, size_t bsize);
24

DESCRIPTION

26       These functions can be used to set additional parameters into an
27       existing EVP_PKEY.
28
29       EVP_PKEY_set_params() sets one or more params into a pkey.  See
30       OSSL_PARAM(3) for information about parameters.
31
32       EVP_PKEY_settable_params() returns a constant list of params indicating
33       the names and types of key parameters that can be set.  See
34       OSSL_PARAM(3) for information about parameters.
35
36       EVP_PKEY_set_int_param() sets an integer value in into a key pkey for
37       the associated field key_name.
38
39       EVP_PKEY_set_size_t_param() sets an size_t value in into a key pkey for
40       the associated field key_name.
41
42       EVP_PKEY_set_bn_param() sets the BIGNUM value bn into a key pkey for
43       the associated field key_name.
44
45       EVP_PKEY_set_utf8_string_param() sets the UTF8 string str into a key
46       pkey for the associated field key_name.
47
48       EVP_PKEY_set_octet_string_param() sets the octet string value buf with
49       a size bsize into a key pkey for the associated field key_name.
50

NOTES

52       These functions only work for EVP_PKEYs that contain a provider side
53       key.
54

RETURN VALUES

56       EVP_PKEY_settable_params() returns NULL on error or if it is not
57       supported,
58
59       All other methods return 1 if a value was successfully set, or 0 if
60       there was an error.
61

SEE ALSO

63       EVP_PKEY_gettable_params(3), EVP_PKEY_CTX_new(3), provider-keymgmt(7),
64       OSSL_PARAM(3),
65

HISTORY

67       These functions were added in OpenSSL 3.0.
68

70       Copyright 2020-2021 The OpenSSL Project Authors. All Rights Reserved.
71
72       Licensed under the Apache License 2.0 (the "License").  You may not use
73       this file except in compliance with the License.  You can obtain a copy
74       in the file LICENSE in the source distribution or at
75       <https://www.openssl.org/source/license.html>.
76
77
78
793.1.1                             2023-08-31   EVP_PKEY_SETTABLE_PARAMS(3ossl)
Impressum