Make v9fs uname and remotename parsing more robust
Subsystems (2)
PATCH 1/1 Make v9fs uname and remotename parsing more robust
match_strcpy() is a somewhat creepy function: the caller needs to make sure that the destination buffer is big enough, and when he screws up or forgets, match_strcpy() happily overruns the buffer.
There's exactly one customer: v9fs_parse_options(). I believe it currently can't overflow its buffer, but that's not exactly obvious.
The source string is a substing of the mount options. The kernel silently truncates those to PAGE_SIZE bytes, including the terminating zero. See compat_sys_mount() and do_mount().
The destination buffer is obtained from __getname(), which allocates from name_cachep, which is initialized by vfs_caches_init() for size PATH_MAX.
We're safe as long as PATH_MAX <= PAGE_SIZE. PATH_MAX is 4096. As far as I know, the smallest PAGE_SIZE is also 4096.
Here's a patch that makes the code a bit more obviously correct. It doesn't depend on PATH_MAX <= PAGE_SIZE.
fs/9p/v9fs.c +2 -2
@@ -135,10 +135,10 @@ static void v9fs_parse_options(struct v9fs_session_info *v9ses) v9ses->trans =v9fs_match_trans (&args[0 ]);break ;case Opt_uname: -match_strcpy (v9ses->uname, &args[0 ]); +match_strlcpy (v9ses->uname, &args[0 ],PATH_MAX );break ;case Opt_remotename: -match_strcpy (v9ses->aname, &args[0 ]); +match_strlcpy (v9ses->aname, &args[0 ],PATH_MAX );break ;case Opt_legacy: v9ses->flags &= ~V9FS_EXTENDED ;
include/linux/parser.h +1 -1
@@ -29,5 +29,5 @@ int match_token(char *, match_table_t table, substring_t args[]);int match_int (substring_t *,int *result);int match_octal (substring_t *,int *result);int match_hex (substring_t *,int *result); -void match_strcpy (char *,const substring_t *); +size_t match_strlcpy (char *,const substring_t *,size_t );char *match_strdup (const substring_t *);
lib/parser.c +20 -12
@@ -182,18 +182,25 @@ int match_hex(substring_t *s, int *result) }/** -* match_strcpy: - copies the characters from a substring_t to a string -* @to: string to copy characters to. -* @s: &substring_t to copy +* match_strlcpy: - Copy the characters from a substring_t to a sized buffer +* @dest: where to copy to +* @src: &substring_t to copy +* @size: size of destination buffer * -* Description: Copies the set of characters represented by the given -* &substring_t @s to the c-style string @to. Caller guarantees that @to is -* large enough to hold the characters of @s. +* Description: Copy the characters in &substring_t @src to the +* c-style string @dest. Copy no more than @size - 1 characters, plus +* the terminating NUL. Return length of @src. */ -void match_strcpy (char *to,const substring_t *s) +size_t match_strlcpy (char *dest,const substring_t *src,size_t size) { -memcpy (to, s->from, s->to - s->from); - to[s->to - s->from] ='\0' ; +size_t ret = src->to - src->from; + +if (size) { +size_t len = ret >= size ? size -1 : ret; +memcpy (dest, src->from, len); + dest[len] ='\0' ; + } +return ret; }/**
@@ -206,9 +213,10 @@ void match_strcpy(char *to, const substring_t *s)*/ char *match_strdup (const substring_t *s) { -char *p =kmalloc (s->to - s->from +1 ,GFP_KERNEL ); +size_t sz = s->to - s->from +1 ; +char *p =kmalloc (sz,GFP_KERNEL );if (p) -match_strcpy (p, s); +match_strlcpy (p, s, sz);return p; }
@@ -216,5 +224,5 @@ EXPORT_SYMBOL(match_token);EXPORT_SYMBOL (match_int);EXPORT_SYMBOL (match_octal);EXPORT_SYMBOL (match_hex); -EXPORT_SYMBOL (match_strcpy); +EXPORT_SYMBOL (match_strlcpy);EXPORT_SYMBOL (match_strdup);
PATCH 1/1 9p: Make uname and remotename parsing more robust
match_strcpy() is a somewhat creepy function: the caller needs to make sure that the destination buffer is big enough, and when he screws up or forgets, match_strcpy() happily overruns the buffer.
There's exactly one customer: v9fs_parse_options(). I believe it currently can't overflow its buffer, but that's not exactly obvious.
The source string is a substring of the mount options. The kernel silently truncates those to PAGE_SIZE bytes, including the terminating zero. See compat_sys_mount() and do_mount().
The destination buffer is obtained from __getname(), which allocates from name_cachep, which is initialized by vfs_caches_init() for size PATH_MAX.
We're safe as long as PATH_MAX <= PAGE_SIZE. PATH_MAX is 4096. As far as I know, the smallest PAGE_SIZE is also 4096.
Here's a patch that makes the code a bit more obviously correct. It doesn't depend on PATH_MAX <= PAGE_SIZE.
fs/9p/v9fs.c +2 -2
@@ -135,10 +135,10 @@ static void v9fs_parse_options(struct v9fs_session_info *v9ses) v9ses->trans =v9fs_match_trans (&args[0 ]);break ;case Opt_uname: -match_strcpy (v9ses->uname, &args[0 ]); +match_strlcpy (v9ses->uname, &args[0 ],PATH_MAX );break ;case Opt_remotename: -match_strcpy (v9ses->aname, &args[0 ]); +match_strlcpy (v9ses->aname, &args[0 ],PATH_MAX );break ;case Opt_legacy: v9ses->flags &= ~V9FS_EXTENDED ;
include/linux/parser.h +1 -1
@@ -29,5 +29,5 @@ int match_token(char *, match_table_t table, substring_t args[]);int match_int (substring_t *,int *result);int match_octal (substring_t *,int *result);int match_hex (substring_t *,int *result); -void match_strcpy (char *,const substring_t *); +size_t match_strlcpy (char *,const substring_t *,size_t );char *match_strdup (const substring_t *);
lib/parser.c +20 -12
@@ -182,18 +182,25 @@ int match_hex(substring_t *s, int *result) }/** -* match_strcpy: - copies the characters from a substring_t to a string -* @to: string to copy characters to. -* @s: &substring_t to copy +* match_strlcpy: - Copy the characters from a substring_t to a sized buffer +* @dest: where to copy to +* @src: &substring_t to copy +* @size: size of destination buffer * -* Description: Copies the set of characters represented by the given -* &substring_t @s to the c-style string @to. Caller guarantees that @to is -* large enough to hold the characters of @s. +* Description: Copy the characters in &substring_t @src to the +* c-style string @dest. Copy no more than @size - 1 characters, plus +* the terminating NUL. Return length of @src. */ -void match_strcpy (char *to,const substring_t *s) +size_t match_strlcpy (char *dest,const substring_t *src,size_t size) { -memcpy (to, s->from, s->to - s->from); - to[s->to - s->from] ='\0' ; +size_t ret = src->to - src->from; + +if (size) { +size_t len = ret >= size ? size -1 : ret; +memcpy (dest, src->from, len); + dest[len] ='\0' ; + } +return ret; }/**
@@ -206,9 +213,10 @@ void match_strcpy(char *to, const substring_t *s)*/ char *match_strdup (const substring_t *s) { -char *p =kmalloc (s->to - s->from +1 ,GFP_KERNEL ); +size_t sz = s->to - s->from +1 ; +char *p =kmalloc (sz,GFP_KERNEL );if (p) -match_strcpy (p, s); +match_strlcpy (p, s, sz);return p; }
@@ -216,5 +224,5 @@ EXPORT_SYMBOL(match_token);EXPORT_SYMBOL (match_int);EXPORT_SYMBOL (match_octal);EXPORT_SYMBOL (match_hex); -EXPORT_SYMBOL (match_strcpy); +EXPORT_SYMBOL (match_strlcpy);EXPORT_SYMBOL (match_strdup);
Andrew Morton
maintainerQuoted 105 lines · On Fri, 15 Feb 2008 18:54:34 +0100 Markus Armbruster <[email protected]> wrote:
match_strcpy()is a somewhat creepy function: the caller needs to make sure that the destination buffer is big enough, and when he screws up or forgets,match_strcpy()happily overruns the buffer.There's exactly one customer:
v9fs_parse_options(). I believe it currently can't overflow its buffer, but that's not exactly obvious.The source string is a substing of the mount options. The kernel silently truncates those to
PAGE_SIZEbytes, including the terminating zero. Seecompat_sys_mount()anddo_mount().The destination buffer is obtained from
__getname(), which allocates fromname_cachep, which is initialized byvfs_caches_init()for sizePATH_MAX.We're safe as long as
PATH_MAX<=PAGE_SIZE.PATH_MAXis 4096. As far as I know, the smallestPAGE_SIZEis also 4096.Here's a patch that makes the code a bit more obviously correct. It doesn't depend on
PATH_MAX<=PAGE_SIZE.Signed-off-by Markus Armbruster <[email protected]>fs/9p/v9fs.c +2
-2@@ -135,10 +135,10 @@ static void v9fs_parse_options(struct v9fs_session_info *v9ses) v9ses->trans =v9fs_match_trans (&args[0 ]);break ;case Opt_uname: -match_strcpy (v9ses->uname, &args[0 ]); +match_strlcpy (v9ses->uname, &args[0 ],PATH_MAX );break ;case Opt_remotename: -match_strcpy (v9ses->aname, &args[0 ]); +match_strlcpy (v9ses->aname, &args[0 ],PATH_MAX );break ;case Opt_legacy: v9ses->flags &= ~V9FS_EXTENDED ;include/linux/parser.h +1
-1@@ -29,5 +29,5 @@ int match_token(char *, match_table_t table, substring_t args[]);int match_int (substring_t *,int *result);int match_octal (substring_t *,int *result);int match_hex (substring_t *,int *result); -void match_strcpy (char *,const substring_t *); +size_t match_strlcpy (char *,const substring_t *,size_t );char *match_strdup (const substring_t *);lib/parser.c +19
-11@@ -182,18 +182,25 @@ int match_hex(substring_t *s, int *result) }/** -* match_strcpy: - copies the characters from a substring_t to a string -* @to: string to copy characters to. -* @s: &substring_t to copy +* match_strlcpy: - Copy the characters from a substring_t to a sized buffer +* @dest: where to copy to +* @src: &substring_t to copy +* @size: size of destination buffer * -* Description: Copies the set of characters represented by the given -* &substring_t @s to the c-style string @to. Caller guarantees that @to is -* large enough to hold the characters of @s. +* Description: Copy the characters in &substring_t @src to the +* c-style string @dest. Copy no more than @size - 1 characters, plus +* the terminating NUL. Return length of @src. */ -void match_strcpy (char *to,const substring_t *s) +size_t match_strlcpy (char *dest,const substring_t *src,size_t size) { -memcpy (to, s->from, s->to - s->from); - to[s->to - s->from] ='\0' ; +size_t ret = src->to - src->from; + +if (size) { +size_t len = ret >= size ? size -1 : ret; +memcpy (dest, src->from, len); + dest[len] ='\0' ; + } +return ret; }/** @@ -206,9 +213,10 @@ void match_strcpy(char *to, const substring_t *s)*/ char *match_strdup (const substring_t *s) { -char *p =kmalloc (s->to - s->from +1 ,GFP_KERNEL ); +size_t sz = s->to - s->from +1 ; +char *p =kmalloc (sz,GFP_KERNEL );if (p) -match_strcpy (p, s); +match_strlcpy (p, s, sz);return p; }
lib/parser.c EXPORT_SYMBOL(match_token); · line 228
Quoted 6 lines
lib/parser.c +1
-1@@ -216,5 +224,5 @@ EXPORT_SYMBOL(match_token);EXPORT_SYMBOL (match_int);EXPORT_SYMBOL (match_octal);EXPORT_SYMBOL (match_hex); -EXPORT_SYMBOL (match_strcpy); +EXPORT_SYMBOL (match_strlcpy);EXPORT_SYMBOL (match_strdup);
It would be better to present this as two patches. One adds the new core APIs and the other uses those APIs in v9fs. The patches would take separate routes into mainline.
I guess I can sneak this one in as-is, as long as the v9fs guys are OK with that?
Quoted 8 lines · Andrew Morton
It would be better to present this as two patches. One adds the new core APIs and the other uses those APIs in v9fs. The patches would take separate routes into mainline.
I guess I can sneak this one in as-is, as long as the v9fs guys are OK with that?
I'm fine with it. Shall I pull it through the v9fs-devel patch line or would you rather send it with your patches Andrew?
-eric
Andrew Morton
maintainerQuoted 7 lines · On Sun, 24 Feb 2008 09:37:23 -0600 "Eric Van Hensbergen" <[email protected]>…
Quoted 5 lines · Andrew Morton
It would be better to present this as two patches. One adds the new core APIs and the other uses those APIs in v9fs. The patches would take separate routes into mainline.
Quoted 7 lines
Quoted 3 lines
I guess I can sneak this one in as-is, as long as the v9fs guys are OK with that?
I'm fine with it. Shall I pull it through the v9fs-devel patch line or would you rather send it with your patches Andrew?
It's more likely to get some testing in your tree, thanks. I'll send over my version with improved title and my s-o-b.