providers/common/ciphers/ciphers_ccm.h

   1 /*
   2  * Copyright 2019 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 typedef struct prov_ccm_hw_st PROV_CCM_HW;
  11
  12 #if defined(OPENSSL_CPUID_OBJ) && defined(__s390__)
  13 /*-
  14  * KMAC-AES parameter block - begin
  15  * (see z/Architecture Principles of Operation >= SA22-7832-08)
  16  */
  17 typedef struct S390X_kmac_params_st {
  18     union {
  19         unsigned long long g[2];
  20         unsigned char b[16];
  21     } icv;
  22     unsigned char k[32];
  23 } S390X_KMAC_PARAMS;
  24 /* KMAC-AES parameter block - end */
  25 #endif
  26
  27 /* Base structure that is shared by AES & ARIA for CCM MODE */
  28 typedef struct prov_ccm_st {
  29     int enc;
  30     int key_set;                /* Set if key initialised */
  31     int iv_set;                 /* Set if an iv is set */
  32     int tag_set;                /* Set if tag is valid */
  33     int len_set;                /* Set if message length set */
  34     size_t l, m;                /* L and M parameters from RFC3610 */
  35     size_t keylen;
  36     int tls_aad_len;            /* TLS AAD length */
  37     int tls_aad_pad_sz;
  38     unsigned char iv[AES_BLOCK_SIZE];
  39     unsigned char buf[AES_BLOCK_SIZE];
  40     CCM128_CONTEXT ccm_ctx;
  41     ccm128_f str;
  42     const PROV_CCM_HW *hw;      /* hardware specific methods  */
  43 } PROV_CCM_CTX;
  44
  45 typedef struct prov_aes_ccm_ctx_st {
  46     PROV_CCM_CTX base;          /* Must be first */
  47     union {
  48         OSSL_UNION_ALIGN;
  49         /*-
  50          * Padding is chosen so that s390x.kmac.k overlaps with ks.ks and
  51          * fc with ks.ks.rounds. Remember that on s390x, an AES_KEY's
  52          * rounds field is used to store the function code and that the key
  53          * schedule is not stored (if aes hardware support is detected).
  54          */
  55         struct {
  56             unsigned char pad[16];
  57             AES_KEY ks;
  58         } ks;
  59 #if defined(OPENSSL_CPUID_OBJ) && defined(__s390__)
  60         struct {
  61             S390X_KMAC_PARAMS kmac;
  62             unsigned long long blocks;
  63             union {
  64                 unsigned long long g[2];
  65                 unsigned char b[AES_BLOCK_SIZE];
  66             } nonce;
  67             union {
  68                 unsigned long long g[2];
  69                 unsigned char b[AES_BLOCK_SIZE];
  70             } buf;
  71             unsigned char dummy_pad[168];
  72             unsigned int fc;    /* fc has same offset as ks.ks.rounds */
  73         } s390x;
  74 #endif /* defined(OPENSSL_CPUID_OBJ) && defined(__s390__) */
  75     } ccm;
  76 } PROV_AES_CCM_CTX;
  77
  78 PROV_CIPHER_FUNC(int, CCM_cipher, (PROV_CCM_CTX *ctx, unsigned char *out,      \
  79                                    size_t *padlen, const unsigned char *in,    \
  80                                    size_t len));
  81 PROV_CIPHER_FUNC(int, CCM_setkey, (PROV_CCM_CTX *ctx,                          \
  82                                    const unsigned char *key, size_t keylen));
  83 PROV_CIPHER_FUNC(int, CCM_setiv, (PROV_CCM_CTX *dat,                           \
  84                                   const unsigned char *iv, size_t ivlen,       \
  85                                   size_t mlen));
  86 PROV_CIPHER_FUNC(int, CCM_setaad, (PROV_CCM_CTX *ctx,                          \
  87                                    const unsigned char *aad, size_t aadlen));
  88 PROV_CIPHER_FUNC(int, CCM_auth_encrypt, (PROV_CCM_CTX *ctx,                    \
  89                                          const unsigned char *in,              \
  90                                          unsigned char *out, size_t len,       \
  91                                          unsigned char *tag, size_t taglen));
  92 PROV_CIPHER_FUNC(int, CCM_auth_decrypt, (PROV_CCM_CTX *ctx,                    \
  93                                          const unsigned char *in,              \
  94                                          unsigned char *out, size_t len,       \
  95                                          unsigned char *tag, size_t taglen));
  96 PROV_CIPHER_FUNC(int, CCM_gettag, (PROV_CCM_CTX *ctx,                          \
  97                                    unsigned char *tag,  size_t taglen));
  98
  99 /*
 100  * CCM Mode internal method table used to handle hardware specific differences,
 101  * (and different algorithms).
 102  */
 103 struct prov_ccm_hw_st {
 104     OSSL_CCM_setkey_fn setkey;
 105     OSSL_CCM_setiv_fn setiv;
 106     OSSL_CCM_setaad_fn setaad;
 107     OSSL_CCM_auth_encrypt_fn auth_encrypt;
 108     OSSL_CCM_auth_decrypt_fn auth_decrypt;
 109     OSSL_CCM_gettag_fn gettag;
 110 };
 111
 112 const PROV_CCM_HW *PROV_AES_HW_ccm(size_t keylen);
 113
 114 #if !defined(OPENSSL_NO_ARIA) && !defined(FIPS_MODE)
 115 # include "internal/aria.h"
 116 typedef struct prov_aria_ccm_ctx_st {
 117     PROV_CCM_CTX base; /* Must be first */
 118     union {
 119         OSSL_UNION_ALIGN;
 120         ARIA_KEY ks;
 121     } ks;                       /* ARIA key schedule to use */
 122 } PROV_ARIA_CCM_CTX;
 123
 124 const PROV_CCM_HW *PROV_ARIA_HW_ccm(size_t keylen);
 125 #endif /* !defined(OPENSSL_NO_ARIA) && !defined(FIPS_MODE) */