arm-trusted-firmware/drivers/nxp
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
..
auth fix(mbedtls): fix mbedtls coverity issues 2023-03-01 12:51:43 +00:00
console refactor(console): disable getc() by default 2023-10-11 08:40:14 +02:00
crypto/caam fix(tree): correct some typos 2023-05-09 15:57:12 +01:00
csu refactor: moved drivers hdr files to include/drivers/nxp 2021-08-03 12:19:56 +02:00
dcfg feat(nxp-dcfg): add Chassis 3 support 2022-03-27 23:24:24 +08:00
ddr fix(tree): correct some typos 2023-05-09 15:57:12 +01:00
flexspi/nor fix(nxp-drivers): fix fspi coverity issue 2022-11-23 09:17:48 +08:00
gic refactor: moved drivers hdr files to include/drivers/nxp 2021-08-03 12:19:56 +02:00
gpio refactor: moved drivers hdr files to include/drivers/nxp 2021-08-03 12:19:56 +02:00
i2c refactor: moved drivers hdr files to include/drivers/nxp 2021-08-03 12:19:56 +02:00
ifc fix(tree): correct some typos 2023-05-09 15:57:12 +01:00
interconnect refactor: moved drivers hdr files to include/drivers/nxp 2021-08-03 12:19:56 +02:00
pmu refactor: moved drivers hdr files to include/drivers/nxp 2021-08-03 12:19:56 +02:00
qspi fix(nxp-qspi): fix include path for QSPI driver 2022-02-15 08:59:58 +08:00
sd fix(tree): correct some typos 2023-05-09 15:57:12 +01:00
sec_mon refactor: moved drivers hdr files to include/drivers/nxp 2021-08-03 12:19:56 +02:00
sfp fix(drivers/nxp/sfp): fix compile warning 2021-10-09 10:57:29 +02:00
timer fix(nxp-drivers): use semicolon instead of comma 2023-03-16 07:43:11 +02:00
trdc feat(imx93): add the trdc driver 2023-06-30 10:24:05 +08:00
tzc fix(nxp-drivers): fix tzc380 memory regions config 2022-11-22 16:35:20 +08:00
drivers.mk feat(nxp/driver/ifc_nand): add IFC NAND flash driver 2022-01-20 23:38:03 +08:00