]> git.saurik.com Git - apple/xnu.git/blobdiff - EXTERNAL_HEADERS/corecrypto/ccmode_impl.h
xnu-7195.50.7.100.1.tar.gz
[apple/xnu.git] / EXTERNAL_HEADERS / corecrypto / ccmode_impl.h
index 817d45070155a2ef2fb5e30b9356712dddf60822..849881ed49d74e4b9ab8ec1427e263055e6c2d3d 100644 (file)
@@ -1,11 +1,12 @@
-/*
- *  ccmode_impl.h
- *  corecrypto
- *
- *  Created on 12/07/2010
- *
- *  Copyright (c) 2012,2015 Apple Inc. All rights reserved.
+/* Copyright (c) (2010,2011,2012,2015,2016,2017,2018,2019) Apple Inc. All rights reserved.
  *
+ * corecrypto is licensed under Apple Inc.’s Internal Use License Agreement (which
+ * is contained in the License.txt file distributed with corecrypto) and only to 
+ * people who accept that license. IMPORTANT:  Any license rights granted to you by 
+ * Apple Inc. (if any) are limited to internal use within your organization only on 
+ * devices and computers you own or control, for the sole purpose of verifying the 
+ * security characteristics and correct functioning of the Apple Software.  You may 
+ * not, directly or indirectly, redistribute the Apple Software or any portions thereof.
  */
 
 #ifndef _CORECRYPTO_CCMODE_IMPL_H_
@@ -21,10 +22,11 @@ cc_aligned_struct(16) ccecb_ctx;
 struct ccmode_ecb {
     size_t size;        /* first argument to ccecb_ctx_decl(). */
     size_t block_size;
-    void (*init)(const struct ccmode_ecb *ecb, ccecb_ctx *ctx,
-                 size_t key_len, const void *key);
-    void (*ecb)(const ccecb_ctx *ctx, size_t nblocks, const void *in,
-                void *out);
+    int (*init)(const struct ccmode_ecb *ecb, ccecb_ctx *ctx,
+                size_t key_nbytes, const void *key);
+    int (*ecb)(const ccecb_ctx *ctx, size_t nblocks, const void *in,
+               void *out);
+    void (*roundkey)(const ccecb_ctx *ctx, unsigned r, void *key);
 };
 
 /*!
@@ -35,7 +37,7 @@ struct ccmode_ecb {
  *   1- ccmod_xxx_init()
  *   2- ccmod_xxx_decrypt()
  *   3- ccmod_xxx_encrypt()
- * 
+ *
  * stateful modes CCM and GCM: They provide 7 interface functions that return error codes if a function is called out of state
  *   1- ccmod_xxx_init()
  *   2- ccmod_xxx_setiv()
@@ -64,11 +66,11 @@ cc_aligned_struct(16) cccbc_iv;
 struct ccmode_cbc {
     size_t size;        /* first argument to cccbc_ctx_decl(). */
     size_t block_size;
-    void (*init)(const struct ccmode_cbc *cbc, cccbc_ctx *ctx,
-                 size_t key_len, const void *key);
+    int (*init)(const struct ccmode_cbc *cbc, cccbc_ctx *ctx,
+                size_t key_len, const void *key);
     /* cbc encrypt or decrypt nblocks from in to out, iv will be used and updated. */
-    void (*cbc)(const cccbc_ctx *ctx, cccbc_iv *iv,
-                size_t nblocks, const void *in, void *out);
+    int (*cbc)(const cccbc_ctx *ctx, cccbc_iv *iv,
+               size_t nblocks, const void *in, void *out);
     const void *custom;
 };
 
