xref: /xnu-8792.81.2/iokit/DriverKit/crypto/aes.h (revision 19c3b8c28c31cb8130e034cfb5df6bf9ba342d90)
1*19c3b8c2SApple OSS Distributions /*
2*19c3b8c2SApple OSS Distributions  * Copyright (c) 2012 Apple Computer, Inc. All rights reserved.
3*19c3b8c2SApple OSS Distributions  *
4*19c3b8c2SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_START@
5*19c3b8c2SApple OSS Distributions  *
6*19c3b8c2SApple OSS Distributions  * This file contains Original Code and/or Modifications of Original Code
7*19c3b8c2SApple OSS Distributions  * as defined in and that are subject to the Apple Public Source License
8*19c3b8c2SApple OSS Distributions  * Version 2.0 (the 'License'). You may not use this file except in
9*19c3b8c2SApple OSS Distributions  * compliance with the License. The rights granted to you under the License
10*19c3b8c2SApple OSS Distributions  * may not be used to create, or enable the creation or redistribution of,
11*19c3b8c2SApple OSS Distributions  * unlawful or unlicensed copies of an Apple operating system, or to
12*19c3b8c2SApple OSS Distributions  * circumvent, violate, or enable the circumvention or violation of, any
13*19c3b8c2SApple OSS Distributions  * terms of an Apple operating system software license agreement.
14*19c3b8c2SApple OSS Distributions  *
15*19c3b8c2SApple OSS Distributions  * Please obtain a copy of the License at
16*19c3b8c2SApple OSS Distributions  * http://www.opensource.apple.com/apsl/ and read it before using this file.
17*19c3b8c2SApple OSS Distributions  *
18*19c3b8c2SApple OSS Distributions  * The Original Code and all software distributed under the License are
19*19c3b8c2SApple OSS Distributions  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
20*19c3b8c2SApple OSS Distributions  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
21*19c3b8c2SApple OSS Distributions  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
22*19c3b8c2SApple OSS Distributions  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
23*19c3b8c2SApple OSS Distributions  * Please see the License for the specific language governing rights and
24*19c3b8c2SApple OSS Distributions  * limitations under the License.
25*19c3b8c2SApple OSS Distributions  *
26*19c3b8c2SApple OSS Distributions  * @APPLE_OSREFERENCE_LICENSE_HEADER_END@
27*19c3b8c2SApple OSS Distributions  */
28*19c3b8c2SApple OSS Distributions 
29*19c3b8c2SApple OSS Distributions #ifndef _AES_H
30*19c3b8c2SApple OSS Distributions #define _AES_H
31*19c3b8c2SApple OSS Distributions 
32*19c3b8c2SApple OSS Distributions #if defined(__cplusplus)
33*19c3b8c2SApple OSS Distributions extern "C"
34*19c3b8c2SApple OSS Distributions {
35*19c3b8c2SApple OSS Distributions #endif
36*19c3b8c2SApple OSS Distributions 
37*19c3b8c2SApple OSS Distributions #include <corecrypto/ccmode.h>
38*19c3b8c2SApple OSS Distributions #include <corecrypto/ccn.h>
39*19c3b8c2SApple OSS Distributions 
40*19c3b8c2SApple OSS Distributions #define AES_BLOCK_SIZE  16  /* the AES block size in bytes          */
41*19c3b8c2SApple OSS Distributions 
42*19c3b8c2SApple OSS Distributions //Unholy HACK: this works because we know the size of the context for every
43*19c3b8c2SApple OSS Distributions //possible corecrypto implementation is less than this.
44*19c3b8c2SApple OSS Distributions #if defined(__ARM_NEON__) && !defined(__arm64__)        // for expanded keys in bit slice format
45*19c3b8c2SApple OSS Distributions #define AES_CBC_CTX_MAX_SIZE (ccn_sizeof_size(sizeof(void *)) + ccn_sizeof_size(AES_BLOCK_SIZE) + ccn_sizeof_size(64*4) + (14-1)*128+32 )
46*19c3b8c2SApple OSS Distributions #else
47*19c3b8c2SApple OSS Distributions #define AES_CBC_CTX_MAX_SIZE (ccn_sizeof_size(sizeof(void *)) + ccn_sizeof_size(AES_BLOCK_SIZE) + ccn_sizeof_size(64*4))
48*19c3b8c2SApple OSS Distributions #endif
49*19c3b8c2SApple OSS Distributions 
50*19c3b8c2SApple OSS Distributions typedef struct{
51*19c3b8c2SApple OSS Distributions 	cccbc_ctx_decl(AES_CBC_CTX_MAX_SIZE, ctx);
52*19c3b8c2SApple OSS Distributions } aes_decrypt_ctx;
53*19c3b8c2SApple OSS Distributions 
54*19c3b8c2SApple OSS Distributions typedef struct{
55*19c3b8c2SApple OSS Distributions 	cccbc_ctx_decl(AES_CBC_CTX_MAX_SIZE, ctx);
56*19c3b8c2SApple OSS Distributions } aes_encrypt_ctx;
57*19c3b8c2SApple OSS Distributions 
58*19c3b8c2SApple OSS Distributions typedef struct{
59*19c3b8c2SApple OSS Distributions 	aes_decrypt_ctx decrypt;
60*19c3b8c2SApple OSS Distributions 	aes_encrypt_ctx encrypt;
61*19c3b8c2SApple OSS Distributions } aes_ctx;
62*19c3b8c2SApple OSS Distributions 
63*19c3b8c2SApple OSS Distributions 
64*19c3b8c2SApple OSS Distributions /* for compatibility with old apis*/
65*19c3b8c2SApple OSS Distributions #define aes_ret     int
66*19c3b8c2SApple OSS Distributions #define aes_good    0
67*19c3b8c2SApple OSS Distributions #define aes_error  -1
68*19c3b8c2SApple OSS Distributions #define aes_rval    aes_ret
69*19c3b8c2SApple OSS Distributions 
70*19c3b8c2SApple OSS Distributions 
71*19c3b8c2SApple OSS Distributions 
72*19c3b8c2SApple OSS Distributions /* Key lengths in the range 16 <= key_len <= 32 are given in bytes, */
73*19c3b8c2SApple OSS Distributions /* those in the range 128 <= key_len <= 256 are given in bits       */
74*19c3b8c2SApple OSS Distributions 
75*19c3b8c2SApple OSS Distributions aes_rval aes_encrypt_key(const unsigned char *key, int key_len, aes_encrypt_ctx cx[1]);
76*19c3b8c2SApple OSS Distributions aes_rval aes_encrypt_key128(const unsigned char *key, aes_encrypt_ctx cx[1]);
77*19c3b8c2SApple OSS Distributions aes_rval aes_encrypt_key256(const unsigned char *key, aes_encrypt_ctx cx[1]);
78*19c3b8c2SApple OSS Distributions 
79*19c3b8c2SApple OSS Distributions #if defined (__i386__) || defined (__x86_64__) || defined (__arm64__)
80*19c3b8c2SApple OSS Distributions aes_rval aes_encrypt(const unsigned char *in, unsigned char *out, aes_encrypt_ctx cx[1]);
81*19c3b8c2SApple OSS Distributions #endif
82*19c3b8c2SApple OSS Distributions 
83*19c3b8c2SApple OSS Distributions aes_rval aes_encrypt_cbc(const unsigned char *in_blk, const unsigned char *in_iv, unsigned int num_blk,
84*19c3b8c2SApple OSS Distributions     unsigned char *out_blk, aes_encrypt_ctx cx[1]);
85*19c3b8c2SApple OSS Distributions 
86*19c3b8c2SApple OSS Distributions 
87*19c3b8c2SApple OSS Distributions aes_rval aes_decrypt_key(const unsigned char *key, int key_len, aes_decrypt_ctx cx[1]);
88*19c3b8c2SApple OSS Distributions aes_rval aes_decrypt_key128(const unsigned char *key, aes_decrypt_ctx cx[1]);
89*19c3b8c2SApple OSS Distributions aes_rval aes_decrypt_key256(const unsigned char *key, aes_decrypt_ctx cx[1]);
90*19c3b8c2SApple OSS Distributions 
91*19c3b8c2SApple OSS Distributions #if defined (__i386__) || defined (__x86_64__) || defined (__arm64__)
92*19c3b8c2SApple OSS Distributions aes_rval aes_decrypt(const unsigned char *in, unsigned char *out, aes_decrypt_ctx cx[1]);
93*19c3b8c2SApple OSS Distributions #endif
94*19c3b8c2SApple OSS Distributions 
95*19c3b8c2SApple OSS Distributions aes_rval aes_decrypt_cbc(const unsigned char *in_blk, const unsigned char *in_iv, unsigned int num_blk,
96*19c3b8c2SApple OSS Distributions     unsigned char *out_blk, aes_decrypt_ctx cx[1]);
97*19c3b8c2SApple OSS Distributions 
98*19c3b8c2SApple OSS Distributions aes_rval aes_encrypt_key_gcm(const unsigned char *key, int key_len, ccgcm_ctx *ctx);
99*19c3b8c2SApple OSS Distributions aes_rval aes_encrypt_key_with_iv_gcm(const unsigned char *key, int key_len, const unsigned char *in_iv, ccgcm_ctx *ctx);
100*19c3b8c2SApple OSS Distributions aes_rval aes_encrypt_set_iv_gcm(const unsigned char *in_iv, unsigned int len, ccgcm_ctx *ctx);
101*19c3b8c2SApple OSS Distributions aes_rval aes_encrypt_reset_gcm(ccgcm_ctx *ctx);
102*19c3b8c2SApple OSS Distributions aes_rval aes_encrypt_inc_iv_gcm(unsigned char *out_iv, ccgcm_ctx *ctx);
103*19c3b8c2SApple OSS Distributions aes_rval aes_encrypt_aad_gcm(const unsigned char *aad, unsigned int aad_bytes, ccgcm_ctx *ctx);
104*19c3b8c2SApple OSS Distributions aes_rval aes_encrypt_gcm(const unsigned char *in_blk, unsigned int num_bytes, unsigned char *out_blk, ccgcm_ctx *ctx);
105*19c3b8c2SApple OSS Distributions aes_rval aes_encrypt_finalize_gcm(unsigned char *tag, size_t tag_bytes, ccgcm_ctx *ctx);
106*19c3b8c2SApple OSS Distributions size_t aes_encrypt_get_ctx_size_gcm(void);
107*19c3b8c2SApple OSS Distributions 
108*19c3b8c2SApple OSS Distributions aes_rval aes_decrypt_key_gcm(const unsigned char *key, int key_len, ccgcm_ctx *ctx);
109*19c3b8c2SApple OSS Distributions aes_rval aes_decrypt_key_with_iv_gcm(const unsigned char *key, int key_len, const unsigned char *in_iv, ccgcm_ctx *ctx);
110*19c3b8c2SApple OSS Distributions aes_rval aes_decrypt_set_iv_gcm(const unsigned char *in_iv, size_t len, ccgcm_ctx *ctx);
111*19c3b8c2SApple OSS Distributions aes_rval aes_decrypt_reset_gcm(ccgcm_ctx *ctx);
112*19c3b8c2SApple OSS Distributions aes_rval aes_decrypt_inc_iv_gcm(unsigned char *out_iv, ccgcm_ctx *ctx);
113*19c3b8c2SApple OSS Distributions aes_rval aes_decrypt_aad_gcm(const unsigned char *aad, unsigned int aad_bytes, ccgcm_ctx *ctx);
114*19c3b8c2SApple OSS Distributions aes_rval aes_decrypt_gcm(const unsigned char *in_blk, unsigned int num_bytes, unsigned char *out_blk, ccgcm_ctx *ctx);
115*19c3b8c2SApple OSS Distributions aes_rval aes_decrypt_finalize_gcm(unsigned char *tag, size_t tag_bytes, ccgcm_ctx *ctx);
116*19c3b8c2SApple OSS Distributions size_t aes_decrypt_get_ctx_size_gcm(void);
117*19c3b8c2SApple OSS Distributions 
118*19c3b8c2SApple OSS Distributions #if defined(__cplusplus)
119*19c3b8c2SApple OSS Distributions }
120*19c3b8c2SApple OSS Distributions #endif
121*19c3b8c2SApple OSS Distributions 
122*19c3b8c2SApple OSS Distributions #endif
123