arm-trusted-firmware/include
Sandrine Bailleux 85bebe18da refactor(console): disable getc() by default
The ability to read a character from the console constitutes an attack
vector into TF-A, as it gives attackers a means to inject arbitrary
data into TF-A. It is dangerous to keep that feature enabled if not
strictly necessary, especially in production firmware builds.

Thus, we need a way to disable this feature. Moreover, when it is
disabled, all related code should be eliminated from the firmware
binaries, such that no remnant/dead getc() code remains in memory,
which could otherwise be used as a gadget as part of a bigger security
attack.

This patch disables getc() feature by default. For legitimate getc()
use cases [1], it can be explicitly enabled by building TF-A with
ENABLE_CONSOLE_GETC=1.

The following changes are introduced when getc() is disabled:

- The multi-console framework no longer provides the console_getc()
  function.

- If the console driver selected by the platform attempts to register
  a getc() callback into the multi-console framework then TF-A will
  now fail to build.

  If registered through the assembly function finish_console_register():
  - On AArch64, you'll get:
      Error: undefined symbol CONSOLE_T_GETC used as an immediate value.
  - On AArch32, you'll get:
      Error: internal_relocation (type: OFFSET_IMM) not fixed up

  If registered through the C function console_register(), this requires
  populating a struct console with a getc field, which will trigger:
    error: 'console_t' {aka 'struct console'} has no member named 'getc'

- All console drivers which previously registered a getc() callback
  have been modified to do so only when ENABLE_CONSOLE_GETC=1.

[1] Example of such use cases would be:
    - Firmware recovery: retrieving a golden BL2 image over the console in
      order to repair a broken firmware on a bricked board.
    - Factory CLI tool: Drive some soak tests through the console.

Discussed on TF-A mailing list here:
https://lists.trustedfirmware.org/archives/list/tf-a@lists.trustedfirmware.org/thread/YS7F6RCNTWBTEOBLAXIRTXWIOYINVRW7/

Change-Id: Icb412304cd23dbdd7662df7cf8992267b7975cc5
Signed-off-by: Sandrine Bailleux <sandrine.bailleux@arm.com>
Acked-by: Baruch Siach <baruch@tkos.co.il>
2023-10-11 08:40:14 +02:00
..
arch refactor(console): disable getc() by default 2023-10-11 08:40:14 +02:00
bl1 style: remove useless trailing semicolon and line continuations 2023-03-09 14:59:08 +01:00
bl2 BL2_AT_EL3: Enable pointer authentication support 2019-02-27 11:58:09 +00:00
bl2u Standardise header guards across codebase 2018-11-08 10:20:19 +00:00
bl31 fix(tree): correct some typos 2023-05-09 15:57:12 +01:00
bl32 refactor(libc): clean up dependencies in libc 2022-09-22 13:23:49 +02:00
common feat(spmd): add spmd logical partitions 2023-08-03 07:03:13 -07:00
drivers refactor(console): disable getc() by default 2023-10-11 08:40:14 +02:00
dt-bindings feat(dt-bindings): add the STM32MP2 clock and reset bindings 2023-09-08 10:56:49 +02:00
export chore: update to use Arm word across TF-A 2023-08-08 15:12:30 +01:00
lib fix(cpus): workaround for Cortex-X3 erratum 2070301 2023-10-04 13:45:16 -05:00
plat refactor(el3-runtime): plat_ic_has_interrupt_type returns bool 2023-09-25 17:09:15 -05:00
services fix(spmd): coverity scan issues 2023-09-25 13:06:13 -07:00
tools_share feat(auth): add explicit entries for key OIDs 2023-07-28 09:01:15 +01:00