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

Add whitelist for image shortcode attributes. #528

Merged
merged 1 commit into from
Nov 20, 2022
Merged

Add whitelist for image shortcode attributes. #528

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
21 changes: 18 additions & 3 deletions src/Shortcodes/ImageShortcodeProvider.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,20 @@
*/
class ImageShortcodeProvider extends FileShortcodeProvider implements ShortcodeHandler, Flushable
{
/**
* A whitelist of attributes which are allowed in the resultant markup.
*
* @config
*/
private static array $attribute_whitelist = [
'alt',
'class',
'height',
'loading',
'src',
'title',
'width',
];

/**
* Gets the list of shortcodes provided by this handler
Expand Down Expand Up @@ -99,9 +113,10 @@ public static function handle_shortcode($args, $content, $parser, $shortcode, $e
$attrs['alt'] = $record->Title;
}

// Clean out any empty attributes (aside from alt)
$attrs = array_filter($attrs ?? [], function ($k, $v) {
return strlen(trim($v ?? '')) || $k === 'alt';
// Clean out any empty attributes (aside from alt) and anything not whitelisted
$whitelist = static::config()->get('attribute_whitelist');
$attrs = array_filter($attrs ?? [], function ($v, $k) use ($whitelist) {
return in_array($k, $whitelist) && (strlen(trim($v ?? '')) || $k === 'alt');
}, ARRAY_FILTER_USE_BOTH);

$markup = HTML::createTag('img', $attrs);
Expand Down
77 changes: 77 additions & 0 deletions tests/php/Shortcodes/ImageShortcodeProviderTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -261,4 +261,81 @@ public function testRegenerateShortcode()
$this->assertSame($expected, $html);
$this->assertTrue($assetStore->isGranted($parsedFileID));
}

public function testEmptyAttributesAreRemoved()
{
$image = $this->objFromFixture(Image::class, 'imageWithTitle');
$parser = new ShortcodeParser();
$parser->register('image', [ImageShortcodeProvider::class, 'handle_shortcode']);

// Note that alt is allowed to be empty
$this->assertEquals(
sprintf(
'<img src="%s" alt="">',
$image->Link()
),
$parser->parse(sprintf('[image id=%d alt="" class=""]', $image->ID))
);
}

public function testOnlyWhitelistedAttributesAllowed()
{
$image = $this->objFromFixture(Image::class, 'imageWithoutTitle');
$parser = new ShortcodeParser();
$parser->register('image', [ImageShortcodeProvider::class, 'handle_shortcode']);
$whitelist = ImageShortcodeProvider::config()->get('attribute_whitelist');

$attributes = '';
foreach ($whitelist as $attrName) {
if ($attrName === 'src') {
continue;
}
$attributes .= $attrName . '="' . $attrName . '" ';
}

$this->assertEquals(
sprintf(
'<img src="%s" %s>',
$image->Link(),
trim($attributes)
),
$parser->parse(sprintf(
'[image id="%d" %s style="width:100px" data-some-value="my-data"]',
$image->ID,
trim($attributes)
))
);
}

public function testWhiteIsConfigurable()
{
$image = $this->objFromFixture(Image::class, 'imageWithoutTitle');
$parser = new ShortcodeParser();
$parser->register('image', [ImageShortcodeProvider::class, 'handle_shortcode']);
$whitelist = ImageShortcodeProvider::config()->get('attribute_whitelist');

$attributes = '';
foreach ($whitelist as $attrName) {
if ($attrName === 'src') {
continue;
}
$attributes .= $attrName . '="' . $attrName . '" ';
}

// Allow new whitelisted attribute
Config::modify()->merge(ImageShortcodeProvider::class, 'attribute_whitelist', ['data-some-value']);

$this->assertEquals(
sprintf(
'<img src="%s" %s>',
$image->Link(),
trim($attributes) . ' data-some-value="my-data"'
),
$parser->parse(sprintf(
'[image id="%d" %s style="width:100px" data-some-value="my-data"]',
$image->ID,
trim($attributes)
))
);
}
}