Skip to content

Commit 6191cc9

Browse files
davidbenagl
authored andcommitted
Document that SSL_PRIVATE_KEY_METHOD should configure signing prefs.
Otherwise BoringSSL may select one the private key does not support. Change-Id: Ia0a57657bd6dedaa6653c23cc850bb6b6fa8f219 Reviewed-on: https://boringssl-review.googlesource.com/c/boringssl/+/48525 Reviewed-by: Adam Langley <[email protected]>
1 parent 519c298 commit 6191cc9

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

include/openssl/ssl.h

+5
Original file line numberDiff line numberDiff line change
@@ -1219,6 +1219,11 @@ enum ssl_private_key_result_t BORINGSSL_ENUM_INT {
12191219
// key hooks. This is used to off-load signing operations to a custom,
12201220
// potentially asynchronous, backend. Metadata about the key such as the type
12211221
// and size are parsed out of the certificate.
1222+
//
1223+
// Callers that use this structure should additionally call
1224+
// |SSL_set_signing_algorithm_prefs| or |SSL_CTX_set_signing_algorithm_prefs|
1225+
// with the private key's capabilities. This ensures BoringSSL will select a
1226+
// suitable signature algorithm for the private key.
12221227
struct ssl_private_key_method_st {
12231228
// sign signs the message |in| in using the specified signature algorithm. On
12241229
// success, it returns |ssl_private_key_success| and writes at most |max_out|

0 commit comments

Comments
 (0)