diff options
| -rw-r--r-- | docs/process/coding-guidelines.rst | 35 | ||||
| -rw-r--r-- | plat/imx/imx8m/imx_aipstz.c | 4 |
2 files changed, 37 insertions, 2 deletions
diff --git a/docs/process/coding-guidelines.rst b/docs/process/coding-guidelines.rst index d524d733..093d66be 100644 --- a/docs/process/coding-guidelines.rst +++ b/docs/process/coding-guidelines.rst @@ -263,6 +263,41 @@ a warning for this. Existing typedefs will be retained for compatibility. +Libc functions that are banned or to be used with caution +--------------------------------------------------------- + +Below is a list of functions that present security risks and either must not be +used (Banned) or are discouraged from use and must be used with care (Caution). + ++------------------------+-----------+--------------------------------------+ +| libc function | Status | Comments | ++========================+===========+======================================+ +| ``strcpy, wcscpy`` | Banned | use strlcpy instead | +| ``strncpy`` | | | ++------------------------+-----------+--------------------------------------+ +| ``strcat, wcscat`` | Banned | use strlcat instead | +| ``strncat`` | | | ++----------------------- +-----------+--------------------------------------+ +| ``sprintf, vsprintf`` | Banned | use snprintf, vsnprintf | +| | | instead | ++---------------------- -+-----------+--------------------------------------+ +| ``snprintf`` | Caution | ensure result fits in buffer | +| | | i.e : snprintf(buf,size...) < size | ++------------------------+-----------+--------------------------------------+ +| ``vsnprintf`` | Caution | inspect va_list match types | +| | | specified in format string | ++------------------------+-----------+--------------------------------------+ +| ``strtok`` | Banned | use strtok_r or strsep instead | ++------------------------+-----------+--------------------------------------+ +| ``strtok_r, strsep`` | Caution | inspect for terminated input buffer | ++------------------------+-----------+--------------------------------------+ +| ``ato*`` | Banned | use equivalent strto* functions | ++------------------------+-----------+--------------------------------------+ +| ``*toa`` | Banned | Use snprintf instead | ++------------------------+-----------+--------------------------------------+ + +The `libc` component in the codebase will not add support for the banned APIs. + Error handling and robustness ----------------------------- diff --git a/plat/imx/imx8m/imx_aipstz.c b/plat/imx/imx8m/imx_aipstz.c index a36e2961..ecf8b1dd 100644 --- a/plat/imx/imx8m/imx_aipstz.c +++ b/plat/imx/imx8m/imx_aipstz.c @@ -1,7 +1,7 @@ /* - * copyright (c) 2019, arm limited and contributors. all rights reserved. + * Copyright (c) 2019, Arm Limited and Contributors. All rights reserved. * - * spdx-license-identifier: bsd-3-clause + * SPDX-License-Identifier: BSD-3-Clause */ #include <lib/mmio.h> |