path-validation

Path validation utility

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
path-validation
0.2.36 years ago6 years agoMinified + gzip package size for path-validation in KB

Readme

path-validation npm version Build Status
This utility package is intended to be used for filesystem path validation from any user input (html form for example).
path-validation does not check the real filesystem structure - check fs.lstat() to validate against filesystem.

isAbsolutePath(str, dirSeparator)

Rules

  1. provided path is string
  1. provided path is not empty string
  1. provided path doesn't have disallowed characters (see list below)
  1. provided path resolves to absolute path
  1. provided path match platform specific rules (see list below)

Linux specific rules (dirSeparator = "/")

  1. a) start with slash
  1. b) does not contain backslash

Windows specific rules (dirSeparator = "\\")

  1. c) start with drive letter
  1. d) does not contain forward slash
  1. e) contain only one colon (after drive letter)

Disallowed characters

The list of disallowed characters include restriced characters on Linux & Windows as well as some characters that should be avoided in file naming. ``` (left square bracket) (right square bracket)
(number sign / hash / pound)
% (percent sign) & (ampersand) { (left curly bracket) } (right curly bracket) < (less than)
(greater than)
  • (asterisk - part of patterns)
? (question mark) \s (any whitespace) \b (backspace) \0 (null byte) $ (dollar) ! (exclamation mark) ' (single quote) : (colon - allowed on Windows to appear once only) @ (at) | (vertical bar or pipe) ā€˜ (backtick) ` (backtick) ā€œ (double quote) " (double quote)
  • (plus sign)
^ (caret) / (slash - disallowed on Windows only) \ (backslash - disallowed on Linux only) ```

isAbsoluteLinuxPath(str)

Alias to isAbsolutePath(str, '/')

isAbsoluteWindowsPath(str)

Alias to isAbsolutePath(str, '\\')

Related articles

  • http://www.mtu.edu/umc/services/digital/writing/characters-avoid/
  • https://serverfault.com/questions/150740/linux-windows-unix-file-names-which-characters-are-allowed-which-are-unesc
  • https://stackoverflow.com/questions/1976007/what-characters-are-forbidden-in-windows-and-linux-directory-names

Contributing

Pull requests are always welcome. Please review and add your test specs for valid and invalid paths.

Alternatives

  1. Node.js path.isAbsolute(). It seems to be insufficient for input validation since it allows glob patterns and traversal.
  1. NPM package path-is-absolute. Not sufficeint for input validation since the only thing it checks for posix path is if it starts with '/' (slash). Therefore backspace, null byte, patters and traversal are allowed.

License

Copyright (c) 2018 Adrian Matylewicz Released under the MIT license.