Skip to contentSkip to conversation

fs: fat: correct file name normalization

PATCH New Heinrich Schuchardt 3 participants 4 messages May 12, 2019 – May 29, 2019 VFAT/FAT/msdos filesystem

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 fs: fat: correct file name normalization

File names may not contain control characters (< 0x20). Simplify the coding.

---
 fs/fat/fat_write.c | 48 +++++++++++++++++++---------------------------
 1 file changed, 20 insertions(+), 28 deletions(-)
fs/fat/fat_write.c +20 -28
index 852f874e58..2a74199236 100644
@@ -1009,40 +1009,32 @@ again:
 	return 0;
 }
 
+/**
+ * normalize_longname() - check long file name and convert to lower case
+ *
+ * We assume here that the FAT file system is using an 8bit code page.
+ * Linux typically uses CP437, EDK2 assumes CP1250.
+ *
+ * @l_filename:	preallocated buffer receiving the normalized name
+ * @filename:	filename to normalize
+ * Return:	0 on success, -1 on failure
+ */
 static int normalize_longname(char *l_filename, const char *filename)
 {
-	const char *p, legal[] = "!#$%&\'()-.@^`_{}~";
-	unsigned char c;
-	int name_len;
-
-	/* Check that the filename is valid */
-	for (p = filename; p < filename + strlen(filename); p++) {
-		c = *p;
-
-		if (('0' <= c) && (c <= '9'))
-			continue;
-		if (('A' <= c) && (c <= 'Z'))
-			continue;
-		if (('a' <= c) && (c <= 'z'))
-			continue;
-		if (strchr(legal, c))
-			continue;
-		/* extended code */
-		if ((0x80 <= c) && (c <= 0xff))
-			continue;
+	const char *p, illegal[] = "<>:\"/\\|?*";
 
+	if (strlen(filename) >= VFAT_MAXLEN_BYTES)
 		return -1;
-	}
 
-	/* Normalize it */
-	name_len = strlen(filename);
-	if (name_len >= VFAT_MAXLEN_BYTES)
-		/* should return an error? */
-		name_len = VFAT_MAXLEN_BYTES - 1;
+	for (p = filename; *p; ++p) {
+		if ((unsigned char)*p < 0x20)
+			return -1;
+		if (strchr(illegal, *p))
+			return -1;
+	}
 
-	memcpy(l_filename, filename, name_len);
-	l_filename[name_len] = 0; /* terminate the string */
-	downcase(l_filename, INT_MAX);
+	strcpy(l_filename, filename);
+	downcase(l_filename, VFAT_MAXLEN_BYTES);
 
 	return 0;
 }

--
2.20.1

#1 lore raw

PATCH 1/1 fs: fat: correct file name normalization

Heinrich,

Quoted 38 lines · Heinrich Schuchardt

File names may not contain control characters (< 0x20). Simplify the coding.

---
 fs/fat/fat_write.c | 48 +++++++++++++++++++---------------------------
 1 file changed, 20 insertions(+), 28 deletions(-)
fs/fat/fat_write.c +10 -10
index 852f874e58..2a74199236 100644
@@ -1009,40 +1009,32 @@ again:
 	return 0;
 }
 
+/**
+ * normalize_longname() - check long file name and convert to lower case
+ *
+ * We assume here that the FAT file system is using an 8bit code page.
+ * Linux typically uses CP437, EDK2 assumes CP1250.
+ *
+ * @l_filename:	preallocated buffer receiving the normalized name
+ * @filename:	filename to normalize
+ * Return:	0 on success, -1 on failure
+ */
 static int normalize_longname(char *l_filename, const char *filename)
 {
-	const char *p, legal[] = "!#$%&\'()-.@^`_{}~";
-	unsigned char c;
-	int name_len;
-
-	/* Check that the filename is valid */
-	for (p = filename; p < filename + strlen(filename); p++) {
-		c = *p;
-
-		if (('0' <= c) && (c <= '9'))
-			continue;

fs/fat/fat_write.c again: · line 1024

Quoted 10 lines
fs/fat/fat_write.c +1 -9
-		if (('A' <= c) && (c <= 'Z'))
-			continue;
-		if (('a' <= c) && (c <= 'z'))
-			continue;
-		if (strchr(legal, c))
-			continue;
-		/* extended code */
-		if ((0x80 <= c) && (c <= 0xff))
-			continue;
+	const char *p, illegal[] = "<>:\"/\\|?*";

With your patch, 8 characters, " +,;-[]" and \177 (= DEL), are added as legal characters. DEL should be excluded. Other than that, the rule seems to be fine for long file names.

Quoted 11 lines
fs/fat/fat_write.c +3 -6
+	if (strlen(filename) >= VFAT_MAXLEN_BYTES)
 		return -1;
-	}
 
-	/* Normalize it */
-	name_len = strlen(filename);
-	if (name_len >= VFAT_MAXLEN_BYTES)
-		/* should return an error? */
-		name_len = VFAT_MAXLEN_BYTES - 1;
+	for (p = filename; *p; ++p) {
+		if ((unsigned char)*p < 0x20)

fs/fat/fat_write.c again: · line 1037

Quoted 10 lines
fs/fat/fat_write.c +6 -3
+			return -1;
+		if (strchr(illegal, *p))
+			return -1;
+	}
 
-	memcpy(l_filename, filename, name_len);
-	l_filename[name_len] = 0; /* terminate the string */
-	downcase(l_filename, INT_MAX);
+	strcpy(l_filename, filename);
+	downcase(l_filename, VFAT_MAXLEN_BYTES);

Strictly speaking,
it is not necessary to 'downcase' a file name here as a long file name may contain lower-case characters.
On the other hand, a short file name, which is to be set in set_name(), should be checked against more restricted character set.

In addition,
l_filename, instead of filename, should be passed to fill_dir_slot() at file_fat_write_at() as fill_dir_slot() expects a long file name. l_dirname in fat_mkdir() as well.

-Takahiro Akashi

Quoted 5 lines
fs/fat/fat_write.c +0 -1
 	return 0;
 }
