Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Blacklist filename chars #2077

Merged
merged 6 commits into from Oct 18, 2017
Merged

Blacklist filename chars #2077

Changes from 3 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b3f8a5a
Disallow filenames with trailing periods
AI0867 Oct 2, 2017
b2ca410
Remove redundant checks
AI0867 Oct 2, 2017
c1bc0ea
Add extra filename blacklist checks
AI0867 Oct 6, 2017
a95567f
Disallow characters not permitted on windows
AI0867 Oct 6, 2017
56329b1
Blacklist C1 control characters
AI0867 Oct 6, 2017
ff3855a
Eat an invalid_utf8_exception
AI0867 Oct 15, 2017
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
40 changes: 33 additions & 7 deletions src/addon/validation.cpp
View file
Open in desktop
Expand Up @@ -15,6 +15,7 @@

#include "addon/validation.hpp"
#include "config.hpp"
#include "serialization/unicode_cast.hpp"

#include <algorithm>

Expand Down Expand Up @@ -44,13 +45,33 @@ namespace {
}
}
};

struct addon_filename_ucs4char_illegal
{
inline bool operator()(ucs4::char_t c) const
{
switch(c){
case ' ':
case '/':
case ':':
case '\\':
case '~':
case 0x7F: // DEL
return true;
default:
return (
c < 0x20 || // control characters
(c >= 0xD800 && c < 0xE000) // surrogate pairs
Copy link
Member

@jyrkive jyrkive Oct 6, 2017 •
edited

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nitpicking: I'd prefer if the comment said just "surrogates" instead of "surrogate pairs", as it analyzes only one code point at a time.

);
}
}
};
}

bool addon_name_legal(const std::string& name)
{
if(name.empty() || name == "." ||
std::find_if(name.begin(), name.end(), addon_name_char_illegal()) != name.end() ||
name.find("..") != std::string::npos) {
if(name.empty() ||
std::find_if(name.begin(), name.end(), addon_name_char_illegal()) != name.end()) {
return false;
} else {
return true;
Expand All @@ -59,12 +80,17 @@ bool addon_name_legal(const std::string& name)

bool addon_filename_legal(const std::string& name)
{
if(name.empty() || name == "." ||
name.find_first_of("/:\\~ \r\n\v\t") != std::string::npos ||
name.find("..") != std::string::npos) {
if(name.empty() || name.back() == '.' ||
name.find("..") != std::string::npos ||
name.size() > 255) {
return false;
} else {
return true;
const ucs4::string name_ucs4 = unicode_cast<ucs4::string>(name);
const std::string name_utf8 = unicode_cast<utf8::string>(name_ucs4);
if(name != name_utf8){ // name is invalid UTF-8
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

did you test that this check works? I'd think that unicode_cast simply throws an exception in case of invalid utf8

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See unicode_cast.hpp. The cast swallows the exception and returns the part of the string that it was able to convert.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tested this yesterday. It works, but a different check failed in archive_addon. Specifically filesystem::looks_like_pbl failed because it uses utf8::lowercase. I've added a try-catch block for this.

return false;
}
return std::find_if(name_ucs4.begin(), name_ucs4.end(), addon_filename_ucs4char_illegal()) == name_ucs4.end();
}
}

Expand Down