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.

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

Jump to bottom

[6.x] File Upload Security fixes #64

Merged
merged 3 commits into from
Feb 11, 2024
Merged

[6.x] File Upload Security fixes #64

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
43bb34f
Only allow uploading certain file extensions
duncanmcclean Feb 11, 2024
01f0a13
Sanitize SVG uploads
duncanmcclean Feb 11, 2024
1403c36
Apply Code Style changes
duncanmcclean Feb 11, 2024
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
22 changes: 18 additions & 4 deletions src/Http/Controllers/GuestEntryController.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,11 @@
use Illuminate\Http\Request;
use Illuminate\Routing\Controller;
use Illuminate\Support\Arr;
use Illuminate\Support\Facades\File;
use Illuminate\Support\Facades\Validator;
use Illuminate\Support\Str;
use Illuminate\Validation\ValidationException;
use Rhukster\DomSanitizer\DOMSanitizer;
use Statamic\Facades\Asset;
use Statamic\Facades\AssetContainer;
use Statamic\Facades\Collection;
Expand All @@ -26,6 +28,7 @@
use Statamic\Fieldtypes\Date as DateFieldtype;
use Statamic\Fieldtypes\Replicator;
use Statamic\Sites\Site;
use Statamic\Validation\AllowedFile;

class GuestEntryController extends Controller
{
Expand Down Expand Up @@ -244,18 +247,29 @@ protected function uploadFile(string $key, Field $field, Request $request)

$uploadedFiles = collect($uploadedFiles)
->each(function ($file) use ($key) {
if (in_array(trim(strtolower($file->getClientOriginalExtension())), ['php', 'php3', 'php4', 'php5', 'php7', 'php8', 'phtml', 'phar'])) {
$validator = Validator::make([], []);
$validator->errors()->add($key, __('Failed to upload.'));
$validator = Validator::make([$key => $file], [
$key => ['file', new AllowedFile],
]);

throw new ValidationException($validator);
if ($validator->fails()) {
throw ValidationException::withMessages($validator->errors()->toArray());
}
})
->filter()
->toArray();

/* @var \Illuminate\Http\Testing\File $file */
foreach ($uploadedFiles as $uploadedFile) {
if (Str::endsWith($uploadedFile->getClientOriginalExtension(), 'svg')) {
$sanitizer = new DOMSanitizer(DOMSanitizer::SVG);

$contents = $sanitizer->sanitize($svg = File::get($uploadedFile->getPathname()), [
'remove-xml-tags' => ! Str::startsWith($svg, '<?xml'),
]);

File::put($uploadedFile->getPathname(), $contents);
}

$path = '/'.$uploadedFile->storeAs(
isset($field->config()['folder'])
? $field->config()['folder']
Expand Down
167 changes: 167 additions & 0 deletions tests/Http/Controllers/GuestEntryControllerTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -465,6 +465,78 @@
$this->assertIsString($entry->get('attachment'));
});

it('can store entry and ensure uploaded SVG file is sanitized', function () {
AssetContainer::make('assets')->disk('local')->save();

Blueprint::make('comments')
->setNamespace('collections.comments')
->setContents([
'title' => 'Comments',
'sections' => [
'main' => [
'display' => 'main',
'fields' => [
[
'handle' => 'title',
'field' => [
'type' => 'text',
],
],
[
'handle' => 'slug',
'field' => [
'type' => 'slug',
],
],
[
'handle' => 'attachment',
'field' => [
'mode' => 'list',
'container' => 'assets',
'restrict' => false,
'allow_uploads' => true,
'show_filename' => true,
'display' => 'Attachment',
'type' => 'assets',
'icon' => 'assets',
'listable' => 'hidden',
'max_items' => 1,
],
],
],
],
],
])
->save();

Collection::make('comments')->save();

$this
->post(route('statamic.guest-entries.store'), [
'_collection' => encrypt('comments'),
'title' => 'This is great',
'slug' => 'this-is-great',
'attachment' => UploadedFile::fake()->createWithContent('foobar.svg', '<?xml version="1.0" encoding="UTF-8" standalone="no"?><svg xmlns="http://www.w3.org/2000/svg" width="500" height="500"><script type="text/javascript">alert(`Bad stuff could go in here.`);</script></svg>'),
])
->assertRedirect();

$entry = Entry::all()->last();

$this->assertNotNull($entry);
$this->assertSame($entry->collectionHandle(), 'comments');
$this->assertSame($entry->get('title'), 'This is great');
$this->assertSame($entry->slug(), 'this-is-great');

$this->assertNotNull($entry->get('attachment'));
$this->assertIsString($entry->get('attachment'));

$file = Storage::disk('local')->get($entry->get('attachment'));

$this->assertStringNotContainsString('<script', $file);
$this->assertStringNotContainsString('Bad stuff could go in here.', $file);
$this->assertStringNotContainsString('</script>', $file);
});

it('cant store an entry when uploading a PHP file', function () {
AssetContainer::make('assets')->disk('local')->save();

Expand Down Expand Up @@ -1528,6 +1600,101 @@
$this->assertIsString($entry->get('attachment'));
});

it('can update entry and ensure uploaded SVG file is sanitized', function () {
AssetContainer::make('assets')->disk('local')->save();

Blueprint::make('albums')
->setNamespace('collections.albums')
->setContents([
'title' => 'Albums',
'sections' => [
'main' => [
'display' => 'main',
'fields' => [
[
'handle' => 'title',
'field' => [
'type' => 'text',
],
],
[
'handle' => 'artist',
'field' => [
'type' => 'text',
],
],
[
'handle' => 'slug',
'field' => [
'type' => 'slug',
],
],
[
'handle' => 'record_label',
'field' => [
'type' => 'text',
],
],
[
'handle' => 'attachment',
'field' => [
'mode' => 'list',
'container' => 'assets',
'restrict' => false,
'allow_uploads' => true,
'show_filename' => true,
'display' => 'Attachment',
'type' => 'assets',
'icon' => 'assets',
'listable' => 'hidden',
'max_items' => 1,
],
],
],
],
],
])
->save();

Collection::make('albums')->save();

Entry::make()
->id('allo-mate-idee')
->collection('albums')
->slug('allo-mate')
->data([
'title' => 'Allo Mate!',
'artist' => 'Guvna B',
])
->save();

$this
->post(route('statamic.guest-entries.update'), [
'_collection' => encrypt('albums'),
'_id' => encrypt('allo-mate-idee'),
'record_label' => 'Unknown',
'attachment' => UploadedFile::fake()->createWithContent('foobar.svg', '<?xml version="1.0" encoding="UTF-8" standalone="no"?><svg xmlns="http://www.w3.org/2000/svg" width="500" height="500"><script type="text/javascript">alert(`Bad stuff could go in here.`);</script></svg>'),
])
->assertRedirect();

$entry = Entry::find('allo-mate-idee');

$this->assertNotNull($entry);
$this->assertSame($entry->collectionHandle(), 'albums');
$this->assertSame($entry->get('title'), 'Allo Mate!');
$this->assertSame($entry->get('record_label'), 'Unknown');
$this->assertSame($entry->slug(), 'allo-mate');

$this->assertNotNull($entry->get('attachment'));
$this->assertIsString($entry->get('attachment'));

$file = Storage::disk('local')->get($entry->get('attachment'));

$this->assertStringNotContainsString('<script', $file);
$this->assertStringNotContainsString('Bad stuff could go in here.', $file);
$this->assertStringNotContainsString('</script>', $file);
});

it('cant update entry when uploading a PHP file', function () {
AssetContainer::make('assets')->disk('local')->save();

Expand Down
2 changes: 1 addition & 1 deletion tests/TestCase.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ protected function resolveApplicationConfiguration($app)
];

foreach ($configs as $config) {
$app['config']->set("statamic.$config", require(__DIR__."/../vendor/statamic/cms/config/{$config}.php"));
$app['config']->set("statamic.$config", require (__DIR__."/../vendor/statamic/cms/config/{$config}.php"));
}

$app['config']->set('statamic.users.repository', 'file');
Expand Down