-
Notifications
You must be signed in to change notification settings - Fork 1.5k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Check for newlines and carriage return in artifact paths and name (#951)
* Check for newlines and carriage return in artifact paths and name * Fix linting issue * Update comments * Add comment about spacing * Remove extra space
- Loading branch information
1 parent
4df5abb
commit 88062ec
Showing
6 changed files
with
162 additions
and
120 deletions.
There are no files selected for viewing
78 changes: 78 additions & 0 deletions
78
packages/artifact/__tests__/path-and-artifact-name-validation.test.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| import { | ||
| checkArtifactName, | ||
| checkArtifactFilePath | ||
| } from '../src/internal/path-and-artifact-name-validation' | ||
| import * as core from '@actions/core' | ||
|
|
||
| describe('Path and artifact name validation', () => { | ||
| beforeAll(() => { | ||
| // mock all output so that there is less noise when running tests | ||
| jest.spyOn(console, 'log').mockImplementation(() => {}) | ||
| jest.spyOn(core, 'debug').mockImplementation(() => {}) | ||
| jest.spyOn(core, 'info').mockImplementation(() => {}) | ||
| jest.spyOn(core, 'warning').mockImplementation(() => {}) | ||
| }) | ||
|
|
||
| it('Check Artifact Name for any invalid characters', () => { | ||
| const invalidNames = [ | ||
| 'my\\artifact', | ||
| 'my/artifact', | ||
| 'my"artifact', | ||
| 'my:artifact', | ||
| 'my<artifact', | ||
| 'my>artifact', | ||
| 'my|artifact', | ||
| 'my*artifact', | ||
| 'my?artifact', | ||
| '' | ||
| ] | ||
| for (const invalidName of invalidNames) { | ||
| expect(() => { | ||
| checkArtifactName(invalidName) | ||
| }).toThrow() | ||
| } | ||
|
|
||
| const validNames = [ | ||
| 'my-normal-artifact', | ||
| 'myNormalArtifact', | ||
| 'm¥ñðrmålÄr†ï£å¢†' | ||
| ] | ||
| for (const validName of validNames) { | ||
| expect(() => { | ||
| checkArtifactName(validName) | ||
| }).not.toThrow() | ||
| } | ||
| }) | ||
|
|
||
| it('Check Artifact File Path for any invalid characters', () => { | ||
| const invalidNames = [ | ||
| 'some/invalid"artifact/path', | ||
| 'some/invalid:artifact/path', | ||
| 'some/invalid<artifact/path', | ||
| 'some/invalid>artifact/path', | ||
| 'some/invalid|artifact/path', | ||
| 'some/invalid*artifact/path', | ||
| 'some/invalid?artifact/path', | ||
| 'some/invalid\rartifact/path', | ||
| 'some/invalid\nartifact/path', | ||
| 'some/invalid\r\nartifact/path', | ||
| '' | ||
| ] | ||
| for (const invalidName of invalidNames) { | ||
| expect(() => { | ||
| checkArtifactFilePath(invalidName) | ||
| }).toThrow() | ||
| } | ||
|
|
||
| const validNames = [ | ||
| 'my/perfectly-normal/artifact-path', | ||
| 'my/perfectly\\Normal/Artifact-path', | ||
| 'm¥/ñðrmål/Är†ï£å¢†' | ||
| ] | ||
| for (const validName of validNames) { | ||
| expect(() => { | ||
| checkArtifactFilePath(validName) | ||
| }).not.toThrow() | ||
| } | ||
| }) | ||
| }) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
82 changes: 82 additions & 0 deletions
82
packages/artifact/src/internal/path-and-artifact-name-validation.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,82 @@ | ||
| import {info} from '@actions/core' | ||
|
|
||
| /** | ||
| * Invalid characters that cannot be in the artifact name or an uploaded file. Will be rejected | ||
| * from the server if attempted to be sent over. These characters are not allowed due to limitations with certain | ||
| * file systems such as NTFS. To maintain platform-agnostic behavior, all characters that are not supported by an | ||
| * individual filesystem/platform will not be supported on all fileSystems/platforms | ||
| * | ||
| * FilePaths can include characters such as \ and / which are not permitted in the artifact name alone | ||
| */ | ||
| const invalidArtifactFilePathCharacters = new Map<string, string>([ | ||
| ['"', ' Double quote "'], | ||
| [':', ' Colon :'], | ||
| ['<', ' Less than <'], | ||
| ['>', ' Greater than >'], | ||
| ['|', ' Vertical bar |'], | ||
| ['*', ' Asterisk *'], | ||
| ['?', ' Question mark ?'], | ||
| ['\r', ' Carriage return \\r'], | ||
| ['\n', ' Line feed \\n'] | ||
| ]) | ||
|
|
||
| const invalidArtifactNameCharacters = new Map<string, string>([ | ||
| ...invalidArtifactFilePathCharacters, | ||
| ['\\', ' Backslash \\'], | ||
| ['/', ' Forward slash /'] | ||
| ]) | ||
|
|
||
| /** | ||
| * Scans the name of the artifact to make sure there are no illegal characters | ||
| */ | ||
| export function checkArtifactName(name: string): void { | ||
| if (!name) { | ||
| throw new Error(`Artifact name: ${name}, is incorrectly provided`) | ||
| } | ||
|
|
||
| for (const [ | ||
| invalidCharacterKey, | ||
| errorMessageForCharacter | ||
| ] of invalidArtifactNameCharacters) { | ||
| if (name.includes(invalidCharacterKey)) { | ||
| throw new Error( | ||
| `Artifact name is not valid: ${name}. Contains the following character: ${errorMessageForCharacter} | ||
| Invalid characters include: ${Array.from( | ||
| invalidArtifactNameCharacters.values() | ||
| ).toString()} | ||
| These characters are not allowed in the artifact name due to limitations with certain file systems such as NTFS. To maintain file system agnostic behavior, these characters are intentionally not allowed to prevent potential problems with downloads on different file systems.` | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| info(`Artifact name is valid!`) | ||
| } | ||
|
|
||
| /** | ||
| * Scans the name of the filePath used to make sure there are no illegal characters | ||
| */ | ||
| export function checkArtifactFilePath(path: string): void { | ||
| if (!path) { | ||
| throw new Error(`Artifact path: ${path}, is incorrectly provided`) | ||
| } | ||
|
|
||
| for (const [ | ||
| invalidCharacterKey, | ||
| errorMessageForCharacter | ||
| ] of invalidArtifactFilePathCharacters) { | ||
| if (path.includes(invalidCharacterKey)) { | ||
| throw new Error( | ||
| `Artifact path is not valid: ${path}. Contains the following character: ${errorMessageForCharacter} | ||
| Invalid characters include: ${Array.from( | ||
| invalidArtifactFilePathCharacters.values() | ||
| ).toString()} | ||
| The following characters are not allowed in files that are uploaded due to limitations with certain file systems such as NTFS. To maintain file system agnostic behavior, these characters are intentionally not allowed to prevent potential problems with downloads on different file systems. | ||
| ` | ||
| ) | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters