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

Change key names so that they are valid header names #186

Merged
merged 4 commits into from
Jun 8, 2024
Merged

Change key names so that they are valid header names #186

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
371081d
Change token name and value keys to use dash
deployHuman Nov 4, 2021
a35c45d
Update tests for new key names
deployHuman Nov 4, 2021
0a9c7f3
Trim - from prefix
akrabat Jun 8, 2024
23e2c75
Update Changelog
akrabat Jun 8, 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
8 changes: 7 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,13 @@

See https://github.com/slimphp/Slim-Csrf/releases for a full list

## Next
## 2.x

- Fixed: The key names are now the correct format to be sent as headers.

This is a potential BC break. The key names now use a dash rather than an
underscore. This should not affect anyone who uses the relvant methods, but
if you have hard-coded, then they will need to be updated.

## 1.5.0

Expand Down
8 changes: 4 additions & 4 deletions src/Guard.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ class Guard implements MiddlewareInterface
protected ResponseFactoryInterface $responseFactory;

/**
* Prefix for CSRF parameters (omit trailing "_" underscore)
* Prefix for CSRF parameters (omit trailing "-")
*/
protected string $prefix;

Expand Down Expand Up @@ -122,7 +122,7 @@ public function __construct(
}

$this->responseFactory = $responseFactory;
$this->prefix = rtrim($prefix, '_');
$this->prefix = rtrim($prefix, '-');
$this->strength = $strength;

$this->setStorage($storage);
Expand Down Expand Up @@ -269,15 +269,15 @@ public function getTokenValue(): ?string
*/
public function getTokenNameKey(): string
{
return $this->prefix . '_name';
return $this->prefix . '-name';
}

/**
* @return string
*/
public function getTokenValueKey(): string
{
return $this->prefix . '_value';
return $this->prefix . '-value';
}

