2 * Copyright 2019-2023 The OpenSSL Project Authors. All Rights Reserved.
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
11 * This file uses the low level AES functions (which are deprecated for
12 * non-internal use) in order to implement provider AES ciphers.
14 #include "internal/deprecated.h"
16 #include "cipher_aes_xts.h"
18 #define XTS_SET_KEY_FN(fn_set_enc_key, fn_set_dec_key, \
19 fn_block_enc, fn_block_dec, \
20 fn_stream_enc, fn_stream_dec) { \
21 size_t bytes = keylen / 2; \
22 size_t bits = bytes * 8; \
25 fn_set_enc_key(key, bits, &xctx->ks1.ks); \
26 xctx->xts.block1 = (block128_f)fn_block_enc; \
28 fn_set_dec_key(key, bits, &xctx->ks1.ks); \
29 xctx->xts.block1 = (block128_f)fn_block_dec; \
31 fn_set_enc_key(key + bytes, bits, &xctx->ks2.ks); \
32 xctx->xts.block2 = (block128_f)fn_block_enc; \
33 xctx->xts.key1 = &xctx->ks1; \
34 xctx->xts.key2 = &xctx->ks2; \
35 xctx->stream = ctx->enc ? fn_stream_enc : fn_stream_dec; \
38 static int cipher_hw_aes_xts_generic_initkey(PROV_CIPHER_CTX
*ctx
,
39 const unsigned char *key
,
42 PROV_AES_XTS_CTX
*xctx
= (PROV_AES_XTS_CTX
*)ctx
;
43 OSSL_xts_stream_fn stream_enc
= NULL
;
44 OSSL_xts_stream_fn stream_dec
= NULL
;
47 stream_enc
= AES_xts_encrypt
;
48 stream_dec
= AES_xts_decrypt
;
49 #endif /* AES_XTS_ASM */
53 # ifdef HWAES_xts_encrypt
54 stream_enc
= HWAES_xts_encrypt
;
55 # endif /* HWAES_xts_encrypt */
56 # ifdef HWAES_xts_decrypt
57 stream_dec
= HWAES_xts_decrypt
;
58 # endif /* HWAES_xts_decrypt */
59 XTS_SET_KEY_FN(HWAES_set_encrypt_key
, HWAES_set_decrypt_key
,
60 HWAES_encrypt
, HWAES_decrypt
,
61 stream_enc
, stream_dec
);
64 #endif /* HWAES_CAPABLE */
68 stream_enc
= ossl_bsaes_xts_encrypt
;
69 stream_dec
= ossl_bsaes_xts_decrypt
;
71 #endif /* BSAES_CAPABLE */
74 XTS_SET_KEY_FN(vpaes_set_encrypt_key
, vpaes_set_decrypt_key
,
75 vpaes_encrypt
, vpaes_decrypt
, stream_enc
, stream_dec
);
78 #endif /* VPAES_CAPABLE */
83 XTS_SET_KEY_FN(AES_set_encrypt_key
, AES_set_decrypt_key
,
84 AES_encrypt
, AES_decrypt
, stream_enc
, stream_dec
);
89 static void cipher_hw_aes_xts_copyctx(PROV_CIPHER_CTX
*dst
,
90 const PROV_CIPHER_CTX
*src
)
92 PROV_AES_XTS_CTX
*sctx
= (PROV_AES_XTS_CTX
*)src
;
93 PROV_AES_XTS_CTX
*dctx
= (PROV_AES_XTS_CTX
*)dst
;
96 dctx
->xts
.key1
= &dctx
->ks1
.ks
;
97 dctx
->xts
.key2
= &dctx
->ks2
.ks
;
100 #if defined(AESNI_CAPABLE)
102 static int cipher_hw_aesni_xts_initkey(PROV_CIPHER_CTX
*ctx
,
103 const unsigned char *key
, size_t keylen
)
105 PROV_AES_XTS_CTX
*xctx
= (PROV_AES_XTS_CTX
*)ctx
;
107 XTS_SET_KEY_FN(aesni_set_encrypt_key
, aesni_set_decrypt_key
,
108 aesni_encrypt
, aesni_decrypt
,
109 aesni_xts_encrypt
, aesni_xts_decrypt
);
113 # define PROV_CIPHER_HW_declare_xts() \
114 static const PROV_CIPHER_HW aesni_xts = { \
115 cipher_hw_aesni_xts_initkey, \
117 cipher_hw_aes_xts_copyctx \
119 # define PROV_CIPHER_HW_select_xts() \
123 # elif defined(SPARC_AES_CAPABLE)
125 static int cipher_hw_aes_xts_t4_initkey(PROV_CIPHER_CTX
*ctx
,
126 const unsigned char *key
, size_t keylen
)
128 PROV_AES_XTS_CTX
*xctx
= (PROV_AES_XTS_CTX
*)ctx
;
129 OSSL_xts_stream_fn stream_enc
= NULL
;
130 OSSL_xts_stream_fn stream_dec
= NULL
;
132 /* Note: keylen is the size of 2 keys */
135 stream_enc
= aes128_t4_xts_encrypt
;
136 stream_dec
= aes128_t4_xts_decrypt
;
139 stream_enc
= aes256_t4_xts_encrypt
;
140 stream_dec
= aes256_t4_xts_decrypt
;
146 XTS_SET_KEY_FN(aes_t4_set_encrypt_key
, aes_t4_set_decrypt_key
,
147 aes_t4_encrypt
, aes_t4_decrypt
,
148 stream_enc
, stream_dec
);
152 # define PROV_CIPHER_HW_declare_xts() \
153 static const PROV_CIPHER_HW aes_xts_t4 = { \
154 cipher_hw_aes_xts_t4_initkey, \
156 cipher_hw_aes_xts_copyctx \
158 # define PROV_CIPHER_HW_select_xts() \
159 if (SPARC_AES_CAPABLE) \
162 #elif defined(__riscv) && __riscv_xlen == 64
164 static int cipher_hw_aes_xts_rv64i_zknd_zkne_initkey(PROV_CIPHER_CTX
*ctx
,
165 const unsigned char *key
,
168 PROV_AES_XTS_CTX
*xctx
= (PROV_AES_XTS_CTX
*)ctx
;
169 OSSL_xts_stream_fn stream_enc
= NULL
;
170 OSSL_xts_stream_fn stream_dec
= NULL
;
172 XTS_SET_KEY_FN(rv64i_zkne_set_encrypt_key
, rv64i_zknd_set_decrypt_key
,
173 rv64i_zkne_encrypt
, rv64i_zknd_decrypt
,
174 stream_enc
, stream_dec
);
178 # define PROV_CIPHER_HW_declare_xts() \
179 static const PROV_CIPHER_HW aes_xts_rv64i_zknd_zkne = { \
180 cipher_hw_aes_xts_rv64i_zknd_zkne_initkey, \
182 cipher_hw_aes_xts_copyctx \
184 # define PROV_CIPHER_HW_select_xts() \
185 if (RISCV_HAS_ZKND_AND_ZKNE()) \
186 return &aes_xts_rv64i_zknd_zkne;
188 #elif defined(__riscv) && __riscv_xlen == 32
190 static int cipher_hw_aes_xts_rv32i_zknd_zkne_initkey(PROV_CIPHER_CTX
*ctx
,
191 const unsigned char *key
,
194 PROV_AES_XTS_CTX
*xctx
= (PROV_AES_XTS_CTX
*)ctx
;
196 XTS_SET_KEY_FN(rv32i_zkne_set_encrypt_key
, rv32i_zknd_zkne_set_decrypt_key
,
197 rv32i_zkne_encrypt
, rv32i_zknd_decrypt
,
202 static int cipher_hw_aes_xts_rv32i_zbkb_zknd_zkne_initkey(PROV_CIPHER_CTX
*ctx
,
203 const unsigned char *key
,
206 PROV_AES_XTS_CTX
*xctx
= (PROV_AES_XTS_CTX
*)ctx
;
208 XTS_SET_KEY_FN(rv32i_zbkb_zkne_set_encrypt_key
, rv32i_zbkb_zknd_zkne_set_decrypt_key
,
209 rv32i_zkne_encrypt
, rv32i_zknd_decrypt
,
214 # define PROV_CIPHER_HW_declare_xts() \
215 static const PROV_CIPHER_HW aes_xts_rv32i_zknd_zkne = { \
216 cipher_hw_aes_xts_rv32i_zknd_zkne_initkey, \
218 cipher_hw_aes_xts_copyctx \
220 static const PROV_CIPHER_HW aes_xts_rv32i_zbkb_zknd_zkne = { \
221 cipher_hw_aes_xts_rv32i_zbkb_zknd_zkne_initkey, \
223 cipher_hw_aes_xts_copyctx \
225 # define PROV_CIPHER_HW_select_xts() \
226 if (RISCV_HAS_ZBKB_AND_ZKND_AND_ZKNE()) \
227 return &aes_xts_rv32i_zbkb_zknd_zkne; \
228 if (RISCV_HAS_ZKND_ZKNE()) \
229 return &aes_xts_rv32i_zknd_zkne;
231 /* The generic case */
232 # define PROV_CIPHER_HW_declare_xts()
233 # define PROV_CIPHER_HW_select_xts()
236 static const PROV_CIPHER_HW aes_generic_xts
= {
237 cipher_hw_aes_xts_generic_initkey
,
239 cipher_hw_aes_xts_copyctx
241 PROV_CIPHER_HW_declare_xts()
242 const PROV_CIPHER_HW
*ossl_prov_cipher_hw_aes_xts(size_t keybits
)
244 PROV_CIPHER_HW_select_xts()
245 return &aes_generic_xts
;