include/crypto/sig.h

1 /* SPDX-License-Identifier: GPL-2.0-or-later */
3  * Public Key Signature Algorithm
13  * struct crypto_sig - user-instantiated objects which encapsulate
23  * DOC: Generic Public Key Signature API
25  * The Public Key Signature API is used with the algorithms of type
30  * crypto_alloc_sig() - allocate signature tfm handle
36  * Allocate a handle for public key signature algorithm. The returned struct
41  *	   of an error, PTR_ERR() returns the error code.
47 	return &tfm->base;  in crypto_sig_tfm()
51  * crypto_free_sig() - free signature tfm handle
63  * crypto_sig_maxsize() - Get len for output buffer
65  * Function returns the dest buffer size required for a given key.
66  * Function assumes that the key is already set in the transformation. If this
75  * crypto_sig_sign() - Invoke signing operation
85  * Return: zero on success; error code in case of error
92  * crypto_sig_verify() - Invoke signature verification
103  * Return: zero on verification success; error code in case of error.
110  * crypto_sig_set_pubkey() - Invoke set public key operation
112  * Function invokes the algorithm specific set key function, which knows
113  * how to decode and interpret the encoded key and parameters
116  * @key:	BER encoded public key, algo OID, paramlen, BER encoded
118  * @keylen:	length of the key (not including other data)
120  * Return: zero on success; error code in case of error
123 			  const void *key, unsigned int keylen);
126  * crypto_sig_set_privkey() - Invoke set private key operation
128  * Function invokes the algorithm specific set key function, which knows
129  * how to decode and interpret the encoded key and parameters
132  * @key:	BER encoded private key, algo OID, paramlen, BER encoded
134  * @keylen:	length of the key (not including other data)
136  * Return: zero on success; error code in case of error
139 			   const void *key, unsigned int keylen);