pekko/akka-docs-dev/rst/scala/http/routing-dsl/directives/security-directives/authenticateBasicPF.rst

.. _-authenticateBasicPF-:

authenticateBasicPF
===================

Signature
---------

.. includecode:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/SecurityDirectives.scala#authenticator-pf

.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/SecurityDirectives.scala
   :snippet: authenticateBasicPF

Description
-----------
Wraps the inner route with Http Basic authentication support using a given ``AuthenticatorPF[T]``.

Provides support for handling `HTTP Basic Authentication`_.

Refer to :ref:`-authenticateBasic-` for a detailed description of this directive.

Its semantics are equivalent to ``authenticateBasicPF`` 's, where not handling a case in the Partial Function (PF)
leaves the request to be rejected with a :class:`AuthenticationFailedRejection` rejection.

Longer-running authentication tasks (like looking up credentials in a database) should use :ref:`-authenticateBasicAsync-`
or :ref:`-authenticateBasicPFAsync-` if you prefer to use the ``PartialFunction`` syntax.

.. warning::
  Make sure to use basic authentication only over SSL/TLS because credentials are transferred in plaintext.

.. _HTTP Basic Authentication: https://en.wikipedia.org/wiki/Basic_auth

Example
-------

.. includecode2:: ../../../../code/docs/http/scaladsl/server/directives/SecurityDirectivesExamplesSpec.scala
   :snippet: authenticateBasicPF-0
=doc Significantly extend HTTP documentation with new content and ports from spray docs 2015-05-11 23:05:18 +02:00			`.. _-authenticateBasicPF-:`

			`authenticateBasicPF`
			`===================`

			`Signature`
			`---------`

+htp #18496 add missing directive documentation (scala) 2015-10-01 13:25:41 +02:00			`.. includecode:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/SecurityDirectives.scala#authenticator-pf`

=doc fix broken links in scala-side HTTP docs 2015-06-19 15:35:24 +02:00			`.. includecode2:: /../../akka-http/src/main/scala/akka/http/scaladsl/server/directives/SecurityDirectives.scala`
=doc Significantly extend HTTP documentation with new content and ports from spray docs 2015-05-11 23:05:18 +02:00			`:snippet: authenticateBasicPF`

			`Description`
			`-----------`
=htc,doc #18496 make all directive docs have the same style, some additions 2015-10-09 15:19:36 +02:00			Wraps the inner route with Http Basic authentication support using a given ``AuthenticatorPF[T]``.
=doc Significantly extend HTTP documentation with new content and ports from spray docs 2015-05-11 23:05:18 +02:00
+htp #18496 add missing directive documentation (scala) 2015-10-01 13:25:41 +02:00			Provides support for handling `HTTP Basic Authentication`_.

=doc,htpi #18496 more security directives docs 2015-10-08 15:20:17 +02:00			Refer to :ref:`-authenticateBasic-` for a detailed description of this directive.

			Its semantics are equivalent to ``authenticateBasicPF`` 's, where not handling a case in the Partial Function (PF)
+htp #18496 add missing directive documentation (scala) 2015-10-01 13:25:41 +02:00			leaves the request to be rejected with a :class:`AuthenticationFailedRejection` rejection.

=htc,doc #18496 make all directive docs have the same style, some additions 2015-10-09 15:19:36 +02:00			Longer-running authentication tasks (like looking up credentials in a database) should use :ref:`-authenticateBasicAsync-`
+htp #18496 add missing directive documentation (scala) 2015-10-01 13:25:41 +02:00			or :ref:`-authenticateBasicPFAsync-` if you prefer to use the ``PartialFunction`` syntax.

			`.. warning::`
=doc,htpi #18496 more security directives docs 2015-10-08 15:20:17 +02:00			`Make sure to use basic authentication only over SSL/TLS because credentials are transferred in plaintext.`
+htp #18496 add missing directive documentation (scala) 2015-10-01 13:25:41 +02:00
			`.. _HTTP Basic Authentication: https://en.wikipedia.org/wiki/Basic_auth`
=doc Significantly extend HTTP documentation with new content and ports from spray docs 2015-05-11 23:05:18 +02:00
			`Example`
			`-------`

=doc #18104 fixes typo which made includecode2 not work in many places Note that some of the files don't exist, fixing this very soon. 2015-09-16 23:50:35 +02:00			`.. includecode2:: ../../../../code/docs/http/scaladsl/server/directives/SecurityDirectivesExamplesSpec.scala`
=doc,htpi #18496 more security directives docs 2015-10-08 15:20:17 +02:00			`:snippet: authenticateBasicPF-0`