Skip to content

Commit

Permalink
usb: gadget: f_uac1: Replace snprintf() with the safer scnprintf() va…
Browse files Browse the repository at this point in the history
…riant

There is a general misunderstanding amongst engineers that {v}snprintf()
returns the length of the data *actually* encoded into the destination
array.  However, as per the C99 standard {v}snprintf() really returns
the length of the data that *would have been* written if there were
enough space for it.  This misunderstanding has led to buffer-overruns
in the past.  It's generally considered safer to use the {v}scnprintf()
variants in their place (or even sprintf() in simple cases).  So let's
do that.

Link: https://lwn.net/Articles/69419/
Link: KSPP#105
Cc: Ruslan Bilovol <ruslan.bilovol@gmail.com>
Cc: Julian Scheel <julian@jusst.de>
Cc: Bryan Wu <cooloney@kernel.org>
Signed-off-by: Lee Jones <lee@kernel.org>
Link: https://lore.kernel.org/r/20231213164246.1021885-3-lee@kernel.org
Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
  • Loading branch information
lag-linaro authored and gregkh committed Dec 15, 2023
1 parent 0466e7e commit c1a3718
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions drivers/usb/gadget/function/f_uac1.c
Original file line number Diff line number Diff line change
Expand Up @@ -1634,7 +1634,7 @@ static ssize_t f_uac1_opts_##name##_show(struct config_item *item, \
int result; \
\
mutex_lock(&opts->lock); \
result = snprintf(page, sizeof(opts->name), "%s", opts->name); \
result = scnprintf(page, sizeof(opts->name), "%s", opts->name); \
mutex_unlock(&opts->lock); \
\
return result; \
Expand All @@ -1652,7 +1652,7 @@ static ssize_t f_uac1_opts_##name##_store(struct config_item *item, \
goto end; \
} \
\
ret = snprintf(opts->name, min(sizeof(opts->name), len), \
ret = scnprintf(opts->name, min(sizeof(opts->name), len), \
"%s", page); \
\
end: \
Expand Down Expand Up @@ -1758,7 +1758,7 @@ static struct usb_function_instance *f_audio_alloc_inst(void)

opts->req_number = UAC1_DEF_REQ_NUM;

snprintf(opts->function_name, sizeof(opts->function_name), "AC Interface");
scnprintf(opts->function_name, sizeof(opts->function_name), "AC Interface");

return &opts->func_inst;
}
Expand Down

0 comments on commit c1a3718

Please sign in to comment.