provider-signature - The signature library <-> provider functions
#include <openssl/core_numbers.h>
#include <openssl/core_names.h>
/*
* None of these are actual functions, but are displayed like this for
* the function signatures for functions that are offered as function
* pointers in OSSL_DISPATCH arrays.
*/
/* Context management */
void *OP_signature_newctx(void *provctx);
void OP_signature_freectx(void *ctx);
void *OP_signature_dupctx(void *ctx);
/* Signing */
int OP_signature_sign_init(void *ctx, void *provkey);
int OP_signature_sign(void *ctx, unsigned char *sig, size_t *siglen,
size_t sigsize, const unsigned char *tbs, size_t tbslen);
/* Verifying */
int OP_signature_verify_init(void *ctx, void *provkey);
int OP_signature_verify(void *ctx, const unsigned char *sig, size_t siglen,
const unsigned char *tbs, size_t tbslen);
/* Verify Recover */
int OP_signature_verify_recover_init(void *ctx, void *provkey);
int OP_signature_verify_recover(void *ctx, unsigned char *rout,
size_t *routlen, size_t routsize,
const unsigned char *sig, size_t siglen);
/* Digest Sign */
int OP_signature_digest_sign_init(void *ctx, const char *mdname,
const char *props, void *provkey);
int OP_signature_digest_sign_update(void *ctx, const unsigned char *data,
size_t datalen);
int OP_signature_digest_sign_final(void *ctx, unsigned char *sig,
size_t *siglen, size_t sigsize);
int OP_signature_digest_sign(void *ctx, unsigned char *sigret, size_t *siglen,
size_t sigsize, const unsigned char *tbs,
size_t tbslen);
/* Digest Verify */
int OP_signature_digest_verify_init(void *ctx, const char *mdname,
const char *props, void *provkey);
int OP_signature_digest_verify_update(void *ctx, const unsigned char *data,
size_t datalen);
int OP_signature_digest_verify_final(void *ctx, const unsigned char *sig,
size_t siglen);
int OP_signature_digest_verify(void *ctx, const unsigned char *sig,
size_t siglen, const unsigned char *tbs,
size_t tbslen);
/* Signature parameters */
int OP_signature_get_ctx_params(void *ctx, OSSL_PARAM params[]);
const OSSL_PARAM *OP_signature_gettable_ctx_params(void);
int OP_signature_set_ctx_params(void *ctx, const OSSL_PARAM params[]);
const OSSL_PARAM *OP_signature_settable_ctx_params(void);
/* MD parameters */
int OP_signature_get_ctx_md_params(void *ctx, OSSL_PARAM params[]);
const OSSL_PARAM * OP_signature_gettable_ctx_md_params(void *ctx);
int OP_signature_set_ctx_md_params(void *ctx, const OSSL_PARAM params[]);
const OSSL_PARAM * OP_signature_settable_ctx_md_params(void *ctx);This documentation is primarily aimed at provider authors. See EVP_PKEY_sign(3), EVP_PKEY_verify_recover(3) (as well as other related functions).
All "functions" mentioned here are passed as function pointers between libcrypto and the provider in OSSL_DISPATCH arrays via OSSL_ALGORITHM arrays that are returned by the provider's provider_query_operation() function (see openssl-core_numbers.h(7), as follows:
OP_signature_newctx OSSL_FUNC_SIGNATURE_NEWCTX
OP_signature_freectx OSSL_FUNC_SIGNATURE_FREECTX
OP_signature_dupctx OSSL_FUNC_SIGNATURE_DUPCTX
OP_signature_sign_init OSSL_FUNC_SIGNATURE_SIGN_INIT
OP_signature_sign OSSL_FUNC_SIGNATURE_SIGN
OP_signature_verify_init OSSL_FUNC_SIGNATURE_VERIFY_INIT
OP_signature_verify OSSL_FUNC_SIGNATURE_VERIFY
OP_signature_verify_recover_init OSSL_FUNC_SIGNATURE_VERIFY_RECOVER_INIT
OP_signature_verify_recover OSSL_FUNC_SIGNATURE_VERIFY_RECOVER
OP_signature_digest_sign_init OSSL_FUNC_SIGNATURE_DIGEST_SIGN_INIT
OP_signature_digest_sign_update OSSL_FUNC_SIGNATURE_DIGEST_SIGN_UPDATE
OP_signature_digest_sign_final OSSL_FUNC_SIGNATURE_DIGEST_SIGN_FINAL
OP_signature_digest_sign OSSL_FUNC_SIGNATURE_DIGEST_SIGN
OP_signature_digest_verify_init OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_INIT
OP_signature_digest_verify_update OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_UPDATE
OP_signature_digest_verify_final OSSL_FUNC_SIGNATURE_DIGEST_VERIFY_FINAL
OP_signature_digest_verify OSSL_FUNC_SIGNATURE_DIGEST_VERIFY
OP_signature_get_ctx_params OSSL_FUNC_SIGNATURE_GET_CTX_PARAMS
OP_signature_gettable_ctx_params OSSL_FUNC_SIGNATURE_GETTABLE_CTX_PARAMS
OP_signature_set_ctx_params OSSL_FUNC_SIGNATURE_SET_CTX_PARAMS
OP_signature_settable_ctx_params OSSL_FUNC_SIGNATURE_SETTABLE_CTX_PARAMS
OP_signature_get_ctx_md_params OSSL_FUNC_SIGNATURE_GET_CTX_MD_PARAMS
OP_signature_gettable_ctx_md_params OSSL_FUNC_SIGNATURE_GETTABLE_CTX_MD_PARAMS
OP_signature_set_ctx_md_params OSSL_FUNC_SIGNATURE_SET_CTX_MD_PARAMS
OP_signature_settable_ctx_md_params OSSL_FUNC_SIGNATURE_SETTABLE_CTX_MD_PARAMSA signature algorithm implementation may not implement all of these functions. In order to be a consistent set of functions we must have at least a set of context functions (OP_signature_newctx and OP_signature_freectx) as well as a set of "signature" functions, i.e. at least one of:
OP_signature_set_ctx_params and OP_signature_settable_ctx_params are optional, but if one of them is present then the other one must also be present. The same applies to OP_signature_get_ctx_params and OP_signature_gettable_ctx_params, as well as the "md_params" functions. The OP_signature_dupctx function is optional.
A signature algorithm must also implement some mechanism for generating, loading or importing keys via the key management (OSSL_OP_KEYMGMT) operation. See Context Management Functions
OP_signature_newctx() should create and return a pointer to a provider side structure for holding context information during a signature operation. A pointer to this context will be passed back in a number of the other signature operation function calls. The parameter provctx is the provider context generated during provider initialisation (see Signing Functions
OP_signature_sign_init() initialises a context for signing given a provider side signature context in the ctx parameter, and a pointer to a provider key object in the provkey parameter. The key object should have been previously generated, loaded or imported into the provider using the key management (OSSL_OP_KEYMGMT) operation (see provider-keymgmt(7)>. OP_signature_sign() performs the actual signing itself. A previously initialised signature context is passed in the ctx parameter. The data to be signed is pointed to be the tbs parameter which is tbslen bytes long. Unless sig is NULL, the signature should be written to the location pointed to by the sig parameter and it should not exceed sigsize bytes in length. The length of the signature should be written to *siglen. If sig is NULL then the maximum length of the signature should be written to *siglen. OP_signature_verify_init() initialises a context for verifying a signature given a provider side signature context in the ctx parameter, and a pointer to a provider key object in the provkey parameter. The key object should have been previously generated, loaded or imported into the provider using the key management (OSSL_OP_KEYMGMT) operation (see provider-keymgmt(7)>. OP_signature_verify() performs the actual verification itself. A previously initialised signature context is passed in the ctx parameter. The data that the signature covers is pointed to be the tbs parameter which is tbslen bytes long. The signature is pointed to by the sig parameter which is siglen bytes long. OP_signature_verify_recover_init() initialises a context for recovering the signed data given a provider side signature context in the ctx parameter, and a pointer to a provider key object in the provkey parameter. The key object should have been previously generated, loaded or imported into the provider using the key management (OSSL_OP_KEYMGMT) operation (see provider-keymgmt(7)>. OP_signature_verify_recover() performs the actual verify recover itself. A previously initialised signature context is passed in the ctx parameter. The signature is pointed to by the sig parameter which is siglen bytes long. Unless rout is NULL, the recovered data should be written to the location pointed to by rout which should not exceed routsize bytes in length. The length of the recovered data should be written to *routlen. If rout is NULL then the maximum size of the output buffer is written to the routlen parameter. OP_signature_digeset_sign_init() initialises a context for signing given a provider side signature context in the ctx parameter, and a pointer to a provider key object in the provkey parameter. The key object should have been previously generated, loaded or imported into the provider using the key management (OSSL_OP_KEYMGMT) operation (see provider-keymgmt(7)>. The name of the digest to be used will be in the mdname parameter. There may also be properties to be used in fetching the digest in the props parameter, although this may be ignored by providers. OP_signature_digest_sign_update() provides data to be signed in the data parameter which should be of length datalen. A previously initialised signature context is passed in the ctx parameter. This function may be called multiple times to cummulatively add data to be signed. OP_signature_digest_sign_final() finalises a signature operation previously started through OP_signature_digest_sign_init() and OP_signature_digest_sign_update() calls. Once finalised no more data will be added through OP_signature_digest_sign_update(). A previously initialised signature context is passed in the ctx parameter. Unless sig is NULL, the signature should be written to the location pointed to by the sig parameter and it should not exceed sigsize bytes in length. The length of the signature should be written to *siglen. If sig is NULL then the maximum length of the signature should be written to *siglen. OP_signature_digest_sign() implements a "one shot" digest sign operation previously started through OP_signature_digeset_sign_init(). A previously initialised signature context is passed in the ctx parameter. The data to be signed is in tbs which should be tbslen bytes long. Unless sig is NULL, the signature should be written to the location pointed to by the sig parameter and it should not exceed sigsize bytes in length. The length of the signature should be written to *siglen. If sig is NULL then the maximum length of the signature should be written to *siglen. OP_signature_digeset_verify_init() initialises a context for verifying given a provider side verification context in the ctx parameter, and a pointer to a provider key object in the provkey parameter. The key object should have been previously generated, loaded or imported into the provider using the key management (OSSL_OP_KEYMGMT) operation (see provider-keymgmt(7)>. The name of the digest to be used will be in the mdname parameter. There may also be properties to be used in fetching the digest in the props parameter, although this may be ignored by providers. OP_signature_digest_verify_update() provides data to be verified in the data parameter which should be of length datalen. A previously initialised verification context is passed in the ctx parameter. This function may be called multiple times to cummulatively add data to be verified. OP_signature_digest_verify_final() finalises a verification operation previously started through OP_signature_digest_verify_init() and OP_signature_digest_verify_update() calls. Once finalised no more data will be added through OP_signature_digest_verify_update(). A previously initialised verification context is passed in the ctx parameter. The signature to be verified is in sig which is siglen bytes long. OP_signature_digest_verify() implements a "one shot" digest verify operation previously started through OP_signature_digeset_verify_init(). A previously initialised verification context is passed in the ctx parameter. The data to be verified is in tbs which should be tbslen bytes long. The signature to be verified is in sig which is siglen bytes long. See "digest" (OSSL_SIGNATURE_PARAM_DIGEST) <UTF8 string>
Get or sets the name of the digest algorithm used for the input to the signature functions. Gets or sets the output size of the digest algorithm used for the input to the signature functions. The length of the "digest-size" parameter should not exceed that of a size_t. = item "algorithm-id" (OSSL_SIGNATURE_PARAM_ALGORITHM_ID) <octet string> Gets the DER encoded AlgorithmIdentifier that corresponds to the combination of signature algorithm and digest algorithm for the signature operation. Sets a flag to modify the sign operation to return an error if the initial calculated signature is invalid. In the normal mode of operation - new random values are chosen until the signature operation succeeds. By default it retries until a signature is calculated. Setting the value to 0 causes the sign operation to retry, otherwise the sign operation is only tried once and returns whether or not it was successful. Known answer tests can be performed if the random generator is overriden to supply known values that either pass or fail. OP_signature_gettable_ctx_params() and OP_signature_settable_ctx_params() get a constant OSSL_PARAM array that describes the gettable and settable parameters, i.e. parameters that can be used with OP_signature_get_ctx_params() and OP_signature_set_ctx_params() respectively. See MD Parameters
See "Digest Parameters" in provider-digest(7) for further information. OP_signature_gettable_md_ctx_params() and OP_signature_settable_md_ctx_params() get a constant OSSL_PARAM array that describes the gettable and settable digest parameters, i.e. parameters that can be used with OP_signature_get_md_ctx_params() and OP_signature_set_md_ctx_params() respectively. See RETURN VALUES
OP_signature_newctx() and OP_signature_dupctx() should return the newly created provider side signature, or NULL on failure. OP_signature_gettable_ctx_params(), OP_signature_settable_ctx_params(), OP_signature_gettable_md_ctx_params() and OP_signature_settable_md_ctx_params(), return the gettable or settable parameters in a constant OSSL_PARAM array. All other functions should return 1 for success or 0 on error. HISTORY
The provider SIGNATURE interface was introduced in OpenSSL 3.0. Copyright 2019-2020 The OpenSSL Project Authors. All Rights Reserved. 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 https://www.openssl.org/source/license.html.Verify Functions
Verify Recover Functions
Digest Sign Functions
Digest Verify Functions
Signature Parameters
SEE ALSO
COPYRIGHT