Package org.keycloak.broker.saml

Class SAMLIdentityProviderConfig

java.lang.Object

org.keycloak.models.IdentityProviderModel

org.keycloak.broker.saml.SAMLIdentityProviderConfig

All Implemented Interfaces:

Serializable

public class SAMLIdentityProviderConfig
extends IdentityProviderModel

Author:

Pedro Igor

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static String	ADD_EXTENSIONS_ELEMENT_WITH_KEY_INFO
static String	ALLOW_CREATE
static String	ATTRIBUTE_CONSUMING_SERVICE_INDEX
static String	ATTRIBUTE_CONSUMING_SERVICE_NAME
static String	AUTHN_CONTEXT_CLASS_REFS
static String	AUTHN_CONTEXT_COMPARISON_TYPE
static String	AUTHN_CONTEXT_DECL_REFS
static String	BACKCHANNEL_SUPPORTED
static XmlKeyInfoKeyNameTransformer	DEFAULT_XML_KEY_INFO_KEY_NAME_TRANSFORMER
static String	ENABLED_FROM_METADATA
static String	ENCRYPTION_ALGORITHM
static String	ENCRYPTION_PUBLIC_KEY
static String	ENTITY_ID
static String	FORCE_AUTHN
static String	IDP_ENTITY_ID
static String	NAME_ID_POLICY_FORMAT
static String	POST_BINDING_AUTHN_REQUEST
static String	POST_BINDING_LOGOUT
static String	POST_BINDING_RESPONSE
static String	PRINCIPAL_ATTRIBUTE
static String	PRINCIPAL_TYPE
static String	SIGN_SP_METADATA
static String	SIGNATURE_ALGORITHM
static String	SIGNING_CERTIFICATE_KEY
static String	SINGLE_LOGOUT_SERVICE_URL
static String	SINGLE_SIGN_ON_SERVICE_URL
static String	VALIDATE_SIGNATURE
static String	WANT_ASSERTIONS_ENCRYPTED
static String	WANT_ASSERTIONS_SIGNED
static String	WANT_AUTHN_REQUESTS_SIGNED
static String	XML_SIG_KEY_INFO_KEY_NAME_TRANSFORMER

Fields inherited from class org.keycloak.models.IdentityProviderModel

addReadTokenRoleOnCreate, ALLOWED_CLOCK_SKEW, HIDE_ON_LOGIN, linkOnly, LOGIN_HINT, PASS_MAX_AGE, SYNC_MODE

Constructor Summary

Constructors

Constructor	Description
SAMLIdentityProviderConfig()
SAMLIdentityProviderConfig(IdentityProviderModel identityProviderModel)

Method Summary