@@ -78,9 +80,9 @@ cc_aligned_struct(16) cccfb_ctx;
 struct ccmode_cfb {
     size_t size;        /* first argument to cccfb_ctx_decl(). */
     size_t block_size;
-    void (*init)(const struct ccmode_cfb *cfb, cccfb_ctx *ctx,
-                 size_t key_len, const void *key, const void *iv);
-    void (*cfb)(cccfb_ctx *ctx, size_t nbytes, const void *in, void *out);
+    int (*init)(const struct ccmode_cfb *cfb, cccfb_ctx *ctx,
+                size_t key_len, const void *key, const void *iv);
+    int (*cfb)(cccfb_ctx *ctx, size_t nbytes, const void *in, void *out);
     const void *custom;
 };
 
@@ -90,9 +92,9 @@ cc_aligned_struct(16) cccfb8_ctx;
 struct ccmode_cfb8 {
     size_t size;        /* first argument to cccfb8_ctx_decl(). */
     size_t block_size;
-    void (*init)(const struct ccmode_cfb8 *cfb8, cccfb8_ctx *ctx,
-                 size_t key_len, const void *key, const void *iv);
-    void (*cfb8)(cccfb8_ctx *ctx, size_t nbytes, const void *in, void *out);
+    int (*init)(const struct ccmode_cfb8 *cfb8, cccfb8_ctx *ctx,
+                size_t key_len, const void *key, const void *iv);
+    int (*cfb8)(cccfb8_ctx *ctx, size_t nbytes, const void *in, void *out);
     const void *custom;
 };
 
@@ -101,10 +103,12 @@ cc_aligned_struct(16) ccctr_ctx;
 
 struct ccmode_ctr {
     size_t size;        /* first argument to ccctr_ctx_decl(). */
-    size_t block_size;
-    void (*init)(const struct ccmode_ctr *ctr, ccctr_ctx *ctx,
-                 size_t key_len, const void *key, const void *iv);
-    void (*ctr)(ccctr_ctx *ctx, size_t nbytes, const void *in, void *out);
+    size_t block_size;  /* for historical reasons, this is set to 1 */
+    size_t ecb_block_size;  /* the actual block size of the underlying cipher */
+    int (*init)(const struct ccmode_ctr *mode, ccctr_ctx *ctx,
+                size_t key_len, const void *key, const void *iv);
+    int (*setctr)(const struct ccmode_ctr *mode, ccctr_ctx *ctx, const void *ctr);
+    int (*ctr)(ccctr_ctx *ctx, size_t nbytes, const void *in, void *out);
     const void *custom;
 };
 
@@ -114,9 +118,9 @@ cc_aligned_struct(16) ccofb_ctx;
 struct ccmode_ofb {
     size_t size;        /* first argument to ccofb_ctx_decl(). */
     size_t block_size;
-    void (*init)(const struct ccmode_ofb *ofb, ccofb_ctx *ctx,
-                 size_t key_len, const void *key, const void *iv);
-    void (*ofb)(ccofb_ctx *ctx, size_t nbytes, const void *in, void *out);
+    int (*init)(const struct ccmode_ofb *ofb, ccofb_ctx *ctx,
+                size_t key_len, const void *key, const void *iv);
+    int (*ofb)(ccofb_ctx *ctx, size_t nbytes, const void *in, void *out);
     const void *custom;
 };
 
