blob: a054cfd5c13c3f4e5b407e6f418dd73356c89a73 [file] [log] [blame]
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +01001/**
2 * \file aesni.h
3 *
4 * \brief AES-NI for hardware AES acceleration on some Intel processors
Andrzej Kurekc470b6b2019-01-31 08:20:20 -05005 *
6 * \warning These functions are only for internal use by other library
7 * functions; you must not call them directly.
Darryl Greena40a1012018-01-05 15:33:17 +00008 */
9/*
Bence Szépkúti1e148272020-08-07 13:07:28 +020010 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +020011 * SPDX-License-Identifier: Apache-2.0
12 *
13 * Licensed under the Apache License, Version 2.0 (the "License"); you may
14 * not use this file except in compliance with the License.
15 * You may obtain a copy of the License at
16 *
17 * http://www.apache.org/licenses/LICENSE-2.0
18 *
19 * Unless required by applicable law or agreed to in writing, software
20 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
21 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
22 * See the License for the specific language governing permissions and
23 * limitations under the License.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +010024 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020025#ifndef MBEDTLS_AESNI_H
26#define MBEDTLS_AESNI_H
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +010027
Bence Szépkútic662b362021-05-27 11:25:03 +020028#include "mbedtls/build_info.h"
Andrzej Kurekc470b6b2019-01-31 08:20:20 -050029
Jaeden Ameroc49fbbf2019-07-04 20:01:14 +010030#include "mbedtls/aes.h"
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +010031
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020032#define MBEDTLS_AESNI_AES 0x02000000u
33#define MBEDTLS_AESNI_CLMUL 0x00000002u
Manuel Pégourié-Gonnard8eaf20b2013-12-18 19:14:53 +010034
Gilles Peskine9c682e72023-03-16 17:21:33 +010035/* Can we do AESNI with inline assembly?
36 * (Only implemented with gas syntax, only for 64-bit.)
37 */
Gilles Peskine9af58cd2023-03-10 22:29:32 +010038#if defined(MBEDTLS_HAVE_ASM) && defined(__GNUC__) && \
Gilles Peskine449bd832023-01-11 14:50:10 +010039 (defined(__amd64__) || defined(__x86_64__)) && \
40 !defined(MBEDTLS_HAVE_X86_64)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020041#define MBEDTLS_HAVE_X86_64
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +010042#endif
43
Gilles Peskine9af58cd2023-03-10 22:29:32 +010044#if defined(MBEDTLS_AESNI_C)
45
Gilles Peskine9c682e72023-03-16 17:21:33 +010046/* Can we do AESNI with intrinsics?
Gilles Peskine30e9f2a2023-03-17 17:29:58 +010047 * (Only implemented with certain compilers, only for certain targets.)
Gilles Peskine9c682e72023-03-16 17:21:33 +010048 */
49#undef MBEDTLS_AESNI_HAVE_INTRINSICS
Gilles Peskine9af58cd2023-03-10 22:29:32 +010050#if defined(_MSC_VER)
Gilles Peskine9c682e72023-03-16 17:21:33 +010051/* Visual Studio supports AESNI intrinsics since VS 2008 SP1. We only support
52 * VS 2013 and up for other reasons anyway, so no need to check the version. */
53#define MBEDTLS_AESNI_HAVE_INTRINSICS
Gilles Peskine9af58cd2023-03-10 22:29:32 +010054#endif
Gilles Peskine9c682e72023-03-16 17:21:33 +010055/* GCC-like compilers: currently, we only support intrinsics if the requisite
56 * target flag is enabled when building the library (e.g. `gcc -mpclmul -msse2`
57 * or `clang -maes -mpclmul`). */
58#if defined(__GNUC__) && defined(__AES__) && defined(__PCLMUL__)
59#define MBEDTLS_AESNI_HAVE_INTRINSICS
Gilles Peskine9af58cd2023-03-10 22:29:32 +010060#endif
61
Gilles Peskine9c682e72023-03-16 17:21:33 +010062/* Choose the implementation of AESNI, if one is available. */
63#undef MBEDTLS_AESNI_HAVE_CODE
Dave Rodgman6365a682023-05-22 11:14:36 +010064/* Favor the intrinsics-based implementation if it's available, for better
65 * maintainability.
66 * Performance is about the same (see #7380).
67 * In the long run, we will likely remove the assembly implementation. */
68#if defined(MBEDTLS_AESNI_HAVE_INTRINSICS)
Gilles Peskine9c682e72023-03-16 17:21:33 +010069#define MBEDTLS_AESNI_HAVE_CODE 2 // via intrinsics
Dave Rodgman6365a682023-05-22 11:14:36 +010070#elif defined(MBEDTLS_HAVE_X86_64)
71#define MBEDTLS_AESNI_HAVE_CODE 1 // via assembly
Gilles Peskine9af58cd2023-03-10 22:29:32 +010072#endif
73
74#if defined(MBEDTLS_AESNI_HAVE_CODE)
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +010075
Manuel Pégourié-Gonnard1a901472015-03-10 16:12:29 +000076#ifdef __cplusplus
77extern "C" {
78#endif
79
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +010080/**
Andrzej Kurekc470b6b2019-01-31 08:20:20 -050081 * \brief Internal function to detect the AES-NI feature in CPUs.
82 *
83 * \note This function is only for internal use by other library
84 * functions; you must not call it directly.
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +010085 *
Manuel Pégourié-Gonnard8eaf20b2013-12-18 19:14:53 +010086 * \param what The feature to detect
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020087 * (MBEDTLS_AESNI_AES or MBEDTLS_AESNI_CLMUL)
Manuel Pégourié-Gonnard8eaf20b2013-12-18 19:14:53 +010088 *
89 * \return 1 if CPU has support for the feature, 0 otherwise
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +010090 */
Gilles Peskine449bd832023-01-11 14:50:10 +010091int mbedtls_aesni_has_support(unsigned int what);
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +010092
Manuel Pégourié-Gonnard5b685652013-12-18 11:45:21 +010093/**
Andrzej Kurekc470b6b2019-01-31 08:20:20 -050094 * \brief Internal AES-NI AES-ECB block encryption and decryption
95 *
96 * \note This function is only for internal use by other library
97 * functions; you must not call it directly.
Manuel Pégourié-Gonnard5b685652013-12-18 11:45:21 +010098 *
99 * \param ctx AES context
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200100 * \param mode MBEDTLS_AES_ENCRYPT or MBEDTLS_AES_DECRYPT
Manuel Pégourié-Gonnard5b685652013-12-18 11:45:21 +0100101 * \param input 16-byte input block
102 * \param output 16-byte output block
103 *
Manuel Pégourié-Gonnardd333f672013-12-26 11:44:46 +0100104 * \return 0 on success (cannot fail)
Manuel Pégourié-Gonnard5b685652013-12-18 11:45:21 +0100105 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100106int mbedtls_aesni_crypt_ecb(mbedtls_aes_context *ctx,
107 int mode,
108 const unsigned char input[16],
109 unsigned char output[16]);
Manuel Pégourié-Gonnard5b685652013-12-18 11:45:21 +0100110
Manuel Pégourié-Gonnardd333f672013-12-26 11:44:46 +0100111/**
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500112 * \brief Internal GCM multiplication: c = a * b in GF(2^128)
113 *
114 * \note This function is only for internal use by other library
115 * functions; you must not call it directly.
Manuel Pégourié-Gonnardd333f672013-12-26 11:44:46 +0100116 *
117 * \param c Result
118 * \param a First operand
119 * \param b Second operand
120 *
121 * \note Both operands and result are bit strings interpreted as
122 * elements of GF(2^128) as per the GCM spec.
Manuel Pégourié-Gonnardd333f672013-12-26 11:44:46 +0100123 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100124void mbedtls_aesni_gcm_mult(unsigned char c[16],
125 const unsigned char a[16],
126 const unsigned char b[16]);
Manuel Pégourié-Gonnardd333f672013-12-26 11:44:46 +0100127
Manuel Pégourié-Gonnard01e31bb2013-12-28 15:58:30 +0100128/**
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500129 * \brief Internal round key inversion. This function computes
130 * decryption round keys from the encryption round keys.
131 *
132 * \note This function is only for internal use by other library
133 * functions; you must not call it directly.
Manuel Pégourié-Gonnard01e31bb2013-12-28 15:58:30 +0100134 *
135 * \param invkey Round keys for the equivalent inverse cipher
136 * \param fwdkey Original round keys (for encryption)
137 * \param nr Number of rounds (that is, number of round keys minus one)
138 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100139void mbedtls_aesni_inverse_key(unsigned char *invkey,
140 const unsigned char *fwdkey,
141 int nr);
Manuel Pégourié-Gonnard01e31bb2013-12-28 15:58:30 +0100142
Manuel Pégourié-Gonnard47a35362013-12-28 20:45:04 +0100143/**
Andrzej Kurekc470b6b2019-01-31 08:20:20 -0500144 * \brief Internal key expansion for encryption
145 *
146 * \note This function is only for internal use by other library
147 * functions; you must not call it directly.
Manuel Pégourié-Gonnard47a35362013-12-28 20:45:04 +0100148 *
149 * \param rk Destination buffer where the round keys are written
150 * \param key Encryption key
151 * \param bits Key size in bits (must be 128, 192 or 256)
152 *
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200153 * \return 0 if successful, or MBEDTLS_ERR_AES_INVALID_KEY_LENGTH
Manuel Pégourié-Gonnard47a35362013-12-28 20:45:04 +0100154 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100155int mbedtls_aesni_setkey_enc(unsigned char *rk,
156 const unsigned char *key,
157 size_t bits);
Manuel Pégourié-Gonnard47a35362013-12-28 20:45:04 +0100158
Manuel Pégourié-Gonnard1a901472015-03-10 16:12:29 +0000159#ifdef __cplusplus
160}
161#endif
162
Gilles Peskine9af58cd2023-03-10 22:29:32 +0100163#endif /* MBEDTLS_AESNI_HAVE_CODE */
164#endif /* MBEDTLS_AESNI_C */
Manuel Pégourié-Gonnard92ac76f2013-12-16 17:12:53 +0100165
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200166#endif /* MBEDTLS_AESNI_H */