Modifier and Type	Method	Description
void	addSigningCertificate(String signingCertificate)
int	getAllowedClockSkew()
Integer	getAttributeConsumingServiceIndex()
String	getAttributeConsumingServiceName()
String	getAuthnContextClassRefs()
AuthnContextComparisonType	getAuthnContextComparisonType()
String	getAuthnContextDeclRefs()
String	getEncryptionAlgorithm()
String	getEncryptionPublicKey()
String	getEntityId()
String	getIdpEntityId()
String	getNameIDPolicyFormat()
String	getPrincipalAttribute()
SamlPrincipalType	getPrincipalType()
String	getSignatureAlgorithm()
String	getSigningCertificate()	Deprecated. Prefer getSigningCertificates()}
String[]	getSigningCertificates()
String	getSingleLogoutServiceUrl()
String	getSingleSignOnServiceUrl()
XmlKeyInfoKeyNameTransformer	getXmlSigKeyInfoKeyNameTransformer()	Always returns non-null result.
boolean	isAddExtensionsElementWithKeyInfo()
boolean	isAllowCreate()
boolean	isBackchannelSupported()
boolean	isEnabledFromMetadata()
boolean	isForceAuthn()
boolean	isPostBindingAuthnRequest()
boolean	isPostBindingLogout()
boolean	isPostBindingResponse()
boolean	isSignSpMetadata()
boolean	isValidateSignature()
boolean	isWantAssertionsEncrypted()
boolean	isWantAssertionsSigned()
boolean	isWantAuthnRequestsSigned()
void	setAddExtensionsElementWithKeyInfo(boolean addExtensionsElementWithKeyInfo)
void	setAllowCreated(boolean allowCreate)
void	setAllowedClockSkew(int allowedClockSkew)
void	setAttributeConsumingServiceIndex(Integer attributeConsumingServiceIndex)
void	setAttributeConsumingServiceName(String attributeConsumingServiceName)
void	setAuthnContextClassRefs(String authnContextClassRefs)
void	setAuthnContextComparisonType(AuthnContextComparisonType authnContextComparisonType)
void	setAuthnContextDeclRefs(String authnContextDeclRefs)
void	setBackchannelSupported(boolean backchannel)
void	setEnabledFromMetadata(boolean enabled)
void	setEncryptionAlgorithm(String encryptionAlgorithm)
void	setEncryptionPublicKey(String encryptionPublicKey)
void	setEntityId(String entityId)
void	setForceAuthn(boolean forceAuthn)
void	setIdpEntityId(String idpEntityId)
void	setNameIDPolicyFormat(String nameIDPolicyFormat)
void	setPostBindingAuthnRequest(boolean postBindingAuthnRequest)
void	setPostBindingLogout(boolean postBindingLogout)
void	setPostBindingResponse(boolean postBindingResponse)
void	setPrincipalAttribute(String principalAttribute)
void	setPrincipalType(SamlPrincipalType principalType)
void	setSignatureAlgorithm(String signatureAlgorithm)
void	setSigningCertificate(String signingCertificate)	Deprecated. Prefer addSigningCertificate(String)}
void	setSignSpMetadata(boolean signSpMetadata)
void	setSingleLogoutServiceUrl(String singleLogoutServiceUrl)
void	setSingleSignOnServiceUrl(String singleSignOnServiceUrl)
void	setValidateSignature(boolean validateSignature)
void	setWantAssertionsEncrypted(boolean wantAssertionsEncrypted)
void	setWantAssertionsSigned(boolean wantAssertionsSigned)
void	setWantAuthnRequestsSigned(boolean wantAuthnRequestsSigned)
void	setXmlSigKeyInfoKeyNameTransformer(XmlKeyInfoKeyNameTransformer xmlSigKeyInfoKeyNameTransformer)
void	validate(RealmModel realm)	Validates this configuration.

Methods inherited from class org.keycloak.models.IdentityProviderModel

getAlias, getConfig, getDisplayIconClasses, getDisplayName, getFirstBrokerLoginFlowId, getInternalId, getPostBrokerLoginFlowId, getProviderId, getSyncMode, isAddReadTokenRoleOnCreate, isAuthenticateByDefault, isEnabled, isHideOnLogin, isLinkOnly, isLoginHint, isPassMaxAge, isStoreToken, isTrustEmail, setAddReadTokenRoleOnCreate, setAlias, setAuthenticateByDefault, setConfig, setDisplayName, setEnabled, setFirstBrokerLoginFlowId, setHideOnLogin, setInternalId, setLinkOnly, setLoginHint, setPassMaxAge, setPostBrokerLoginFlowId, setProviderId, setStoreToken, setSyncMode, setTrustEmail

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_XML_KEY_INFO_KEY_NAME_TRANSFORMER

public static final XmlKeyInfoKeyNameTransformer DEFAULT_XML_KEY_INFO_KEY_NAME_TRANSFORMER

ENTITY_ID

public static final String ENTITY_ID

See Also:

Constant Field Values

IDP_ENTITY_ID

public static final String IDP_ENTITY_ID

See Also:

Constant Field Values

ADD_EXTENSIONS_ELEMENT_WITH_KEY_INFO

public static final String ADD_EXTENSIONS_ELEMENT_WITH_KEY_INFO

See Also:

Constant Field Values

BACKCHANNEL_SUPPORTED

public static final String BACKCHANNEL_SUPPORTED

See Also:

Constant Field Values

ENCRYPTION_PUBLIC_KEY

public static final String ENCRYPTION_PUBLIC_KEY

See Also:

Constant Field Values

FORCE_AUTHN

public static final String FORCE_AUTHN

See Also:

Constant Field Values

NAME_ID_POLICY_FORMAT

public static final String NAME_ID_POLICY_FORMAT

See Also:

Constant Field Values

POST_BINDING_AUTHN_REQUEST

public static final String POST_BINDING_AUTHN_REQUEST

See Also:

Constant Field Values

POST_BINDING_LOGOUT

public static final String POST_BINDING_LOGOUT

See Also:

Constant Field Values

POST_BINDING_RESPONSE

public static final String POST_BINDING_RESPONSE

See Also:

Constant Field Values

SIGNATURE_ALGORITHM

public static final String SIGNATURE_ALGORITHM

See Also:

Constant Field Values

ENCRYPTION_ALGORITHM

public static final String ENCRYPTION_ALGORITHM

