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