EXTERNAL_HEADERS/corecrypto/ccmode_factory.h

   1 /*
   2  *  ccmode_factory.h
   3  *  corecrypto
   4  *
   5  *  Created on 01/21/2011
   6  *
   7  *  Copyright (c) 2011,2012,2013,2014,2015 Apple Inc. All rights reserved.
   8  *
   9  */
  10
  11 #ifndef _CORECRYPTO_CCMODE_FACTORY_H_
  12 #define _CORECRYPTO_CCMODE_FACTORY_H_
  13
  14 #include <corecrypto/ccn.h>  /* TODO: Remove dependency on this header. */
  15 #include <corecrypto/ccmode_impl.h>
  16
  17 /* Function and macros defined in this file are only to be used
  18  within corecrypto files.
  19  */
  20
  21 /* For CBC, direction of underlying ecb is the same as the cbc direction */
  22 #define CCMODE_CBC_FACTORY(_cipher_, _dir_)                                     \
  23 static struct ccmode_cbc cbc_##_cipher_##_##_dir_;                              \
  24                                                                                 \
  25 const struct ccmode_cbc *cc##_cipher_##_cbc_##_dir_##_mode(void)                \
  26 {                                                                               \
  27     const struct ccmode_ecb *ecb=cc##_cipher_##_ecb_##_dir_##_mode();           \
  28     ccmode_factory_cbc_##_dir_(&cbc_##_cipher_##_##_dir_, ecb);                 \
  29     return &cbc_##_cipher_##_##_dir_;                                           \
  30 }
  31
  32 /* For CTR, only one direction, underlying ecb is always encrypt */
  33 #define CCMODE_CTR_FACTORY(_cipher_)                                            \
  34 static struct ccmode_ctr ctr_##_cipher_;                                        \
  35                                                                                 \
  36 const struct ccmode_ctr *cc##_cipher_##_ctr_crypt_mode(void)                    \
  37 {                                                                               \
  38     const struct ccmode_ecb *ecb=cc##_cipher_##_ecb_encrypt_mode();             \
  39     ccmode_factory_ctr_crypt(&ctr_##_cipher_, ecb);                             \
  40     return &ctr_##_cipher_;                                                     \
  41 }
  42
  43 /* OFB, same as CTR */
  44 #define CCMODE_OFB_FACTORY(_cipher_)                                            \
  45 static struct ccmode_ofb ofb_##_cipher_;                                        \
  46                                                                                 \
  47 const struct ccmode_ofb *cc##_cipher_##_ofb_crypt_mode(void)                    \
  48 {                                                                               \
  49     const struct ccmode_ecb *ecb=cc##_cipher_##_ecb_encrypt_mode();             \
  50     ccmode_factory_ofb_crypt(&ofb_##_cipher_, ecb);                             \
  51     return &ofb_##_cipher_;                                                     \
  52 }
  53
  54
  55 /* For CFB, the underlying ecb operation is encrypt for both directions */
  56 #define CCMODE_CFB_FACTORY(_cipher_, _mode_, _dir_)                             \
  57 static struct ccmode_##_mode_ _mode_##_##_cipher_##_##_dir_;                    \
  58                                                                                 \
  59 const struct ccmode_##_mode_ *cc##_cipher_##_##_mode_##_##_dir_##_mode(void)    \
  60 {                                                                               \
  61     const struct ccmode_ecb *ecb=cc##_cipher_##_ecb_encrypt_mode();             \
  62     ccmode_factory_##_mode_##_##_dir_(&_mode_##_##_cipher_##_##_dir_, ecb);     \
  63     return &_mode_##_##_cipher_##_##_dir_;                                      \
  64 }
  65
  66 /* For GCM, same as CFB */
  67 #define CCMODE_GCM_FACTORY(_cipher_, _dir_) CCMODE_CFB_FACTORY(_cipher_, gcm, _dir_)
  68
  69 /* For CCM, same as CFB */
  70 #define CCMODE_CCM_FACTORY(_cipher_, _dir_) CCMODE_CFB_FACTORY(_cipher_, ccm, _dir_)
  71
  72
  73 /* Fot XTS, you always need an ecb encrypt */
  74 #define CCMODE_XTS_FACTORY(_cipher_ , _dir_)                                    \
  75 static struct ccmode_xts xts##_cipher_##_##_dir_;                               \
  76                                                                                 \
  77 const struct ccmode_xts *cc##_cipher_##_xts_##_dir_##_mode(void)                \
  78 {                                                                               \
  79     const struct ccmode_ecb *ecb=cc##_cipher_##_ecb_##_dir_##_mode();           \
  80     const struct ccmode_ecb *ecb_enc=cc##_cipher_##_ecb_encrypt_mode();         \
  81                                                                                 \
  82     ccmode_factory_xts_##_dir_(&xts##_cipher_##_##_dir_, ecb, ecb_enc);         \
  83     return &xts##_cipher_##_##_dir_;                                            \
  84 }
  85
  86 #if 0
  87
  88 /* example of how to make the selection function thread safe */
  89
  90 struct ccmode_cbc cc3des_cbc_mode_encrypt;
  91 dispatch_once_t cc3des_mode_encrypt_init_once;
  92
  93 void cc3des_mode_encrypt_init(void *ctx) {
  94     struct ccmode_ecb *ecb = cc3des_ecb_encrypt_mode();
  95     ccmode_factory_cbc_encrypt(&cc3des_mode_encrypt, ecb);
  96 }
  97
  98 const struct ccmode_cbc *cc3des_cbc_encrypt_mode(void) {
  99     dispatch_once_f(&cc3des_mode_encrypt_init_once, NULL, cc3des_mode_encrypt_init);
 100     return &cc3des_mode_encrypt;
 101 }
 102
 103 struct ccmode_cbc cc3des_cbc_mode_encrypt = {
 104     .n = CC3DES_LTC_ECB_ENCRYPT_N,
 105     .init = ccmode_cbc_init,
 106     .cbc = ccmode_cbc_encrypt,
 107     .custom = &cc3des_ltc_ecb_encrypt
 108 };
 109
 110 const struct ccmode_cbc *cc3des_cbc_encrypt_mode(void) {
 111     return &cc3des_mode_encrypt;
 112 }
 113
 114 #endif
 115
 116
 117
 118 void ccmode_cbc_init(const struct ccmode_cbc *cbc, cccbc_ctx *ctx,
 119                      size_t rawkey_len, const void *rawkey);
 120 void ccmode_cbc_decrypt(const cccbc_ctx *ctx, cccbc_iv *iv, size_t nblocks,
 121                         const void *in, void *out);
 122 void ccmode_cbc_encrypt(const cccbc_ctx *ctx, cccbc_iv *iv, size_t nblocks,
 123                         const void *in, void *out);
 124
 125 struct _ccmode_cbc_key {
 126     const struct ccmode_ecb *ecb;
 127     cc_unit u[];
 128 };
 129
 130 /* Use this to statically initialize a ccmode_cbc object for decryption. */
 131 #define CCMODE_FACTORY_CBC_DECRYPT(ECB) { \
 132 .size = ccn_sizeof_size(sizeof(struct _ccmode_cbc_key)) + ccn_sizeof_size((ECB)->block_size) + ccn_sizeof_size((ECB)->size), \
 133 .block_size = (ECB)->block_size, \
 134 .init = ccmode_cbc_init, \
 135 .cbc = ccmode_cbc_decrypt, \
 136 .custom = (ECB) \
 137 }
 138
 139 /* Use this to statically initialize a ccmode_cbc object for encryption. */
 140 #define CCMODE_FACTORY_CBC_ENCRYPT(ECB) { \
 141 .size = ccn_sizeof_size(sizeof(struct _ccmode_cbc_key)) + ccn_sizeof_size((ECB)->block_size) + ccn_sizeof_size((ECB)->size), \
 142 .block_size = (ECB)->block_size, \
 143 .init = ccmode_cbc_init, \
 144 .cbc = ccmode_cbc_encrypt, \
 145 .custom = (ECB) \
 146 }
 147
 148 /* Use these function to runtime initialize a ccmode_cbc decrypt object (for
 149  example if it's part of a larger structure). Normally you would pass a
 150  ecb decrypt mode implementation of some underlying algorithm as the ecb
 151  parameter. */
 152 void ccmode_factory_cbc_decrypt(struct ccmode_cbc *cbc,
 153                                 const struct ccmode_ecb *ecb);
 154
 155 /* Use these function to runtime initialize a ccmode_cbc encrypt object (for
 156  example if it's part of a larger structure). Normally you would pass a
 157  ecb encrypt mode implementation of some underlying algorithm as the ecb
 158  parameter. */
 159 void ccmode_factory_cbc_encrypt(struct ccmode_cbc *cbc,
 160                                 const struct ccmode_ecb *ecb);
 161
 162
 163 void ccmode_cfb_init(const struct ccmode_cfb *cfb, cccfb_ctx *ctx,
 164                      size_t rawkey_len, const void *rawkey,
 165                      const void *iv);
 166 void ccmode_cfb_decrypt(cccfb_ctx *ctx, size_t nbytes,
 167                         const void *in, void *out);
 168 void ccmode_cfb_encrypt(cccfb_ctx *ctx, size_t nbytes,
 169                         const void *in, void *out);
 170 struct _ccmode_cfb_key {
 171     const struct ccmode_ecb *ecb;
 172     size_t pad_len;
 173     cc_unit u[];
 174 };
 175
 176 /* Use this to statically initialize a ccmode_cfb object for decryption. */
 177 #define CCMODE_FACTORY_CFB_DECRYPT(ECB) { \
 178 .size = ccn_sizeof_size(sizeof(struct _ccmode_cfb_key)) + 2 * ccn_sizeof_size((ECB)->block_size) + ccn_sizeof_size((ECB)->size), \
 179 .block_size = 1, \
 180 .init = ccmode_cfb_init, \
 181 .cfb = ccmode_cfb_decrypt, \
 182 .custom = (ECB) \
 183 }
 184
 185 /* Use this to statically initialize a ccmode_cfb object for encryption. */
 186 #define CCMODE_FACTORY_CFB_ENCRYPT(ECB) { \
 187 .size = ccn_sizeof_size(sizeof(struct _ccmode_cfb_key)) + 2 * ccn_sizeof_size((ECB)->block_size) + ccn_sizeof_size((ECB)->size), \
 188 .block_size = 1, \
 189 .init = ccmode_cfb_init, \
 190 .cfb = ccmode_cfb_encrypt, \
 191 .custom = (ECB) \
 192 }
 193
 194 /* Use these function to runtime initialize a ccmode_cfb decrypt object (for
 195  example if it's part of a larger structure). Normally you would pass a
 196  ecb encrypt mode implementation of some underlying algorithm as the ecb
 197  parameter. */
 198 void ccmode_factory_cfb_decrypt(struct ccmode_cfb *cfb,
 199                                 const struct ccmode_ecb *ecb);
 200
 201 /* Use these function to runtime initialize a ccmode_cfb encrypt object (for
 202  example if it's part of a larger structure). Normally you would pass a
 203  ecb encrypt mode implementation of some underlying algorithm as the ecb
 204  parameter. */
 205 void ccmode_factory_cfb_encrypt(struct ccmode_cfb *cfb,
 206                                 const struct ccmode_ecb *ecb);
 207
 208 void ccmode_cfb8_init(const struct ccmode_cfb8 *cfb8, cccfb8_ctx *ctx,
 209                       size_t rawkey_len, const void *rawkey, const void *iv);
 210 void ccmode_cfb8_decrypt(cccfb8_ctx *ctx, size_t nbytes,
 211                          const void *in, void *out);
 212 void ccmode_cfb8_encrypt(cccfb8_ctx *ctx, size_t nbytes,
 213                          const void *in, void *out);
 214
 215 struct _ccmode_cfb8_key {
 216     const struct ccmode_ecb *ecb;
 217     cc_unit u[];
 218 };
 219
 220 /* Use this to statically initialize a ccmode_cfb8 object for decryption. */
 221 #define CCMODE_FACTORY_CFB8_DECRYPT(ECB) { \
 222 .size = ccn_sizeof_size(sizeof(struct _ccmode_cfb8_key)) + 2 * ccn_sizeof_size((ECB)->block_size) + ccn_sizeof_size((ECB)->size), \
 223 .block_size = 1, \
 224 .init = ccmode_cfb8_init, \
 225 .cfb8 = ccmode_cfb8_decrypt, \
 226 .custom = (ECB) \
 227 }
 228
 229 /* Use this to statically initialize a ccmode_cfb8 object for encryption. */
 230 #define CCMODE_FACTORY_CFB8_ENCRYPT(ECB) { \
 231 .size = ccn_sizeof_size(sizeof(struct _ccmode_cfb8_key)) + 2 * ccn_sizeof_size((ECB)->block_size) + ccn_sizeof_size((ECB)->size), \
 232 .block_size = 1, \
 233 .init = ccmode_cfb8_init, \
 234 .cfb8 = ccmode_cfb8_encrypt, \
 235 .custom = (ECB) \
 236 }
 237
 238 /* Use these function to runtime initialize a ccmode_cfb8 decrypt object (for
 239  example if it's part of a larger structure). Normally you would pass a
 240  ecb decrypt mode implementation of some underlying algorithm as the ecb
 241  parameter. */
 242 void ccmode_factory_cfb8_decrypt(struct ccmode_cfb8 *cfb8,
 243                                  const struct ccmode_ecb *ecb);
 244
 245 /* Use these function to runtime initialize a ccmode_cfb8 encrypt object (for
 246  example if it's part of a larger structure). Normally you would pass a
 247  ecb encrypt mode implementation of some underlying algorithm as the ecb
 248  parameter. */
 249 void ccmode_factory_cfb8_encrypt(struct ccmode_cfb8 *cfb8,
 250                                  const struct ccmode_ecb *ecb);
 251
 252 void ccmode_ctr_init(const struct ccmode_ctr *ctr, ccctr_ctx *ctx,
 253                      size_t rawkey_len, const void *rawkey, const void *iv);
 254 void ccmode_ctr_crypt(ccctr_ctx *ctx, size_t nbytes,
 255                       const void *in, void *out);
 256
 257 struct _ccmode_ctr_key {
 258     const struct ccmode_ecb *ecb;
 259     size_t pad_len;
 260     cc_unit u[];
 261 };
 262
 263 /* Use this to statically initialize a ccmode_ctr object for decryption. */
 264 #define CCMODE_FACTORY_CTR_CRYPT(ECB_ENCRYPT) { \
 265 .size = ccn_sizeof_size(sizeof(struct _ccmode_ctr_key)) + 2 * ccn_sizeof_size((ECB_ENCRYPT)->block_size) + ccn_sizeof_size((ECB_ENCRYPT)->size), \
 266 .block_size = 1, \
 267 .init = ccmode_ctr_init, \
 268 .ctr = ccmode_ctr_crypt, \
 269 .custom = (ECB_ENCRYPT) \
 270 }
 271
 272 /* Use these function to runtime initialize a ccmode_ctr decrypt object (for
 273  example if it's part of a larger structure). Normally you would pass a
 274  ecb encrypt mode implementation of some underlying algorithm as the ecb
 275  parameter. */
 276 void ccmode_factory_ctr_crypt(struct ccmode_ctr *ctr,
 277                               const struct ccmode_ecb *ecb);
 278
 279
 280 /* Create a gcm key from a gcm mode object.
 281  key must point to at least sizeof(CCMODE_GCM_KEY(ecb)) bytes of free
 282  storage. */
 283 int ccmode_gcm_init(const struct ccmode_gcm *gcm, ccgcm_ctx *ctx,
 284                      size_t rawkey_len, const void *rawkey);
 285 int ccmode_gcm_set_iv(ccgcm_ctx *ctx, size_t iv_size, const void *iv);
 286 int ccmode_gcm_aad(ccgcm_ctx *ctx, size_t nbytes, const void *in);
 287 int ccmode_gcm_decrypt(ccgcm_ctx *ctx, size_t nbytes, const void *in,
 288                         void *out);
 289 int ccmode_gcm_encrypt(ccgcm_ctx *ctx, size_t nbytes, const void *in,
 290                         void *out);
 291
 292 /*!
 293  @function  ccmode_gcm_finalize() finalizes AES-GCM call sequence
 294  @param key encryption or decryption key
 295  @param tag_size
 296  @param tag
 297  @result        0=success or non zero= error
 298  @discussion For decryption, the tag parameter must be the expected-tag. A secure compare is performed between the provided expected-tag and the computed-tag. If they are the same, 0 is returned. Otherwise, non zero is returned. For encryption, tag is output and provides the authentication tag.
 299
 300  */
 301 int ccmode_gcm_finalize(ccgcm_ctx *key, size_t tag_size, void *tag);
 302 int ccmode_gcm_reset(ccgcm_ctx *key);
 303
 304
 305 // Here is what the structure looks like in memory
 306 // [ temp space | length | *ecb | *ecb_key | table | ecb_key ]
 307 // size of table depends on the implementation (VNG vs factory)
 308 struct _ccmode_gcm_key {
 309     // 5 blocks of temp space.
 310     unsigned char H[16];       /* multiplier */
 311     unsigned char X[16];       /* accumulator */
 312     unsigned char Y[16];       /* counter */
 313     unsigned char Y_0[16];     /* initial counter */
 314     unsigned char buf[16];      /* buffer for stuff */
 315
 316     // State and length
 317     uint32_t ivmode;       /* Which mode is the IV in? */
 318     uint32_t state;        /* state the GCM code is in */
 319     uint32_t buflen;       /* length of data in buf */
 320
 321     uint64_t totlen;       /* 64-bit counter used for IV and AAD */
 322     uint64_t pttotlen;     /* 64-bit counter for the plaintext PT */
 323
 324     // ECB
 325     const struct ccmode_ecb *ecb;              // ecb mode
 326     // Pointer to the ECB key in the buffer
 327     void *ecb_key;                             // address of the ecb_key in u, set in init function
 328     int encdec; //is it an encrypt or decrypt object
 329
 330     // Buffer with ECB key and H table if applicable
 331     unsigned char u[] __attribute__ ((aligned (16))); // ecb key + tables
 332 };
 333
 334 #define GCM_ECB_KEY_SIZE(ECB_ENCRYPT) \
 335         ((5 * ccn_sizeof_size((ECB_ENCRYPT)->block_size)) \
 336     + ccn_sizeof_size((ECB_ENCRYPT)->size))
 337
 338 /* Use these function to runtime initialize a ccmode_gcm decrypt object (for
 339  example if it's part of a larger structure). For GCM you always pass a
 340  ecb encrypt mode implementation of some underlying algorithm as the ecb
 341  parameter. */
 342 void ccmode_factory_gcm_decrypt(struct ccmode_gcm *gcm,
 343                                 const struct ccmode_ecb *ecb_encrypt);
 344
 345 /* Use these function to runtime initialize a ccmode_gcm encrypt object (for
 346  example if it's part of a larger structure). For GCM you always pass a
 347  ecb encrypt mode implementation of some underlying algorithm as the ecb
 348  parameter. */
 349 void ccmode_factory_gcm_encrypt(struct ccmode_gcm *gcm,
 350                                 const struct ccmode_ecb *ecb_encrypt);
 351
 352
 353 /* CCM (only NIST approved with AES) */
 354 int ccmode_ccm_init(const struct ccmode_ccm *ccm, ccccm_ctx *ctx,
 355                      size_t rawkey_len, const void *rawkey);
 356 int ccmode_ccm_set_iv(ccccm_ctx *ctx, ccccm_nonce *nonce_ctx, size_t nonce_len, const void *nonce,
 357                        size_t mac_size, size_t auth_len, size_t data_len);
 358 /* internal function */
 359 void ccmode_ccm_macdata(ccccm_ctx *key, ccccm_nonce *nonce_ctx, unsigned new_block, size_t nbytes, const void *in);
 360 /* api function - disallows only mac'd data after data to encrypt was sent */
 361 int ccmode_ccm_cbcmac(ccccm_ctx *ctx, ccccm_nonce *nonce_ctx, size_t nbytes, const void *in);
 362 /* internal function */
 363 void ccmode_ccm_crypt(ccccm_ctx *key, ccccm_nonce *nonce_ctx, size_t nbytes, const void *in, void *out);
 364 int ccmode_ccm_decrypt(ccccm_ctx *ctx, ccccm_nonce *nonce_ctx, size_t nbytes, const void *in,
 365                         void *out);
 366 int ccmode_ccm_encrypt(ccccm_ctx *ctx, ccccm_nonce *nonce_ctx, size_t nbytes, const void *in,
 367                         void *out);
 368 int ccmode_ccm_finalize(ccccm_ctx *key, ccccm_nonce *nonce_ctx, void *mac);
 369 int ccmode_ccm_reset(ccccm_ctx *key, ccccm_nonce *nonce_ctx);
 370
 371 struct _ccmode_ccm_key {
 372     const struct ccmode_ecb *ecb;
 373     cc_unit u[];
 374 };
 375
 376 struct _ccmode_ccm_nonce {
 377     unsigned char A_i[16];      /* crypto block iv */
 378     unsigned char B_i[16];      /* mac block iv */
 379     unsigned char MAC[16];      /* crypted mac */
 380     unsigned char buf[16];      /* crypt buffer */
 381
 382     uint32_t mode;         /* mode: IV -> AD -> DATA */
 383     uint32_t buflen;       /* length of data in buf */
 384     uint32_t b_i_len;      /* length of cbcmac data in B_i */
 385
 386     size_t nonce_size;
 387     size_t mac_size;
 388 };
 389
 390 /* Use this to statically initialize a ccmode_ccm object for decryption. */
 391 #define CCMODE_FACTORY_CCM_DECRYPT(ECB_ENCRYPT) { \
 392 .size = ccn_sizeof_size(sizeof(struct _ccmode_ccm_key)) + ccn_sizeof_size((ECB_ENCRYPT)->block_size) + ccn_sizeof_size((ECB_ENCRYPT)->size), \
 393 .nonce_size = ccn_sizeof_size(sizeof(struct _ccmode_ccm_nonce)), \
 394 .block_size = 1, \
 395 .init = ccmode_ccm_init, \
 396 .set_iv = ccmode_ccm_set_iv, \
 397 .cbcmac = ccmode_ccm_cbcmac, \
 398 .ccm = ccmode_ccm_decrypt, \
 399 .finalize = ccmode_ccm_finalize, \
 400 .reset = ccmode_ccm_reset, \
 401 .custom = (ECB_ENCRYPT) \
 402 }
 403
 404 /* Use this to statically initialize a ccmode_ccm object for encryption. */
 405 #define CCMODE_FACTORY_CCM_ENCRYPT(ECB_ENCRYPT) { \
 406 .size = ccn_sizeof_size(sizeof(struct _ccmode_ccm_key)) + ccn_sizeof_size((ECB_ENCRYPT)->block_size) + ccn_sizeof_size((ECB_ENCRYPT)->size), \
 407 .nonce_size = ccn_sizeof_size(sizeof(struct _ccmode_ccm_nonce)), \
 408 .block_size = 1, \
 409 .init = ccmode_ccm_init, \
 410 .set_iv = ccmode_ccm_set_iv, \
 411 .cbcmac = ccmode_ccm_cbcmac, \
 412 .ccm = ccmode_ccm_encrypt, \
 413 .finalize = ccmode_ccm_finalize, \
 414 .reset = ccmode_ccm_reset, \
 415 .custom = (ECB_ENCRYPT) \
 416 }
 417
 418 /* Use these function to runtime initialize a ccmode_ccm decrypt object (for
 419  example if it's part of a larger structure). For CCM you always pass a
 420  ecb encrypt mode implementation of some underlying algorithm as the ecb
 421  parameter. */
 422
 423 void ccmode_factory_ccm_decrypt(struct ccmode_ccm *ccm,
 424                                 const struct ccmode_ecb *ecb_encrypt);
 425
 426 /* Use these function to runtime initialize a ccmode_ccm encrypt object (for
 427  example if it's part of a larger structure). For CCM you always pass a
 428  ecb encrypt mode implementation of some underlying algorithm as the ecb
 429  parameter. */
 430 void ccmode_factory_ccm_encrypt(struct ccmode_ccm *ccm,
 431                                 const struct ccmode_ecb *ecb_encrypt);
 432
 433
 434 void ccmode_ofb_init(const struct ccmode_ofb *ofb, ccofb_ctx *ctx,
 435                      size_t rawkey_len, const void *rawkey,
 436                      const void *iv);
 437 void ccmode_ofb_crypt(ccofb_ctx *ctx, size_t nbytes,
 438                       const void *in, void *out);
 439
 440 struct _ccmode_ofb_key {
 441     const struct ccmode_ecb *ecb;
 442     size_t pad_len;
 443     cc_unit u[];
 444 };
 445
 446 /* Use this to statically initialize a ccmode_ofb object. */
 447 #define CCMODE_FACTORY_OFB_CRYPT(ECB) { \
 448 .size = ccn_sizeof_size(sizeof(struct _ccmode_ofb_key)) + ccn_sizeof_size((ECB)->block_size) + ccn_sizeof_size((ECB)->size), \
 449 .block_size = 1, \
 450 .init = ccmode_ofb_init, \
 451 .ofb = ccmode_ofb_crypt, \
 452 .custom = (ECB) \
 453 }
 454
 455 /* Use these function to runtime initialize a ccmode_ofb encrypt object (for
 456  example if it's part of a larger structure). Normally you would pass a
 457  ecb encrypt mode implementation of some underlying algorithm as the ecb
 458  parameter. */
 459 void ccmode_factory_ofb_crypt(struct ccmode_ofb *ofb,
 460                               const struct ccmode_ecb *ecb);
 461
 462 int ccmode_omac_decrypt(ccomac_ctx *ctx, size_t nblocks,
 463                         const void *tweak, const void *in, void *out);
 464 int ccmode_omac_encrypt(ccomac_ctx *ctx, size_t nblocks,
 465                         const void *tweak, const void *in, void *out);
 466
 467 /* Create a omac key from a omac mode object.  The tweak_len here
 468  determines how long the tweak is in bytes, for each subsequent call to
 469  ccmode_omac->omac().
 470  key must point to at least sizeof(CCMODE_OMAC_KEY(ecb)) bytes of free
 471  storage. */
 472 void ccmode_omac_init(const struct ccmode_omac *omac, ccomac_ctx *ctx,
 473                       size_t tweak_len, size_t rawkey_len,
 474                       const void *rawkey);
 475
 476 struct _ccmode_omac_key {
 477     const struct ccmode_ecb *ecb;
 478     size_t tweak_len;
 479     cc_unit u[];
 480 };
 481
 482 /* Use this to statically initialize a ccmode_omac object for decryption. */
 483 #define CCMODE_FACTORY_OMAC_DECRYPT(ECB) { \
 484 .size = ccn_sizeof_size(sizeof(struct _ccmode_omac_key)) + 2 * ccn_sizeof_size((ECB)->size), \
 485 .block_size = (ECB)->block_size, \
 486 .init = ccmode_omac_init, \
 487 .omac = ccmode_omac_decrypt, \
 488 .custom = (ECB) \
 489 }
 490
 491 /* Use this to statically initialize a ccmode_omac object for encryption. */
 492 #define CCMODE_FACTORY_OMAC_ENCRYPT(ECB) { \
 493 .size = ccn_sizeof_size(sizeof(struct _ccmode_omac_key)) + 2 * ccn_sizeof_size((ECB)->size), \
 494 .block_size = (ECB)->block_size, \
 495 .init = ccmode_omac_init, \
 496 .omac = ccmode_omac_encrypt, \
 497 .custom = (ECB) \
 498 }
 499
 500 /* Use these function to runtime initialize a ccmode_omac decrypt object (for
 501  example if it's part of a larger structure). Normally you would pass a
 502  ecb decrypt mode implementation of some underlying algorithm as the ecb
 503  parameter. */
 504 void ccmode_factory_omac_decrypt(struct ccmode_omac *omac,
 505                                  const struct ccmode_ecb *ecb);
 506
 507 /* Use these function to runtime initialize a ccmode_omac encrypt object (for
 508  example if it's part of a larger structure). Normally you would pass a
 509  ecb encrypt mode implementation of some underlying algorithm as the ecb
 510  parameter. */
 511 void ccmode_factory_omac_encrypt(struct ccmode_omac *omac,
 512                                  const struct ccmode_ecb *ecb);
 513
 514
 515 /* Function prototypes used by the macros below, do not call directly. */
 516 void ccmode_xts_init(const struct ccmode_xts *xts, ccxts_ctx *ctx,
 517                      size_t key_len, const void *data_key,
 518                      const void *tweak_key);
 519 void *ccmode_xts_crypt(const ccxts_ctx *ctx, ccxts_tweak *tweak,
 520                        size_t nblocks, const void *in, void *out);
 521 void ccmode_xts_set_tweak(const ccxts_ctx *ctx, ccxts_tweak *tweak,
 522                           const void *iv);
 523
 524
 525 struct _ccmode_xts_key {
 526     const struct ccmode_ecb *ecb;
 527     const struct ccmode_ecb *ecb_encrypt;
 528     cc_unit u[];
 529 };
 530
 531 struct _ccmode_xts_tweak {
 532     // FIPS requires that for XTS that no more that 2^20 AES blocks may be processed for any given
 533     // Key, Tweak Key, and tweak combination
 534     // the bytes_processed field in the context will accumuate the number of blocks processed and
 535     // will fail the encrypt/decrypt if the size is violated.  This counter will be reset to 0
 536     // when set_tweak is called.
 537     size_t  blocks_processed;
 538     cc_unit u[];
 539 };
 540
 541 /* Use this to statically initialize a ccmode_xts object for decryption. */
 542 #define CCMODE_FACTORY_XTS_DECRYPT(ECB, ECB_ENCRYPT) { \
 543 .size = ccn_sizeof_size(sizeof(struct _ccmode_xts_key)) + 2 * ccn_sizeof_size((ECB)->size), \
 544 .tweak_size = ccn_sizeof_size(sizeof(struct _ccmode_xts_tweak)) + ccn_sizeof_size(ecb->block_size), \
 545 .block_size = ecb->block_size, \
 546 .init = ccmode_xts_init, \
 547 .set_tweak = ccmode_xts_set_tweak, \
 548 .xts = ccmode_xts_crypt, \
 549 .custom = (ECB), \
 550 .custom1 = (ECB_ENCRYPT) \
 551 }
 552
 553 /* Use this to statically initialize a ccmode_xts object for encryption. */
 554 #define CCMODE_FACTORY_XTS_ENCRYPT(ECB, ECB_ENCRYPT) { \
 555 .size = ccn_sizeof_size(sizeof(struct _ccmode_xts_key)) + 2 * ccn_sizeof_size((ECB)->size), \
 556 .tweak_size = ccn_sizeof_size(sizeof(struct _ccmode_xts_tweak)) + ccn_sizeof_size(ecb->block_size), \
 557 .block_size = ecb->block_size, \
 558 .init = ccmode_xts_init, \
 559 .set_tweak = ccmode_xts_set_tweak, \
 560 .xts = ccmode_xts_crypt, \
 561 .custom = (ECB), \
 562 .custom1 = (ECB_ENCRYPT) \
 563 }
 564
 565 /* Use these function to runtime initialize a ccmode_xts decrypt object (for
 566  example if it's part of a larger structure). Normally you would pass a
 567  ecb decrypt mode implementation of some underlying algorithm as the ecb
 568  parameter. */
 569 void ccmode_factory_xts_decrypt(struct ccmode_xts *xts,
 570                                 const struct ccmode_ecb *ecb,
 571                                 const struct ccmode_ecb *ecb_encrypt);
 572
 573 /* Use these function to runtime initialize a ccmode_xts encrypt object (for
 574  example if it's part of a larger structure). Normally you would pass a
 575  ecb encrypt mode implementation of some underlying algorithm as the ecb
 576  parameter. */
 577 void ccmode_factory_xts_encrypt(struct ccmode_xts *xts,
 578                                 const struct ccmode_ecb *ecb,
 579                                 const struct ccmode_ecb *ecb_encrypt);
 580
 581 #endif /* _CORECRYPTO_CCMODE_FACTORY_H_ */