org.keycloak.protocol.saml.SamlClient クラス

org.keycloak.protocol.saml.SamlClient の継承関係図

org.keycloak.protocol.saml.SamlClient 連携図

公開メンバ関数
	SamlClient (ClientModel client)
String	getCanonicalizationMethod ()
void	setCanonicalizationMethod (String value)
SignatureAlgorithm	getSignatureAlgorithm ()
void	setSignatureAlgorithm (SignatureAlgorithm algorithm)
String	getNameIDFormat ()
void	setNameIDFormat (String format)
boolean	includeAuthnStatement ()
void	setIncludeAuthnStatement (boolean val)
boolean	forceNameIDFormat ()
void	setForceNameIDFormat (boolean val)
boolean	requiresRealmSignature ()
void	setRequiresRealmSignature (boolean val)
boolean	addExtensionsElementWithKeyInfo ()
void	setAddExtensionsElementWithKeyInfo (boolean val)
boolean	forcePostBinding ()
void	setForcePostBinding (boolean val)
boolean	requiresAssertionSignature ()
void	setRequiresAssertionSignature (boolean val)
boolean	requiresEncryption ()
void	setRequiresEncryption (boolean val)
boolean	requiresClientSignature ()
void	setRequiresClientSignature (boolean val)
String	getClientSigningCertificate ()
void	setClientSigningCertificate (String val)
String	getClientSigningPrivateKey ()
void	setClientSigningPrivateKey (String val)
String	getClientEncryptingCertificate ()
void	setClientEncryptingCertificate (String val)
String	getClientEncryptingPrivateKey ()
void	setClientEncryptingPrivateKey (String val)
XmlKeyInfoKeyNameTransformer	getXmlSigKeyInfoKeyNameTransformer ()
void	setXmlSigKeyInfoKeyNameTransformer (XmlKeyInfoKeyNameTransformer xmlSigKeyInfoKeyNameTransformer)
boolean	includeOneTimeUseCondition ()
void	setIncludeOneTimeUseCondition (boolean val)
String	resolveAttribute (String name)
boolean	isFrontchannelLogout ()

静的公開メンバ関数
static String	samlNameIDFormatToClientAttribute (String nameIdFormat)

静的公開変数類
static final XmlKeyInfoKeyNameTransformer	DEFAULT_XML_KEY_INFO_KEY_NAME_TRANSFORMER = XmlKeyInfoKeyNameTransformer.KEY_ID

限定公開変数類
ClientModel	client

関数
boolean	isConsentRequired ()
boolean	isStandardFlowEnabled ()
boolean	isServiceAccountsEnabled ()

詳解

Configuration of a SAML-enabled client.

著者

Bill Burke

バージョン

Revision

1

構築子と解体子

SamlClient()

org.keycloak.protocol.saml.SamlClient.SamlClient ( ClientModel  client )

inline

                                          {
        super(client);
    }

関数詳解

addExtensionsElementWithKeyInfo()

boolean org.keycloak.protocol.saml.SamlClient.addExtensionsElementWithKeyInfo ( )

inline

                                                     {
        return "true".equals(resolveAttribute(SamlConfigAttributes.SAML_SERVER_SIGNATURE_KEYINFO_EXT));
    }

forceNameIDFormat()

boolean org.keycloak.protocol.saml.SamlClient.forceNameIDFormat ( )

inline

                                       {
        return "true".equals(resolveAttribute(SamlConfigAttributes.SAML_FORCE_NAME_ID_FORMAT_ATTRIBUTE));

    }

forcePostBinding()

boolean org.keycloak.protocol.saml.SamlClient.forcePostBinding ( )

inline

                                      {
        return "true".equals(resolveAttribute(SamlConfigAttributes.SAML_FORCE_POST_BINDING));
    }

getCanonicalizationMethod()

String org.keycloak.protocol.saml.SamlClient.getCanonicalizationMethod ( )

inline

                                              {
        return resolveAttribute(SamlConfigAttributes.SAML_CANONICALIZATION_METHOD_ATTRIBUTE);
    }

getClientEncryptingCertificate()

String org.keycloak.protocol.saml.SamlClient.getClientEncryptingCertificate ( )

inline

                                                   {
        return client.getAttribute(SamlConfigAttributes.SAML_ENCRYPTION_CERTIFICATE_ATTRIBUTE);
    }

