diff options
Diffstat (limited to 'docs/process')
| -rw-r--r-- | docs/process/index.rst | 1 | ||||
| -rw-r--r-- | docs/process/security-hardening.rst | 58 | ||||
| -rw-r--r-- | docs/process/security.rst | 16 |
3 files changed, 67 insertions, 8 deletions
diff --git a/docs/process/index.rst b/docs/process/index.rst index aa5d6bba..a870c8f5 100644 --- a/docs/process/index.rst +++ b/docs/process/index.rst @@ -12,3 +12,4 @@ Processes & Policies coding-guidelines contributing faq + security-hardening diff --git a/docs/process/security-hardening.rst b/docs/process/security-hardening.rst new file mode 100644 index 00000000..e2c68b8f --- /dev/null +++ b/docs/process/security-hardening.rst @@ -0,0 +1,58 @@ +Security hardening +================== + +This page contains guidance on what to check for additional security measures, +including build options that can be modified to improve security or catch issues +early in development. + +Build options +------------- + +Several build options can be used to check for security issues. Refer to the +`user guide`_ for detailed information on the specific build options. + +- The ``BRANCH_PROTECTION`` build flag can be used to enable Pointer + Authentication and Branch Target Identification. + +- The ``ENABLE_STACK_PROTECTOR`` build flag can be used to identify buffer + overflows. + +- The ``W`` build flag can be used to enable a number of compiler warning + options to detect potentially incorrect code. + + - W=0 (default value) + + The ``Wunused`` with ``Wno-unused-parameter``, ``Wdisabled-optimization`` + and ``Wvla`` flags are enabled. + + The ``Wunused-but-set-variable``, ``Wmaybe-uninitialized`` and + ``Wpacked-bitfield-compat`` are GCC specific flags that are also enabled. + + - W=1 + + Adds ``Wextra``, ``Wmissing-declarations``, ``Wmissing-format-attribute``, + ``Wmissing-prototypes``, ``Wold-style-definition`` and + ``Wunused-const-variable``. + + - W=2 + + Adds ``Waggregate-return``, ``Wcast-align``, ``Wnested-externs``, + ``Wshadow``, ``Wlogical-op``, ``Wmissing-field-initializers`` and + ``Wsign-compare``. + + - W=3 + + Adds ``Wbad-function-cast``, ``Wcast-qual``, ``Wconversion``, ``Wpacked``, + ``Wpadded``, ``Wpointer-arith``, ``Wredundant-decls`` and + ``Wswitch-default``. + + Refer to the GCC or Clang documentation for more information on the individual + options: https://gcc.gnu.org/onlinedocs/gcc/Warning-Options.html and + https://clang.llvm.org/docs/DiagnosticsReference.html. + + NB: The ``Werror`` flag is enabled by default in TF-A and can be disabled by + setting the ``E`` build flag to 0. + +*Copyright (c) 2019, Arm Limited. All rights reserved.* + +.. _user guide: ../getting_started/user-guide.rst diff --git a/docs/process/security.rst b/docs/process/security.rst index d1c997ba..94eb9c3b 100644 --- a/docs/process/security.rst +++ b/docs/process/security.rst @@ -95,11 +95,11 @@ Security Advisories .. _issue tracker: https://developer.trustedfirmware.org/project/board/1/ .. _this PGP/GPG key: security-reporting.asc -.. _TFV-1: ./security_advisories/security-advisory-tfv-1.rst -.. _TFV-2: ./security_advisories/security-advisory-tfv-2.rst -.. _TFV-3: ./security_advisories/security-advisory-tfv-3.rst -.. _TFV-4: ./security_advisories/security-advisory-tfv-4.rst -.. _TFV-5: ./security_advisories/security-advisory-tfv-5.rst -.. _TFV-6: ./security_advisories/security-advisory-tfv-6.rst -.. _TFV-7: ./security_advisories/security-advisory-tfv-7.rst -.. _TFV-8: ./security_advisories/security-advisory-tfv-8.rst +.. _TFV-1: ../security_advisories/security-advisory-tfv-1.rst +.. _TFV-2: ../security_advisories/security-advisory-tfv-2.rst +.. _TFV-3: ../security_advisories/security-advisory-tfv-3.rst +.. _TFV-4: ../security_advisories/security-advisory-tfv-4.rst +.. _TFV-5: ../security_advisories/security-advisory-tfv-5.rst +.. _TFV-6: ../security_advisories/security-advisory-tfv-6.rst +.. _TFV-7: ../security_advisories/security-advisory-tfv-7.rst +.. _TFV-8: ../security_advisories/security-advisory-tfv-8.rst |