trait SecurityDirectives extends AnyRef
Provides directives for securing an inner route using the standard Http authentication headers `WWW-Authenticate` and Authorization. Most prominently, HTTP Basic authentication and OAuth 2.0 Authorization Framework as defined in RFC 2617 and RFC 6750 respectively.
- Source
- SecurityDirectives.scala
- Grouped
- Alphabetic
- By Inheritance
- SecurityDirectives
- AnyRef
- Any
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- Protected
Security directives
- type AsyncAuthenticator[T] = (Credentials) => Future[Option[T]]
- type AsyncAuthenticatorPF[T] = PartialFunction[Credentials, Future[T]]
- type AuthenticationResult[+T] = Either[HttpChallenge, T]
The result of an HTTP authentication attempt is either the user object or an HttpChallenge to present to the browser.
- type Authenticator[T] = (Credentials) => Option[T]
- type AuthenticatorPF[T] = PartialFunction[Credentials, T]
- def authenticateBasic[T](realm: String, authenticator: Authenticator[T]): AuthenticationDirective[T]
Wraps the inner route with Http Basic authentication support using a given
Authenticator[T]
.Wraps the inner route with Http Basic authentication support using a given
Authenticator[T]
. The given authenticator determines whether the credentials in the request are valid and, if so, which user object to supply to the inner route. - def authenticateBasicAsync[T](realm: String, authenticator: AsyncAuthenticator[T]): AuthenticationDirective[T]
Wraps the inner route with Http Basic authentication support.
Wraps the inner route with Http Basic authentication support. The given authenticator determines whether the credentials in the request are valid and, if so, which user object to supply to the inner route.
- def authenticateBasicPF[T](realm: String, authenticator: AuthenticatorPF[T]): AuthenticationDirective[T]
A directive that wraps the inner route with Http Basic authentication support.
A directive that wraps the inner route with Http Basic authentication support. The given authenticator determines whether the credentials in the request are valid and, if so, which user object to supply to the inner route.
- def authenticateBasicPFAsync[T](realm: String, authenticator: AsyncAuthenticatorPF[T]): AuthenticationDirective[T]
A directive that wraps the inner route with Http Basic authentication support.
A directive that wraps the inner route with Http Basic authentication support. The given authenticator determines whether the credentials in the request are valid and, if so, which user object to supply to the inner route.
- def authenticateOAuth2[T](realm: String, authenticator: Authenticator[T]): AuthenticationDirective[T]
A directive that wraps the inner route with OAuth2 Bearer Token authentication support.
A directive that wraps the inner route with OAuth2 Bearer Token authentication support. The given authenticator determines whether the credentials in the request are valid and, if so, which user object to supply to the inner route.
- def authenticateOAuth2Async[T](realm: String, authenticator: AsyncAuthenticator[T]): AuthenticationDirective[T]
A directive that wraps the inner route with OAuth2 Bearer Token authentication support.
A directive that wraps the inner route with OAuth2 Bearer Token authentication support. The given authenticator determines whether the credentials in the request are valid and, if so, which user object to supply to the inner route.
- def authenticateOAuth2PF[T](realm: String, authenticator: AuthenticatorPF[T]): AuthenticationDirective[T]
A directive that wraps the inner route with OAuth2 Bearer Token authentication support.
A directive that wraps the inner route with OAuth2 Bearer Token authentication support. The given authenticator determines whether the credentials in the request are valid and, if so, which user object to supply to the inner route.
- def authenticateOAuth2PFAsync[T](realm: String, authenticator: AsyncAuthenticatorPF[T]): AuthenticationDirective[T]
A directive that wraps the inner route with OAuth2 Bearer Token authentication support.
A directive that wraps the inner route with OAuth2 Bearer Token authentication support. The given authenticator determines whether the credentials in the request are valid and, if so, which user object to supply to the inner route.
- def authenticateOrRejectWithChallenge[C <: HttpCredentials, T](authenticator: (Option[C]) => Future[AuthenticationResult[T]])(implicit arg0: ClassTag[C]): AuthenticationDirective[T]
Lifts an authenticator function into a directive.
Lifts an authenticator function into a directive. Same as
authenticateOrRejectWithChallenge
but only applies the authenticator function with a certain type of credentials. - def authenticateOrRejectWithChallenge[T](authenticator: (Option[HttpCredentials]) => Future[AuthenticationResult[T]]): AuthenticationDirective[T]
Lifts an authenticator function into a directive.
Lifts an authenticator function into a directive. The authenticator function gets passed in credentials from the Authorization header of the request. If the function returns
Right(user)
the user object is provided to the inner route. If the function returnsLeft(challenge)
the request is rejected with an AuthenticationFailedRejection that contains this challenge to be added to the response. - def authorize(check: (RequestContext) => Boolean): Directive0
Applies the given authorization check to the request.
Applies the given authorization check to the request. If the check fails the route is rejected with an AuthorizationFailedRejection.
- def authorize(check: => Boolean): Directive0
Applies the given authorization check to the request.
Applies the given authorization check to the request. If the check fails the route is rejected with an AuthorizationFailedRejection.
- def authorizeAsync(check: (RequestContext) => Future[Boolean]): Directive0
Asynchronous version of authorize.
Asynchronous version of authorize. If the Future fails or is completed with
false
authorization fails and the route is rejected with an AuthorizationFailedRejection. - def authorizeAsync(check: => Future[Boolean]): Directive0
Asynchronous version of authorize.
Asynchronous version of authorize. If the Future fails or is completed with
false
authorization fails and the route is rejected with an AuthorizationFailedRejection. - def extractCredentials: Directive1[Option[HttpCredentials]]
Extracts the potentially present HttpCredentials provided with the request's Authorization header.