Skip to content

[5.x] Fix token path traversal#14700

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.

Sign up for GitHub

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

Merged
jasonvarga merged 10 commits into from
May 21, 2026
Merged

[5.x] Fix token path traversal #14700

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
68330c3
Add failing test
duncanmcclean May 21, 2026
a5ad9f0
Tweak tests
duncanmcclean May 21, 2026
0e9bddf
Prevent path traversal in token repository
duncanmcclean May 21, 2026
4f4351e
Handle race condition in `LivePreview::tokenize()`
duncanmcclean May 21, 2026
151ac7e
Skip token lookup when token is empty
duncanmcclean May 21, 2026
8d0a82c
Use unique token name in test
duncanmcclean May 21, 2026
efe7f59
keep the race condition fix out of this pr
jasonvarga May 21, 2026
e3e770c
Validate token names against an allowlist
jasonvarga May 21, 2026
0b75e1c
Throw when making a token with an invalid name
jasonvarga May 21, 2026
19e1eaf
Use \z anchor so a trailing newline is rejected
jasonvarga May 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions src/Tokens/FileTokenRepository.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,11 +11,19 @@ class FileTokenRepository extends TokenRepository
{
public function make(?string $token, string $handler, array $data = []): TokenContract
{
if ($token && ! $this->isValidTokenName($token)) {
throw new \InvalidArgumentException("Invalid token name [{$token}].");
}

return app()->makeWith(TokenContract::class, compact('token', 'handler', 'data'));
}

public function find(string $token): ?TokenContract
{
if (! $this->isValidTokenName($token)) {
return null;
}

$path = storage_path('statamic/tokens/'.$token.'.yaml');

if (! File::exists($path)) {
Expand DownExpand Up@@ -55,6 +63,11 @@ public function collectGarbage(): void
->each->delete();
}

private function isValidTokenName(string $token): bool
{
return (bool) preg_match('/^[A-Za-z0-9_-]+\z/', $token);
}

private function makeFromPath(string $path): FileToken
{
$yaml = YAML::file($path)->parse();
Expand Down
32 changes: 32 additions & 0 deletions tests/Tokens/TokenRepositoryTest.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@
use Facades\Statamic\Tokens\Generator;
use Illuminate\Support\Carbon;
use Illuminate\Support\Collection;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Test;
use Statamic\Contracts\Tokens\Token;
use Statamic\Facades\File;
Expand DownExpand Up@@ -129,6 +130,37 @@ public function attempting_to_find_a_non_existent_token_returns_null()
$this->assertNull($this->tokens->find('missing-token'));
}

#[Test]
public function it_prevents_path_traversal_in_find()
{
File::put(storage_path('statamic/evil.yaml'), "handler: 'Handler'\nexpires_at: 9999999999\ndata: []");

$this->assertNull($this->tokens->find('../evil'));
}

#[Test]
#[DataProvider('invalidTokenNameProvider')]
public function it_throws_when_making_a_token_with_an_invalid_name($token)
{
$this->expectException(\InvalidArgumentException::class);

$this->tokens->make($token, 'Handler');
}

public static function invalidTokenNameProvider()
{
return [
'parent traversal' => ['../evil'],
'backslash traversal' => ['..\\evil'],
'nested traversal' => ['foo/../../evil'],
'forward slash' => ['foo/evil'],
'dots only' => ['..'],
'absolute path' => ['/etc/passwd'],
'windows drive' => ['C:\\evil'],
'trailing newline' => ["evil\n"],
];
}

#[Test]
public function it_deletes_expired_tokens()
{
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
[5.x] Fix token path traversal by duncanmcclean · Pull Request #14700 · statamic/cms · GitHub
Skip to content
[5.x] Fix token path traversal#14700

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.

 Sign up for GitHub

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

 Merged

jasonvarga
merged 10 commits into

from

May 21, 2026
 Merged


[5.x] Fix token path traversal
#14700
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
68330c3

Add failing test


duncanmcclean May 21, 2026
a5ad9f0

Tweak tests


duncanmcclean May 21, 2026
0e9bddf

Prevent path traversal in token repository


duncanmcclean May 21, 2026
4f4351e

Handle race condition in `LivePreview::tokenize()`


duncanmcclean May 21, 2026
151ac7e

Skip token lookup when token is empty


duncanmcclean May 21, 2026
8d0a82c

Use unique token name in test


duncanmcclean May 21, 2026
efe7f59

keep the race condition fix out of this pr


jasonvarga May 21, 2026
e3e770c

Validate token names against an allowlist


jasonvarga May 21, 2026
0b75e1c

Throw when making a token with an invalid name


jasonvarga May 21, 2026
19e1eaf

Use \z anchor so a trailing newline is rejected


jasonvarga May 21, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


13 changes: 13 additions & 0 deletions
src/Tokens/FileTokenRepository.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,11 +11,19 @@ class FileTokenRepository extends TokenRepository
{
 public function make(?string $token, string $handler, array $data = []): TokenContract
 {
 if ($token && ! $this->isValidTokenName($token)) {
 throw new \InvalidArgumentException("Invalid token name [{$token}].");
 }

 return app()->makeWith(TokenContract::class, compact('token', 'handler', 'data'));
 }

 public function find(string $token): ?TokenContract
 {
 if (! $this->isValidTokenName($token)) {
 return null;
 }

 $path = storage_path('statamic/tokens/'.$token.'.yaml');

 if (! File::exists($path)) {
Expand DownExpand Up@@ -55,6 +63,11 @@ public function collectGarbage(): void
 ->each->delete();
 }

 private function isValidTokenName(string $token): bool
 {
 return (bool) preg_match('/^[A-Za-z0-9_-]+\z/', $token);
 }

 private function makeFromPath(string $path): FileToken
 {
 $yaml = YAML::file($path)->parse();
Expand Down

32 changes: 32 additions & 0 deletions
tests/Tokens/TokenRepositoryTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@
use Facades\Statamic\Tokens\Generator;
use Illuminate\Support\Carbon;
use Illuminate\Support\Collection;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Test;
use Statamic\Contracts\Tokens\Token;
use Statamic\Facades\File;
Expand DownExpand Up@@ -129,6 +130,37 @@ public function attempting_to_find_a_non_existent_token_returns_null()
 $this->assertNull($this->tokens->find('missing-token'));
 }

 #[Test]
 public function it_prevents_path_traversal_in_find()
 {
 File::put(storage_path('statamic/evil.yaml'), "handler: 'Handler'\nexpires_at: 9999999999\ndata: []");

 $this->assertNull($this->tokens->find('../evil'));
 }

 #[Test]
 #[DataProvider('invalidTokenNameProvider')]
 public function it_throws_when_making_a_token_with_an_invalid_name($token)
 {
 $this->expectException(\InvalidArgumentException::class);

 $this->tokens->make($token, 'Handler');
 }

 public static function invalidTokenNameProvider()
 {
 return [
 'parent traversal' => ['../evil'],
 'backslash traversal' => ['..\\evil'],
 'nested traversal' => ['foo/../../evil'],
 'forward slash' => ['foo/evil'],
 'dots only' => ['..'],
 'absolute path' => ['/etc/passwd'],
 'windows drive' => ['C:\\evil'],
 'trailing newline' => ["evil\n"],
 ];
 }

 #[Test]
 public function it_deletes_expired_tokens()
 {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[5.x] Fix token path traversal by duncanmcclean · Pull Request #14700 · statamic/cms · GitHub
Skip to content
[5.x] Fix token path traversal#14700

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.

 Sign up for GitHub

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

 Merged

jasonvarga
merged 10 commits into

from

May 21, 2026
 Merged


[5.x] Fix token path traversal
#14700
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
68330c3

Add failing test


duncanmcclean May 21, 2026
a5ad9f0

Tweak tests


duncanmcclean May 21, 2026
0e9bddf

Prevent path traversal in token repository


duncanmcclean May 21, 2026
4f4351e

Handle race condition in `LivePreview::tokenize()`


duncanmcclean May 21, 2026
151ac7e

Skip token lookup when token is empty


duncanmcclean May 21, 2026
8d0a82c

Use unique token name in test


duncanmcclean May 21, 2026
efe7f59

keep the race condition fix out of this pr


jasonvarga May 21, 2026
e3e770c

Validate token names against an allowlist


jasonvarga May 21, 2026
0b75e1c

Throw when making a token with an invalid name


jasonvarga May 21, 2026
19e1eaf

Use \z anchor so a trailing newline is rejected


jasonvarga May 21, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


13 changes: 13 additions & 0 deletions
src/Tokens/FileTokenRepository.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,11 +11,19 @@ class FileTokenRepository extends TokenRepository
{
 public function make(?string $token, string $handler, array $data = []): TokenContract
 {
 if ($token && ! $this->isValidTokenName($token)) {
 throw new \InvalidArgumentException("Invalid token name [{$token}].");
 }

 return app()->makeWith(TokenContract::class, compact('token', 'handler', 'data'));
 }

 public function find(string $token): ?TokenContract
 {
 if (! $this->isValidTokenName($token)) {
 return null;
 }

 $path = storage_path('statamic/tokens/'.$token.'.yaml');

 if (! File::exists($path)) {
Expand DownExpand Up@@ -55,6 +63,11 @@ public function collectGarbage(): void
 ->each->delete();
 }

 private function isValidTokenName(string $token): bool
 {
 return (bool) preg_match('/^[A-Za-z0-9_-]+\z/', $token);
 }

 private function makeFromPath(string $path): FileToken
 {
 $yaml = YAML::file($path)->parse();
Expand Down

32 changes: 32 additions & 0 deletions
tests/Tokens/TokenRepositoryTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@
use Facades\Statamic\Tokens\Generator;
use Illuminate\Support\Carbon;
use Illuminate\Support\Collection;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Test;
use Statamic\Contracts\Tokens\Token;
use Statamic\Facades\File;
Expand DownExpand Up@@ -129,6 +130,37 @@ public function attempting_to_find_a_non_existent_token_returns_null()
 $this->assertNull($this->tokens->find('missing-token'));
 }

 #[Test]
 public function it_prevents_path_traversal_in_find()
 {
 File::put(storage_path('statamic/evil.yaml'), "handler: 'Handler'\nexpires_at: 9999999999\ndata: []");

 $this->assertNull($this->tokens->find('../evil'));
 }

 #[Test]
 #[DataProvider('invalidTokenNameProvider')]
 public function it_throws_when_making_a_token_with_an_invalid_name($token)
 {
 $this->expectException(\InvalidArgumentException::class);

 $this->tokens->make($token, 'Handler');
 }

 public static function invalidTokenNameProvider()
 {
 return [
 'parent traversal' => ['../evil'],
 'backslash traversal' => ['..\\evil'],
 'nested traversal' => ['foo/../../evil'],
 'forward slash' => ['foo/evil'],
 'dots only' => ['..'],
 'absolute path' => ['/etc/passwd'],
 'windows drive' => ['C:\\evil'],
 'trailing newline' => ["evil\n"],
 ];
 }

 #[Test]
 public function it_deletes_expired_tokens()
 {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[5.x] Fix token path traversal by duncanmcclean · Pull Request #14700 · statamic/cms · GitHub
Skip to content
[5.x] Fix token path traversal#14700

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.

 Sign up for GitHub

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

 Merged

jasonvarga
merged 10 commits into

from

May 21, 2026
 Merged


[5.x] Fix token path traversal
#14700
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
68330c3

Add failing test


duncanmcclean May 21, 2026
a5ad9f0

Tweak tests


duncanmcclean May 21, 2026
0e9bddf

Prevent path traversal in token repository


duncanmcclean May 21, 2026
4f4351e

Handle race condition in `LivePreview::tokenize()`


duncanmcclean May 21, 2026
151ac7e

Skip token lookup when token is empty


duncanmcclean May 21, 2026
8d0a82c

Use unique token name in test


duncanmcclean May 21, 2026
efe7f59

keep the race condition fix out of this pr


jasonvarga May 21, 2026
e3e770c

Validate token names against an allowlist


jasonvarga May 21, 2026
0b75e1c

Throw when making a token with an invalid name


jasonvarga May 21, 2026
19e1eaf

Use \z anchor so a trailing newline is rejected


jasonvarga May 21, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


13 changes: 13 additions & 0 deletions
src/Tokens/FileTokenRepository.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,11 +11,19 @@ class FileTokenRepository extends TokenRepository
{
 public function make(?string $token, string $handler, array $data = []): TokenContract
 {
 if ($token && ! $this->isValidTokenName($token)) {
 throw new \InvalidArgumentException("Invalid token name [{$token}].");
 }

 return app()->makeWith(TokenContract::class, compact('token', 'handler', 'data'));
 }

 public function find(string $token): ?TokenContract
 {
 if (! $this->isValidTokenName($token)) {
 return null;
 }

 $path = storage_path('statamic/tokens/'.$token.'.yaml');

 if (! File::exists($path)) {
Expand DownExpand Up@@ -55,6 +63,11 @@ public function collectGarbage(): void
 ->each->delete();
 }

 private function isValidTokenName(string $token): bool
 {
 return (bool) preg_match('/^[A-Za-z0-9_-]+\z/', $token);
 }

 private function makeFromPath(string $path): FileToken
 {
 $yaml = YAML::file($path)->parse();
Expand Down

32 changes: 32 additions & 0 deletions
tests/Tokens/TokenRepositoryTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@
use Facades\Statamic\Tokens\Generator;
use Illuminate\Support\Carbon;
use Illuminate\Support\Collection;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Test;
use Statamic\Contracts\Tokens\Token;
use Statamic\Facades\File;
Expand DownExpand Up@@ -129,6 +130,37 @@ public function attempting_to_find_a_non_existent_token_returns_null()
 $this->assertNull($this->tokens->find('missing-token'));
 }

 #[Test]
 public function it_prevents_path_traversal_in_find()
 {
 File::put(storage_path('statamic/evil.yaml'), "handler: 'Handler'\nexpires_at: 9999999999\ndata: []");

 $this->assertNull($this->tokens->find('../evil'));
 }

 #[Test]
 #[DataProvider('invalidTokenNameProvider')]
 public function it_throws_when_making_a_token_with_an_invalid_name($token)
 {
 $this->expectException(\InvalidArgumentException::class);

 $this->tokens->make($token, 'Handler');
 }

 public static function invalidTokenNameProvider()
 {
 return [
 'parent traversal' => ['../evil'],
 'backslash traversal' => ['..\\evil'],
 'nested traversal' => ['foo/../../evil'],
 'forward slash' => ['foo/evil'],
 'dots only' => ['..'],
 'absolute path' => ['/etc/passwd'],
 'windows drive' => ['C:\\evil'],
 'trailing newline' => ["evil\n"],
 ];
 }

 #[Test]
 public function it_deletes_expired_tokens()
 {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
[5.x] Fix token path traversal by duncanmcclean · Pull Request #14700 · statamic/cms · GitHub
Skip to content
[5.x] Fix token path traversal#14700

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.

 Sign up for GitHub

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

 Merged

jasonvarga
merged 10 commits into

from

May 21, 2026
 Merged


[5.x] Fix token path traversal
#14700
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
68330c3

Add failing test


duncanmcclean May 21, 2026
a5ad9f0

Tweak tests


duncanmcclean May 21, 2026
0e9bddf

Prevent path traversal in token repository


duncanmcclean May 21, 2026
4f4351e

Handle race condition in `LivePreview::tokenize()`


duncanmcclean May 21, 2026
151ac7e

Skip token lookup when token is empty


duncanmcclean May 21, 2026
8d0a82c

Use unique token name in test


duncanmcclean May 21, 2026
efe7f59

keep the race condition fix out of this pr


jasonvarga May 21, 2026
e3e770c

Validate token names against an allowlist


jasonvarga May 21, 2026
0b75e1c

Throw when making a token with an invalid name


jasonvarga May 21, 2026
19e1eaf

Use \z anchor so a trailing newline is rejected


jasonvarga May 21, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


13 changes: 13 additions & 0 deletions
src/Tokens/FileTokenRepository.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,11 +11,19 @@ class FileTokenRepository extends TokenRepository
{
 public function make(?string $token, string $handler, array $data = []): TokenContract
 {
 if ($token && ! $this->isValidTokenName($token)) {
 throw new \InvalidArgumentException("Invalid token name [{$token}].");
 }

 return app()->makeWith(TokenContract::class, compact('token', 'handler', 'data'));
 }

 public function find(string $token): ?TokenContract
 {
 if (! $this->isValidTokenName($token)) {
 return null;
 }

 $path = storage_path('statamic/tokens/'.$token.'.yaml');

 if (! File::exists($path)) {
Expand DownExpand Up@@ -55,6 +63,11 @@ public function collectGarbage(): void
 ->each->delete();
 }

 private function isValidTokenName(string $token): bool
 {
 return (bool) preg_match('/^[A-Za-z0-9_-]+\z/', $token);
 }

 private function makeFromPath(string $path): FileToken
 {
 $yaml = YAML::file($path)->parse();
Expand Down

32 changes: 32 additions & 0 deletions
tests/Tokens/TokenRepositoryTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@
use Facades\Statamic\Tokens\Generator;
use Illuminate\Support\Carbon;
use Illuminate\Support\Collection;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Test;
use Statamic\Contracts\Tokens\Token;
use Statamic\Facades\File;
Expand DownExpand Up@@ -129,6 +130,37 @@ public function attempting_to_find_a_non_existent_token_returns_null()
 $this->assertNull($this->tokens->find('missing-token'));
 }

 #[Test]
 public function it_prevents_path_traversal_in_find()
 {
 File::put(storage_path('statamic/evil.yaml'), "handler: 'Handler'\nexpires_at: 9999999999\ndata: []");

 $this->assertNull($this->tokens->find('../evil'));
 }

 #[Test]
 #[DataProvider('invalidTokenNameProvider')]
 public function it_throws_when_making_a_token_with_an_invalid_name($token)
 {
 $this->expectException(\InvalidArgumentException::class);

 $this->tokens->make($token, 'Handler');
 }

 public static function invalidTokenNameProvider()
 {
 return [
 'parent traversal' => ['../evil'],
 'backslash traversal' => ['..\\evil'],
 'nested traversal' => ['foo/../../evil'],
 'forward slash' => ['foo/evil'],
 'dots only' => ['..'],
 'absolute path' => ['/etc/passwd'],
 'windows drive' => ['C:\\evil'],
 'trailing newline' => ["evil\n"],
 ];
 }

 #[Test]
 public function it_deletes_expired_tokens()
 {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[5.x] Fix token path traversal by duncanmcclean · Pull Request #14700 · statamic/cms · GitHub
Skip to content
[5.x] Fix token path traversal#14700

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.

 Sign up for GitHub

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

 Merged

jasonvarga
merged 10 commits into

from

May 21, 2026
 Merged


[5.x] Fix token path traversal
#14700
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
68330c3

Add failing test


duncanmcclean May 21, 2026
a5ad9f0

Tweak tests


duncanmcclean May 21, 2026
0e9bddf

Prevent path traversal in token repository


duncanmcclean May 21, 2026
4f4351e

Handle race condition in `LivePreview::tokenize()`


duncanmcclean May 21, 2026
151ac7e

Skip token lookup when token is empty


duncanmcclean May 21, 2026
8d0a82c

Use unique token name in test


duncanmcclean May 21, 2026
efe7f59

keep the race condition fix out of this pr


jasonvarga May 21, 2026
e3e770c

Validate token names against an allowlist


jasonvarga May 21, 2026
0b75e1c

Throw when making a token with an invalid name


jasonvarga May 21, 2026
19e1eaf

Use \z anchor so a trailing newline is rejected


jasonvarga May 21, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


13 changes: 13 additions & 0 deletions
src/Tokens/FileTokenRepository.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,11 +11,19 @@ class FileTokenRepository extends TokenRepository
{
 public function make(?string $token, string $handler, array $data = []): TokenContract
 {
 if ($token && ! $this->isValidTokenName($token)) {
 throw new \InvalidArgumentException("Invalid token name [{$token}].");
 }

 return app()->makeWith(TokenContract::class, compact('token', 'handler', 'data'));
 }

 public function find(string $token): ?TokenContract
 {
 if (! $this->isValidTokenName($token)) {
 return null;
 }

 $path = storage_path('statamic/tokens/'.$token.'.yaml');

 if (! File::exists($path)) {
Expand DownExpand Up@@ -55,6 +63,11 @@ public function collectGarbage(): void
 ->each->delete();
 }

 private function isValidTokenName(string $token): bool
 {
 return (bool) preg_match('/^[A-Za-z0-9_-]+\z/', $token);
 }

 private function makeFromPath(string $path): FileToken
 {
 $yaml = YAML::file($path)->parse();
Expand Down

32 changes: 32 additions & 0 deletions
tests/Tokens/TokenRepositoryTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@
use Facades\Statamic\Tokens\Generator;
use Illuminate\Support\Carbon;
use Illuminate\Support\Collection;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Test;
use Statamic\Contracts\Tokens\Token;
use Statamic\Facades\File;
Expand DownExpand Up@@ -129,6 +130,37 @@ public function attempting_to_find_a_non_existent_token_returns_null()
 $this->assertNull($this->tokens->find('missing-token'));
 }

 #[Test]
 public function it_prevents_path_traversal_in_find()
 {
 File::put(storage_path('statamic/evil.yaml'), "handler: 'Handler'\nexpires_at: 9999999999\ndata: []");

 $this->assertNull($this->tokens->find('../evil'));
 }

 #[Test]
 #[DataProvider('invalidTokenNameProvider')]
 public function it_throws_when_making_a_token_with_an_invalid_name($token)
 {
 $this->expectException(\InvalidArgumentException::class);

 $this->tokens->make($token, 'Handler');
 }

 public static function invalidTokenNameProvider()
 {
 return [
 'parent traversal' => ['../evil'],
 'backslash traversal' => ['..\\evil'],
 'nested traversal' => ['foo/../../evil'],
 'forward slash' => ['foo/evil'],
 'dots only' => ['..'],
 'absolute path' => ['/etc/passwd'],
 'windows drive' => ['C:\\evil'],
 'trailing newline' => ["evil\n"],
 ];
 }

 #[Test]
 public function it_deletes_expired_tokens()
 {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
})();
[5.x] Fix token path traversal by duncanmcclean · Pull Request #14700 · statamic/cms · GitHub
Skip to content
[5.x] Fix token path traversal#14700

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.

 Sign up for GitHub

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

 Merged

jasonvarga
merged 10 commits into

from

May 21, 2026
 Merged


[5.x] Fix token path traversal
#14700
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
68330c3

Add failing test


duncanmcclean May 21, 2026
a5ad9f0

Tweak tests


duncanmcclean May 21, 2026
0e9bddf

Prevent path traversal in token repository


duncanmcclean May 21, 2026
4f4351e

Handle race condition in `LivePreview::tokenize()`


duncanmcclean May 21, 2026
151ac7e

Skip token lookup when token is empty


duncanmcclean May 21, 2026
8d0a82c

Use unique token name in test


duncanmcclean May 21, 2026
efe7f59

keep the race condition fix out of this pr


jasonvarga May 21, 2026
e3e770c

Validate token names against an allowlist


jasonvarga May 21, 2026
0b75e1c

Throw when making a token with an invalid name


jasonvarga May 21, 2026
19e1eaf

Use \z anchor so a trailing newline is rejected


jasonvarga May 21, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


13 changes: 13 additions & 0 deletions
src/Tokens/FileTokenRepository.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -11,11 +11,19 @@ class FileTokenRepository extends TokenRepository
{
 public function make(?string $token, string $handler, array $data = []): TokenContract
 {
 if ($token && ! $this->isValidTokenName($token)) {
 throw new \InvalidArgumentException("Invalid token name [{$token}].");
 }

 return app()->makeWith(TokenContract::class, compact('token', 'handler', 'data'));
 }

 public function find(string $token): ?TokenContract
 {
 if (! $this->isValidTokenName($token)) {
 return null;
 }

 $path = storage_path('statamic/tokens/'.$token.'.yaml');

 if (! File::exists($path)) {
Expand DownExpand Up@@ -55,6 +63,11 @@ public function collectGarbage(): void
 ->each->delete();
 }

 private function isValidTokenName(string $token): bool
 {
 return (bool) preg_match('/^[A-Za-z0-9_-]+\z/', $token);
 }

 private function makeFromPath(string $path): FileToken
 {
 $yaml = YAML::file($path)->parse();
Expand Down

32 changes: 32 additions & 0 deletions
tests/Tokens/TokenRepositoryTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -5,6 +5,7 @@
use Facades\Statamic\Tokens\Generator;
use Illuminate\Support\Carbon;
use Illuminate\Support\Collection;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Test;
use Statamic\Contracts\Tokens\Token;
use Statamic\Facades\File;
Expand DownExpand Up@@ -129,6 +130,37 @@ public function attempting_to_find_a_non_existent_token_returns_null()
 $this->assertNull($this->tokens->find('missing-token'));
 }

 #[Test]
 public function it_prevents_path_traversal_in_find()
 {
 File::put(storage_path('statamic/evil.yaml'), "handler: 'Handler'\nexpires_at: 9999999999\ndata: []");

 $this->assertNull($this->tokens->find('../evil'));
 }

 #[Test]
 #[DataProvider('invalidTokenNameProvider')]
 public function it_throws_when_making_a_token_with_an_invalid_name($token)
 {
 $this->expectException(\InvalidArgumentException::class);

 $this->tokens->make($token, 'Handler');
 }

 public static function invalidTokenNameProvider()
 {
 return [
 'parent traversal' => ['../evil'],
 'backslash traversal' => ['..\\evil'],
 'nested traversal' => ['foo/../../evil'],
 'forward slash' => ['foo/evil'],
 'dots only' => ['..'],
 'absolute path' => ['/etc/passwd'],
 'windows drive' => ['C:\\evil'],
 'trailing newline' => ["evil\n"],
 ];
 }

 #[Test]
 public function it_deletes_expired_tokens()
 {
Expand Down
Loading