staging/wlan-ng: remove strcpy() use in favor of strscpy()
PATCH v2 1/1 staging/wlan-ng: remove strcpy() use in favor of strscpy()
In response to the suggestion by Dan Carpenter on the initial patch, this patch provides a correct usage of the strscpy() in place of the current strcpy() implementation.
strscpy() copies characters from the source buffer to the destination buffer until one of the following conditions is met:
- null-terminator ('\0') is encountered in the source string.
- specified maximum length of the destination buffer is reached.
- source buffer is exhausted.
Example:
char dest[11]; const char *PRISM2_USB_FWFILE = "prism2_ru.fw"; strscpy(dest, PRISM2_USB_FWFILE, sizeof(dest)); In this case, strscpy copies the first 10 characters of src into dest and add a null-terminator. dest will then contain "prism2_ru.f" with proper null-termination.
Since the specified length of the dest buffer is not derived from the dest buffer itself and rather form plug length (s3plug[i].len), replacing strcpy() with strscpy() is a better option because it will ensures that the destination string is always properly terminated.
--- drivers/staging/wlan-ng/prism2fw.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)
drivers/staging/wlan-ng/prism2fw.c +1 -1
@@ -725,7 +725,7 @@ static int plugimage(struct imgchunk *fchunk, unsigned int nfchunks,if (j ==-1 ) {/* plug the filename */ memset (dest,0 , s3plug[i].len); -strncpy (dest,PRISM2_USB_FWFILE , s3plug[i].len -1 ); +strscpy (dest,PRISM2_USB_FWFILE , s3plug[i].len); }else {/* plug a PDR */ memcpy (dest, &pda->rec[j]->data, s3plug[i].len); }
Signature · 1 line
2.34.1
Greg Kroah-Hartman
maintainerQuoted 45 lines · Calvince Otieno
In response to the suggestion by Dan Carpenter on the initial patch, this patch provides a correct usage of the
strscpy()in place of the currentstrcpy()implementation.
strscpy()copies characters from the source buffer to the destination buffer until one of the following conditions is met:
- null-terminator ('\0') is encountered in the source string.
- specified maximum length of the destination buffer is reached.
- source buffer is exhausted.
Example:char dest[11]; const char *PRISM2_USB_FWFILE = "prism2_ru.fw"; strscpy(dest, PRISM2_USB_FWFILE, sizeof(dest)); In this case, strscpy copies the first 10 characters of src into dest and add a null-terminator. dest will then contain "prism2_ru.f" with proper null-termination.Since the specified length of the dest buffer is not derived from the dest buffer itself and rather form plug length (s3plug[i].len), replacing
strcpy()withstrscpy()is a better option because it will ensures that the destination string is always properly terminated.Signed-off-by Calvince Otieno <[email protected]>--- drivers/staging/wlan-ng/prism2fw.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)drivers/staging/wlan-ng/prism2fw.c +1
-1@@ -725,7 +725,7 @@ static int plugimage(struct imgchunk *fchunk, unsigned int nfchunks,if (j ==-1 ) {/* plug the filename */ memset (dest,0 , s3plug[i].len); -strncpy (dest,PRISM2_USB_FWFILE , s3plug[i].len -1 ); +strscpy (dest,PRISM2_USB_FWFILE , s3plug[i].len); }else {/* plug a PDR */ memcpy (dest, &pda->rec[j]->data, s3plug[i].len); }Signature · 1 line
2.34.1
Hi,
This is the friendly patch-bot of Greg Kroah-Hartman. You have sent him a patch that has triggered this response. He used to manually respond to these common problems, but in order to save his sanity (he kept writing the same thing over and over, yet to different people), I was created. Hopefully you will not take offence and will fix the problem in your patch and resubmit it so that it can be accepted into the Linux kernel tree.
You are receiving this message because of the following common error(s) as indicated below:
- This looks like a new version of a previously submitted patch, but you did not list below the --- line any changes from the previous version. Please read the section entitled "The canonical patch format" in the kernel file, Documentation/process/submitting-patches.rst for what needs to be done here to properly describe this.
If you wish to discuss this problem further, or you have questions about how to resolve this issue, please feel free to respond to this email and Greg will reply once he has dug out from the pending patches received from other developers.
thanks,
greg k-h's patch email bot
Quoted 67 lines · Greg Kroah-Hartman
Quoted 42 lines · Calvince Otieno
In response to the suggestion by Dan Carpenter on the initial patch, this patch provides a correct usage of the
strscpy()in place of the currentstrcpy()implementation.
strscpy()copies characters from the source buffer to the destination buffer until one of the following conditions is met:
- null-terminator ('\0') is encountered in the source string.
- specified maximum length of the destination buffer is reached.
- source buffer is exhausted.
Example:char dest[11]; const char *PRISM2_USB_FWFILE = "prism2_ru.fw"; strscpy(dest, PRISM2_USB_FWFILE, sizeof(dest)); In this case, strscpy copies the first 10 characters of src into dest and add a null-terminator. dest will then contain "prism2_ru.f" with proper null-termination.Since the specified length of the dest buffer is not derived from the dest buffer itself and rather form plug length (s3plug[i].len), replacing
strcpy()withstrscpy()is a better option because it will ensures that the destination string is always properly terminated.Signed-off-by Calvince Otieno <[email protected]>--- drivers/staging/wlan-ng/prism2fw.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)drivers/staging/wlan-ng/prism2fw.c +1
-2@@ -725,7 +725,7 @@ static int plugimage(struct imgchunk *fchunk, unsigned int nfchunks,if (j ==-1 ) {/* plug the filename */ memset (dest,0 , s3plug[i].len); -strncpy (dest,PRISM2_USB_FWFILE , s3plug[i].len -1 ); +strscpy (dest,PRISM2_USB_FWFILE , s3plug[i].len); }else {/* plug a PDR */ memcpy (dest, &pda->rec[j]->data, s3plug[i].len); } --Quoted 3 lines
2.34.1
Hi,
This is the friendly patch-bot of Greg Kroah-Hartman. You have sent him a patch that has triggered this response. He used to manually respond to these common problems, but in order to save his sanity (he kept writing the same thing over and over, yet to different people), I was created. Hopefully you will not take offence and will fix the problem in your patch and resubmit it so that it can be accepted into the Linux kernel tree.
You are receiving this message because of the following common error(s) as indicated below:
- This looks like a new version of a previously submitted patch, but you did not list below the --- line any changes from the previous version. Please read the section entitled "The canonical patch format" in the kernel file,
Documentation/process/submitting-patches.rstfor what needs to be done here to properly describe this.
Quoted 8 lines
If you wish to discuss this problem further, or you have questions about how to resolve this issue, please feel free to respond to this email and Greg will reply once he has dug out from the pending patches received from other developers.
thanks,
greg k-h's patch email bot
Hello Greg,
I did amend my first commit
I used the command: git commit --amend -v
The result of this commit action is what I sent over.
Signature · 2 lines
Kind regards, Calvince Otieno
Quoted 22 lines · Calvince Otieno
Quoted 20 lines · Greg Kroah-Hartman
Quoted 18 lines · Calvince Otieno
In response to the suggestion by Dan Carpenter on the initial patch, this patch provides a correct usage of the
strscpy()in place of the currentstrcpy()implementation.
strscpy()copies characters from the source buffer to the destination buffer until one of the following conditions is met:
- null-terminator ('\0') is encountered in the source string.
- specified maximum length of the destination buffer is reached.
- source buffer is exhausted.
Example:char dest[11]; const char *PRISM2_USB_FWFILE = "prism2_ru.fw"; strscpy(dest, PRISM2_USB_FWFILE, sizeof(dest)); In this case, strscpy copies the first 10 characters of src into dest and add a null-terminator. dest will then contain "prism2_ru.f" with proper null-termination.
Quoted 7 lines
Quoted 7 lines
Quoted 7 lines
Since the specified length of the dest buffer is not derived from the dest buffer itself and rather form plug length (s3plug[i].len), replacing
strcpy()withstrscpy()is a better option because it will ensures that the destination string is always properly terminated.Signed-off-by Calvince Otieno <[email protected]>---
Hi,
Greg wants you to add a changelog here below the "---". Can look like this:
v2 : description of changes
Bye Philipp
Quoted 57 lines
Quoted 40 lines
Quoted 17 lines
drivers/staging/wlan-ng/prism2fw.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-)drivers/staging/wlan-ng/prism2fw.c +1
-2@@ -725,7 +725,7 @@ static int plugimage(struct imgchunk *fchunk, unsigned int nfchunks,if (j ==-1 ) {/* plug the filename */ memset (dest,0 , s3plug[i].len); -strncpy (dest,PRISM2_USB_FWFILE , s3plug[i].len -1 ); +strscpy (dest,PRISM2_USB_FWFILE , s3plug[i].len); }else {/* plug a PDR */ memcpy (dest, &pda->rec[j]->data, s3plug[i].len); } --Quoted 3 lines
2.34.1
Hi,
This is the friendly patch-bot of Greg Kroah-Hartman. You have sent him a patch that has triggered this response. He used to manually respond to these common problems, but in order to save his sanity (he kept writing the same thing over and over, yet to different people), I was created. Hopefully you will not take offence and will fix the problem in your patch and resubmit it so that it can be accepted into the Linux kernel tree.
You are receiving this message because of the following common error(s) as indicated below:
- This looks like a new version of a previously submitted patch, but you did not list below the --- line any changes from the previous version. Please read the section entitled "The canonical patch format" in the kernel file,
Documentation/process/submitting-patches.rstfor what needs to be done here to properly describe this.Quoted 8 lines
If you wish to discuss this problem further, or you have questions about how to resolve this issue, please feel free to respond to this email and Greg will reply once he has dug out from the pending patches received from other developers.
thanks,
greg k-h's patch email bot
Hello Greg,
I did amend my first commit
I used the command: git commit --amend -v
The result of this commit action is what I sent over.
Quoted 18 lines · Calvince Otieno
In response to the suggestion by Dan Carpenter on the initial patch, this patch provides a correct usage of the
strscpy()in place of the currentstrcpy()implementation.
strscpy()copies characters from the source buffer to the destination buffer until one of the following conditions is met:
- null-terminator ('\0') is encountered in the source string.
- specified maximum length of the destination buffer is reached.
- source buffer is exhausted.
Example:char dest[11]; const char *PRISM2_USB_FWFILE = "prism2_ru.fw"; strscpy(dest, PRISM2_USB_FWFILE, sizeof(dest)); In this case, strscpy copies the first 10 characters of src into dest and add a null-terminator. dest will then contain "prism2_ru.f" with proper null-termination.
Quoted 4 lines
Since the specified length of the dest buffer is not derived from the dest buffer itself and rather form plug length (s3plug[i].len), replacing
strcpy()withstrscpy()is a better option because it will ensures that the destination string is always properly terminated.
Ok, the original code also ensured that the destination string was NUL terminated.
Here is what I want this commit message to look like:
===
Checkpatch encourages everyone to use strscpy() instead of strncpy(). The advantages are that it always adds a NUL terminator and it prevents a read overflow if the src string is not properly terminated. One potential disadvantage is that it doesn't zero pad the string like strncpy() does.
In this code, strscpy() and strncpy() are equivalent and it does not affect runtime behavior. The string is zeroed on the line before using memset(). The resulting string was always NUL terminated and PRISM2_USB_FWFILE is string literal "prism2_ru.fw" so it's NUL terminated.
However, even though using strscpy() does not fix any bugs, it's still nicer and makes checkpatch happy.
===
Quoted 3 lines
Signed-off-by Calvince Otieno <[email protected]>---
v2: Update the commit message. Remove the " - 1" from the strcpy().
regards,
dan carpenter