/**
Expand Down
96 changes: 48 additions & 48 deletions tests/GuardTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -193,35 +193,35 @@ public function testDefaultFailureHandler()
public function testValidateToken()
{
$storage = [
'test_name' => 'value'
'test-name' => 'value'
];
$responseFactoryProphecy = $this->prophesize(ResponseFactoryInterface::class);
$mw = new Guard($responseFactoryProphecy->reveal(), 'test', $storage);

$maskedToken = $this->maskToken($mw, 'value');
$this->assertTrue($mw->validateToken('test_name', $maskedToken));
$this->assertTrue($mw->validateToken('test-name', $maskedToken));

$maskedToken2 = $this->maskToken($mw, 'value');
$this->assertTrue($mw->validateToken('test_name', $maskedToken2));
$this->assertTrue($mw->validateToken('test-name', $maskedToken2));

$this->assertNotSame($maskedToken, $maskedToken2);
}

public function testNotValidatingBadToken()
{
$storage = [
'test_name' => 'value'
'test-name' => 'value'
];
$responseFactoryProphecy = $this->prophesize(ResponseFactoryInterface::class);
$mw = new Guard($responseFactoryProphecy->reveal(), 'test', $storage);

$maskedToken = 'MY_BAD_BASE64???';
$this->assertFalse($mw->validateToken('test_name', $maskedToken), 'Token contains bad base64 characters');
$this->assertFalse($mw->validateToken('test-name', $maskedToken), 'Token contains bad base64 characters');

$maskedToken2 = $this->maskToken($mw, 'value');
// Remove some part of base64
$maskedToken2 = substr($maskedToken2, 0, -6);
$this->assertFalse($mw->validateToken('test_name', $maskedToken2), 'Token size should be even');
$this->assertFalse($mw->validateToken('test-name', $maskedToken2), 'Token size should be even');
}

public function testGetTokenNameAndValue()
Expand All @@ -238,12 +238,12 @@ public function testGetTokenNameAndValue()
$loadLastKeyPairMethod->invoke($mw);

$storage = [
'test_name' => 'value',
'test-name' => 'value',
];
$mw->setStorage($storage);
$loadLastKeyPairMethod->invoke($mw);

$this->assertEquals('test_name', $mw->getTokenName());
$this->assertEquals('test-name', $mw->getTokenName());

$unmaskTokenMethod = new ReflectionMethod($mw, 'unmaskToken');
$unmaskTokenMethod->setAccessible(true);
Expand All @@ -266,30 +266,30 @@ public function testGetTokenNameKeyAndValue()
$responseFactoryProphecy = $this->prophesize(ResponseFactoryInterface::class);
$mw = new Guard($responseFactoryProphecy->reveal(), 'test', $storage);

$this->assertEquals('test_name', $mw->getTokenNameKey());
$this->assertEquals('test_value', $mw->getTokenValueKey());
$this->assertEquals('test-name', $mw->getTokenNameKey());
$this->assertEquals('test-value', $mw->getTokenValueKey());
}

public function testRemoveTokenFromStorage()
{
$storage = [
'test_name' => 'value',
'test-name' => 'value',
];
$responseFactoryProphecy = $this->prophesize(ResponseFactoryInterface::class);
$mw = new Guard($responseFactoryProphecy->reveal(), 'test', $storage);

$removeTokenFromStorageMethod = new ReflectionMethod($mw, 'removeTokenFromStorage');
$removeTokenFromStorageMethod->setAccessible(true);
$removeTokenFromStorageMethod->invoke($mw, 'test_name');
$removeTokenFromStorageMethod->invoke($mw, 'test-name');

$this->assertArrayNotHasKey('test_name', $storage);
$this->assertArrayNotHasKey('test-name', $storage);
}

public function testEnforceStorageLimitWithArray()
{
$storage = [
'test_name' => 'value',
'test_name2' => 'value2',
'test-name' => 'value',
'test-name2' => 'value2',
];
$responseFactoryProphecy = $this->prophesize(ResponseFactoryInterface::class);
$mw = new Guard($responseFactoryProphecy->reveal(), 'test', $storage, null, 1);
Expand All @@ -298,15 +298,15 @@ public function testEnforceStorageLimitWithArray()
$enforceStorageLimitMethod->setAccessible(true);
$enforceStorageLimitMethod->invoke($mw);

$this->assertArrayNotHasKey('test_name', $storage);
$this->assertArrayHasKey('test_name2', $storage);
$this->assertArrayNotHasKey('test-name', $storage);
$this->assertArrayHasKey('test-name2', $storage);
}

public function testNotEnforceStorageLimitWithArrayWhenLimitIsZero()
{
$initial_storage = $storage = [
'test_name' => 'value',
'test_name2' => 'value2',
'test-name' => 'value',
'test-name2' => 'value2',
];
$responseFactoryProphecy = $this->prophesize(ResponseFactoryInterface::class);
$mw = new Guard($responseFactoryProphecy->reveal(), 'test', $storage, null, 0);
Expand All @@ -321,8 +321,8 @@ public function testNotEnforceStorageLimitWithArrayWhenLimitIsZero()
public function testEnforceStorageLimitWithIterator()
{
$storage = new ArrayIterator([
'test_name' => 'value',
'test_name2' => 'value',
'test-name' => 'value',
'test-name2' => 'value',
]);
$responseFactoryProphecy = $this->prophesize(ResponseFactoryInterface::class);
$mw = new Guard($responseFactoryProphecy->reveal(), 'test', $storage, null, 1);
Expand All @@ -331,14 +331,14 @@ public function testEnforceStorageLimitWithIterator()
$enforceStorageLimitMethod->setAccessible(true);
$enforceStorageLimitMethod->invoke($mw);

$this->assertArrayNotHasKey('test_name', $storage);
$this->assertArrayHasKey('test_name2', $storage);
$this->assertArrayNotHasKey('test-name', $storage);
$this->assertArrayHasKey('test-name2', $storage);
}

public function testTokenIsRemovedFromStorageWhenPersistentModeIsOff()
{
$storage = [
'test_name' => 'test_value123',
'test-name' => 'test-value123',
];

$responseProphecy = $this->prophesize(ResponseInterface::class)
Expand Down Expand Up @@ -366,21 +366,21 @@ public function testTokenIsRemovedFromStorageWhenPersistentModeIsOff()
$requestProphecy
->getParsedBody()
->willReturn([
'test_name' => 'test_name',
'test_value' => $this->maskToken($mw, 'test_value123'),
'test-name' => 'test-name',
'test-value' => $this->maskToken($mw, 'test-value123'),
])
->shouldBeCalledOnce();


$mw->process($requestProphecy->reveal(), $requestHandlerProphecy->reveal());
self::assertArrayNotHasKey('test_name', $storage);
self::assertArrayNotHasKey('test-name', $storage);
}

public function testTokenIsRemovedFromStorageWhenPersistentModeIsOffOnFailure()
{
$storage = [
'test_name' => 'test_value123',
'test_name2' => 'test_value234',
'test-name' => 'test-value123',
'test-name2' => 'test-value234',
];

$streamProphecy = $this->prophesize(StreamInterface::class);
Expand Down Expand Up @@ -429,19 +429,19 @@ public function testTokenIsRemovedFromStorageWhenPersistentModeIsOffOnFailure()
$requestProphecy
->getParsedBody()
->willReturn([
'test_name' => 'test_value123',
'test-name' => 'test-value123',
])
->shouldBeCalledOnce();

$mw->process($requestProphecy->reveal(), $requestHandlerProphecy->reveal());

$this->assertArrayNotHasKey('test_name', $storage);
$this->assertArrayNotHasKey('test-name', $storage);
}

public function testTokenInBodyOfGetIsInvalid()
{
$storage = [
'test_name' => 'test_value123',
'test-name' => 'test-value123',
];

// we set up a failure handler that we expect to be called because a GET cannot have a token
Expand All @@ -467,8 +467,8 @@ public function testTokenInBodyOfGetIsInvalid()
$requestProphecy
->getParsedBody()
->willReturn([
'test_name' => 'test_name',
'test_value' => 'test_value123',
'test-name' => 'test-name',
'test-value' => 'test-value123',
])
->shouldBeCalledOnce();

Expand Down Expand Up @@ -510,7 +510,7 @@ public function testProcessAppendsNewTokensWhenPersistentTokenModeIsOff()
public function testProcessAppendsNewTokensWhenPersistentTokenModeIsOn()
{
$storage = [
'test_name123' => 'test_value123',
'test-name123' => 'test-value123',
];
$responseFactoryProphecy = $this->prophesize(ResponseFactoryInterface::class);
$mw = new Guard($responseFactoryProphecy->reveal(), 'test', $storage, null, 200, 16, true);
Expand All @@ -526,12 +526,12 @@ public function testProcessAppendsNewTokensWhenPersistentTokenModeIsOn()
->shouldBeCalledOnce();

$requestProphecy
->withAttribute('test_name', 'test_name123')
->withAttribute('test-name', 'test-name123')
->willReturn($requestProphecy->reveal())
->shouldBeCalledOnce();

$requestProphecy
->withAttribute('test_value', Argument::type('string'))
->withAttribute('test-value', Argument::type('string'))
->willReturn($requestProphecy->reveal())
->shouldBeCalledOnce();

Expand All @@ -548,8 +548,8 @@ public function testProcessAppendsNewTokensWhenPersistentTokenModeIsOn()
public function testCanGetLastKeyPairFromIterator()
{
$storage = new ArrayIterator([
'test_key1' => 'value1',
'test_key2' => 'value2',
'test-key1' => 'value1',
'test-key2' => 'value2',
]);
$responseFactoryProphecy = $this->prophesize(ResponseFactoryInterface::class);
$mw = new Guard($responseFactoryProphecy->reveal(), 'test', $storage, null, 1);
Expand All @@ -559,20 +559,20 @@ public function testCanGetLastKeyPairFromIterator()
$keyPair = $enforceStorageLimitMethod->invoke($mw);

$this->assertIsArray($keyPair);
$this->assertArrayHasKey('test_name', $keyPair);
$this->assertArrayHasKey('test_value', $keyPair);
$this->assertEquals('test_key2', $keyPair['test_name']);
$this->assertArrayHasKey('test-name', $keyPair);
$this->assertArrayHasKey('test-value', $keyPair);
$this->assertEquals('test-key2', $keyPair['test-name']);

$unmaskTokenMethod = new ReflectionMethod($mw, 'unmaskToken');
$unmaskTokenMethod->setAccessible(true);
$unmaskedToken = $unmaskTokenMethod->invoke($mw, $keyPair['test_value']);
$unmaskedToken = $unmaskTokenMethod->invoke($mw, $keyPair['test-value']);
$this->assertEquals('value2', $unmaskedToken);
}

public function testTokenFromHeaderOnDelete()
{
$storage = [
'test_name' => 'test_value123',
'test-name' => 'test-value123',
];

$responseProphecy = $this->prophesize(ResponseInterface::class)
Expand Down Expand Up @@ -602,12 +602,12 @@ public function testTokenFromHeaderOnDelete()
->willReturn([])
->shouldBeCalledOnce();
$requestProphecy
->getHeader('test_name')
->willReturn(['test_name'])
->getHeader('test-name')
->willReturn(['test-name'])
->shouldBeCalledOnce();
$requestProphecy
->getHeader('test_value')
->willReturn([$this->maskToken($mw, 'test_value123')])
->getHeader('test-value')
->willReturn([$this->maskToken($mw, 'test-value123')])
->shouldBeCalledOnce();

$mw->process($requestProphecy->reveal(), $requestHandlerProphecy->reveal());
Expand Down
Loading