2016-05-17 18:51:26 +00:00
|
|
|
/*
|
2023-09-07 08:59:15 +00:00
|
|
|
* Copyright 2011-2023 The OpenSSL Project Authors. All Rights Reserved.
|
2016-05-17 18:51:26 +00:00
|
|
|
*
|
2018-12-06 13:03:01 +00:00
|
|
|
* Licensed under the Apache License 2.0 (the "License"). You may not use
|
2016-05-17 18:51:26 +00:00
|
|
|
* this file except in compliance with the License. You can obtain a copy
|
|
|
|
|
* in the file LICENSE in the source distribution or at
|
|
|
|
|
* https://www.openssl.org/source/license.html
|
|
|
|
|
*/
|
|
|
|
|
|
2019-09-27 22:45:57 +00:00
|
|
|
#ifndef OSSL_CRYPTO_ARM_ARCH_H
|
|
|
|
|
# define OSSL_CRYPTO_ARM_ARCH_H
|
2011-04-01 21:09:09 +00:00
|
|
|
|
2015-01-22 03:40:55 +00:00
|
|
|
# if !defined(__ARM_ARCH__)
|
|
|
|
|
# if defined(__CC_ARM)
|
|
|
|
|
# define __ARM_ARCH__ __TARGET_ARCH_ARM
|
|
|
|
|
# if defined(__BIG_ENDIAN)
|
2014-06-01 15:21:06 +00:00
|
|
|
# define __ARMEB__
|
|
|
|
|
# else
|
|
|
|
|
# define __ARMEL__
|
|
|
|
|
# endif
|
2015-01-22 03:40:55 +00:00
|
|
|
# elif defined(__GNUC__)
|
|
|
|
|
# if defined(__aarch64__)
|
|
|
|
|
# define __ARM_ARCH__ 8
|
2011-04-01 21:09:09 +00:00
|
|
|
/*
|
|
|
|
|
* Why doesn't gcc define __ARM_ARCH__? Instead it defines
|
2017-11-12 00:03:10 +00:00
|
|
|
* bunch of below macros. See all_architectures[] table in
|
2011-04-01 21:09:09 +00:00
|
|
|
* gcc/config/arm/arm.c. On a side note it defines
|
|
|
|
|
* __ARMEL__/__ARMEB__ for little-/big-endian.
|
|
|
|
|
*/
|
2015-01-22 03:40:55 +00:00
|
|
|
# elif defined(__ARM_ARCH)
|
|
|
|
|
# define __ARM_ARCH__ __ARM_ARCH
|
|
|
|
|
# elif defined(__ARM_ARCH_8A__)
|
|
|
|
|
# define __ARM_ARCH__ 8
|
|
|
|
|
# elif defined(__ARM_ARCH_7__) || defined(__ARM_ARCH_7A__) || \
|
|
|
|
|
defined(__ARM_ARCH_7R__)|| defined(__ARM_ARCH_7M__) || \
|
|
|
|
|
defined(__ARM_ARCH_7EM__)
|
|
|
|
|
# define __ARM_ARCH__ 7
|
|
|
|
|
# elif defined(__ARM_ARCH_6__) || defined(__ARM_ARCH_6J__) || \
|
|
|
|
|
defined(__ARM_ARCH_6K__)|| defined(__ARM_ARCH_6M__) || \
|
|
|
|
|
defined(__ARM_ARCH_6Z__)|| defined(__ARM_ARCH_6ZK__) || \
|
|
|
|
|
defined(__ARM_ARCH_6T2__)
|
|
|
|
|
# define __ARM_ARCH__ 6
|
|
|
|
|
# elif defined(__ARM_ARCH_5__) || defined(__ARM_ARCH_5T__) || \
|
|
|
|
|
defined(__ARM_ARCH_5E__)|| defined(__ARM_ARCH_5TE__) || \
|
|
|
|
|
defined(__ARM_ARCH_5TEJ__)
|
|
|
|
|
# define __ARM_ARCH__ 5
|
|
|
|
|
# elif defined(__ARM_ARCH_4__) || defined(__ARM_ARCH_4T__)
|
|
|
|
|
# define __ARM_ARCH__ 4
|
|
|
|
|
# else
|
|
|
|
|
# error "unsupported ARM architecture"
|
|
|
|
|
# endif
|
2011-04-01 21:09:09 +00:00
|
|
|
# endif
|
|
|
|
|
# endif
|
|
|
|
|
|
2015-01-22 03:40:55 +00:00
|
|
|
# if !defined(__ARM_MAX_ARCH__)
|
|
|
|
|
# define __ARM_MAX_ARCH__ __ARM_ARCH__
|
|
|
|
|
# endif
|
2014-11-07 21:48:22 +00:00
|
|
|
|
2015-01-22 03:40:55 +00:00
|
|
|
# if __ARM_MAX_ARCH__<__ARM_ARCH__
|
|
|
|
|
# error "__ARM_MAX_ARCH__ can't be less than __ARM_ARCH__"
|
|
|
|
|
# elif __ARM_MAX_ARCH__!=__ARM_ARCH__
|
|
|
|
|
# if __ARM_ARCH__<7 && __ARM_MAX_ARCH__>=7 && defined(__ARMEB__)
|
|
|
|
|
# error "can't build universal big-endian binary"
|
|
|
|
|
# endif
|
2014-11-07 21:48:22 +00:00
|
|
|
# endif
|
|
|
|
|
|
2018-04-19 18:56:46 +00:00
|
|
|
# ifndef __ASSEMBLER__
|
2011-07-17 17:40:29 +00:00
|
|
|
extern unsigned int OPENSSL_armcap_P;
|
2020-04-28 02:33:50 +00:00
|
|
|
extern unsigned int OPENSSL_arm_midr;
|
2021-05-11 09:37:22 +00:00
|
|
|
extern unsigned int OPENSSL_armv8_rsa_neonized;
|
2015-01-22 03:40:55 +00:00
|
|
|
# endif
|
|
|
|
|
|
|
|
|
|
# define ARMV7_NEON (1<<0)
|
|
|
|
|
# define ARMV7_TICK (1<<1)
|
|
|
|
|
# define ARMV8_AES (1<<2)
|
|
|
|
|
# define ARMV8_SHA1 (1<<3)
|
|
|
|
|
# define ARMV8_SHA256 (1<<4)
|
|
|
|
|
# define ARMV8_PMULL (1<<5)
|
2018-02-11 11:29:06 +00:00
|
|
|
# define ARMV8_SHA512 (1<<6)
|
2020-04-28 02:33:50 +00:00
|
|
|
# define ARMV8_CPUID (1<<7)
|
2021-05-19 18:54:20 +00:00
|
|
|
# define ARMV8_RNG (1<<8)
|
2021-12-24 08:29:04 +00:00
|
|
|
# define ARMV8_SM3 (1<<9)
|
2021-10-19 21:49:05 +00:00
|
|
|
# define ARMV8_SM4 (1<<10)
|
2021-06-09 06:35:46 +00:00
|
|
|
# define ARMV8_SHA3 (1<<11)
|
|
|
|
|
# define ARMV8_UNROLL8_EOR3 (1<<12)
|
2022-02-07 10:17:06 +00:00
|
|
|
# define ARMV8_SVE (1<<13)
|
|
|
|
|
# define ARMV8_SVE2 (1<<14)
|
2023-07-15 15:26:05 +00:00
|
|
|
# define ARMV8_HAVE_SHA3_AND_WORTH_USING (1<<15)
|
2011-07-17 17:40:29 +00:00
|
|
|
|
2020-04-28 02:33:50 +00:00
|
|
|
/*
|
|
|
|
|
* MIDR_EL1 system register
|
|
|
|
|
*
|
|
|
|
|
* 63___ _ ___32_31___ _ ___24_23_____20_19_____16_15__ _ __4_3_______0
|
|
|
|
|
* | | | | | | |
|
|
|
|
|
* |RES0 | Implementer | Variant | Arch | PartNum |Revision|
|
|
|
|
|
* |____ _ _____|_____ _ _____|_________|_______ _|____ _ ___|________|
|
|
|
|
|
*
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
# define ARM_CPU_IMP_ARM 0x41
|
2022-10-31 03:28:15 +00:00
|
|
|
# define HISI_CPU_IMP 0x48
|
2023-07-07 11:26:10 +00:00
|
|
|
# define ARM_CPU_IMP_APPLE 0x61
|
2020-04-28 02:33:50 +00:00
|
|
|
|
|
|
|
|
# define ARM_CPU_PART_CORTEX_A72 0xD08
|
|
|
|
|
# define ARM_CPU_PART_N1 0xD0C
|
2021-06-09 06:35:46 +00:00
|
|
|
# define ARM_CPU_PART_V1 0xD40
|
2022-05-18 02:27:55 +00:00
|
|
|
# define ARM_CPU_PART_N2 0xD49
|
2022-10-31 03:28:15 +00:00
|
|
|
# define HISI_CPU_PART_KP920 0xD01
|
2023-01-29 06:22:43 +00:00
|
|
|
# define ARM_CPU_PART_V2 0xD4F
|
2020-04-28 02:33:50 +00:00
|
|
|
|
2023-07-07 11:26:10 +00:00
|
|
|
# define APPLE_CPU_PART_M1_ICESTORM 0x022
|
|
|
|
|
# define APPLE_CPU_PART_M1_FIRESTORM 0x023
|
|
|
|
|
# define APPLE_CPU_PART_M1_ICESTORM_PRO 0x024
|
|
|
|
|
# define APPLE_CPU_PART_M1_FIRESTORM_PRO 0x025
|
|
|
|
|
# define APPLE_CPU_PART_M1_ICESTORM_MAX 0x028
|
|
|
|
|
# define APPLE_CPU_PART_M1_FIRESTORM_MAX 0x029
|
|
|
|
|
# define APPLE_CPU_PART_M2_BLIZZARD 0x032
|
|
|
|
|
# define APPLE_CPU_PART_M2_AVALANCHE 0x033
|
|
|
|
|
# define APPLE_CPU_PART_M2_BLIZZARD_PRO 0x034
|
|
|
|
|
# define APPLE_CPU_PART_M2_AVALANCHE_PRO 0x035
|
|
|
|
|
# define APPLE_CPU_PART_M2_BLIZZARD_MAX 0x038
|
|
|
|
|
# define APPLE_CPU_PART_M2_AVALANCHE_MAX 0x039
|
|
|
|
|
|
2020-04-28 02:33:50 +00:00
|
|
|
# define MIDR_PARTNUM_SHIFT 4
|
2022-07-18 09:24:47 +00:00
|
|
|
# define MIDR_PARTNUM_MASK (0xfffU << MIDR_PARTNUM_SHIFT)
|
2020-04-28 02:33:50 +00:00
|
|
|
# define MIDR_PARTNUM(midr) \
|
|
|
|
|
(((midr) & MIDR_PARTNUM_MASK) >> MIDR_PARTNUM_SHIFT)
|
|
|
|
|
|
|
|
|
|
# define MIDR_IMPLEMENTER_SHIFT 24
|
2022-07-18 09:24:47 +00:00
|
|
|
# define MIDR_IMPLEMENTER_MASK (0xffU << MIDR_IMPLEMENTER_SHIFT)
|
2020-04-28 02:33:50 +00:00
|
|
|
# define MIDR_IMPLEMENTER(midr) \
|
|
|
|
|
(((midr) & MIDR_IMPLEMENTER_MASK) >> MIDR_IMPLEMENTER_SHIFT)
|
|
|
|
|
|
|
|
|
|
# define MIDR_ARCHITECTURE_SHIFT 16
|
2022-07-18 09:24:47 +00:00
|
|
|
# define MIDR_ARCHITECTURE_MASK (0xfU << MIDR_ARCHITECTURE_SHIFT)
|
2020-04-28 02:33:50 +00:00
|
|
|
# define MIDR_ARCHITECTURE(midr) \
|
|
|
|
|
(((midr) & MIDR_ARCHITECTURE_MASK) >> MIDR_ARCHITECTURE_SHIFT)
|
|
|
|
|
|
|
|
|
|
# define MIDR_CPU_MODEL_MASK \
|
|
|
|
|
(MIDR_IMPLEMENTER_MASK | \
|
|
|
|
|
MIDR_PARTNUM_MASK | \
|
|
|
|
|
MIDR_ARCHITECTURE_MASK)
|
|
|
|
|
|
|
|
|
|
# define MIDR_CPU_MODEL(imp, partnum) \
|
|
|
|
|
(((imp) << MIDR_IMPLEMENTER_SHIFT) | \
|
2022-07-18 09:24:47 +00:00
|
|
|
(0xfU << MIDR_ARCHITECTURE_SHIFT) | \
|
2020-04-28 02:33:50 +00:00
|
|
|
((partnum) << MIDR_PARTNUM_SHIFT))
|
|
|
|
|
|
|
|
|
|
# define MIDR_IS_CPU_MODEL(midr, imp, partnum) \
|
|
|
|
|
(((midr) & MIDR_CPU_MODEL_MASK) == MIDR_CPU_MODEL(imp, partnum))
|
aarch64: support BTI and pointer authentication in assembly
This change adds optional support for
- Armv8.3-A Pointer Authentication (PAuth) and
- Armv8.5-A Branch Target Identification (BTI)
features to the perl scripts.
Both features can be enabled with additional compiler flags.
Unless any of these are enabled explicitly there is no code change at
all.
The extensions are briefly described below. Please read the appropriate
chapters of the Arm Architecture Reference Manual for the complete
specification.
Scope
-----
This change only affects generated assembly code.
Armv8.3-A Pointer Authentication
--------------------------------
Pointer Authentication extension supports the authentication of the
contents of registers before they are used for indirect branching
or load.
PAuth provides a probabilistic method to detect corruption of register
values. PAuth signing instructions generate a Pointer Authentication
Code (PAC) based on the value of a register, a seed and a key.
The generated PAC is inserted into the original value in the register.
A PAuth authentication instruction recomputes the PAC, and if it matches
the PAC in the register, restores its original value. In case of a
mismatch, an architecturally unmapped address is generated instead.
With PAuth, mitigation against ROP (Return-oriented Programming) attacks
can be implemented. This is achieved by signing the contents of the
link-register (LR) before it is pushed to stack. Once LR is popped,
it is authenticated. This way a stack corruption which overwrites the
LR on the stack is detectable.
The PAuth extension adds several new instructions, some of which are not
recognized by older hardware. To support a single codebase for both pre
Armv8.3-A targets and newer ones, only NOP-space instructions are added
by this patch. These instructions are treated as NOPs on hardware
which does not support Armv8.3-A. Furthermore, this patch only considers
cases where LR is saved to the stack and then restored before branching
to its content. There are cases in the code where LR is pushed to stack
but it is not used later. We do not address these cases as they are not
affected by PAuth.
There are two keys available to sign an instruction address: A and B.
PACIASP and PACIBSP only differ in the used keys: A and B, respectively.
The keys are typically managed by the operating system.
To enable generating code for PAuth compile with
-mbranch-protection=<mode>:
- standard or pac-ret: add PACIASP and AUTIASP, also enables BTI
(read below)
- pac-ret+b-key: add PACIBSP and AUTIBSP
Armv8.5-A Branch Target Identification
--------------------------------------
Branch Target Identification features some new instructions which
protect the execution of instructions on guarded pages which are not
intended branch targets.
If Armv8.5-A is supported by the hardware, execution of an instruction
changes the value of PSTATE.BTYPE field. If an indirect branch
lands on a guarded page the target instruction must be one of the
BTI <jc> flavors, or in case of a direct call or jump it can be any
other instruction. If the target instruction is not compatible with the
value of PSTATE.BTYPE a Branch Target Exception is generated.
In short, indirect jumps are compatible with BTI <j> and <jc> while
indirect calls are compatible with BTI <c> and <jc>. Please refer to the
specification for the details.
Armv8.3-A PACIASP and PACIBSP are implicit branch target
identification instructions which are equivalent with BTI c or BTI jc
depending on system register configuration.
BTI is used to mitigate JOP (Jump-oriented Programming) attacks by
limiting the set of instructions which can be jumped to.
BTI requires active linker support to mark the pages with BTI-enabled
code as guarded. For ELF64 files BTI compatibility is recorded in the
.note.gnu.property section. For a shared object or static binary it is
required that all linked units support BTI. This means that even a
single assembly file without the required note section turns-off BTI
for the whole binary or shared object.
The new BTI instructions are treated as NOPs on hardware which does
not support Armv8.5-A or on pages which are not guarded.
To insert this new and optional instruction compile with
-mbranch-protection=standard (also enables PAuth) or +bti.
When targeting a guarded page from a non-guarded page, weaker
compatibility restrictions apply to maintain compatibility between
legacy and new code. For detailed rules please refer to the Arm ARM.
Compiler support
----------------
Compiler support requires understanding '-mbranch-protection=<mode>'
and emitting the appropriate feature macros (__ARM_FEATURE_BTI_DEFAULT
and __ARM_FEATURE_PAC_DEFAULT). The current state is the following:
-------------------------------------------------------
| Compiler | -mbranch-protection | Feature macros |
+----------+---------------------+--------------------+
| clang | 9.0.0 | 11.0.0 |
+----------+---------------------+--------------------+
| gcc | 9 | expected in 10.1+ |
-------------------------------------------------------
Available Platforms
------------------
Arm Fast Model and QEMU support both extensions.
https://developer.arm.com/tools-and-software/simulation-models/fast-models
https://www.qemu.org/
Implementation Notes
--------------------
This change adds BTI landing pads even to assembly functions which are
likely to be directly called only. In these cases, landing pads might
be superfluous depending on what code the linker generates.
Code size and performance impact for these cases would be negligible.
Interaction with C code
-----------------------
Pointer Authentication is a per-frame protection while Branch Target
Identification can be turned on and off only for all code pages of a
whole shared object or static binary. Because of these properties if
C/C++ code is compiled without any of the above features but assembly
files support any of them unconditionally there is no incompatibility
between the two.
Useful Links
------------
To fully understand the details of both PAuth and BTI it is advised to
read the related chapters of the Arm Architecture Reference Manual
(Arm ARM):
https://developer.arm.com/documentation/ddi0487/latest/
Additional materials:
"Providing protection for complex software"
https://developer.arm.com/architectures/learn-the-architecture/providing-protection-for-complex-software
Arm Compiler Reference Guide Version 6.14: -mbranch-protection
https://developer.arm.com/documentation/101754/0614/armclang-Reference/armclang-Command-line-Options/-mbranch-protection?lang=en
Arm C Language Extensions (ACLE)
https://developer.arm.com/docs/101028/latest
Addional Notes
--------------
This patch is a copy of the work done by Tamas Petz in boringssl. It
contains the changes from the following commits:
aarch64: support BTI and pointer authentication in assembly
Change-Id: I4335f92e2ccc8e209c7d68a0a79f1acdf3aeb791
URL: https://boringssl-review.googlesource.com/c/boringssl/+/42084
aarch64: Improve conditional compilation
Change-Id: I14902a64e5f403c2b6a117bc9f5fb1a4f4611ebf
URL: https://boringssl-review.googlesource.com/c/boringssl/+/43524
aarch64: Fix name of gnu property note section
Change-Id: I6c432d1c852129e9c273f6469a8b60e3983671ec
URL: https://boringssl-review.googlesource.com/c/boringssl/+/44024
Change-Id: I2d95ebc5e4aeb5610d3b226f9754ee80cf74a9af
Reviewed-by: Paul Dale <pauli@openssl.org>
Reviewed-by: Tomas Mraz <tomas@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/16674)
2021-08-28 18:57:09 +00:00
|
|
|
|
|
|
|
|
#if defined(__ASSEMBLER__)
|
|
|
|
|
|
|
|
|
|
/*
|
|
|
|
|
* Support macros for
|
|
|
|
|
* - Armv8.3-A Pointer Authentication and
|
|
|
|
|
* - Armv8.5-A Branch Target Identification
|
|
|
|
|
* features which require emitting a .note.gnu.property section with the
|
|
|
|
|
* appropriate architecture-dependent feature bits set.
|
|
|
|
|
* Read more: "ELF for the Arm® 64-bit Architecture"
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
# if defined(__ARM_FEATURE_BTI_DEFAULT) && __ARM_FEATURE_BTI_DEFAULT == 1
|
|
|
|
|
# define GNU_PROPERTY_AARCH64_BTI (1 << 0) /* Has Branch Target Identification */
|
|
|
|
|
# define AARCH64_VALID_CALL_TARGET hint #34 /* BTI 'c' */
|
|
|
|
|
# else
|
|
|
|
|
# define GNU_PROPERTY_AARCH64_BTI 0 /* No Branch Target Identification */
|
|
|
|
|
# define AARCH64_VALID_CALL_TARGET
|
|
|
|
|
# endif
|
|
|
|
|
|
|
|
|
|
# if defined(__ARM_FEATURE_PAC_DEFAULT) && \
|
|
|
|
|
(__ARM_FEATURE_PAC_DEFAULT & 1) == 1 /* Signed with A-key */
|
|
|
|
|
# define GNU_PROPERTY_AARCH64_POINTER_AUTH \
|
|
|
|
|
(1 << 1) /* Has Pointer Authentication */
|
|
|
|
|
# define AARCH64_SIGN_LINK_REGISTER hint #25 /* PACIASP */
|
|
|
|
|
# define AARCH64_VALIDATE_LINK_REGISTER hint #29 /* AUTIASP */
|
|
|
|
|
# elif defined(__ARM_FEATURE_PAC_DEFAULT) && \
|
|
|
|
|
(__ARM_FEATURE_PAC_DEFAULT & 2) == 2 /* Signed with B-key */
|
|
|
|
|
# define GNU_PROPERTY_AARCH64_POINTER_AUTH \
|
|
|
|
|
(1 << 1) /* Has Pointer Authentication */
|
|
|
|
|
# define AARCH64_SIGN_LINK_REGISTER hint #27 /* PACIBSP */
|
|
|
|
|
# define AARCH64_VALIDATE_LINK_REGISTER hint #31 /* AUTIBSP */
|
|
|
|
|
# else
|
|
|
|
|
# define GNU_PROPERTY_AARCH64_POINTER_AUTH 0 /* No Pointer Authentication */
|
|
|
|
|
# if GNU_PROPERTY_AARCH64_BTI != 0
|
|
|
|
|
# define AARCH64_SIGN_LINK_REGISTER AARCH64_VALID_CALL_TARGET
|
|
|
|
|
# else
|
|
|
|
|
# define AARCH64_SIGN_LINK_REGISTER
|
|
|
|
|
# endif
|
|
|
|
|
# define AARCH64_VALIDATE_LINK_REGISTER
|
|
|
|
|
# endif
|
|
|
|
|
|
|
|
|
|
# if GNU_PROPERTY_AARCH64_POINTER_AUTH != 0 || GNU_PROPERTY_AARCH64_BTI != 0
|
|
|
|
|
.pushsection .note.gnu.property, "a";
|
|
|
|
|
.balign 8;
|
|
|
|
|
.long 4;
|
|
|
|
|
.long 0x10;
|
|
|
|
|
.long 0x5;
|
|
|
|
|
.asciz "GNU";
|
|
|
|
|
.long 0xc0000000; /* GNU_PROPERTY_AARCH64_FEATURE_1_AND */
|
|
|
|
|
.long 4;
|
|
|
|
|
.long (GNU_PROPERTY_AARCH64_POINTER_AUTH | GNU_PROPERTY_AARCH64_BTI);
|
|
|
|
|
.long 0;
|
|
|
|
|
.popsection;
|
|
|
|
|
# endif
|
|
|
|
|
|
|
|
|
|
# endif /* defined __ASSEMBLER__ */
|
|
|
|
|
|
2021-06-09 06:35:46 +00:00
|
|
|
# define IS_CPU_SUPPORT_UNROLL8_EOR3() \
|
|
|
|
|
(OPENSSL_armcap_P & ARMV8_UNROLL8_EOR3)
|
|
|
|
|
|
2011-04-01 21:09:09 +00:00
|
|
|
#endif
|
