org.mitre.discovery.web.DiscoveryEndpoint クラス

org.mitre.discovery.web.DiscoveryEndpoint 連携図

公開メンバ関数
String	webfinger (@RequestParam("resource") String resource, @RequestParam(value="rel", required=false) String rel, Model model)
String	providerConfiguration (Model model)

静的公開変数類
static final String	WELL_KNOWN_URL = ".well-known"
static final String	OPENID_CONFIGURATION_URL = WELL_KNOWN_URL + "/openid-configuration"
static final String	WEBFINGER_URL = WELL_KNOWN_URL + "/webfinger"

非公開変数類
ConfigurationPropertiesBean	config
SystemScopeService	scopeService
JWTSigningAndValidationService	signService
JWTEncryptionAndDecryptionService	encService
UserInfoService	userService
Function< Algorithm, String >	toAlgorithmName

静的非公開変数類
static final Logger	logger = LoggerFactory.getLogger(DiscoveryEndpoint.class)

詳解

Handle OpenID Connect Discovery.

著者

jricher

関数詳解

providerConfiguration()

String org.mitre.discovery.web.DiscoveryEndpoint.providerConfiguration ( Model  model )

inline

                                                         {

                /*
                    issuer
                        REQUIRED. URL using the https scheme with no query or fragment component that the OP asserts as its Issuer Identifier.
                    authorization_endpoint
                        OPTIONAL. URL of the OP's Authentication and Authorization Endpoint [OpenID.Messages].
                    token_endpoint
                        OPTIONAL. URL of the OP's OAuth 2.0 Token Endpoint [OpenID.Messages].
                    userinfo_endpoint
                        RECOMMENDED. URL of the OP's UserInfo Endpoint [OpenID.Messages]. This URL MUST use the https scheme
                        and MAY contain port, path, and query parameter components.
                    check_session_iframe
                        OPTIONAL. URL of an OP endpoint that provides a page to support cross-origin communications for session state information with
                        the RP Client, using the HTML5 postMessage API. The page is loaded from an invisible iframe embedded in an RP page so that
                        it can run in the OP's security context. See [OpenID.Session].
                    end_session_endpoint
                        OPTIONAL. URL of the OP's endpoint that initiates logging out the End-User. See [OpenID.Session].
                    jwks_uri
                        REQUIRED. URL of the OP's JSON Web Key Set [JWK] document. This contains the signing key(s) the Client uses to
                        validate signatures from the OP. The JWK Set MAY also contain the Server's encryption key(s),
                        which are used by Clients to encrypt requests to the Server. When both signing and encryption keys are made available,
                        a use (Key Use) parameter value is REQUIRED for all keys in the document to indicate each key's intended usage.
                    registration_endpoint
                        RECOMMENDED. URL of the OP's Dynamic Client Registration Endpoint [OpenID.Registration].
                    scopes_supported
                        RECOMMENDED. JSON array containing a list of the OAuth 2.0 [RFC6749] scope values that this server supports.
                        The server MUST support the openid scope value.
                    response_types_supported
                        REQUIRED. JSON array containing a list of the OAuth 2.0 response_type values that this server supports.
                        The server MUST support the code, id_token, and the token id_token response type values.
                    grant_types_supported
                        OPTIONAL. JSON array containing a list of the OAuth 2.0 grant type values that this server supports.
                        The server MUST support the authorization_code and implicit grant type values
                        and MAY support the urn:ietf:params:oauth:grant-type:jwt-bearer grant type defined in OAuth JWT Bearer Token Profiles [OAuth.JWT].
                        If omitted, the default value is ["authorization_code", "implicit"].
                    acr_values_supported
                        OPTIONAL. JSON array containing a list of the Authentication Context Class References that this server supports.
                    subject_types_supported
                        REQUIRED. JSON array containing a list of the subject identifier types that this server supports. Valid types include pairwise and public.
                    userinfo_signing_alg_values_supported
                        OPTIONAL. JSON array containing a list of the JWS [JWS] signing algorithms (alg values) [JWA] supported by the UserInfo Endpoint to
                        encode the Claims in a JWT [JWT].
                    userinfo_encryption_alg_values_supported
                        OPTIONAL. JSON array containing a list of the JWE [JWE] encryption algorithms (alg values) [JWA] supported by the UserInfo Endpoint to
                        encode the Claims in a JWT [JWT].
                    userinfo_encryption_enc_values_supported
                        OPTIONAL. JSON array containing a list of the JWE encryption algorithms (enc values) [JWA] supported by the UserInfo Endpoint to
                        encode the Claims in a JWT [JWT].
                    id_token_signing_alg_values_supported
                        REQUIRED. JSON array containing a list of the JWS signing algorithms (alg values) supported by the Authorization Server for the
                        ID Token to encode the Claims in a JWT [JWT].
                    id_token_encryption_alg_values_supported
                        OPTIONAL. JSON array containing a list of the JWE encryption algorithms (alg values) supported by the Authorization Server for the
                        ID Token to encode the Claims in a JWT [JWT].
                    id_token_encryption_enc_values_supported
                        OPTIONAL. JSON array containing a list of the JWE encryption algorithms (enc values) supported by the Authorization Server for the
                        ID Token to encode the Claims in a JWT [JWT].
                    request_object_signing_alg_values_supported
                        OPTIONAL. JSON array containing a list of the JWS signing algorithms (alg values) supported by the Authorization Server for
                        the Request Object described in Section 2.9 of OpenID Connect Messages 1.0 [OpenID.Messages]. These algorithms are used both when
                        the Request Object is passed by value (using the request parameter) and when it is passed by reference (using the request_uri parameter).
                        Servers SHOULD support none and RS256.
                    request_object_encryption_alg_values_supported
                        OPTIONAL. JSON array containing a list of the JWE encryption algorithms (alg values) supported by the Authorization Server for
                        the Request Object described in Section 2.9 of OpenID Connect Messages 1.0 [OpenID.Messages]. These algorithms are used both when
                        the Request Object is passed by value and when it is passed by reference.
                    request_object_encryption_enc_values_supported
                        OPTIONAL. JSON array containing a list of the JWE encryption algorithms (enc values) supported by the Authorization Server for
                        the Request Object described in Section 2.9 of OpenID Connect Messages 1.0 [OpenID.Messages]. These algorithms are used both when
                        the Request Object is passed by value and when it is passed by reference.
                    token_endpoint_auth_methods_supported
                        OPTIONAL. JSON array containing a list of authentication methods supported by this Token Endpoint.
                        The options are client_secret_post, client_secret_basic, client_secret_jwt, and private_key_jwt,
                        as described in Section 2.2.1 of OpenID Connect Messages 1.0 [OpenID.Messages].
                        Other authentication methods MAY be defined by extensions.
                        If omitted, the default is client_secret_basic -- the HTTP Basic Authentication Scheme as specified in
                        Section 2.3.1 of OAuth 2.0 [RFC6749].
                    token_endpoint_auth_signing_alg_values_supported
                        OPTIONAL. JSON array containing a list of the JWS signing algorithms (alg values) supported by the Token Endpoint for
                        the private_key_jwt and client_secret_jwt methods to encode the JWT [JWT]. Servers SHOULD support RS256.
                    display_values_supported
                        OPTIONAL. JSON array containing a list of the display parameter values that the OpenID Provider supports.
                        These values are described in Section 2.1.1 of OpenID Connect Messages 1.0 [OpenID.Messages].
                    claim_types_supported
                        OPTIONAL. JSON array containing a list of the Claim Types that the OpenID Provider supports.
                        These Claim Types are described in Section 2.6 of OpenID Connect Messages 1.0 [OpenID.Messages].
                        Values defined by this specification are normal, aggregated, and distributed.
                        If not specified, the implementation supports only normal Claims.
                    claims_supported
                        RECOMMENDED. JSON array containing a list of the Claim Names of the Claims that the OpenID Provider MAY be able to supply values for.
                        Note that for privacy or other reasons, this might not be an exhaustive list.
                    service_documentation
                        OPTIONAL. URL of a page containing human-readable information that developers might want or need to know when using the OpenID Provider.
                        In particular, if the OpenID Provider does not support Dynamic Client Registration, then information on how to register Clients needs
                        to be provided in this documentation.
                    claims_locales_supported
                        OPTIONAL. Languages and scripts supported for values in Claims being returned, represented as a JSON array of
                        BCP47 [RFC5646] language tag values. Not all languages and scripts are necessarily supported for all Claim values.
                    ui_locales_supported
                        OPTIONAL. Languages and scripts supported for the user interface, represented as a JSON array of BCP47 [RFC5646] language tag values.
                    claims_parameter_supported
                        OPTIONAL. Boolean value specifying whether the OP supports use of the claims parameter, with true indicating support.
                        If omitted, the default value is false.
                    request_parameter_supported
                        OPTIONAL. Boolean value specifying whether the OP supports use of the request parameter, with true indicating support.
                        If omitted, the default value is false.
                    request_uri_parameter_supported
                        OPTIONAL. Boolean value specifying whether the OP supports use of the request_uri parameter, with true indicating support.
                        If omitted, the default value is true.
                    require_request_uri_registration
                        OPTIONAL. Boolean value specifying whether the OP requires any request_uri values used to be pre-registered using
                        the request_uris registration parameter. Pre-registration is REQUIRED when the value is true. If omitted, the default value is false.
                    op_policy_uri
                        OPTIONAL. URL that the OpenID Provider provides to the person registering the Client to read about the OP's requirements on
                        how the Relying Party can use the data provided by the OP. The registration process SHOULD display this URL to the person registering
                        the Client if it is given.
                    op_tos_uri
                        OPTIONAL. URL that the OpenID Provider provides to the person registering the Client to read about OpenID Provider's terms of service.
                        The registration process SHOULD display this URL to the person registering the Client if it is given.
                 */
                String baseUrl = config.getIssuer();

                if (!baseUrl.endsWith("/")) {
                        logger.debug("Configured issuer doesn't end in /, adding for discovery: {}", baseUrl);
                        baseUrl = baseUrl.concat("/");
                }

                signService.getAllSigningAlgsSupported();
                Lists.newArrayList(JWSAlgorithm.HS256, JWSAlgorithm.HS384, JWSAlgorithm.HS512);
                Collection<JWSAlgorithm> clientSymmetricAndAsymmetricSigningAlgs = Lists.newArrayList(JWSAlgorithm.HS256, JWSAlgorithm.HS384, JWSAlgorithm.HS512,
                                JWSAlgorithm.RS256, JWSAlgorithm.RS384, JWSAlgorithm.RS512,
                                JWSAlgorithm.ES256, JWSAlgorithm.ES384, JWSAlgorithm.ES512,
                                JWSAlgorithm.PS256, JWSAlgorithm.PS384, JWSAlgorithm.PS512);
                Collection<Algorithm> clientSymmetricAndAsymmetricSigningAlgsWithNone = Lists.newArrayList(JWSAlgorithm.HS256, JWSAlgorithm.HS384, JWSAlgorithm.HS512,
                                JWSAlgorithm.RS256, JWSAlgorithm.RS384, JWSAlgorithm.RS512,
                                JWSAlgorithm.ES256, JWSAlgorithm.ES384, JWSAlgorithm.ES512,
                                JWSAlgorithm.PS256, JWSAlgorithm.PS384, JWSAlgorithm.PS512,
                                Algorithm.NONE);
                ArrayList<String> grantTypes = Lists.newArrayList("authorization_code", "implicit", "urn:ietf:params:oauth:grant-type:jwt-bearer", "client_credentials", "urn:ietf:params:oauth:grant_type:redelegate", "urn:ietf:params:oauth:grant-type:device_code");

                Map<String, Object> m = new HashMap<>();
                m.put("issuer", config.getIssuer());
                m.put("authorization_endpoint", baseUrl + "authorize");
                m.put("token_endpoint", baseUrl + "token");
                m.put("userinfo_endpoint", baseUrl + UserInfoEndpoint.URL);
                //check_session_iframe
                m.put("end_session_endpoint", baseUrl + EndSessionEndpoint.URL);
                m.put("jwks_uri", baseUrl + JWKSetPublishingEndpoint.URL);
                m.put("registration_endpoint", baseUrl + DynamicClientRegistrationEndpoint.URL);
                m.put("scopes_supported", scopeService.toStrings(scopeService.getUnrestricted())); // these are the scopes that you can dynamically register for, which is what matters for discovery
                m.put("response_types_supported", Lists.newArrayList("code", "token")); // we don't support these yet: , "id_token", "id_token token"));
                m.put("grant_types_supported", grantTypes);
                //acr_values_supported
                m.put("subject_types_supported", Lists.newArrayList("public", "pairwise"));
                m.put("userinfo_signing_alg_values_supported", Collections2.transform(clientSymmetricAndAsymmetricSigningAlgs, toAlgorithmName));
                m.put("userinfo_encryption_alg_values_supported", Collections2.transform(encService.getAllEncryptionAlgsSupported(), toAlgorithmName));
                m.put("userinfo_encryption_enc_values_supported", Collections2.transform(encService.getAllEncryptionEncsSupported(), toAlgorithmName));
                m.put("id_token_signing_alg_values_supported", Collections2.transform(clientSymmetricAndAsymmetricSigningAlgsWithNone, toAlgorithmName));
                m.put("id_token_encryption_alg_values_supported", Collections2.transform(encService.getAllEncryptionAlgsSupported(), toAlgorithmName));
                m.put("id_token_encryption_enc_values_supported", Collections2.transform(encService.getAllEncryptionEncsSupported(), toAlgorithmName));
                m.put("request_object_signing_alg_values_supported", Collections2.transform(clientSymmetricAndAsymmetricSigningAlgs, toAlgorithmName));
                m.put("request_object_encryption_alg_values_supported", Collections2.transform(encService.getAllEncryptionAlgsSupported(), toAlgorithmName));
                m.put("request_object_encryption_enc_values_supported", Collections2.transform(encService.getAllEncryptionEncsSupported(), toAlgorithmName));
                m.put("token_endpoint_auth_methods_supported", Lists.newArrayList("client_secret_post", "client_secret_basic", "client_secret_jwt", "private_key_jwt", "none"));
                m.put("token_endpoint_auth_signing_alg_values_supported", Collections2.transform(clientSymmetricAndAsymmetricSigningAlgs, toAlgorithmName));
                //display_types_supported
                m.put("claim_types_supported", Lists.newArrayList("normal" /*, "aggregated", "distributed"*/));
                m.put("claims_supported", Lists.newArrayList(
                                "sub",
                                "name",
                                "preferred_username",
                                "given_name",
                                "family_name",
                                "middle_name",
                                "nickname",
                                "profile",
                                "picture",
                                "website",
                                "gender",
                                "zoneinfo",
                                "locale",
                                "updated_at",
                                "birthdate",
                                "email",
                                "email_verified",
                                "phone_number",
                                "phone_number_verified",
                                "address"
                                ));
                m.put("service_documentation", baseUrl + "about");
                //claims_locales_supported
                //ui_locales_supported
                m.put("claims_parameter_supported", false);
                m.put("request_parameter_supported", true);
                m.put("request_uri_parameter_supported", false);
                m.put("require_request_uri_registration", false);
                m.put("op_policy_uri", baseUrl + "about");
                m.put("op_tos_uri", baseUrl + "about");

                m.put("introspection_endpoint", baseUrl + IntrospectionEndpoint.URL); // token introspection endpoint for verifying tokens
                m.put("revocation_endpoint", baseUrl + RevocationEndpoint.URL); // token revocation endpoint

                m.put("code_challenge_methods_supported", Lists.newArrayList(PKCEAlgorithm.plain.getName(), PKCEAlgorithm.S256.getName()));

                m.put("device_authorization_endpoint", baseUrl + DeviceEndpoint.URL);

                model.addAttribute(JsonEntityView.ENTITY, m);

                return JsonEntityView.VIEWNAME;
        }

