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
- Alphabetic
- By Inheritance
- SAMLAuthConfig
- Serializable
- Serializable
- Product
- Equals
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
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
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
- val authnRequestBindingType: String
- val callbackurl: String
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @HotSpotIntrinsicCandidate()
- val cookieDomain: Option[String]
- val cookieExtension: Option[String]
- val cookiePath: String
- val cookieSecure: Option[Boolean]
- val csrfTokenKey: String
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- val forceRedirectScheme: Option[String]
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val idpMetadataPath: String
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- val keystorePassword: String
- val keystorePath: String
- val lifetimeSeconds: Long
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- val privateKeyPassword: String
- val sessionCookieName: String
- val spMetadataPath: Option[String]
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
Deprecated Value Members
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] ) @Deprecated
- Deprecated