org.keycloak.protocol.saml.installation.KeycloakSamlClientInstallation クラス

org.keycloak.protocol.saml.installation.KeycloakSamlClientInstallation の継承関係図

org.keycloak.protocol.saml.installation.KeycloakSamlClientInstallation 連携図

公開メンバ関数
Response	generateInstallation (KeycloakSession session, RealmModel realm, ClientModel client, URI baseUri)
String	getProtocol ()
String	getDisplayType ()
String	getHelpText ()
String	getFilename ()
String	getMediaType ()
boolean	isDownloadOnly ()
void	close ()
ClientInstallationProvider	create (KeycloakSession session)
void	init (Config.Scope config)
void	postInit (KeycloakSessionFactory factory)
String	getId ()

静的公開メンバ関数
static void	baseXml (KeycloakSession session, RealmModel realm, ClientModel client, URI baseUri, SamlClient samlClient, StringBuilder buffer)

詳解

著者

Bill Burke

バージョン

Revision

1

関数詳解

baseXml()

static void org.keycloak.protocol.saml.installation.KeycloakSamlClientInstallation.baseXml ( KeycloakSession  session, RealmModel  realm, ClientModel  client, URI  baseUri, SamlClient  samlClient, StringBuilder  buffer  )

inlinestatic

                                                                                                                                                        {
        buffer.append("    <SP entityID=\"").append(client.getClientId()).append("\"\n");
        buffer.append("        sslPolicy=\"").append(realm.getSslRequired().name()).append("\"\n");
        buffer.append("        logoutPage=\"SPECIFY YOUR LOGOUT PAGE!\">\n");
        if (samlClient.requiresClientSignature() || samlClient.requiresEncryption()) {
            buffer.append("        <Keys>\n");
            if (samlClient.requiresClientSignature()) {
                buffer.append("            <Key signing=\"true\">\n");
                buffer.append("                <PrivateKeyPem>\n");
                if (samlClient.getClientSigningPrivateKey() == null) {
                    buffer.append("                    PRIVATE KEY NOT SET UP OR KNOWN\n");
                } else {
                    buffer.append("                    ").append(samlClient.getClientSigningPrivateKey()).append("\n");
                }
                buffer.append("                </PrivateKeyPem>\n");
                buffer.append("                <CertificatePem>\n");
                if (samlClient.getClientSigningCertificate() == null) {
                    buffer.append("                    YOU MUST CONFIGURE YOUR CLIENT's SIGNING CERTIFICATE\n");
                } else {
                    buffer.append("                    ").append(samlClient.getClientSigningCertificate()).append("\n");
                }
                buffer.append("                </CertificatePem>\n");
                buffer.append("            </Key>\n");
            }
            if (samlClient.requiresEncryption()) {
                buffer.append("            <Key encryption=\"true\">\n");
                buffer.append("                <PrivateKeyPem>\n");
                if (samlClient.getClientEncryptingPrivateKey() == null) {
                    buffer.append("                    PRIVATE KEY NOT SET UP OR KNOWN\n");
                } else {
                    buffer.append("                    ").append(samlClient.getClientEncryptingPrivateKey()).append("\n");
                }
                buffer.append("                </PrivateKeyPem>\n");
                buffer.append("            </Key>\n");

            }
            buffer.append("        </Keys>\n");
        }
        buffer.append("        <IDP entityID=\"idp\"");
        if (samlClient.requiresClientSignature()) {
            buffer.append("\n             signatureAlgorithm=\"").append(samlClient.getSignatureAlgorithm()).append("\"");
            if (samlClient.getCanonicalizationMethod() != null) {
                buffer.append("\n             signatureCanonicalizationMethod=\"").append(samlClient.getCanonicalizationMethod()).append("\"");
            }
        }
        buffer.append(">\n");
        buffer.append("            <SingleSignOnService signRequest=\"").append(Boolean.toString(samlClient.requiresClientSignature())).append("\"\n");
        buffer.append("                                 validateResponseSignature=\"").append(Boolean.toString(samlClient.requiresRealmSignature())).append("\"\n");
        buffer.append("                                 validateAssertionSignature=\"").append(Boolean.toString(samlClient.requiresAssertionSignature())).append("\"\n");
        buffer.append("                                 requestBinding=\"POST\"\n");
        UriBuilder bindingUrlBuilder = UriBuilder.fromUri(baseUri);
        String bindingUrl = RealmsResource.protocolUrl(bindingUrlBuilder)
                .build(realm.getName(), SamlProtocol.LOGIN_PROTOCOL).toString();
        buffer.append("                                 bindingUrl=\"").append(bindingUrl).append("\"/>\n");

        buffer.append("            <SingleLogoutService signRequest=\"").append(Boolean.toString(samlClient.requiresClientSignature())).append("\"\n");
        buffer.append("                                 signResponse=\"").append(Boolean.toString(samlClient.requiresClientSignature())).append("\"\n");
        buffer.append("                                 validateRequestSignature=\"").append(Boolean.toString(samlClient.requiresRealmSignature())).append("\"\n");
        buffer.append("                                 validateResponseSignature=\"").append(Boolean.toString(samlClient.requiresRealmSignature())).append("\"\n");
        buffer.append("                                 requestBinding=\"POST\"\n");
        buffer.append("                                 responseBinding=\"POST\"\n");
        buffer.append("                                 postBindingUrl=\"").append(bindingUrl).append("\"\n");
        buffer.append("                                 redirectBindingUrl=\"").append(bindingUrl).append("\"");
        buffer.append("/>\n");
        buffer.append("        </IDP>\n");
        buffer.append("    </SP>\n");
    }