webfinger()

String org.mitre.discovery.web.DiscoveryEndpoint.webfinger ( @RequestParam("resource") String  resource, @RequestParam(value="rel", required=false) String  rel, Model  model  )

inline

                                                                                                                                                   {

                if (!Strings.isNullOrEmpty(rel) && !rel.equals("http://openid.net/specs/connect/1.0/issuer")) {
                        logger.warn("Responding to webfinger request for non-OIDC relation: " + rel);
                }

                if (!resource.equals(config.getIssuer())) {
                        // it's not the issuer directly, need to check other methods

                        UriComponents resourceUri = WebfingerURLNormalizer.normalizeResource(resource);
                        if (resourceUri != null
                                        && resourceUri.getScheme() != null
                                        && resourceUri.getScheme().equals("acct")) {
                                // acct: URI (email address format)

                                // check on email addresses first
                                UserInfo user = userService.getByEmailAddress(resourceUri.getUserInfo() + "@" + resourceUri.getHost());

                                if (user == null) {
                                        // user wasn't found, see if the local part of the username matches, plus our issuer host

                                        user = userService.getByUsername(resourceUri.getUserInfo()); // first part is the username

                                        if (user != null) {
                                                // username matched, check the host component
                                                UriComponents issuerComponents = UriComponentsBuilder.fromHttpUrl(config.getIssuer()).build();
                                                if (!Strings.nullToEmpty(issuerComponents.getHost())
                                                                .equals(Strings.nullToEmpty(resourceUri.getHost()))) {
                                                        logger.info("Host mismatch, expected " + issuerComponents.getHost() + " got " + resourceUri.getHost());
                                                        model.addAttribute(HttpCodeView.CODE, HttpStatus.NOT_FOUND);
                                                        return HttpCodeView.VIEWNAME;
                                                }

                                        } else {

                                                // if the user's still null, punt and say we didn't find them

                                                logger.info("User not found: " + resource);
                                                model.addAttribute(HttpCodeView.CODE, HttpStatus.NOT_FOUND);
                                                return HttpCodeView.VIEWNAME;
                                        }

                                }

                        } else {
                                logger.info("Unknown URI format: " + resource);
                                model.addAttribute(HttpCodeView.CODE, HttpStatus.NOT_FOUND);
                                return HttpCodeView.VIEWNAME;
                        }
                }

                // if we got here, then we're good, return ourselves
                model.addAttribute("resource", resource);
                model.addAttribute("issuer", config.getIssuer());

                return "webfingerView";
        }

