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

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

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

公開メンバ関数
Response	generateInstallation (KeycloakSession session, RealmModel realm, ClientModel client, URI serverBaseUri)
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 ()
default int	order ()

静的公開メンバ関数
static String	getIDPDescriptorForClient (KeycloakSession session, RealmModel realm, ClientModel client, URI serverBaseUri)

静的非公開メンバ関数
static void	addKeyInfo (StringBuilder target, RsaKeyMetadata key, String purpose)

詳解

著者

Bill Burke

バージョン

Revision

1

関数詳解

addKeyInfo()

static void org.keycloak.protocol.saml.installation.SamlIDPDescriptorClientInstallation.addKeyInfo ( StringBuilder  target, RsaKeyMetadata  key, String  purpose  )

inlinestaticprivate

                                                                                             {
        if (key == null) {
            return;
        }

        target.append(SPMetadataDescriptor.xmlKeyInfo("      ", key.getKid(), PemUtils.encodeCertificate(key.getCertificate()), purpose, false));
    }

close()

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

inline

org.keycloak.provider.Providerを実装しています。

                        {

    }

create()

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

inline

org.keycloak.provider.ProviderFactory< T extends Provider >を実装しています。

                                                                      {
        return this;
    }

generateInstallation()

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

inline

org.keycloak.protocol.ClientInstallationProviderを実装しています。

                                                                                                                           {
        String descriptor = getIDPDescriptorForClient(session, realm, client, serverBaseUri);
        return Response.ok(descriptor, MediaType.TEXT_PLAIN_TYPE).build();
    }

getDisplayType()

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

inline

org.keycloak.protocol.ClientInstallationProviderを実装しています。

                                   {
        return "SAML Metadata IDPSSODescriptor";
    }

getFilename()

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

inline

org.keycloak.protocol.ClientInstallationProviderを実装しています。

                                {
        return "client-tailored-saml-idp-metadata.xml";
    }

getHelpText()

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

inline

org.keycloak.protocol.ClientInstallationProviderを実装しています。

                                {
        return "SAML Metadata IDPSSODescriptor tailored for the client.  This is special because not every client may require things like digital signatures";
    }

getId()

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

inline

org.keycloak.provider.ProviderFactory< T extends Provider >を実装しています。

                          {
        return "saml-idp-descriptor";
    }

getIDPDescriptorForClient()

static String org.keycloak.protocol.saml.installation.SamlIDPDescriptorClientInstallation.getIDPDescriptorForClient ( KeycloakSession  session, RealmModel  realm, ClientModel  client, URI  serverBaseUri  )

inlinestatic

                                                                                                                                     {
        SamlClient samlClient = new SamlClient(client);
        String idpEntityId = RealmsResource.realmBaseUrl(UriBuilder.fromUri(serverBaseUri)).build(realm.getName()).toString();
        String bindUrl = RealmsResource.protocolUrl(UriBuilder.fromUri(serverBaseUri)).build(realm.getName(), SamlProtocol.LOGIN_PROTOCOL).toString();
        StringBuilder sb = new StringBuilder();
        sb.append("<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n"
          + "<EntityDescriptor entityID=\"").append(idpEntityId).append("\"\n"
          + "                   xmlns=\"urn:oasis:names:tc:SAML:2.0:metadata\"\n"
          + "                   xmlns:dsig=\"http://www.w3.org/2000/09/xmldsig#\"\n"
          + "                   xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">\n"
          + "   <IDPSSODescriptor WantAuthnRequestsSigned=\"")
          .append(samlClient.requiresClientSignature())
          .append("\"\n"
            + "      protocolSupportEnumeration=\"urn:oasis:names:tc:SAML:2.0:protocol\">\n");

        // logout service
        sb.append("      <SingleLogoutService\n"
                + "         Binding=\"urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST\"\n"
                + "         Location=\"").append(bindUrl).append("\" />\n");
        if (! samlClient.forcePostBinding()) {
            sb.append("      <SingleLogoutService\n"
                    + "         Binding=\"urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect\"\n"
                    + "         Location=\"").append(bindUrl).append("\" />\n");
        }
        // nameid format
        if (samlClient.forceNameIDFormat() && samlClient.getNameIDFormat() != null) {
            sb.append("   <NameIDFormat>").append(samlClient.getNameIDFormat()).append("</NameIDFormat>\n");
        } else {
            sb.append("   <NameIDFormat>urn:oasis:names:tc:SAML:2.0:nameid-format:persistent</NameIDFormat>\n"
              + "   <NameIDFormat>urn:oasis:names:tc:SAML:2.0:nameid-format:transient</NameIDFormat>\n"
              + "   <NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:unspecified</NameIDFormat>\n"
              + "   <NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress</NameIDFormat>\n");
        }
        // sign on service
        sb.append("\n"
          + "      <SingleSignOnService Binding=\"urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST\"\n"
          + "         Location=\"").append(bindUrl).append("\" />\n");
        if (! samlClient.forcePostBinding()) {
           sb.append("      <SingleSignOnService Binding=\"urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect\"\n"
             + "         Location=\"").append(bindUrl).append("\" />\n");

        }

        // keys
        Set<RsaKeyMetadata> keys = new TreeSet<>((o1, o2) -> o1.getStatus() == o2.getStatus() // Status can be only PASSIVE OR ACTIVE, push PASSIVE to end of list
          ? (int) (o2.getProviderPriority() - o1.getProviderPriority())
          : (o1.getStatus() == KeyStatus.PASSIVE ? 1 : -1));
        keys.addAll(session.keys().getRsaKeys(realm));
        for (RsaKeyMetadata key : keys) {
            addKeyInfo(sb, key, KeyTypes.SIGNING.value());
        }

        sb.append("   </IDPSSODescriptor>\n"
          + "</EntityDescriptor>\n");
        return sb.toString();
    }

getMediaType()

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

inline

org.keycloak.protocol.ClientInstallationProviderを実装しています。

                                 {
        return MediaType.APPLICATION_XML;
    }

getProtocol()

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

inline

org.keycloak.protocol.ClientInstallationProviderを実装しています。

                                {
        return SamlProtocol.LOGIN_PROTOCOL;
    }

init()

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

inline

org.keycloak.provider.ProviderFactory< T extends Provider >を実装しています。

                                          {

    }

isDownloadOnly()

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

inline

org.keycloak.protocol.ClientInstallationProviderを実装しています。

                                    {
        return false;
    }

order()

default int org.keycloak.provider.ProviderFactory< T extends Provider >.order ( )

inlineinherited

org.keycloak.protocol.docker.DockerAuthV2ProtocolFactory, org.keycloak.urls.HostnameProviderFactory, org.keycloak.protocol.oidc.ext.OIDCExtProviderFactoryで実装されています。

                        {
        return 0;
    }

postInit()

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

inline

org.keycloak.provider.ProviderFactory< T extends Provider >を実装しています。

                                                         {

    }

---

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

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