The patch titled
Subject: checkpatch: add warnings in favor of strscpy().
has been added to the -mm tree. Its filename is
checkpatch-added-warnings-in-favor-of-strscpy.patch
This patch should soon appear at
http://ozlabs.org/~akpm/mmots/broken-out/checkpatch-added-warnings-in-favor-of-strscpy.patch
and later at
http://ozlabs.org/~akpm/mmotm/broken-out/checkpatch-added-warnings-in-favor-of-strscpy.patch
Before you just go and hit "reply", please:
a) Consider who else should be cc'ed
b) Prefer to cc a suitable mailing list as well
c) Ideally: find the original patch on the mailing list and do a
reply-to-all to that, adding suitable additional cc's
*** Remember to use Documentation/process/submit-checklist.rst when testing your code ***
The -mm tree is included into linux-next and is updated
there every 3-4 working days
------------------------------------------------------
From: Nitin Gote <nitin.r.gote@xxxxxxxxx>
Subject: checkpatch: add warnings in favor of strscpy().
Added warnings in checkpatch.pl script to:
1. Deprecate strcpy() in favor of strscpy().
2. Deprecate strlcpy() in favor of strscpy().
3. Deprecate strncpy() in favor of strscpy() or strscpy_pad().
Update strncpy() section in Documentation/process/deprecated.rst to cover
strscpy_pad() case.
Link: http://lkml.kernel.org/r/1562219683-15474-1-git-send-email-nitin.r.gote@xxxxxxxxx
Signed-off-by: Nitin Gote <nitin.r.gote@xxxxxxxxx>
Acked-by: Kees Cook <keescook@xxxxxxxxxxxx>
Cc: Jonathan Corbet <corbet@xxxxxxx>
Cc: Joe Perches <joe@xxxxxxxxxxx>
Signed-off-by: Andrew Morton <akpm@xxxxxxxxxxxxxxxxxxxx>
---
Documentation/process/deprecated.rst | 6 +++---
scripts/checkpatch.pl | 5 +++++
2 files changed, 8 insertions(+), 3 deletions(-)
--- a/Documentation/process/deprecated.rst~checkpatch-added-warnings-in-favor-of-strscpy
+++ a/Documentation/process/deprecated.rst
@@ -93,9 +93,9 @@ will be NUL terminated. This can lead to
and other misbehavior due to the missing termination. It also NUL-pads the
destination buffer if the source contents are shorter than the destination
buffer size, which may be a needless performance penalty for callers using
-only NUL-terminated strings. The safe replacement is :c:func:`strscpy`.
-(Users of :c:func:`strscpy` still needing NUL-padding will need an
-explicit :c:func:`memset` added.)
+only NUL-terminated strings. In this case, the safe replacement is
+:c:func:`strscpy`. If, however, the destination buffer still needs
+NUL-padding, the safe replacement is :c:func:`strscpy_pad`.
If a caller is using non-NUL-terminated strings, :c:func:`strncpy()` can
still be used, but destinations should be marked with the `__nonstring
--- a/scripts/checkpatch.pl~checkpatch-added-warnings-in-favor-of-strscpy
+++ a/scripts/checkpatch.pl
@@ -595,6 +595,11 @@ our %deprecated_apis = (
"rcu_barrier_sched" => "rcu_barrier",
"get_state_synchronize_sched" => "get_state_synchronize_rcu",
"cond_synchronize_sched" => "cond_synchronize_rcu",
+ "strcpy" => "strscpy",
+ "strlcpy" => "strscpy",
+ "strncpy" => "strscpy, strscpy_pad or for
+ non-NUL-terminated strings, strncpy() can still be used, but
+ destinations should be marked with the __nonstring",
);
#Create a search pattern for all these strings to speed up a loop below
_
Patches currently in -mm which might be from nitin.r.gote@xxxxxxxxx are
checkpatch-added-warnings-in-favor-of-strscpy.patch