getClientEncryptingPrivateKey()

String org.keycloak.protocol.saml.SamlClient.getClientEncryptingPrivateKey ( )

inline

                                                  {
        return client.getAttribute(SamlConfigAttributes.SAML_ENCRYPTION_PRIVATE_KEY_ATTRIBUTE);
    }

getClientSigningCertificate()

String org.keycloak.protocol.saml.SamlClient.getClientSigningCertificate ( )

inline

                                                {
        return client.getAttribute(SamlConfigAttributes.SAML_SIGNING_CERTIFICATE_ATTRIBUTE);
    }

getClientSigningPrivateKey()

String org.keycloak.protocol.saml.SamlClient.getClientSigningPrivateKey ( )

inline

                                               {
        return client.getAttribute(SamlConfigAttributes.SAML_SIGNING_PRIVATE_KEY);
    }

getNameIDFormat()

String org.keycloak.protocol.saml.SamlClient.getNameIDFormat ( )

inline

                                    {
        String nameIdFormat = null;

        String configuredNameIdFormat = resolveAttribute(SamlConfigAttributes.SAML_NAME_ID_FORMAT_ATTRIBUTE);
        if (configuredNameIdFormat != null) {
            if (configuredNameIdFormat.equals("email")) {
                nameIdFormat = JBossSAMLURIConstants.NAMEID_FORMAT_EMAIL.get();
            } else if (configuredNameIdFormat.equals("persistent")) {
                nameIdFormat = JBossSAMLURIConstants.NAMEID_FORMAT_PERSISTENT.get();
            } else if (configuredNameIdFormat.equals("transient")) {
                nameIdFormat = JBossSAMLURIConstants.NAMEID_FORMAT_TRANSIENT.get();
            } else if (configuredNameIdFormat.equals("username")) {
                nameIdFormat = JBossSAMLURIConstants.NAMEID_FORMAT_UNSPECIFIED.get();
            } else {
                nameIdFormat = JBossSAMLURIConstants.NAMEID_FORMAT_UNSPECIFIED.get();
            }
        }
        return nameIdFormat;

    }

getSignatureAlgorithm()

SignatureAlgorithm org.keycloak.protocol.saml.SamlClient.getSignatureAlgorithm ( )

inline

                                                      {
        String alg = resolveAttribute(SamlConfigAttributes.SAML_SIGNATURE_ALGORITHM);
        if (alg != null) {
            SignatureAlgorithm algorithm = SignatureAlgorithm.valueOf(alg);
            if (algorithm != null)
                return algorithm;
        }
        return SignatureAlgorithm.RSA_SHA256;
    }

getXmlSigKeyInfoKeyNameTransformer()

XmlKeyInfoKeyNameTransformer org.keycloak.protocol.saml.SamlClient.getXmlSigKeyInfoKeyNameTransformer ( )

inline

Always returns non-

null 

result.

戻り値

Configured ransformer of DEFAULT_XML_KEY_INFO_KEY_NAME_TRANSFORMER if not set.

                                                                             {
        return XmlKeyInfoKeyNameTransformer.from(
                client.getAttribute(SamlConfigAttributes.SAML_SERVER_SIGNATURE_KEYINFO_KEY_NAME_TRANSFORMER),
                DEFAULT_XML_KEY_INFO_KEY_NAME_TRANSFORMER);
    }

includeAuthnStatement()

boolean org.keycloak.protocol.saml.SamlClient.includeAuthnStatement ( )

inline

                                           {
        return "true".equals(resolveAttribute(SamlConfigAttributes.SAML_AUTHNSTATEMENT));
    }

includeOneTimeUseCondition()

boolean org.keycloak.protocol.saml.SamlClient.includeOneTimeUseCondition ( )

inline

                                                {
        return "true".equals(resolveAttribute(SamlConfigAttributes.SAML_ONETIMEUSE_CONDITION));
    }

isConsentRequired()

boolean org.keycloak.models.ClientConfigResolver.isConsentRequired ( )

inlinepackageinherited

                                {
        return client.isConsentRequired();
    }

isFrontchannelLogout()

boolean org.keycloak.models.ClientConfigResolver.isFrontchannelLogout ( )

inlineinherited

                                          {
        return client.isFrontchannelLogout();
    }

