Skip to content

Update api_key_authentication.rst - POST Method #3759

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

Closed
wants to merge 2 commits into from
Closed

Update api_key_authentication.rst - POST Method #3759

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
779c0fc
Update api_key_authentication.rst - POST Method
BourotBenjamin Apr 4, 2014
416ca0f
Check for api_key in request
BourotBenjamin Jun 12, 2014
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
26 changes: 18 additions & 8 deletions cookbook/security/api_key_authentication.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,15 +45,25 @@ value and then a User object is created::

public function createToken(Request $request, $providerKey)
{
if (!$request->query->has('apikey')) {
throw new BadCredentialsException('No API key found');
if ($request->query->has('apikey')) {
return new PreAuthenticatedToken(
'anon.',
$request->query->get('apikey'),
$providerKey
);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is indented too far - just indent 4 spaces :)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

the problem is that it uses tabs instead of spaces

}

return new PreAuthenticatedToken(
'anon.',
$request->query->get('apikey'),
$providerKey
);
else if($request->headers->has('apikey'))
{
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

don't put curly braces on an extra line

return new PreAuthenticatedToken(
'anon.',
$request->headers->get('apikey'),
$providerKey
);
}
else
{
throw new BadCredentialsException('No API key found');
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would write the code like this:

// look for an apikey query parameter
$apiKey = $request->query->get('apikey');

// or if you want to use an "apikey" header, then do something like this:
// $apiKey = $request->headers->get('apikey');

if (!$apiKey) {
    throw new BadCredentialsException('No API key found');
}

return new PreAuthenticatedToken(
    'anon.',
    $apiKey,
    $providerKey
);

@BourotBenjamin What do you think about this?

}

public function authenticateToken(TokenInterface $token, UserProviderInterface $userProvider, $providerKey)
Expand Down