42 lines
1.7 KiB
ReStructuredText
42 lines
1.7 KiB
ReStructuredText
.. _-authenticateOAuth2-:
|
|
|
|
authenticateOAuth2
|
|
==================
|
|
|
|
Signature
|
|
---------
|
|
|
|
.. includecode:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/SecurityDirectives.scala#authenticator
|
|
|
|
.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/SecurityDirectives.scala
|
|
:snippet: authenticateOAuth2
|
|
|
|
Description
|
|
-----------
|
|
Wraps the inner route with OAuth Bearer Token authentication support using a given ``AuthenticatorPF[T]``
|
|
|
|
Provides support for extracting the so-called "*Bearer Token*" from the :class:`Authorization` HTTP Header,
|
|
which is used to initiate an OAuth2 authorization.
|
|
|
|
.. warning::
|
|
This directive does not implement the complete OAuth2 protocol, but instead enables implementing it,
|
|
by extracting the needed token from the HTTP headers.
|
|
|
|
Given a function returning ``Some[T]`` upon successful authentication and ``None`` otherwise,
|
|
respectively applies the inner route or rejects the request with a :class:`AuthenticationFailedRejection` rejection,
|
|
which by default is mapped to an ``401 Unauthorized`` response.
|
|
|
|
Longer-running authentication tasks (like looking up credentials in a database) should use the :ref:`-authenticateOAuth2Async-`
|
|
variant of this directive which allows it to run without blocking routing layer of Akka HTTP, freeing it for other requests.
|
|
|
|
See :ref:`credentials-and-timing-attacks-scala` for details about verifying the secret.
|
|
|
|
For more information on how OAuth2 works see `RFC 6750`_.
|
|
|
|
.. _RFC 6750: https://tools.ietf.org/html/rfc6750
|
|
|
|
Example
|
|
-------
|
|
|
|
Usage in code is exactly the same as :ref:`-authenticateBasic-`,
|
|
with the difference that one must validate the token as OAuth2 dictates (which is currently not part of Akka HTTP itself).
|