@@ -125,20 +129,24 @@ cc_aligned_struct(16) ccxts_ctx;
 cc_aligned_struct(16) ccxts_tweak;
 
 struct ccmode_xts {
-    size_t size;        /* first argument to ccxts_ctx_decl(). */
-    size_t tweak_size;  /* first argument to ccxts_tweak_decl(). */
+    size_t size;        /* first argument to ccxts_ctx_decl(). Size of the ctx data structure */
+    size_t tweak_size;  /* first argument to ccxts_tweak_decl(). Size of the tweak structure, not the expected tweak size */
     size_t block_size;
 
-    /* Create a xts key from a xts mode object.  The tweak_len here
-     determines how long the tweak is in bytes, for each subsequent call to
-     ccmode_xts->xts().
-     key must point to at least 'size' cc_units of free storage.
-     tweak_key must point to at least 'tweak_size' cc_units of free storage. */
-    void (*init)(const struct ccmode_xts *xts, ccxts_ctx *ctx,
-                 size_t key_len, const void *key, const void *tweak_key);
+    /* Create a xts key from a xts mode object.
+     key must point to at least 'size' bytes of free storage.
+     tweak_key must point to at least 'tweak_size' bytes of free storage.
+     key and tweak_key must differ.
+     Returns nonzero on failure.
+     */
+    int (*init)(const struct ccmode_xts *xts, ccxts_ctx *ctx,
+                size_t key_nbytes, const void *data_key, const void *tweak_key);
+
+    void (*key_sched)(const struct ccmode_xts *xts, ccxts_ctx *ctx,
+                      size_t key_nbytes, const void *data_key, const void *tweak_key);
 
     /* Set the tweak (sector number), the block within the sector zero. */
-    void (*set_tweak)(const ccxts_ctx *ctx, ccxts_tweak *tweak, const void *iv);
+    int (*set_tweak)(const ccxts_ctx *ctx, ccxts_tweak *tweak, const void *iv);
 
     /* Encrypt blocks for a sector, clients must call set_tweak before calling
        this function. Return a pointer to the tweak buffer */
@@ -159,16 +167,16 @@ struct ccmode_gcm {
     int encdec;        //is it encrypt or decrypt object
     size_t block_size;
     int (*init)(const struct ccmode_gcm *gcm, ccgcm_ctx *ctx,
-                 size_t key_len, const void *key);
-    int (*set_iv)(ccgcm_ctx *ctx, size_t iv_size, const void *iv);
+                 size_t key_nbytes, const void *key);
+    int (*set_iv)(ccgcm_ctx *ctx, size_t iv_nbytes, const void *iv);
     int (*gmac)(ccgcm_ctx *ctx, size_t nbytes, const void *in);  // could just be gcm with NULL out
     int (*gcm)(ccgcm_ctx *ctx, size_t nbytes, const void *in, void *out);
-    int (*finalize)(ccgcm_ctx *key, size_t tag_size, void *tag);
+    int (*finalize)(ccgcm_ctx *key, size_t tag_nbytes, void *tag);
     int (*reset)(ccgcm_ctx *ctx);
     const void *custom;
 };
 
-//8- GCM mode, statful
+//8- CCM mode, stateful
 cc_aligned_struct(16) ccccm_ctx;
 cc_aligned_struct(16) ccccm_nonce;
 
@@ -187,6 +195,20 @@ struct ccmode_ccm {
     const void *custom;
 };
 
+/* We need to expose this (currently)to keep CommonCrypto happy. */
+struct _ccmode_ccm_nonce {
+    unsigned char A_i[16];      /* crypto block iv */
+    unsigned char B_i[16];      /* mac block iv */
+    unsigned char MAC[16];      /* crypted mac */
+    unsigned char buf[16];      /* crypt buffer */
+
+    uint32_t mode;         /* mode: IV -> AD -> DATA */
+    uint32_t buflen;       /* length of data in buf */
+    uint32_t b_i_len;      /* length of cbcmac data in B_i */
+
+    size_t nonce_size;
+    size_t mac_size;
+};
 
 /* OMAC mode. */
 cc_aligned_struct(16) ccomac_ctx;
@@ -194,8 +216,8 @@ cc_aligned_struct(16) ccomac_ctx;
 struct ccmode_omac {
     size_t size;        /* first argument to ccomac_ctx_decl(). */
     size_t block_size;
-    void (*init)(const struct ccmode_omac *omac, ccomac_ctx *ctx,
-                 size_t tweak_len, size_t key_len, const void *key);
+    int (*init)(const struct ccmode_omac *omac, ccomac_ctx *ctx,
+                size_t tweak_len, size_t key_len, const void *key);
     int (*omac)(ccomac_ctx *ctx, size_t nblocks,
                 const void *tweak, const void *in, void *out);
     const void *custom;