See Also:

Constant Field Values

SIGNING_CERTIFICATE_KEY

public static final String SIGNING_CERTIFICATE_KEY

See Also:

Constant Field Values

SINGLE_LOGOUT_SERVICE_URL

public static final String SINGLE_LOGOUT_SERVICE_URL

See Also:

Constant Field Values

SINGLE_SIGN_ON_SERVICE_URL

public static final String SINGLE_SIGN_ON_SERVICE_URL

See Also:

Constant Field Values

VALIDATE_SIGNATURE

public static final String VALIDATE_SIGNATURE

See Also:

Constant Field Values

PRINCIPAL_TYPE

public static final String PRINCIPAL_TYPE

See Also:

Constant Field Values

PRINCIPAL_ATTRIBUTE

public static final String PRINCIPAL_ATTRIBUTE

See Also:

Constant Field Values

WANT_ASSERTIONS_ENCRYPTED

public static final String WANT_ASSERTIONS_ENCRYPTED

See Also:

Constant Field Values

WANT_ASSERTIONS_SIGNED

public static final String WANT_ASSERTIONS_SIGNED

See Also:

Constant Field Values

WANT_AUTHN_REQUESTS_SIGNED

public static final String WANT_AUTHN_REQUESTS_SIGNED

See Also:

Constant Field Values

XML_SIG_KEY_INFO_KEY_NAME_TRANSFORMER

public static final String XML_SIG_KEY_INFO_KEY_NAME_TRANSFORMER

See Also:

Constant Field Values

ENABLED_FROM_METADATA

public static final String ENABLED_FROM_METADATA

See Also:

Constant Field Values

AUTHN_CONTEXT_COMPARISON_TYPE

public static final String AUTHN_CONTEXT_COMPARISON_TYPE

See Also:

Constant Field Values

AUTHN_CONTEXT_CLASS_REFS

public static final String AUTHN_CONTEXT_CLASS_REFS

See Also:

Constant Field Values

AUTHN_CONTEXT_DECL_REFS

public static final String AUTHN_CONTEXT_DECL_REFS

See Also:

Constant Field Values

SIGN_SP_METADATA

public static final String SIGN_SP_METADATA

See Also:

Constant Field Values

ALLOW_CREATE

public static final String ALLOW_CREATE

See Also:

Constant Field Values

ATTRIBUTE_CONSUMING_SERVICE_INDEX

public static final String ATTRIBUTE_CONSUMING_SERVICE_INDEX

See Also:

Constant Field Values

ATTRIBUTE_CONSUMING_SERVICE_NAME

public static final String ATTRIBUTE_CONSUMING_SERVICE_NAME

See Also:

Constant Field Values

Constructor Detail

SAMLIdentityProviderConfig

public SAMLIdentityProviderConfig()

SAMLIdentityProviderConfig

public SAMLIdentityProviderConfig(IdentityProviderModel identityProviderModel)

Method Detail

getEntityId

public String getEntityId()

setEntityId

public void setEntityId(String entityId)

getIdpEntityId

public String getIdpEntityId()

setIdpEntityId

public void setIdpEntityId(String idpEntityId)

getSingleSignOnServiceUrl

public String getSingleSignOnServiceUrl()

setSingleSignOnServiceUrl

public void setSingleSignOnServiceUrl(String singleSignOnServiceUrl)

getSingleLogoutServiceUrl

public String getSingleLogoutServiceUrl()

setSingleLogoutServiceUrl

public void setSingleLogoutServiceUrl(String singleLogoutServiceUrl)

isValidateSignature

public boolean isValidateSignature()

setValidateSignature

public void setValidateSignature(boolean validateSignature)

isForceAuthn

public boolean isForceAuthn()

setForceAuthn

public void setForceAuthn(boolean forceAuthn)

getSigningCertificate

public String getSigningCertificate()

Deprecated.

Prefer getSigningCertificates()}

Parameters:

signingCertificate -

setSigningCertificate

public void setSigningCertificate(String signingCertificate)

Deprecated.

Prefer addSigningCertificate(String)}

Parameters:

signingCertificate -

addSigningCertificate

public void addSigningCertificate(String signingCertificate)

getSigningCertificates

public String[] getSigningCertificates()

getNameIDPolicyFormat

public String getNameIDPolicyFormat()

setNameIDPolicyFormat

public void setNameIDPolicyFormat(String nameIDPolicyFormat)

isWantAuthnRequestsSigned

public boolean isWantAuthnRequestsSigned()

setWantAuthnRequestsSigned