--

2.20.1

#2 lore raw

PATCH 1/1 fs: fat: correct file name normalization

Quoted 47 lines · AKASHI Takahiro

Heinrich,

Quoted 44 lines · Heinrich Schuchardt

File names may not contain control characters (< 0x20). Simplify the coding.

---
 fs/fat/fat_write.c | 48 +++++++++++++++++++---------------------------
 1 file changed, 20 insertions(+), 28 deletions(-)
fs/fat/fat_write.c +10 -16
index 852f874e58..2a74199236 100644
@@ -1009,40 +1009,32 @@ again:
 	return 0;
 }
 
+/**
+ * normalize_longname() - check long file name and convert to lower case
+ *
+ * We assume here that the FAT file system is using an 8bit code page.
+ * Linux typically uses CP437, EDK2 assumes CP1250.
+ *
+ * @l_filename:	preallocated buffer receiving the normalized name
+ * @filename:	filename to normalize
+ * Return:	0 on success, -1 on failure
+ */
 static int normalize_longname(char *l_filename, const char *filename)
 {
-	const char *p, legal[] = "!#$%&\'()-.@^`_{}~";
-	unsigned char c;
-	int name_len;
-
-	/* Check that the filename is valid */
-	for (p = filename; p < filename + strlen(filename); p++) {
-		c = *p;
-
-		if (('0' <= c) && (c <= '9'))
-			continue;
-		if (('A' <= c) && (c <= 'Z'))
-			continue;
-		if (('a' <= c) && (c <= 'z'))
-			continue;
-		if (strchr(legal, c))
-			continue;
Quoted 8 lines

fs/fat/fat_write.c again: · line 1024

Quoted 4 lines
fs/fat/fat_write.c +1 -3
-		/* extended code */
-		if ((0x80 <= c) && (c <= 0xff))
-			continue;
+	const char *p, illegal[] = "<>:\"/\\|?*";

With your patch, 8 characters, " +,;-[]" and \177 (= DEL), are added as legal characters. DEL should be excluded. Other than that, the rule seems to be fine for long file names.

The Microsoft specification can be found here:
http://read.pudn.com/downloads77/ebook/294884/FAT32%20Spec%20%28SDA%20Contribution%29.pdf

Long file names allow more characters than short file names but 0x7f is not added.

So we have to correct this in the implementation of the Unicode collation protocol as well.

Quoted 17 lines
Quoted 17 lines
fs/fat/fat_write.c +7 -6
+	if (strlen(filename) >= VFAT_MAXLEN_BYTES)
 		return -1;
-	}
 
-	/* Normalize it */
-	name_len = strlen(filename);
-	if (name_len >= VFAT_MAXLEN_BYTES)
-		/* should return an error? */
-		name_len = VFAT_MAXLEN_BYTES - 1;
+	for (p = filename; *p; ++p) {
+		if ((unsigned char)*p < 0x20)
+			return -1;
+		if (strchr(illegal, *p))
+			return -1;
+	}
 
Quoted 11 lines

fs/fat/fat_write.c again: · line 1037

Quoted 5 lines
fs/fat/fat_write.c +2 -3
-	memcpy(l_filename, filename, name_len);
-	l_filename[name_len] = 0; /* terminate the string */
-	downcase(l_filename, INT_MAX);
+	strcpy(l_filename, filename);
+	downcase(l_filename, VFAT_MAXLEN_BYTES);

Strictly speaking,
it is not necessary to 'downcase' a file name here as a long file name may contain lower-case characters.
On the other hand, a short file name, which is to be set in set_name(), should be checked against more restricted character set.

When looking up files in the directory we should convert both the filename on disk and the filename in the API call to the same upper or lower case. This should also include characters above 0x7f.

When creating a file we should use the same case as provided to the API.

The current downcase function does not treat characters > 07xf correctly.

I think the best thing to do here is to split the patch into two:
- one caring about allowable letters
- one caring about handling of the case.

Thanks for reviewing.

Best regards

Heinrich

Quoted 14 lines

In addition,
l_filename, instead of filename, should be passed to fill_dir_slot() at file_fat_write_at() as fill_dir_slot() expects a long file name. l_dirname in fat_mkdir() as well.

-Takahiro Akashi

Quoted 5 lines
fs/fat/fat_write.c +0 -1
 	return 0;
 }
--

2.20.1

#3 lore raw

PATCH 1/1 fs: fat: correct file name normalization

In reply to Heinrich Schuchardt
Quoted 4 lines · Heinrich Schuchardt

File names may not contain control characters (< 0x20). Simplify the coding.

Applied to u-boot/master, thanks!

Signature · 8 lines
Tom
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 819 bytes
Desc: not available
URL: <http://lists.denx.de/pipermail/u-boot/attachments/20190529/07b4ac6a/attachment.sig>