Skip to content

Commit

Permalink
fix: sanitaze paths before validating them
Browse files Browse the repository at this point in the history
  • Loading branch information
JoanVicens committed Nov 30, 2022
1 parent aadeef4 commit c0be00d
Show file tree
Hide file tree
Showing 2 changed files with 61 additions and 12 deletions.
14 changes: 11 additions & 3 deletions src/workers/utils/name-verification.ts
Original file line number Diff line number Diff line change
@@ -1,13 +1,21 @@
import path from 'path';

const isWindowsRootDirectory = /[a-zA-Z]:[\\/]/;
const containsNullCharacter = /\0/g;

const validations = [
(name: string) => name.includes('../'),
(name: string) => name.includes('..'),
(name: string) => name.startsWith('/'),
(name: string) => isWindowsRootDirectory.test(name),
(name: string) => name.includes('\\'),
(name: string) => containsNullCharacter.test(name),
];

export const fileNameIsValid = (fileName: string): boolean =>
validations.every((validation) => !validation(fileName));
const sanitazeRelativePath = (relativePath: string) =>
relativePath.replaceAll(path.sep, '/');

export const fileNameIsValid = (fileName: string): boolean => {
const sanitazedPath = sanitazeRelativePath(fileName);

return validations.every((validation) => !validation(sanitazedPath));
};
59 changes: 50 additions & 9 deletions src/workers/utils/test/name-verification.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@ import { fileNameIsValid } from '../name-verification';

import sensibleFiles from './sensible-files.json';

const path = require('path');

describe('name verifiaction test', () => {
const INVALID = false;
const VALID = true;
Expand All @@ -24,15 +26,6 @@ describe('name verifiaction test', () => {
});

describe('firts level files', () => {
it('startup folder is not valid', () => {
const maliciousFileName =
'..App\\DataRoaming\\MicrosoftWindows\\Start Menu\\Programs\\Startup';

const result = fileNameIsValid(maliciousFileName);

expect(result).toBe(INVALID);
});

it('parent folder is not valid', () => {
const maliciousFileName = '../file.txt';

Expand Down Expand Up @@ -106,4 +99,52 @@ describe('name verifiaction test', () => {
expect(result).toBe(INVALID);
});
});

describe('windows file system', () => {
let originalPathSeparation: string;

beforeAll(() => {
originalPathSeparation = path.sep as string;
path.sep = '\\';
});

afterAll(() => {
path.sep = originalPathSeparation;
});

it('startup folder is not valid', () => {
const maliciousFileName =
'..App\\DataRoaming\\MicrosoftWindows\\Start Menu\\Programs\\Startup';

const result = fileNameIsValid(maliciousFileName);

expect(result).toBe(INVALID);
});

it('second level files on windows are valid', () => {
const fileName = 'folder_name\\my-image.jpg';

const result = fileNameIsValid(fileName);

expect(result).toBe(VALID);
});

describe('n level files', () => {
const correctWindowsFiles = [
'folder_name\\my-images\\cat.jpg',
'cat.jpg',
'folder_name\\my-images\\february\\cat.jpg',
'folder_name\\my-image.jpg',
];

it.each(correctWindowsFiles)(
'valid paths are correctly validated',
(fileName: string) => {
const result = fileNameIsValid(fileName);

expect(result).toBe(VALID);
}
);
});
});
});

0 comments on commit c0be00d

Please sign in to comment.