close()

void org.keycloak.protocol.saml.installation.KeycloakSamlClientInstallation.close ( )

inline

                        {

    }

create()

ClientInstallationProvider org.keycloak.protocol.saml.installation.KeycloakSamlClientInstallation.create ( KeycloakSession  session )

inline

                                                                      {
        return this;
    }

generateInstallation()

Response org.keycloak.protocol.saml.installation.KeycloakSamlClientInstallation.generateInstallation ( KeycloakSession  session, RealmModel  realm, ClientModel  client, URI  baseUri  )

inline

                                                                                                                     {
        SamlClient samlClient = new SamlClient(client);
        StringBuilder buffer = new StringBuilder();
        buffer.append("<keycloak-saml-adapter>\n");
        baseXml(session, realm, client, baseUri, samlClient, buffer);
        buffer.append("</keycloak-saml-adapter>\n");
        return Response.ok(buffer.toString(), MediaType.TEXT_PLAIN_TYPE).build();
    }

getDisplayType()

String org.keycloak.protocol.saml.installation.KeycloakSamlClientInstallation.getDisplayType ( )

inline

                                   {
        return "Keycloak SAML Adapter keycloak-saml.xml";
    }

getFilename()

String org.keycloak.protocol.saml.installation.KeycloakSamlClientInstallation.getFilename ( )

inline

                                {
        return "keycloak-saml.xml";
    }

getHelpText()

String org.keycloak.protocol.saml.installation.KeycloakSamlClientInstallation.getHelpText ( )

inline

                                {
        return "Keycloak SAML adapter configuration file.  Put this in WEB-INF directory of your WAR.";
    }

getId()

String org.keycloak.protocol.saml.installation.KeycloakSamlClientInstallation.getId ( )

inline

                          {
        return "keycloak-saml";
    }

getMediaType()

String org.keycloak.protocol.saml.installation.KeycloakSamlClientInstallation.getMediaType ( )

inline

                                 {
        return MediaType.APPLICATION_XML;
    }

getProtocol()

String org.keycloak.protocol.saml.installation.KeycloakSamlClientInstallation.getProtocol ( )

inline

                                {
        return SamlProtocol.LOGIN_PROTOCOL;
    }

init()

void org.keycloak.protocol.saml.installation.KeycloakSamlClientInstallation.init ( Config.Scope  config )

inline

                                          {

    }

isDownloadOnly()

boolean org.keycloak.protocol.saml.installation.KeycloakSamlClientInstallation.isDownloadOnly ( )

inline

                                    {
        return false;
    }

postInit()

void org.keycloak.protocol.saml.installation.KeycloakSamlClientInstallation.postInit ( KeycloakSessionFactory  factory )

inline

                                                         {

    }

---

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

• D:/AppData/doxygen/keycloak/rest-service/src/services/src/main/java/org/keycloak/protocol/saml/installation/KeycloakSamlClientInstallation.java