blob: ad407f2ea39bd77829d60299bff4c2a3bedb13bb [file] [log] [blame]
Paul Bakker5121ce52009-01-03 21:22:43 +00001/**
2 * \file padlock.h
Paul Bakkere0ccd0a2009-01-04 16:27:10 +00003 *
Paul Bakkerb9e4e2c2014-05-01 14:18:25 +02004 * \brief VIA PadLock ACE for HW encryption/decryption supported by some
5 * processors
Manuel Pégourié-Gonnardad54c492018-12-13 11:15:26 +01006 *
Manuel Pégourié-Gonnardb66e7db2018-12-18 09:57:18 +01007 * \warning These functions are only for internal use by other library
8 * functions; you must not call them directly.
Darryl Greena40a1012018-01-05 15:33:17 +00009 */
10/*
Bence Szépkúti1e148272020-08-07 13:07:28 +020011 * Copyright The Mbed TLS Contributors
Manuel Pégourié-Gonnard37ff1402015-09-04 14:21:07 +020012 * SPDX-License-Identifier: Apache-2.0
13 *
14 * Licensed under the Apache License, Version 2.0 (the "License"); you may
15 * not use this file except in compliance with the License.
16 * You may obtain a copy of the License at
17 *
18 * http://www.apache.org/licenses/LICENSE-2.0
19 *
20 * Unless required by applicable law or agreed to in writing, software
21 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
22 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
23 * See the License for the specific language governing permissions and
24 * limitations under the License.
Paul Bakker5121ce52009-01-03 21:22:43 +000025 */
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020026#ifndef MBEDTLS_PADLOCK_H
27#define MBEDTLS_PADLOCK_H
Paul Bakker5121ce52009-01-03 21:22:43 +000028
Bence Szépkútic662b362021-05-27 11:25:03 +020029#include "mbedtls/build_info.h"
Ron Eldor8b0cf2e2018-02-14 16:02:41 +020030
Jaeden Ameroc49fbbf2019-07-04 20:01:14 +010031#include "mbedtls/aes.h"
Paul Bakker5121ce52009-01-03 21:22:43 +000032
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020033#define MBEDTLS_ERR_PADLOCK_DATA_MISALIGNED -0x0030 /**< Input data should be aligned. */
Paul Bakker70338f52011-05-23 10:19:31 +000034
Manuel Pégourié-Gonnardf659f0c2015-08-04 22:19:05 +020035#if defined(__has_feature)
36#if __has_feature(address_sanitizer)
37#define MBEDTLS_HAVE_ASAN
38#endif
39#endif
40
41/* Some versions of ASan result in errors about not enough registers */
42#if defined(MBEDTLS_HAVE_ASM) && defined(__GNUC__) && defined(__i386__) && \
Manuel Pégourié-Gonnarde14dec62015-08-04 22:49:07 +020043 !defined(MBEDTLS_HAVE_ASAN)
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020044#ifndef MBEDTLS_HAVE_X86
45#define MBEDTLS_HAVE_X86
Paul Bakker5121ce52009-01-03 21:22:43 +000046#endif
47
Manuel Pégourié-Gonnardab229102015-04-15 11:53:16 +020048#include <stdint.h>
Paul Bakker5c2364c2012-10-01 14:41:15 +000049
Jerry Yu36606232023-04-19 10:44:29 +080050#if !defined(MBEDTLS_PADLOCK_C) && defined(MBEDTLS_AES_USE_HARDWARE_ONLY)
Jerry Yu8840a8c2023-04-19 10:18:50 +080051#error "MBEDTLS_AES_C defined, but not all prerequisites"
Jerry Yu4d030f32023-04-18 11:25:18 +080052#endif
53
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020054#define MBEDTLS_PADLOCK_RNG 0x000C
55#define MBEDTLS_PADLOCK_ACE 0x00C0
56#define MBEDTLS_PADLOCK_PHE 0x0C00
57#define MBEDTLS_PADLOCK_PMM 0x3000
Paul Bakker5121ce52009-01-03 21:22:43 +000058
Hanno Becker1eeca412018-10-15 12:01:35 +010059#define MBEDTLS_PADLOCK_ALIGN16(x) (uint32_t *) (16 + ((int32_t) (x) & ~15))
Paul Bakker5121ce52009-01-03 21:22:43 +000060
61#ifdef __cplusplus
62extern "C" {
63#endif
64
65/**
Manuel Pégourié-Gonnardad54c492018-12-13 11:15:26 +010066 * \brief Internal PadLock detection routine
67 *
68 * \note This function is only for internal use by other library
69 * functions; you must not call it directly.
Paul Bakker5121ce52009-01-03 21:22:43 +000070 *
Paul Bakkera36d23e2013-12-30 17:57:27 +010071 * \param feature The feature to detect
Paul Bakker13e2dfe2009-07-28 07:18:38 +000072 *
Dave Rodgmanc1ae30a2021-05-18 18:59:37 +010073 * \return non-zero if CPU has support for the feature, 0 otherwise
Paul Bakker5121ce52009-01-03 21:22:43 +000074 */
Jerry Yu36606232023-04-19 10:44:29 +080075#if !defined(MBEDTLS_AES_USE_HARDWARE_ONLY)
Gilles Peskine449bd832023-01-11 14:50:10 +010076int mbedtls_padlock_has_support(int feature);
Jerry Yu0d4f4e52023-03-31 14:32:47 +080077#else
78#define /* no-check-names */ mbedtls_padlock_has_support(feature) 1
79#endif
Paul Bakker5121ce52009-01-03 21:22:43 +000080
81/**
Manuel Pégourié-Gonnardad54c492018-12-13 11:15:26 +010082 * \brief Internal PadLock AES-ECB block en(de)cryption
83 *
84 * \note This function is only for internal use by other library
85 * functions; you must not call it directly.
Paul Bakker5121ce52009-01-03 21:22:43 +000086 *
87 * \param ctx AES context
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +020088 * \param mode MBEDTLS_AES_ENCRYPT or MBEDTLS_AES_DECRYPT
Paul Bakker5121ce52009-01-03 21:22:43 +000089 * \param input 16-byte input block
90 * \param output 16-byte output block
91 *
92 * \return 0 if success, 1 if operation failed
93 */
Gilles Peskine449bd832023-01-11 14:50:10 +010094int mbedtls_padlock_xcryptecb(mbedtls_aes_context *ctx,
95 int mode,
96 const unsigned char input[16],
97 unsigned char output[16]);
Paul Bakker5121ce52009-01-03 21:22:43 +000098
99/**
Manuel Pégourié-Gonnardad54c492018-12-13 11:15:26 +0100100 * \brief Internal PadLock AES-CBC buffer en(de)cryption
101 *
102 * \note This function is only for internal use by other library
103 * functions; you must not call it directly.
Paul Bakker5121ce52009-01-03 21:22:43 +0000104 *
105 * \param ctx AES context
Manuel Pégourié-Gonnard2cf5a7c2015-04-08 12:49:31 +0200106 * \param mode MBEDTLS_AES_ENCRYPT or MBEDTLS_AES_DECRYPT
Paul Bakker5121ce52009-01-03 21:22:43 +0000107 * \param length length of the input data
108 * \param iv initialization vector (updated after use)
109 * \param input buffer holding the input data
110 * \param output buffer holding the output data
111 *
112 * \return 0 if success, 1 if operation failed
113 */
Gilles Peskine449bd832023-01-11 14:50:10 +0100114int mbedtls_padlock_xcryptcbc(mbedtls_aes_context *ctx,
115 int mode,
116 size_t length,
117 unsigned char iv[16],
118 const unsigned char *input,
119 unsigned char *output);
Paul Bakker5121ce52009-01-03 21:22:43 +0000120
121#ifdef __cplusplus
122}
123#endif
124
125#endif /* HAVE_X86 */
126
127#endif /* padlock.h */