root
/
openssl
mirror of https://github.com/openssl/openssl.git
1
0
Fork 0
Code Issues Actions 7 Packages Projects Releases Wiki Activity
openssl/doc/man3/EVP_PKEY_settable_params.pod

84 lines
2.7 KiB
Plaintext
Raw Normal View History

Add functions to set values into an EVP_PKEY Reviewed-by: Matt Caswell <matt@openssl.org> Reviewed-by: Tomas Mraz <tomas@openssl.org> (Merged from https://github.com/openssl/openssl/pull/13139)
2020-10-15 11:39:02 +08:00
=pod
=head1 NAME
EVP_PKEY_settable_params, EVP_PKEY_set_params,
EVP_PKEY_set_int_param, EVP_PKEY_set_size_t_param, EVP_PKEY_set_bn_param,
EVP_PKEY_set_utf8_string_param, EVP_PKEY_set_octet_string_param
- set key parameters into a key
=head1 SYNOPSIS
#include <openssl/evp.h>
const OSSL_PARAM *EVP_PKEY_settable_params(EVP_PKEY *pkey);
int EVP_PKEY_set_params(EVP_PKEY *pkey, OSSL_PARAM params[]);
int EVP_PKEY_set_int_param(EVP_PKEY *pkey, const char *key_name, int in);
int EVP_PKEY_set_size_t_param(EVP_PKEY *pkey, const char *key_name, size_t in);
EVP: Adapt the other EVP_PKEY_set_xxx_param() functions They were calling evp_keymgmt_set_params() directly. Those calls are changed to go through EVP_PKEY_set_params(). We take the opportunity to constify these functions. They have to unconstify internally for the compiler to stop complaining when placing those pointers in an OSSL_PARAM element, but that's still better than forcing the callers to do that cast. Reviewed-by: Paul Dale <pauli@openssl.org> (Merged from https://github.com/openssl/openssl/pull/14056)
2021-02-03 20:55:30 +08:00
int EVP_PKEY_set_bn_param(EVP_PKEY *pkey, const char *key_name,
const BIGNUM *bn);
Add functions to set values into an EVP_PKEY Reviewed-by: Matt Caswell <matt@openssl.org> Reviewed-by: Tomas Mraz <tomas@openssl.org> (Merged from https://github.com/openssl/openssl/pull/13139)
2020-10-15 11:39:02 +08:00
int EVP_PKEY_set_utf8_string_param(EVP_PKEY *pkey, const char *key_name,
EVP: Adapt the other EVP_PKEY_set_xxx_param() functions They were calling evp_keymgmt_set_params() directly. Those calls are changed to go through EVP_PKEY_set_params(). We take the opportunity to constify these functions. They have to unconstify internally for the compiler to stop complaining when placing those pointers in an OSSL_PARAM element, but that's still better than forcing the callers to do that cast. Reviewed-by: Paul Dale <pauli@openssl.org> (Merged from https://github.com/openssl/openssl/pull/14056)
2021-02-03 20:55:30 +08:00
const char *str);
Add functions to set values into an EVP_PKEY Reviewed-by: Matt Caswell <matt@openssl.org> Reviewed-by: Tomas Mraz <tomas@openssl.org> (Merged from https://github.com/openssl/openssl/pull/13139)
2020-10-15 11:39:02 +08:00
int EVP_PKEY_set_octet_string_param(EVP_PKEY *pkey, const char *key_name,
EVP: Adapt the other EVP_PKEY_set_xxx_param() functions They were calling evp_keymgmt_set_params() directly. Those calls are changed to go through EVP_PKEY_set_params(). We take the opportunity to constify these functions. They have to unconstify internally for the compiler to stop complaining when placing those pointers in an OSSL_PARAM element, but that's still better than forcing the callers to do that cast. Reviewed-by: Paul Dale <pauli@openssl.org> (Merged from https://github.com/openssl/openssl/pull/14056)
2021-02-03 20:55:30 +08:00
const unsigned char *buf, size_t bsize);
Add functions to set values into an EVP_PKEY Reviewed-by: Matt Caswell <matt@openssl.org> Reviewed-by: Tomas Mraz <tomas@openssl.org> (Merged from https://github.com/openssl/openssl/pull/13139)
2020-10-15 11:39:02 +08:00
=head1 DESCRIPTION
These functions can be used to set additional parameters into an existing
B<EVP_PKEY>.
EVP_PKEY_set_params() sets one or more I<params> into a I<pkey>.
See L<OSSL_PARAM(3)> for information about parameters.
EVP_PKEY_settable_params() returns a constant list of I<params> indicating
the names and types of key parameters that can be set.
See L<OSSL_PARAM(3)> for information about parameters.
EVP_PKEY_set_int_param() sets an integer value I<in> into a key I<pkey> for the
associated field I<key_name>.
EVP_PKEY_set_size_t_param() sets an size_t value I<in> into a key I<pkey> for
the associated field I<key_name>.
EVP_PKEY_set_bn_param() sets the BIGNUM value I<bn> into a key I<pkey> for the
associated field I<key_name>.
EVP_PKEY_set_utf8_string_param() sets the UTF8 string I<str> into a key I<pkey>
for the associated field I<key_name>.
EVP_PKEY_set_octet_string_param() sets the octet string value I<buf> with a
size I<bsize> into a key I<pkey> for the associated field I<key_name>.
=head1 NOTES
These functions only work for B<EVP_PKEY>s that contain a provider side key.
=head1 RETURN VALUES
EVP_PKEY_settable_params() returns NULL on error or if it is not supported,
All other methods return 1 if a value was successfully set, or 0 if
there was an error.
=head1 SEE ALSO
L<EVP_PKEY_gettable_params(3)>,
L<EVP_PKEY_CTX_new(3)>, L<provider-keymgmt(7)>, L<OSSL_PARAM(3)>,
=head1 HISTORY
These functions were added in OpenSSL 3.0.
=head1 COPYRIGHT
Update copyright year Reviewed-by: Tomas Mraz <tomas@openssl.org> (Merged from https://github.com/openssl/openssl/pull/13999)
2021-01-28 20:54:57 +08:00
Copyright 2020-2021 The OpenSSL Project Authors. All Rights Reserved.
Add functions to set values into an EVP_PKEY Reviewed-by: Matt Caswell <matt@openssl.org> Reviewed-by: Tomas Mraz <tomas@openssl.org> (Merged from https://github.com/openssl/openssl/pull/13139)
2020-10-15 11:39:02 +08:00
Licensed under the Apache License 2.0 (the "License"). You may not use
this file except in compliance with the License. You can obtain a copy
in the file LICENSE in the source distribution or at
L<https://www.openssl.org/source/license.html>.
=cut