isServiceAccountsEnabled()

boolean org.keycloak.models.ClientConfigResolver.isServiceAccountsEnabled ( )

inlinepackageinherited

                                       {
        return client.isServiceAccountsEnabled();
    }

isStandardFlowEnabled()

boolean org.keycloak.models.ClientConfigResolver.isStandardFlowEnabled ( )

inlinepackageinherited

                                    {
        return client.isStandardFlowEnabled();
    }

requiresAssertionSignature()

boolean org.keycloak.protocol.saml.SamlClient.requiresAssertionSignature ( )

inline

                                                {
        return "true".equals(resolveAttribute(SamlConfigAttributes.SAML_ASSERTION_SIGNATURE));
    }

requiresClientSignature()

boolean org.keycloak.protocol.saml.SamlClient.requiresClientSignature ( )

inline

                                             {
        return "true".equals(resolveAttribute(SamlConfigAttributes.SAML_CLIENT_SIGNATURE_ATTRIBUTE));
    }

requiresEncryption()

boolean org.keycloak.protocol.saml.SamlClient.requiresEncryption ( )

inline

                                        {
        return "true".equals(resolveAttribute(SamlConfigAttributes.SAML_ENCRYPT));
    }

requiresRealmSignature()

boolean org.keycloak.protocol.saml.SamlClient.requiresRealmSignature ( )

inline

                                            {
        return "true".equals(resolveAttribute(SamlConfigAttributes.SAML_SERVER_SIGNATURE));
    }

resolveAttribute()

String org.keycloak.models.ClientConfigResolver.resolveAttribute ( String  name )

inlineinherited

                                                {
        return client.getAttribute(name);
    }

samlNameIDFormatToClientAttribute()

static String org.keycloak.protocol.saml.SamlClient.samlNameIDFormatToClientAttribute ( String  nameIdFormat )

inlinestatic

                                                                                {
        if (nameIdFormat.equals(JBossSAMLURIConstants.NAMEID_FORMAT_EMAIL.get())) {
            return "email";
        } else if (nameIdFormat.equals(JBossSAMLURIConstants.NAMEID_FORMAT_PERSISTENT.get())) {
            return "persistent";
        } else if (nameIdFormat.equals(JBossSAMLURIConstants.NAMEID_FORMAT_TRANSIENT.get())) {
            return "transient";
        } else if (nameIdFormat.equals(JBossSAMLURIConstants.NAMEID_FORMAT_UNSPECIFIED.get())) {
            return "username";
        }
        return null;

    }

setAddExtensionsElementWithKeyInfo()

void org.keycloak.protocol.saml.SamlClient.setAddExtensionsElementWithKeyInfo ( boolean  val )

inline

                                                                {
        client.setAttribute(SamlConfigAttributes.SAML_SERVER_SIGNATURE_KEYINFO_EXT, Boolean.toString(val));
    }

setCanonicalizationMethod()

void org.keycloak.protocol.saml.SamlClient.setCanonicalizationMethod ( String  value )

inline

                                                        {
        client.setAttribute(SamlConfigAttributes.SAML_CANONICALIZATION_METHOD_ATTRIBUTE, value);
    }

setClientEncryptingCertificate()

void org.keycloak.protocol.saml.SamlClient.setClientEncryptingCertificate ( String  val )

inline

                                                           {
        client.setAttribute(SamlConfigAttributes.SAML_ENCRYPTION_CERTIFICATE_ATTRIBUTE, val);

    }

setClientEncryptingPrivateKey()

void org.keycloak.protocol.saml.SamlClient.setClientEncryptingPrivateKey ( String  val )

inline

                                                          {
        client.setAttribute(SamlConfigAttributes.SAML_ENCRYPTION_PRIVATE_KEY_ATTRIBUTE, val);

    }

setClientSigningCertificate()

void org.keycloak.protocol.saml.SamlClient.setClientSigningCertificate ( String  val )

inline

                                                        {
        client.setAttribute(SamlConfigAttributes.SAML_SIGNING_CERTIFICATE_ATTRIBUTE, val);

    }

setClientSigningPrivateKey()

void org.keycloak.protocol.saml.SamlClient.setClientSigningPrivateKey ( String  val )

