mirror of https://github.com/ipxe/ipxe.git
345 lines
10 KiB
C
345 lines
10 KiB
C
#ifndef _IPXE_CRYPTO_H
|
|
#define _IPXE_CRYPTO_H
|
|
|
|
/** @file
|
|
*
|
|
* Cryptographic API
|
|
*
|
|
*/
|
|
|
|
FILE_LICENCE ( GPL2_OR_LATER_OR_UBDL );
|
|
|
|
#include <stdint.h>
|
|
#include <stddef.h>
|
|
#include <assert.h>
|
|
#include <ipxe/asn1.h>
|
|
|
|
/** A message digest algorithm */
|
|
struct digest_algorithm {
|
|
/** Algorithm name */
|
|
const char *name;
|
|
/** Context size */
|
|
size_t ctxsize;
|
|
/** Block size */
|
|
size_t blocksize;
|
|
/** Digest size */
|
|
size_t digestsize;
|
|
/** Initialise digest
|
|
*
|
|
* @v ctx Context
|
|
*/
|
|
void ( * init ) ( void *ctx );
|
|
/** Update digest with new data
|
|
*
|
|
* @v ctx Context
|
|
* @v src Data to digest
|
|
* @v len Length of data
|
|
*
|
|
* @v len is not necessarily a multiple of @c blocksize.
|
|
*/
|
|
void ( * update ) ( void *ctx, const void *src, size_t len );
|
|
/** Finalise digest
|
|
*
|
|
* @v ctx Context
|
|
* @v out Buffer for digest output
|
|
*/
|
|
void ( * final ) ( void *ctx, void *out );
|
|
};
|
|
|
|
/** A cipher algorithm */
|
|
struct cipher_algorithm {
|
|
/** Algorithm name */
|
|
const char *name;
|
|
/** Context size */
|
|
size_t ctxsize;
|
|
/** Block size
|
|
*
|
|
* Every call to encrypt() or decrypt() must be for a multiple
|
|
* of this size.
|
|
*/
|
|
size_t blocksize;
|
|
/** Alignment size
|
|
*
|
|
* Every call to encrypt() or decrypt() must begin at a
|
|
* multiple of this offset from the start of the stream.
|
|
* (Equivalently: all but the last call to encrypt() or
|
|
* decrypt() must be for a multiple of this size.)
|
|
*
|
|
* For ciphers supporting additional data, the main data
|
|
* stream and additional data stream are both considered to
|
|
* begin at offset zero.
|
|
*/
|
|
size_t alignsize;
|
|
/** Authentication tag size */
|
|
size_t authsize;
|
|
/** Set key
|
|
*
|
|
* @v ctx Context
|
|
* @v key Key
|
|
* @v keylen Key length
|
|
* @ret rc Return status code
|
|
*/
|
|
int ( * setkey ) ( void *ctx, const void *key, size_t keylen );
|
|
/** Set initialisation vector
|
|
*
|
|
* @v ctx Context
|
|
* @v iv Initialisation vector
|
|
* @v ivlen Initialisation vector length
|
|
*/
|
|
void ( * setiv ) ( void *ctx, const void *iv, size_t ivlen );
|
|
/** Encrypt data
|
|
*
|
|
* @v ctx Context
|
|
* @v src Data to encrypt
|
|
* @v dst Buffer for encrypted data, or NULL for additional data
|
|
* @v len Length of data
|
|
*
|
|
* @v len is guaranteed to be a multiple of @c blocksize.
|
|
*/
|
|
void ( * encrypt ) ( void *ctx, const void *src, void *dst,
|
|
size_t len );
|
|
/** Decrypt data
|
|
*
|
|
* @v ctx Context
|
|
* @v src Data to decrypt
|
|
* @v dst Buffer for decrypted data, or NULL for additional data
|
|
* @v len Length of data
|
|
*
|
|
* @v len is guaranteed to be a multiple of @c blocksize.
|
|
*/
|
|
void ( * decrypt ) ( void *ctx, const void *src, void *dst,
|
|
size_t len );
|
|
/** Generate authentication tag
|
|
*
|
|
* @v ctx Context
|
|
* @v auth Authentication tag
|
|
*/
|
|
void ( * auth ) ( void *ctx, void *auth );
|
|
};
|
|
|
|
/** A public key algorithm */
|
|
struct pubkey_algorithm {
|
|
/** Algorithm name */
|
|
const char *name;
|
|
/** Calculate maximum output length
|
|
*
|
|
* @v key Key
|
|
* @ret max_len Maximum output length
|
|
*/
|
|
size_t ( * max_len ) ( const struct asn1_cursor *key );
|
|
/** Encrypt
|
|
*
|
|
* @v key Key
|
|
* @v plaintext Plaintext
|
|
* @v plaintext_len Length of plaintext
|
|
* @v ciphertext Ciphertext
|
|
* @ret ciphertext_len Length of ciphertext, or negative error
|
|
*/
|
|
int ( * encrypt ) ( const struct asn1_cursor *key, const void *data,
|
|
size_t len, void *out );
|
|
/** Decrypt
|
|
*
|
|
* @v key Key
|
|
* @v ciphertext Ciphertext
|
|
* @v ciphertext_len Ciphertext length
|
|
* @v plaintext Plaintext
|
|
* @ret plaintext_len Plaintext length, or negative error
|
|
*/
|
|
int ( * decrypt ) ( const struct asn1_cursor *key, const void *data,
|
|
size_t len, void *out );
|
|
/** Sign digest value
|
|
*
|
|
* @v key Key
|
|
* @v digest Digest algorithm
|
|
* @v value Digest value
|
|
* @v signature Signature
|
|
* @ret signature_len Signature length, or negative error
|
|
*/
|
|
int ( * sign ) ( const struct asn1_cursor *key,
|
|
struct digest_algorithm *digest, const void *value,
|
|
void *signature );
|
|
/** Verify signed digest value
|
|
*
|
|
* @v key Key
|
|
* @v digest Digest algorithm
|
|
* @v value Digest value
|
|
* @v signature Signature
|
|
* @v signature_len Signature length
|
|
* @ret rc Return status code
|
|
*/
|
|
int ( * verify ) ( const struct asn1_cursor *key,
|
|
struct digest_algorithm *digest, const void *value,
|
|
const void *signature, size_t signature_len );
|
|
/** Check that public key matches private key
|
|
*
|
|
* @v private_key Private key
|
|
* @v public_key Public key
|
|
* @ret rc Return status code
|
|
*/
|
|
int ( * match ) ( const struct asn1_cursor *private_key,
|
|
const struct asn1_cursor *public_key );
|
|
};
|
|
|
|
/** An elliptic curve */
|
|
struct elliptic_curve {
|
|
/** Curve name */
|
|
const char *name;
|
|
/** Key size */
|
|
size_t keysize;
|
|
/** Multiply scalar by curve point
|
|
*
|
|
* @v base Base point (or NULL to use generator)
|
|
* @v scalar Scalar multiple
|
|
* @v result Result point to fill in
|
|
* @ret rc Return status code
|
|
*/
|
|
int ( * multiply ) ( const void *base, const void *scalar,
|
|
void *result );
|
|
};
|
|
|
|
static inline __attribute__ (( always_inline )) void
|
|
digest_init ( struct digest_algorithm *digest, void *ctx ) {
|
|
digest->init ( ctx );
|
|
}
|
|
|
|
static inline __attribute__ (( always_inline )) void
|
|
digest_update ( struct digest_algorithm *digest, void *ctx,
|
|
const void *data, size_t len ) {
|
|
digest->update ( ctx, data, len );
|
|
}
|
|
|
|
static inline __attribute__ (( always_inline )) void
|
|
digest_final ( struct digest_algorithm *digest, void *ctx, void *out ) {
|
|
digest->final ( ctx, out );
|
|
}
|
|
|
|
static inline __attribute__ (( always_inline )) int
|
|
cipher_setkey ( struct cipher_algorithm *cipher, void *ctx,
|
|
const void *key, size_t keylen ) {
|
|
return cipher->setkey ( ctx, key, keylen );
|
|
}
|
|
|
|
static inline __attribute__ (( always_inline )) void
|
|
cipher_setiv ( struct cipher_algorithm *cipher, void *ctx,
|
|
const void *iv, size_t ivlen ) {
|
|
cipher->setiv ( ctx, iv, ivlen );
|
|
}
|
|
|
|
static inline __attribute__ (( always_inline )) void
|
|
cipher_encrypt ( struct cipher_algorithm *cipher, void *ctx,
|
|
const void *src, void *dst, size_t len ) {
|
|
cipher->encrypt ( ctx, src, dst, len );
|
|
}
|
|
#define cipher_encrypt( cipher, ctx, src, dst, len ) do { \
|
|
assert ( ( (len) & ( (cipher)->blocksize - 1 ) ) == 0 ); \
|
|
cipher_encrypt ( (cipher), (ctx), (src), (dst), (len) ); \
|
|
} while ( 0 )
|
|
|
|
static inline __attribute__ (( always_inline )) void
|
|
cipher_decrypt ( struct cipher_algorithm *cipher, void *ctx,
|
|
const void *src, void *dst, size_t len ) {
|
|
cipher->decrypt ( ctx, src, dst, len );
|
|
}
|
|
#define cipher_decrypt( cipher, ctx, src, dst, len ) do { \
|
|
assert ( ( (len) & ( (cipher)->blocksize - 1 ) ) == 0 ); \
|
|
cipher_decrypt ( (cipher), (ctx), (src), (dst), (len) ); \
|
|
} while ( 0 )
|
|
|
|
static inline __attribute__ (( always_inline )) void
|
|
cipher_auth ( struct cipher_algorithm *cipher, void *ctx, void *auth ) {
|
|
cipher->auth ( ctx, auth );
|
|
}
|
|
|
|
static inline __attribute__ (( always_inline )) int
|
|
is_stream_cipher ( struct cipher_algorithm *cipher ) {
|
|
return ( cipher->blocksize == 1 );
|
|
}
|
|
|
|
static inline __attribute__ (( always_inline )) int
|
|
is_block_cipher ( struct cipher_algorithm *cipher ) {
|
|
return ( cipher->blocksize > 1 );
|
|
}
|
|
|
|
static inline __attribute__ (( always_inline )) int
|
|
is_auth_cipher ( struct cipher_algorithm *cipher ) {
|
|
return cipher->authsize;
|
|
}
|
|
|
|
static inline __attribute__ (( always_inline )) size_t
|
|
pubkey_max_len ( struct pubkey_algorithm *pubkey,
|
|
const struct asn1_cursor *key ) {
|
|
return pubkey->max_len ( key );
|
|
}
|
|
|
|
static inline __attribute__ (( always_inline )) int
|
|
pubkey_encrypt ( struct pubkey_algorithm *pubkey, const struct asn1_cursor *key,
|
|
const void *data, size_t len, void *out ) {
|
|
return pubkey->encrypt ( key, data, len, out );
|
|
}
|
|
|
|
static inline __attribute__ (( always_inline )) int
|
|
pubkey_decrypt ( struct pubkey_algorithm *pubkey, const struct asn1_cursor *key,
|
|
const void *data, size_t len, void *out ) {
|
|
return pubkey->decrypt ( key, data, len, out );
|
|
}
|
|
|
|
static inline __attribute__ (( always_inline )) int
|
|
pubkey_sign ( struct pubkey_algorithm *pubkey, const struct asn1_cursor *key,
|
|
struct digest_algorithm *digest, const void *value,
|
|
void *signature ) {
|
|
return pubkey->sign ( key, digest, value, signature );
|
|
}
|
|
|
|
static inline __attribute__ (( always_inline )) int
|
|
pubkey_verify ( struct pubkey_algorithm *pubkey, const struct asn1_cursor *key,
|
|
struct digest_algorithm *digest, const void *value,
|
|
const void *signature, size_t signature_len ) {
|
|
return pubkey->verify ( key, digest, value, signature, signature_len );
|
|
}
|
|
|
|
static inline __attribute__ (( always_inline )) int
|
|
pubkey_match ( struct pubkey_algorithm *pubkey,
|
|
const struct asn1_cursor *private_key,
|
|
const struct asn1_cursor *public_key ) {
|
|
return pubkey->match ( private_key, public_key );
|
|
}
|
|
|
|
static inline __attribute__ (( always_inline )) int
|
|
elliptic_multiply ( struct elliptic_curve *curve,
|
|
const void *base, const void *scalar, void *result ) {
|
|
return curve->multiply ( base, scalar, result );
|
|
}
|
|
|
|
extern void digest_null_init ( void *ctx );
|
|
extern void digest_null_update ( void *ctx, const void *src, size_t len );
|
|
extern void digest_null_final ( void *ctx, void *out );
|
|
|
|
extern int cipher_null_setkey ( void *ctx, const void *key, size_t keylen );
|
|
extern void cipher_null_setiv ( void *ctx, const void *iv, size_t ivlen );
|
|
extern void cipher_null_encrypt ( void *ctx, const void *src, void *dst,
|
|
size_t len );
|
|
extern void cipher_null_decrypt ( void *ctx, const void *src, void *dst,
|
|
size_t len );
|
|
extern void cipher_null_auth ( void *ctx, void *auth );
|
|
|
|
extern size_t pubkey_null_max_len ( const struct asn1_cursor *key );
|
|
extern int pubkey_null_encrypt ( const struct asn1_cursor *key,
|
|
const void *plaintext, size_t plaintext_len,
|
|
void *ciphertext );
|
|
extern int pubkey_null_decrypt ( const struct asn1_cursor *key,
|
|
const void *ciphertext, size_t ciphertext_len,
|
|
void *plaintext );
|
|
extern int pubkey_null_sign ( const struct asn1_cursor *key,
|
|
struct digest_algorithm *digest,
|
|
const void *value, void *signature );
|
|
extern int pubkey_null_verify ( const struct asn1_cursor *key,
|
|
struct digest_algorithm *digest,
|
|
const void *value, const void *signature ,
|
|
size_t signature_len );
|
|
|
|
extern struct digest_algorithm digest_null;
|
|
extern struct cipher_algorithm cipher_null;
|
|
extern struct pubkey_algorithm pubkey_null;
|
|
|
|
#endif /* _IPXE_CRYPTO_H */
|