メンバ詳解

config

ConfigurationPropertiesBean org.mitre.discovery.web.DiscoveryEndpoint.config

private

encService

JWTEncryptionAndDecryptionService org.mitre.discovery.web.DiscoveryEndpoint.encService

private

logger

final Logger org.mitre.discovery.web.DiscoveryEndpoint.logger = LoggerFactory.getLogger(DiscoveryEndpoint.class)

staticprivate

Logger for this class

OPENID_CONFIGURATION_URL

final String org.mitre.discovery.web.DiscoveryEndpoint.OPENID_CONFIGURATION_URL = WELL_KNOWN_URL + "/openid-configuration"

static

scopeService

SystemScopeService org.mitre.discovery.web.DiscoveryEndpoint.scopeService

private

signService

JWTSigningAndValidationService org.mitre.discovery.web.DiscoveryEndpoint.signService

private

toAlgorithmName

Function<Algorithm, String> org.mitre.discovery.web.DiscoveryEndpoint.toAlgorithmName

private

初期値:

= new Function<Algorithm, String>() {
                @Override
                public String apply(Algorithm alg) {
                        if (alg == null) {
                                return null;
                        } else {
                                return alg.getName();
                        }
                }
        }

userService

UserInfoService org.mitre.discovery.web.DiscoveryEndpoint.userService

private

WEBFINGER_URL

final String org.mitre.discovery.web.DiscoveryEndpoint.WEBFINGER_URL = WELL_KNOWN_URL + "/webfinger"

static

WELL_KNOWN_URL

final String org.mitre.discovery.web.DiscoveryEndpoint.WELL_KNOWN_URL = ".well-known"

static

---

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

• D:/AppData/OpenId/mitreid-connect/src/openid-connect-server/src/main/java/org/mitre/discovery/web/DiscoveryEndpoint.java