tracing/boot: Replace strlcpy with strscpy
PATCH 1/1 tracing/boot: Replace strlcpy with strscpy
strlcpy() reads the entire source buffer first. This read may exceed the destination size limit. This is both inefficient and can lead to linear read overflows if a source string is not NUL-terminated [1]. In an effort to remove strlcpy() completely [2], replace strlcpy() here with strscpy().
Direct replacement is safe here since return value of -E2BIG is used to check for truncation instead of sizeof(dest).
[1] https://www.kernel.org/doc/html/latest/process/deprecated.html#strlcpy
[2] https://github.com/KSPP/linux/issues/89
--- kernel/trace/trace_boot.c | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)
kernel/trace/trace_boot.c +4 -4
@@ -31,7 +31,7 @@ trace_boot_set_instance_options(struct trace_array *tr, struct xbc_node *node)/* Common ftrace options */ xbc_node_for_each_array_value (node,"options" , anode, p) { -if (strlcpy (buf, p,ARRAY_SIZE (buf)) >=ARRAY_SIZE (buf)) { +if (strscpy (buf, p,ARRAY_SIZE (buf)) == -E2BIG ) {pr_err ("String is too long: %s\n" , p);continue ; }
@@ -87,7 +87,7 @@ trace_boot_enable_events(struct trace_array *tr, struct xbc_node *node)const char *p;xbc_node_for_each_array_value (node,"events" , anode, p) { -if (strlcpy (buf, p,ARRAY_SIZE (buf)) >=ARRAY_SIZE (buf)) { +if (strscpy (buf, p,ARRAY_SIZE (buf)) == -E2BIG ) {pr_err ("String is too long: %s\n" , p);continue ; }
@@ -486,7 +486,7 @@ trace_boot_init_one_event(struct trace_array *tr, struct xbc_node *gnode, p =xbc_node_find_value (enode,"filter" ,NULL );if (p && *p !='\0' ) { -if (strlcpy (buf, p,ARRAY_SIZE (buf)) >=ARRAY_SIZE (buf)) +if (strscpy (buf, p,ARRAY_SIZE (buf)) == -E2BIG )pr_err ("filter string is too long: %s\n" , p);else if (apply_event_filter (file, buf) <0 )pr_err ("Failed to apply filter: %s\n" , buf);
@@ -494,7 +494,7 @@ trace_boot_init_one_event(struct trace_array *tr, struct xbc_node *gnode,if (IS_ENABLED (CONFIG_HIST_TRIGGERS )) {xbc_node_for_each_array_value (enode,"actions" , anode, p) { -if (strlcpy (buf, p,ARRAY_SIZE (buf)) >=ARRAY_SIZE (buf)) +if (strscpy (buf, p,ARRAY_SIZE (buf)) == -E2BIG )pr_err ("action string is too long: %s\n" , p);else if (trigger_process_regex (file, buf) <0 )pr_err ("Failed to apply an action: %s\n" , p);
Signature · 1 line
2.41.0.162.gfafddb0af9-goog
Quoted 9 lines · Azeem Shaikh
strlcpy()reads the entire source buffer first. This read may exceed the destination size limit. This is both inefficient and can lead to linear read overflows if a source string is not NUL-terminated [1]. In an effort to removestrlcpy()completely [2], replacestrlcpy()here withstrscpy().Direct replacement is safe here since return value of
-E2BIGis used to check for truncation instead of sizeof(dest).
This looks technically correct, but I wonder if "< 0" is a better test?
Quoted 5 lines
[1] https://www.kernel.org/doc/html/latest/process/deprecated.html#strlcpy
[2] https://github.com/KSPP/linux/issues/89Signed-off-by Azeem Shaikh <[email protected]>
Either way
-Kees
Quoted 48 lines
--- kernel/trace/trace_boot.c | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)kernel/trace/trace_boot.c +4
-4@@ -31,7 +31,7 @@ trace_boot_set_instance_options(struct trace_array *tr, struct xbc_node *node)/* Common ftrace options */ xbc_node_for_each_array_value (node,"options" , anode, p) { -if (strlcpy (buf, p,ARRAY_SIZE (buf)) >=ARRAY_SIZE (buf)) { +if (strscpy (buf, p,ARRAY_SIZE (buf)) == -E2BIG ) {pr_err ("String is too long: %s\n" , p);continue ; }@@ -87,7 +87,7 @@ trace_boot_enable_events(struct trace_array *tr, struct xbc_node *node)const char *p;xbc_node_for_each_array_value (node,"events" , anode, p) { -if (strlcpy (buf, p,ARRAY_SIZE (buf)) >=ARRAY_SIZE (buf)) { +if (strscpy (buf, p,ARRAY_SIZE (buf)) == -E2BIG ) {pr_err ("String is too long: %s\n" , p);continue ; }@@ -486,7 +486,7 @@ trace_boot_init_one_event(struct trace_array *tr, struct xbc_node *gnode, p =xbc_node_find_value (enode,"filter" ,NULL );if (p && *p !='\0' ) { -if (strlcpy (buf, p,ARRAY_SIZE (buf)) >=ARRAY_SIZE (buf)) +if (strscpy (buf, p,ARRAY_SIZE (buf)) == -E2BIG )pr_err ("filter string is too long: %s\n" , p);else if (apply_event_filter (file, buf) <0 )pr_err ("Failed to apply filter: %s\n" , buf);@@ -494,7 +494,7 @@ trace_boot_init_one_event(struct trace_array *tr, struct xbc_node *gnode,if (IS_ENABLED (CONFIG_HIST_TRIGGERS )) {xbc_node_for_each_array_value (enode,"actions" , anode, p) { -if (strlcpy (buf, p,ARRAY_SIZE (buf)) >=ARRAY_SIZE (buf)) +if (strscpy (buf, p,ARRAY_SIZE (buf)) == -E2BIG )pr_err ("action string is too long: %s\n" , p);else if (trigger_process_regex (file, buf) <0 )pr_err ("Failed to apply an action: %s\n" , p);Signature · 1 line
2.41.0.162.gfafddb0af9-goog
Signature · 1 line
Kees Cook
Quoted 9 lines · Kees Cook
Quoted 7 lines · Azeem Shaikh
strlcpy()reads the entire source buffer first. This read may exceed the destination size limit. This is both inefficient and can lead to linear read overflows if a source string is not NUL-terminated [1]. In an effort to removestrlcpy()completely [2], replacestrlcpy()here withstrscpy().
Quoted 4 lines
Quoted 2 lines
Direct replacement is safe here since return value of
-E2BIGis used to check for truncation instead of sizeof(dest).This looks technically correct, but I wonder if "< 0" is a better test?
Agreed. "< 0" might more generically represent -errno. Happy to send over a v2 if you prefer that instead of sticking with this patch.
Quoted 64 lines
Quoted 6 lines
[1] https://www.kernel.org/doc/html/latest/process/deprecated.html#strlcpy
[2] https://github.com/KSPP/linux/issues/89Signed-off-by Azeem Shaikh <[email protected]>Either way
Reviewed-by Kees Cook <[email protected]>-Kees
Quoted 45 lines
--- kernel/trace/trace_boot.c | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-)kernel/trace/trace_boot.c +4
-5@@ -31,7 +31,7 @@ trace_boot_set_instance_options(struct trace_array *tr, struct xbc_node *node)/* Common ftrace options */ xbc_node_for_each_array_value (node,"options" , anode, p) { -if (strlcpy (buf, p,ARRAY_SIZE (buf)) >=ARRAY_SIZE (buf)) { +if (strscpy (buf, p,ARRAY_SIZE (buf)) == -E2BIG ) {pr_err ("String is too long: %s\n" , p);continue ; }@@ -87,7 +87,7 @@ trace_boot_enable_events(struct trace_array *tr, struct xbc_node *node)const char *p;xbc_node_for_each_array_value (node,"events" , anode, p) { -if (strlcpy (buf, p,ARRAY_SIZE (buf)) >=ARRAY_SIZE (buf)) { +if (strscpy (buf, p,ARRAY_SIZE (buf)) == -E2BIG ) {pr_err ("String is too long: %s\n" , p);continue ; }@@ -486,7 +486,7 @@ trace_boot_init_one_event(struct trace_array *tr, struct xbc_node *gnode, p =xbc_node_find_value (enode,"filter" ,NULL );if (p && *p !='\0' ) { -if (strlcpy (buf, p,ARRAY_SIZE (buf)) >=ARRAY_SIZE (buf)) +if (strscpy (buf, p,ARRAY_SIZE (buf)) == -E2BIG )pr_err ("filter string is too long: %s\n" , p);else if (apply_event_filter (file, buf) <0 )pr_err ("Failed to apply filter: %s\n" , buf);@@ -494,7 +494,7 @@ trace_boot_init_one_event(struct trace_array *tr, struct xbc_node *gnode,if (IS_ENABLED (CONFIG_HIST_TRIGGERS )) {xbc_node_for_each_array_value (enode,"actions" , anode, p) { -if (strlcpy (buf, p,ARRAY_SIZE (buf)) >=ARRAY_SIZE (buf)) +if (strscpy (buf, p,ARRAY_SIZE (buf)) == -E2BIG )pr_err ("action string is too long: %s\n" , p);else if (trigger_process_regex (file, buf) <0 )pr_err ("Failed to apply an action: %s\n" , p); --Quoted 3 lines
2.41.0.162.gfafddb0af9-goog
--
Kees Cook
Quoted 10 lines · Azeem Shaikh
Quoted 9 lines · Kees Cook
Quoted 7 lines · Azeem Shaikh
strlcpy()reads the entire source buffer first. This read may exceed the destination size limit. This is both inefficient and can lead to linear read overflows if a source string is not NUL-terminated [1]. In an effort to removestrlcpy()completely [2], replacestrlcpy()here withstrscpy().
Quoted 7 lines
Quoted 4 lines
Quoted 2 lines
Direct replacement is safe here since return value of
-E2BIGis used to check for truncation instead of sizeof(dest).This looks technically correct, but I wonder if "< 0" is a better test?
Agreed. "< 0" might more generically represent -errno. Happy to send over a v2 if you prefer that instead of sticking with this patch.
Please go with "< 0", since it's easier to read and less error-prone. (It would be easy to mistype -E2BIG as -EFBIG, or E2BIG, for example...)
- Eric
Quoted 15 lines · Eric Biggers
Quoted 13 lines · Azeem Shaikh
Quoted 12 lines · Kees Cook
Quoted 9 lines · Azeem Shaikh
strlcpy()reads the entire source buffer first. This read may exceed the destination size limit. This is both inefficient and can lead to linear read overflows if a source string is not NUL-terminated [1]. In an effort to removestrlcpy()completely [2], replacestrlcpy()here withstrscpy().Direct replacement is safe here since return value of
-E2BIGis used to check for truncation instead of sizeof(dest).
Quoted 8 lines
Quoted 4 lines
Quoted 1 line
This looks technically correct, but I wonder if "< 0" is a better test?
Agreed. "< 0" might more generically represent -errno. Happy to send over a v2 if you prefer that instead of sticking with this patch.
Please go with "< 0", since it's easier to read and less error-prone. (It would be easy to mistype
-E2BIGas-EFBIG, or E2BIG, for example...)
Thanks, sent out a v2 with this change.