providers

Type Members

1. class BasicAuthProvider extends RequestProvider

   

   A request provider implementation which supports HTTP basic authentication.

   A request provider implementation which supports HTTP basic authentication.

   The provider supports the change of password hashing algorithms on the fly. Sometimes it may be possible to change the hashing algorithm used by the application. But the hashes stored in the backing store can't be converted back into plain text passwords, to hash them again with the new algorithm. So if a user successfully authenticates after the application has changed the hashing algorithm, the provider hashes the entered password again with the new algorithm and stores the auth info in the backing store.

2. case class CommonSocialProfile(loginInfo: LoginInfo, firstName: Option[String] = None, lastName: Option[String] = None, fullName: Option[String] = None, email: Option[String] = None, avatarURL: Option[String] = None) extends SocialProfile with Product with Serializable

   

   The social profile contains all the data returned from the social providers after authentication.

   The social profile contains all the data returned from the social providers after authentication.

   Not every provider returns all the data defined in this class. This is also the representation of the most common profile information provided by the social providers. The data can be used to create a new identity for the first authentication(which is also the registration) or to update an existing identity on every subsequent authentication.

   loginInfo

   The linked login info.

   firstName

   Maybe the first name of the authenticated user.

   lastName

   Maybe the last name of the authenticated user.

   fullName

   Maybe the full name of the authenticated user.

   email

   Maybe the email of the authenticated provider.

   avatarURL

   Maybe the avatar URL of the authenticated provider.

3. trait CommonSocialProfileBuilder extends AnyRef

   

   The profile builder for the common social profile.

4. class CredentialsProvider extends Provider

   

   A provider for authenticating with credentials.

   A provider for authenticating with credentials.

   The provider supports the change of password hashing algorithms on the fly. Sometimes it may be possible to change the hashing algorithm used by the application. But the hashes stored in the backing store can't be converted back into plain text passwords, to hash them again with the new algorithm. So if a user successfully authenticates after the application has changed the hashing algorithm, the provider hashes the entered password again with the new algorithm and stores the auth info in the backing store.

5. case class OAuth1Info(token: String, secret: String) extends AuthInfo with Product with Serializable

   

   The OAuth1 details.

   The OAuth1 details.

   token

   The consumer token.

   secret

   The consumer secret.

6. abstract class OAuth1Provider extends SocialProvider with Logger

   

   Base class for all OAuth1 providers.

7. trait OAuth1Service extends AnyRef

   

   The OAuth1 service trait.

8. case class OAuth1Settings(requestTokenURL: String, accessTokenURL: String, authorizationURL: String, callbackURL: String, consumerKey: String, consumerSecret: String) extends Product with Serializable

   

   The OAuth1 settings.

   The OAuth1 settings.

   requestTokenURL

   The request token URL provided by the OAuth provider.

   accessTokenURL

   The access token URL provided by the OAuth provider.

   authorizationURL

   The authorization URL provided by the OAuth provider.

   callbackURL

   The callback URL to the application after a successful authentication on the OAuth provider. The URL can be a relative path which will be resolved against the current request's host.

   consumerKey

   The consumer ID provided by the OAuth provider.

   consumerSecret

   The consumer secret provided by the OAuth provider.

9. trait OAuth1TokenSecret extends AnyRef

   

   The OAuth1 token secret.

   The OAuth1 token secret.

   This represents the oauth_token_secret returned from the provider with the request token and which is then needed to retrieve the access token. The secret must be stored between two requests and this implementation provides an abstract way to store the secret in different locations.

10. trait OAuth1TokenSecretProvider extends AnyRef

    

    Provides the token secret for OAuth1 authentication providers.

11. case class OAuth2Info(accessToken: String, tokenType: Option[String] = None, expiresIn: Option[Int] = None, refreshToken: Option[String] = None, params: Option[Map[String, String]] = None) extends AuthInfo with Product with Serializable

    

    The Oauth2 info.

    The Oauth2 info.

    accessToken

    The access token.

    tokenType

    The token type.

    expiresIn

    The number of seconds before the token expires.

    refreshToken

    The refresh token.

    params

    Additional params transported in conjunction with the token.

12. abstract class OAuth2Provider extends SocialProvider with Logger

    

    Base class for all OAuth2 providers.

13. case class OAuth2Settings(authorizationURL: Option[String] = None, accessTokenURL: String, redirectURL: String, clientID: String, clientSecret: String, scope: Option[String] = None, authorizationParams: Map[String, String] = Map(), accessTokenParams: Map[String, String] = Map(), customProperties: Map[String, String] = Map()) extends Product with Serializable

    

    The OAuth2 settings.

    The OAuth2 settings.

    authorizationURL

    The authorization URL provided by the OAuth provider.

    accessTokenURL

    The access token URL provided by the OAuth provider.

    redirectURL

    The redirect URL to the application after a successful authentication on the OAuth provider. The URL can be a relative path which will be resolved against the current request's host.

    clientID

    The client ID provided by the OAuth provider.

    clientSecret

    The client secret provided by the OAuth provider.

    scope

    The OAuth2 scope parameter provided by the OAuth provider.

    authorizationParams

    Additional params to add to the authorization request.

    accessTokenParams

    Additional params to add to the access token request.

    customProperties

    A map of custom properties for the different providers.

14. trait OAuth2State extends AnyRef

    

    The OAuth2 state.

    The OAuth2 state.

    This is to prevent the client for CSRF attacks as described in the OAuth2 RFC.

    See also

    https://tools.ietf.org/html/rfc6749#section-10.12

15. trait OAuth2StateProvider extends AnyRef

    

    Provides state for authentication providers.

16. case class OpenIDInfo(id: String, attributes: Map[String, String]) extends AuthInfo with Product with Serializable

    

    The OpenID details.

    The OpenID details.

    id

    The openID.

    attributes

    The attributes returned from the provider.

17. abstract class OpenIDProvider extends SocialProvider with Logger

    

    Base class for all OpenID providers.

18. trait OpenIDService extends AnyRef

    

    The OpenID service trait.

19. case class OpenIDSettings(providerURL: String, callbackURL: String, axRequired: Seq[(String, String)] = Seq.empty, axOptional: Seq[(String, String)] = Seq.empty, realm: Option[String] = None) extends Product with Serializable

    

    The OpenID settings.

    The OpenID settings.

    providerURL

    The OpenID provider URL used if no openID was given. @see https://willnorris.com/2009/07/openid-directed-identity-identifier-select

    callbackURL

    The callback URL to the application after a successful authentication on the OpenID provider. The URL can be a relative path which will be resolved against the current request's host.

    axRequired

    Required attributes to return from the provider after a successful authentication.

    axOptional

    Optional attributes to return from the provider after a successful authentication.

    realm

    An URL pattern that represents the part of URL-space for which an OpenID Authentication request is valid.

20. trait SocialProfile extends AnyRef

    

    The social profile contains all the data returned from the social providers after authentication.

21. trait SocialProfileBuilder extends AnyRef

    

    Builds the social profile.

22. trait SocialProfileParser[C, P <: SocialProfile] extends AnyRef

    

    Parses a social profile.

    Parses a social profile.

    A parser transforms the content returned from the provider into a social profile instance. Parsers can be reused by other parsers to avoid duplicating code.

    C

    The content type to parse a profile from.

    P

    The type of the profile to parse to.

23. trait SocialProvider extends Provider with SocialProfileBuilder

    

    The base interface for all social providers.