public void setWantAuthnRequestsSigned(boolean wantAuthnRequestsSigned)

isWantAssertionsSigned

public boolean isWantAssertionsSigned()

setWantAssertionsSigned

public void setWantAssertionsSigned(boolean wantAssertionsSigned)

isWantAssertionsEncrypted

public boolean isWantAssertionsEncrypted()

setWantAssertionsEncrypted

public void setWantAssertionsEncrypted(boolean wantAssertionsEncrypted)

isAddExtensionsElementWithKeyInfo

public boolean isAddExtensionsElementWithKeyInfo()

setAddExtensionsElementWithKeyInfo

public void setAddExtensionsElementWithKeyInfo(boolean addExtensionsElementWithKeyInfo)

getSignatureAlgorithm

public String getSignatureAlgorithm()

setSignatureAlgorithm

public void setSignatureAlgorithm(String signatureAlgorithm)

getEncryptionAlgorithm

public String getEncryptionAlgorithm()

setEncryptionAlgorithm

public void setEncryptionAlgorithm(String encryptionAlgorithm)

getEncryptionPublicKey

public String getEncryptionPublicKey()

setEncryptionPublicKey

public void setEncryptionPublicKey(String encryptionPublicKey)

isPostBindingAuthnRequest

public boolean isPostBindingAuthnRequest()

setPostBindingAuthnRequest

public void setPostBindingAuthnRequest(boolean postBindingAuthnRequest)

isPostBindingResponse

public boolean isPostBindingResponse()

setPostBindingResponse

public void setPostBindingResponse(boolean postBindingResponse)

isPostBindingLogout

public boolean isPostBindingLogout()

setPostBindingLogout

public void setPostBindingLogout(boolean postBindingLogout)

isBackchannelSupported

public boolean isBackchannelSupported()

setBackchannelSupported

public void setBackchannelSupported(boolean backchannel)

getXmlSigKeyInfoKeyNameTransformer

public XmlKeyInfoKeyNameTransformer getXmlSigKeyInfoKeyNameTransformer()

Always returns non-null result.

Returns:

Configured ransformer of DEFAULT_XML_KEY_INFO_KEY_NAME_TRANSFORMER if not set.

setXmlSigKeyInfoKeyNameTransformer

public void setXmlSigKeyInfoKeyNameTransformer(XmlKeyInfoKeyNameTransformer xmlSigKeyInfoKeyNameTransformer)

getAllowedClockSkew

public int getAllowedClockSkew()

setAllowedClockSkew

public void setAllowedClockSkew(int allowedClockSkew)

getPrincipalType

public SamlPrincipalType getPrincipalType()

setPrincipalType

public void setPrincipalType(SamlPrincipalType principalType)

getPrincipalAttribute

public String getPrincipalAttribute()

setPrincipalAttribute

public void setPrincipalAttribute(String principalAttribute)

isEnabledFromMetadata

public boolean isEnabledFromMetadata()

setEnabledFromMetadata

public void setEnabledFromMetadata(boolean enabled)

getAuthnContextComparisonType

public AuthnContextComparisonType getAuthnContextComparisonType()

setAuthnContextComparisonType

public void setAuthnContextComparisonType(AuthnContextComparisonType authnContextComparisonType)

getAuthnContextClassRefs

public String getAuthnContextClassRefs()

setAuthnContextClassRefs

public void setAuthnContextClassRefs(String authnContextClassRefs)

getAuthnContextDeclRefs

public String getAuthnContextDeclRefs()

setAuthnContextDeclRefs

public void setAuthnContextDeclRefs(String authnContextDeclRefs)

isSignSpMetadata

public boolean isSignSpMetadata()

setSignSpMetadata

public void setSignSpMetadata(boolean signSpMetadata)

isAllowCreate

public boolean isAllowCreate()

setAllowCreated

public void setAllowCreated(boolean allowCreate)

getAttributeConsumingServiceIndex

public Integer getAttributeConsumingServiceIndex()

setAttributeConsumingServiceIndex

public void setAttributeConsumingServiceIndex(Integer attributeConsumingServiceIndex)

setAttributeConsumingServiceName

public void setAttributeConsumingServiceName(String attributeConsumingServiceName)

getAttributeConsumingServiceName

public String getAttributeConsumingServiceName()

validate

public void validate(RealmModel realm)

Description copied from class: IdentityProviderModel

Validates this configuration.

Sub-classes can override this method in order to enforce provider specific validations.

Overrides:

validate in class IdentityProviderModel

Parameters:

realm - the realm