inline

                                                       {
        client.setAttribute(SamlConfigAttributes.SAML_SIGNING_PRIVATE_KEY, val);

    }

setForceNameIDFormat()

void org.keycloak.protocol.saml.SamlClient.setForceNameIDFormat ( boolean  val )

inline

                                                  {
        client.setAttribute(SamlConfigAttributes.SAML_FORCE_NAME_ID_FORMAT_ATTRIBUTE, Boolean.toString(val));
    }

setForcePostBinding()

void org.keycloak.protocol.saml.SamlClient.setForcePostBinding ( boolean  val )

inline

                                                 {
        client.setAttribute(SamlConfigAttributes.SAML_FORCE_POST_BINDING, Boolean.toString(val));

    }

setIncludeAuthnStatement()

void org.keycloak.protocol.saml.SamlClient.setIncludeAuthnStatement ( boolean  val )

inline

                                                      {
        client.setAttribute(SamlConfigAttributes.SAML_AUTHNSTATEMENT, Boolean.toString(val));
    }

setIncludeOneTimeUseCondition()

void org.keycloak.protocol.saml.SamlClient.setIncludeOneTimeUseCondition ( boolean  val )

inline

                                                           {
        client.setAttribute(SamlConfigAttributes.SAML_ONETIMEUSE_CONDITION, Boolean.toString(val));
    }

setNameIDFormat()

void org.keycloak.protocol.saml.SamlClient.setNameIDFormat ( String  format )

inline

                                               {
        client.setAttribute(SamlConfigAttributes.SAML_NAME_ID_FORMAT_ATTRIBUTE, format);
    }

setRequiresAssertionSignature()

void org.keycloak.protocol.saml.SamlClient.setRequiresAssertionSignature ( boolean  val )

inline

                                                           {
        client.setAttribute(SamlConfigAttributes.SAML_ASSERTION_SIGNATURE, Boolean.toString(val));

    }

setRequiresClientSignature()

void org.keycloak.protocol.saml.SamlClient.setRequiresClientSignature ( boolean  val )

inline

                                                        {
        client.setAttribute(SamlConfigAttributes.SAML_CLIENT_SIGNATURE_ATTRIBUTE, Boolean.toString(val));

    }

setRequiresEncryption()

void org.keycloak.protocol.saml.SamlClient.setRequiresEncryption ( boolean  val )

inline

                                                   {
        client.setAttribute(SamlConfigAttributes.SAML_ENCRYPT, Boolean.toString(val));

    }

setRequiresRealmSignature()

void org.keycloak.protocol.saml.SamlClient.setRequiresRealmSignature ( boolean  val )

inline

                                                       {
        client.setAttribute(SamlConfigAttributes.SAML_SERVER_SIGNATURE, Boolean.toString(val));
    }

setSignatureAlgorithm()

void org.keycloak.protocol.saml.SamlClient.setSignatureAlgorithm ( SignatureAlgorithm  algorithm )

inline

                                                                    {
        client.setAttribute(SamlConfigAttributes.SAML_SIGNATURE_ALGORITHM, algorithm.name());
    }

setXmlSigKeyInfoKeyNameTransformer()

void org.keycloak.protocol.saml.SamlClient.setXmlSigKeyInfoKeyNameTransformer ( XmlKeyInfoKeyNameTransformer  xmlSigKeyInfoKeyNameTransformer )

inline

                                                                                                                 {
        client.setAttribute(SamlConfigAttributes.SAML_SERVER_SIGNATURE_KEYINFO_KEY_NAME_TRANSFORMER,
                xmlSigKeyInfoKeyNameTransformer == null
                        ? null
                        : xmlSigKeyInfoKeyNameTransformer.name());
    }

メンバ詳解

client

ClientModel org.keycloak.models.ClientConfigResolver.client

protectedinherited

DEFAULT_XML_KEY_INFO_KEY_NAME_TRANSFORMER

final XmlKeyInfoKeyNameTransformer org.keycloak.protocol.saml.SamlClient.DEFAULT_XML_KEY_INFO_KEY_NAME_TRANSFORMER = XmlKeyInfoKeyNameTransformer.KEY_ID

static

---

このクラス詳解は次のファイルから抽出されました:

• D:/AppData/doxygen/keycloak/src/keycloak/src/main/java/org/keycloak/protocol/saml/SamlClient.java