1 /* 2 * Copyright 2019-2022 The OpenSSL Project Authors. All Rights Reserved. 3 * 4 * Licensed under the Apache License 2.0 (the "License"). You may not use 5 * this file except in compliance with the License. You can obtain a copy 6 * in the file LICENSE in the source distribution or at 7 * https://www.openssl.org/source/license.html 8 */ 9 10 #ifndef OSSL_PROV_CIPHERCOMMON_CCM_H 11 # define OSSL_PROV_CIPHERCOMMON_CCM_H 12 # pragma once 13 14 # include "ciphercommon_aead.h" 15 16 typedef struct prov_ccm_hw_st PROV_CCM_HW; 17 18 # if defined(OPENSSL_CPUID_OBJ) && defined(__s390__) 19 /*- 20 * KMAC-AES parameter block - begin 21 * (see z/Architecture Principles of Operation >= SA22-7832-08) 22 */ 23 typedef struct S390X_kmac_params_st { 24 union { 25 unsigned long long g[2]; 26 unsigned char b[16]; 27 } icv; 28 unsigned char k[32]; 29 } S390X_KMAC_PARAMS; 30 /* KMAC-AES parameter block - end */ 31 # endif 32 33 /* Base structure that is shared by AES & ARIA for CCM MODE */ 34 typedef struct prov_ccm_st { 35 unsigned int enc : 1; 36 unsigned int key_set : 1; /* Set if key initialised */ 37 unsigned int iv_set : 1; /* Set if an iv is set */ 38 unsigned int tag_set : 1; /* Set if tag is valid */ 39 unsigned int len_set : 1; /* Set if message length set */ 40 size_t l, m; /* L and M parameters from RFC3610 */ 41 size_t keylen; 42 size_t tls_aad_len; /* TLS AAD length */ 43 size_t tls_aad_pad_sz; 44 unsigned char iv[GENERIC_BLOCK_SIZE]; 45 unsigned char buf[GENERIC_BLOCK_SIZE]; 46 CCM128_CONTEXT ccm_ctx; 47 ccm128_f str; 48 const PROV_CCM_HW *hw; /* hardware specific methods */ 49 } PROV_CCM_CTX; 50 51 PROV_CIPHER_FUNC(int, CCM_cipher, (PROV_CCM_CTX *ctx, unsigned char *out, \ 52 size_t *padlen, const unsigned char *in, \ 53 size_t len)); 54 PROV_CIPHER_FUNC(int, CCM_setkey, (PROV_CCM_CTX *ctx, \ 55 const unsigned char *key, size_t keylen)); 56 PROV_CIPHER_FUNC(int, CCM_setiv, (PROV_CCM_CTX *dat, \ 57 const unsigned char *iv, size_t ivlen, \ 58 size_t mlen)); 59 PROV_CIPHER_FUNC(int, CCM_setaad, (PROV_CCM_CTX *ctx, \ 60 const unsigned char *aad, size_t aadlen)); 61 PROV_CIPHER_FUNC(int, CCM_auth_encrypt, (PROV_CCM_CTX *ctx, \ 62 const unsigned char *in, \ 63 unsigned char *out, size_t len, \ 64 unsigned char *tag, size_t taglen)); 65 PROV_CIPHER_FUNC(int, CCM_auth_decrypt, (PROV_CCM_CTX *ctx, \ 66 const unsigned char *in, \ 67 unsigned char *out, size_t len, \ 68 unsigned char *tag, size_t taglen)); 69 PROV_CIPHER_FUNC(int, CCM_gettag, (PROV_CCM_CTX *ctx, \ 70 unsigned char *tag, size_t taglen)); 71 72 /* 73 * CCM Mode internal method table used to handle hardware specific differences, 74 * (and different algorithms). 75 */ 76 struct prov_ccm_hw_st { 77 OSSL_CCM_setkey_fn setkey; 78 OSSL_CCM_setiv_fn setiv; 79 OSSL_CCM_setaad_fn setaad; 80 OSSL_CCM_auth_encrypt_fn auth_encrypt; 81 OSSL_CCM_auth_decrypt_fn auth_decrypt; 82 OSSL_CCM_gettag_fn gettag; 83 }; 84 85 OSSL_FUNC_cipher_encrypt_init_fn ossl_ccm_einit; 86 OSSL_FUNC_cipher_decrypt_init_fn ossl_ccm_dinit; 87 OSSL_FUNC_cipher_get_ctx_params_fn ossl_ccm_get_ctx_params; 88 OSSL_FUNC_cipher_set_ctx_params_fn ossl_ccm_set_ctx_params; 89 OSSL_FUNC_cipher_update_fn ossl_ccm_stream_update; 90 OSSL_FUNC_cipher_final_fn ossl_ccm_stream_final; 91 OSSL_FUNC_cipher_cipher_fn ossl_ccm_cipher; 92 void ossl_ccm_initctx(PROV_CCM_CTX *ctx, size_t keybits, const PROV_CCM_HW *hw); 93 94 int ossl_ccm_generic_setiv(PROV_CCM_CTX *ctx, const unsigned char *nonce, 95 size_t nlen, size_t mlen); 96 int ossl_ccm_generic_setaad(PROV_CCM_CTX *ctx, const unsigned char *aad, 97 size_t alen); 98 int ossl_ccm_generic_gettag(PROV_CCM_CTX *ctx, unsigned char *tag, size_t tlen); 99 int ossl_ccm_generic_auth_encrypt(PROV_CCM_CTX *ctx, const unsigned char *in, 100 unsigned char *out, size_t len, 101 unsigned char *tag, size_t taglen); 102 int ossl_ccm_generic_auth_decrypt(PROV_CCM_CTX *ctx, const unsigned char *in, 103 unsigned char *out, size_t len, 104 unsigned char *expected_tag, size_t taglen); 105 106 #endif 107