Packages

case class SAMLAuthConfig(keystorePath: String, keystorePassword: String, privateKeyPassword: String, idpMetadataPath: String, spMetadataPath: Option[String], authnRequestBindingType: String = ..., callbackurl: String, sessionCookieName: String = Pac4jConstants.SESSION_ID, lifetimeSeconds: Long = 86400 * 3, cookiePath: String = Pac4jConstants.DEFAULT_URL_VALUE, cookieSecure: Option[Boolean] = Some(true), cookieDomain: Option[String] = None, cookieExtension: Option[String] = Some("SameSite=None"), forceRedirectScheme: Option[String] = Some("https"), csrfTokenKey: String = Pac4jConstants.CSRF_TOKEN) extends Product with Serializable

By default, it injects the configuration model with application.conf loaded.

keystorePath

SAML keystore path

keystorePassword

SAML keystore password

privateKeyPassword

Private key password

idpMetadataPath

Identity provider metadata file

spMetadataPath

Service provider metadata file

authnRequestBindingType

AuthnRequest binding type

callbackurl

SAML callback url

sessionCookieName

SESSION cookie name

lifetimeSeconds

Cookie lifetime seconds.

cookiePath

Cookie path

cookieSecure

Cookie secure mode. If not specified, check if the request uri scheme is https. In the case of SSL L4 termination, the client may not have the Secure attribute even though it is supposed to be communicating over SSL. Therefore, set True when enforcing Secure

cookieDomain

Cookie domain

cookieExtension

Cookie extension. For use with the REST API, the SameSite=None; attribute and https communication are mandatory..

forceRedirectScheme

For SSL L4 termination, to prevent that when the web app receives a request via http, the redirect URI is also http. Basically, https is required because SameSite=None; is required, but it is optional because you may test with http for verification.

csrfTokenKey

CSRF token cookie name

Linear Supertypes
Serializable, Serializable, Product, Equals, AnyRef, Any
Known Subclasses
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. SAMLAuthConfig
  2. Serializable
  3. Serializable
  4. Product
  5. Equals
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new SAMLAuthConfig(keystorePath: String, keystorePassword: String, privateKeyPassword: String, idpMetadataPath: String, spMetadataPath: Option[String], authnRequestBindingType: String = ..., callbackurl: String, sessionCookieName: String = Pac4jConstants.SESSION_ID, lifetimeSeconds: Long = 86400 * 3, cookiePath: String = Pac4jConstants.DEFAULT_URL_VALUE, cookieSecure: Option[Boolean] = Some(true), cookieDomain: Option[String] = None, cookieExtension: Option[String] = Some("SameSite=None"), forceRedirectScheme: Option[String] = Some("https"), csrfTokenKey: String = Pac4jConstants.CSRF_TOKEN)

    keystorePath

    SAML keystore path

    keystorePassword

    SAML keystore password

    privateKeyPassword

    Private key password

    idpMetadataPath

    Identity provider metadata file

    spMetadataPath

    Service provider metadata file

    authnRequestBindingType

    AuthnRequest binding type

    callbackurl

    SAML callback url

    sessionCookieName

    SESSION cookie name

    lifetimeSeconds

    Cookie lifetime seconds.

    cookiePath

    Cookie path

    cookieSecure

    Cookie secure mode. If not specified, check if the request uri scheme is https. In the case of SSL L4 termination, the client may not have the Secure attribute even though it is supposed to be communicating over SSL. Therefore, set True when enforcing Secure

    cookieDomain

    Cookie domain

    cookieExtension

    Cookie extension. For use with the REST API, the SameSite=None; attribute and https communication are mandatory..

    forceRedirectScheme

    For SSL L4 termination, to prevent that when the web app receives a request via http, the redirect URI is also http. Basically, https is required because SameSite=None; is required, but it is optional because you may test with http for verification.

    csrfTokenKey

    CSRF token cookie name

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. val authnRequestBindingType: String
  6. val callbackurl: String
  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  8. val cookieDomain: Option[String]
  9. val cookieExtension: Option[String]
  10. val cookiePath: String
  11. val cookieSecure: Option[Boolean]
  12. val csrfTokenKey: String
  13. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  14. val forceRedirectScheme: Option[String]
  15. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  16. val idpMetadataPath: String
  17. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  18. val keystorePassword: String
  19. val keystorePath: String
  20. val lifetimeSeconds: Long
  21. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  22. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  23. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  24. val privateKeyPassword: String
  25. val sessionCookieName: String
  26. val spMetadataPath: Option[String]
  27. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  28. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  29. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  30. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from Serializable

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from AnyRef

Inherited from Any

Ungrouped