1 /* SPDX-License-Identifier: BSD-2-Clause */ 2 /* 3 * Copyright (c) 2014-2017, Linaro Limited 4 */ 5 6 /* 7 * This is the Cryptographic Provider API (CP API). 8 * 9 * This defines how most crypto syscalls that implement the Cryptographic 10 * Operations API can invoke the actual providers of cryptographic algorithms 11 * (such as LibTomCrypt). 12 * 13 * To add a new provider, you need to provide an implementation of this 14 * interface. 15 * 16 * The following parameters are commonly used. 17 * 18 * @ctx: context allocated by the syscall, for later use by the algorithm 19 * @algo: algorithm identifier (TEE_ALG_*) 20 */ 21 22 #ifndef __CRYPTO_CRYPTO_H 23 #define __CRYPTO_CRYPTO_H 24 25 #include <tee_api_types.h> 26 27 TEE_Result crypto_init(void); 28 29 /* Message digest functions */ 30 TEE_Result crypto_hash_alloc_ctx(void **ctx, uint32_t algo); 31 TEE_Result crypto_hash_init(void *ctx, uint32_t algo); 32 TEE_Result crypto_hash_update(void *ctx, uint32_t algo, const uint8_t *data, 33 size_t len); 34 TEE_Result crypto_hash_final(void *ctx, uint32_t algo, uint8_t *digest, 35 size_t len); 36 void crypto_hash_free_ctx(void *ctx, uint32_t algo); 37 void crypto_hash_copy_state(void *dst_ctx, void *src_ctx, uint32_t algo); 38 39 /* Symmetric ciphers */ 40 TEE_Result crypto_cipher_get_ctx_size(uint32_t algo, size_t *size); 41 TEE_Result crypto_cipher_init(void *ctx, uint32_t algo, TEE_OperationMode mode, 42 const uint8_t *key1, size_t key1_len, 43 const uint8_t *key2, size_t key2_len, 44 const uint8_t *iv, size_t iv_len); 45 TEE_Result crypto_cipher_update(void *ctx, uint32_t algo, 46 TEE_OperationMode mode, bool last_block, 47 const uint8_t *data, size_t len, uint8_t *dst); 48 void crypto_cipher_final(void *ctx, uint32_t algo); 49 TEE_Result crypto_cipher_get_block_size(uint32_t algo, size_t *size); 50 51 /* Message Authentication Code functions */ 52 TEE_Result crypto_mac_get_ctx_size(uint32_t algo, size_t *size); 53 TEE_Result crypto_mac_init(void *ctx, uint32_t algo, const uint8_t *key, 54 size_t len); 55 TEE_Result crypto_mac_update(void *ctx, uint32_t algo, const uint8_t *data, 56 size_t len); 57 TEE_Result crypto_mac_final(void *ctx, uint32_t algo, uint8_t *digest, 58 size_t digest_len); 59 60 /* Authenticated encryption */ 61 TEE_Result crypto_authenc_get_ctx_size(uint32_t algo, size_t *size); 62 TEE_Result crypto_authenc_init(void *ctx, uint32_t algo, TEE_OperationMode mode, 63 const uint8_t *key, size_t key_len, 64 const uint8_t *nonce, size_t nonce_len, 65 size_t tag_len, size_t aad_len, 66 size_t payload_len); 67 TEE_Result crypto_authenc_update_aad(void *ctx, uint32_t algo, 68 TEE_OperationMode mode, 69 const uint8_t *data, size_t len); 70 TEE_Result crypto_authenc_update_payload(void *ctx, uint32_t algo, 71 TEE_OperationMode mode, 72 const uint8_t *src_data, 73 size_t src_len, uint8_t *dst_data, 74 size_t *dst_len); 75 TEE_Result crypto_authenc_enc_final(void *ctx, uint32_t algo, 76 const uint8_t *src_data, size_t src_len, 77 uint8_t *dst_data, size_t *dst_len, 78 uint8_t *dst_tag, size_t *dst_tag_len); 79 TEE_Result crypto_authenc_dec_final(void *ctx, uint32_t algo, 80 const uint8_t *src_data, size_t src_len, 81 uint8_t *dst_data, size_t *dst_len, 82 const uint8_t *tag, size_t tag_len); 83 void crypto_authenc_final(void *ctx, uint32_t algo); 84 85 /* Implementation-defined big numbers */ 86 87 /* 88 * Allocate a bignum capable of holding an unsigned integer value of 89 * up to bitsize bits 90 */ 91 struct bignum *crypto_bignum_allocate(size_t size_bits); 92 TEE_Result crypto_bignum_bin2bn(const uint8_t *from, size_t fromsize, 93 struct bignum *to); 94 size_t crypto_bignum_num_bytes(struct bignum *a); 95 size_t crypto_bignum_num_bits(struct bignum *a); 96 void crypto_bignum_bn2bin(const struct bignum *from, uint8_t *to); 97 void crypto_bignum_copy(struct bignum *to, const struct bignum *from); 98 void crypto_bignum_free(struct bignum *a); 99 void crypto_bignum_clear(struct bignum *a); 100 101 /* return -1 if a<b, 0 if a==b, +1 if a>b */ 102 int32_t crypto_bignum_compare(struct bignum *a, struct bignum *b); 103 104 /* Asymmetric algorithms */ 105 106 struct rsa_keypair { 107 struct bignum *e; /* Public exponent */ 108 struct bignum *d; /* Private exponent */ 109 struct bignum *n; /* Modulus */ 110 111 /* Optional CRT parameters (all NULL if unused) */ 112 struct bignum *p; /* N = pq */ 113 struct bignum *q; 114 struct bignum *qp; /* 1/q mod p */ 115 struct bignum *dp; /* d mod (p-1) */ 116 struct bignum *dq; /* d mod (q-1) */ 117 }; 118 119 struct rsa_public_key { 120 struct bignum *e; /* Public exponent */ 121 struct bignum *n; /* Modulus */ 122 }; 123 124 struct dsa_keypair { 125 struct bignum *g; /* Generator of subgroup (public) */ 126 struct bignum *p; /* Prime number (public) */ 127 struct bignum *q; /* Order of subgroup (public) */ 128 struct bignum *y; /* Public key */ 129 struct bignum *x; /* Private key */ 130 }; 131 132 struct dsa_public_key { 133 struct bignum *g; /* Generator of subgroup (public) */ 134 struct bignum *p; /* Prime number (public) */ 135 struct bignum *q; /* Order of subgroup (public) */ 136 struct bignum *y; /* Public key */ 137 }; 138 139 struct dh_keypair { 140 struct bignum *g; /* Generator of Z_p (shared) */ 141 struct bignum *p; /* Prime modulus (shared) */ 142 struct bignum *x; /* Private key */ 143 struct bignum *y; /* Public key y = g^x */ 144 145 /* 146 * Optional parameters used by key generation. 147 * When not used, q == NULL and xbits == 0 148 */ 149 struct bignum *q; /* x must be in the range [2, q-2] */ 150 uint32_t xbits; /* Number of bits in the private key */ 151 }; 152 153 struct ecc_public_key { 154 struct bignum *x; /* Public value x */ 155 struct bignum *y; /* Public value y */ 156 uint32_t curve; /* Curve type */ 157 }; 158 159 struct ecc_keypair { 160 struct bignum *d; /* Private value */ 161 struct bignum *x; /* Public value x */ 162 struct bignum *y; /* Public value y */ 163 uint32_t curve; /* Curve type */ 164 }; 165 166 /* 167 * Key allocation functions 168 * Allocate the bignum's inside a key structure. 169 * TEE core will later use crypto_bignum_free(). 170 */ 171 TEE_Result crypto_acipher_alloc_rsa_keypair(struct rsa_keypair *s, 172 size_t key_size_bits); 173 TEE_Result crypto_acipher_alloc_rsa_public_key(struct rsa_public_key *s, 174 size_t key_size_bits); 175 void crypto_acipher_free_rsa_public_key(struct rsa_public_key *s); 176 TEE_Result crypto_acipher_alloc_dsa_keypair(struct dsa_keypair *s, 177 size_t key_size_bits); 178 TEE_Result crypto_acipher_alloc_dsa_public_key(struct dsa_public_key *s, 179 size_t key_size_bits); 180 TEE_Result crypto_acipher_alloc_dh_keypair(struct dh_keypair *s, 181 size_t key_size_bits); 182 TEE_Result crypto_acipher_alloc_ecc_public_key(struct ecc_public_key *s, 183 size_t key_size_bits); 184 TEE_Result crypto_acipher_alloc_ecc_keypair(struct ecc_keypair *s, 185 size_t key_size_bits); 186 void crypto_acipher_free_ecc_public_key(struct ecc_public_key *s); 187 188 /* 189 * Key generation functions 190 */ 191 TEE_Result crypto_acipher_gen_rsa_key(struct rsa_keypair *key, size_t key_size); 192 TEE_Result crypto_acipher_gen_dsa_key(struct dsa_keypair *key, size_t key_size); 193 TEE_Result crypto_acipher_gen_dh_key(struct dh_keypair *key, struct bignum *q, 194 size_t xbits); 195 TEE_Result crypto_acipher_gen_ecc_key(struct ecc_keypair *key); 196 197 TEE_Result crypto_acipher_dh_shared_secret(struct dh_keypair *private_key, 198 struct bignum *public_key, 199 struct bignum *secret); 200 201 TEE_Result crypto_acipher_rsanopad_decrypt(struct rsa_keypair *key, 202 const uint8_t *src, size_t src_len, 203 uint8_t *dst, size_t *dst_len); 204 TEE_Result crypto_acipher_rsanopad_encrypt(struct rsa_public_key *key, 205 const uint8_t *src, size_t src_len, 206 uint8_t *dst, size_t *dst_len); 207 TEE_Result crypto_acipher_rsaes_decrypt(uint32_t algo, struct rsa_keypair *key, 208 const uint8_t *label, size_t label_len, 209 const uint8_t *src, size_t src_len, 210 uint8_t *dst, size_t *dst_len); 211 TEE_Result crypto_acipher_rsaes_encrypt(uint32_t algo, 212 struct rsa_public_key *key, 213 const uint8_t *label, size_t label_len, 214 const uint8_t *src, size_t src_len, 215 uint8_t *dst, size_t *dst_len); 216 /* RSA SSA sign/verify: if salt_len == -1, use default value */ 217 TEE_Result crypto_acipher_rsassa_sign(uint32_t algo, struct rsa_keypair *key, 218 int salt_len, const uint8_t *msg, 219 size_t msg_len, uint8_t *sig, 220 size_t *sig_len); 221 TEE_Result crypto_acipher_rsassa_verify(uint32_t algo, 222 struct rsa_public_key *key, 223 int salt_len, const uint8_t *msg, 224 size_t msg_len, const uint8_t *sig, 225 size_t sig_len); 226 TEE_Result crypto_acipher_dsa_sign(uint32_t algo, struct dsa_keypair *key, 227 const uint8_t *msg, size_t msg_len, 228 uint8_t *sig, size_t *sig_len); 229 TEE_Result crypto_acipher_dsa_verify(uint32_t algo, struct dsa_public_key *key, 230 const uint8_t *msg, size_t msg_len, 231 const uint8_t *sig, size_t sig_len); 232 TEE_Result crypto_acipher_ecc_sign(uint32_t algo, struct ecc_keypair *key, 233 const uint8_t *msg, size_t msg_len, 234 uint8_t *sig, size_t *sig_len); 235 TEE_Result crypto_acipher_ecc_verify(uint32_t algo, struct ecc_public_key *key, 236 const uint8_t *msg, size_t msg_len, 237 const uint8_t *sig, size_t sig_len); 238 TEE_Result crypto_acipher_ecc_shared_secret(struct ecc_keypair *private_key, 239 struct ecc_public_key *public_key, 240 void *secret, 241 unsigned long *secret_len); 242 243 /* 244 * Verifies a SHA-256 hash, doesn't require crypto_init() to be called in 245 * advance and has as few dependencies as possible. 246 * 247 * This function is primarily used by pager and early initialization code 248 * where the complete crypto library isn't available. 249 */ 250 TEE_Result hash_sha256_check(const uint8_t *hash, const uint8_t *data, 251 size_t data_size); 252 253 /* Add entropy to PRNG entropy pool. */ 254 TEE_Result crypto_rng_add_entropy(const uint8_t *inbuf, size_t len); 255 256 /* To read random data from PRNG implementation. */ 257 TEE_Result crypto_rng_read(void *buf, size_t blen); 258 259 TEE_Result rng_generate(void *buffer, size_t len); 260 261 TEE_Result crypto_aes_expand_enc_key(const void *key, size_t key_len, 262 void *enc_key, unsigned int *rounds); 263 void crypto_aes_enc_block(const void *enc_key, unsigned int rounds, 264 const void *src, void *dst); 265 266 #endif /* __CRYPTO_CRYPTO_H */ 267