Module iu.util.auth.config
Package edu.iu.auth.config

Interface IuOpenIdProviderMetadata

public interface IuOpenIdProviderMetadata
OpenID Connect Provider Discovery Metadata.
See Also:

  • Method Details

    • getIssuer

      URI getIssuer()
      URL using the https scheme with no query or fragment components that the OP asserts as its Issuer Identifier. If Issuer discovery is supported (see Section 2), this value MUST be identical to the issuer value returned by WebFinger. This also MUST be identical to the iss Claim value in ID Tokens issued from this Issuer.
      Returns:
      URI

    • getAuthorizationEndpoint

      URI getAuthorizationEndpoint()
      URL of the OP's OAuth 2.0 Authorization Endpoint [OpenID.Core]. This URL MUST use the https scheme and MAY contain port, path, and query parameter components.
      Returns:
      URI

    • getTokenEndpoint

      URI getTokenEndpoint()
      URL of the OP's OAuth 2.0 Token Endpoint [OpenID.Core]. This is REQUIRED unless only the Implicit Flow is used. This URL MUST use the https scheme and MAY contain port, path, and query parameter components.
      Returns:
      URI

    • getUserinfoEndpoint

      URI getUserinfoEndpoint()
      URL of the OP's UserInfo Endpoint [OpenID.Core]. This URL MUST use the https scheme and MAY contain port, path, and query parameter components.
      Returns:
      URI

    • getJwksUri

      URI getJwksUri()
      URL of the OP's JWK Set [JWK] document, which MUST use the https scheme. This contains the signing key(s) the RP uses to validate signatures from the OP. The JWK Set MAY also contain the Server's encryption key(s), which are used by RPs to encrypt requests to the Server. When both signing and encryption keys are made available, a use (public key use) parameter value is REQUIRED for all keys in the referenced JWK Set to indicate each key's intended usage. Although some algorithms allow the same key to be used for both signatures and encryption, doing so is NOT RECOMMENDED, as it is less secure. The JWK x5c parameter MAY be used to provide X.509 representations of keys provided. When used, the bare key values MUST still be present and MUST match those in the certificate. The JWK Set MUST NOT contain private or symmetric key values.
      Returns:
      URI

    • getRegistrationEndpoint

      URI getRegistrationEndpoint()
      URL of the OP's Dynamic Client Registration Endpoint [OpenID.Registration], which MUST use the https scheme.
      Returns:
      URI

    • getScopesSupported

      Set<String> getScopesSupported()
      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. Servers MAY choose not to advertise some supported scope values even when this parameter is used, although those defined in [OpenID.Core] SHOULD be listed, if supported.
      Returns:
      Set of OAuth 2.0 scope values

    • getResponseTypesSupported

      Set<String> getResponseTypesSupported()
      JSON array containing a list of the OAuth 2.0 response_type values that this OP supports. Dynamic OpenID Providers MUST support the code, id_token, and the id_token token Response Type values.
      Returns:
      Set of OAuth 2.0 response types

    • getResponseModesSupported

      Set<String> getResponseModesSupported()
      JSON array containing a list of the OAuth 2.0 response_mode values that this OP supports, as specified in OAuth 2.0 Multiple Response Type Encoding Practices [OAuth.Responses]. If omitted, the default for Dynamic OpenID Providers is ["query", "fragment"].
      Returns:
      Set of OAuth 2.0 response modes

    • getGrantTypesSupported

      Set<String> getGrantTypesSupported()
      JSON array containing a list of the OAuth 2.0 Grant Type values that this OP supports. Dynamic OpenID Providers MUST support the authorization_code and implicit Grant Type values and MAY support other Grant Types. If omitted, the default value is ["authorization_code", "implicit"].
      Returns:
      Set of OAuth 2.0 grant types

    • getAcrValuesSupported

      Set<String> getAcrValuesSupported()
      JSON array containing a list of the Authentication Context Class Reference values that this OP supports.
      Returns:
      Set of ACR values

    • getSubjectTypesSupported

      Set<String> getSubjectTypesSupported()
      JSON array containing a list of the Subject Identifier types that this OP supports. Valid types include pairwise and public.
      Returns:
      Set of subject types

    • getIdTokenSigningAlgValuesSupported

      Set<WebKey.Algorithm> getIdTokenSigningAlgValuesSupported()
      JSON array containing a list of the JWS signing algorithms (alg values) supported by the OP for the ID Token to encode the Claims in a JWT [JWT]. The algorithm RS256 MUST be included. The value none MAY be supported but MUST NOT be used unless the Response Type used returns no ID Token from the Authorization Endpoint (such as when using the Authorization Code Flow).
      Returns:
      Set of WebKey.Algorithm

    • getIdTokenEncryptionAlgValuesSupported

      Set<WebKey.Algorithm> getIdTokenEncryptionAlgValuesSupported()
      JSON array containing a list of the JWE encryption algorithms (alg values) supported by the OP for the ID Token to encode the Claims in a JWT [JWT].
      Returns:
      Set of WebKey.Algorithm

    • getIdTokenEncryptionEncValuesSupported

      Set<WebEncryption.Encryption> getIdTokenEncryptionEncValuesSupported()
      JSON array containing a list of the JWE encryption algorithms (enc values) supported by the OP for the ID Token to encode the Claims in a JWT [JWT].
      Returns:
      Set of WebEncryption.Encryption

    • getUserinfoSigningAlgValuesSupported

      Set<WebKey.Algorithm> getUserinfoSigningAlgValuesSupported()
      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]. The value none MAY be included.
      Returns:
      Set of WebKey.Algorithm

    • getUserinfoEncryptionAlgValuesSupported

      Set<WebKey.Algorithm> getUserinfoEncryptionAlgValuesSupported()
      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].
      Returns:
      Set of WebKey.Algorithm

    • getUserinfoEncryptionEncValuesSupported

      Set<WebEncryption.Encryption> getUserinfoEncryptionEncValuesSupported()
      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].
      Returns:
      Set of WebEncryption.Encryption

    • getRequestObjectSigningAlgValuesSupported

      Set<WebKey.Algorithm> getRequestObjectSigningAlgValuesSupported()
      JSON array containing a list of the JWS signing algorithms (alg values) supported by the OP for Request Objects, which are described in Section 6.1 of OpenID Connect Core 1.0 [OpenID.Core]. 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.
      Returns:
      Set of WebKey.Algorithm

    • getRequestObjectEncryptionAlgValuesSupported

      Set<WebKey.Algorithm> getRequestObjectEncryptionAlgValuesSupported()
      JSON array containing a list of the JWE encryption algorithms (alg values) supported by the OP for Request Objects. These algorithms are used both when the Request Object is passed by value and when it is passed by reference.
      Returns:
      Set of WebKey.Algorithm

    • getRequestObjectEncryptionEncValuesSupported

      Set<WebEncryption.Encryption> getRequestObjectEncryptionEncValuesSupported()
      JSON array containing a list of the JWE encryption algorithms (enc values) supported by the OP for Request Objects. These algorithms are used both when the Request Object is passed by value and when it is passed by reference.
      Returns:
      Set of WebEncryption.Encryption

    • getTokenEndpointAuthMethodsSupported

      Set<IuAuthorizationClient.AuthMethod> getTokenEndpointAuthMethodsSupported()
      JSON array containing a list of Client 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 9 of OpenID Connect Core 1.0 [OpenID.Core]. Other authentication methods MAY be defined by extensions. If omitted, the default is client_secret_basic -- the HTTP Basic Authentication Scheme specified in Section 2.3.1 of OAuth 2.0 [RFC6749].
      Returns:
      Set of IuAuthorizationClient.AuthMethod

    • getTokenEndpointSigningAlgValuesSupported

      Set<WebKey.Algorithm> getTokenEndpointSigningAlgValuesSupported()
      JSON array containing a list of the JWS signing algorithms (alg values) supported by the Token Endpoint for the signature on the JWT [JWT] used to authenticate the Client at the Token Endpoint for the private_key_jwt and client_secret_jwt authentication methods. Servers SHOULD support RS256. The value none MUST NOT be used.
      Returns:
      Set of WebKey.Algorithm

    • getClaimsSupported

      Set<String> getClaimsSupported()
      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.
      Returns:
      Set of supported claims names

    • getDisplayValuesSupported

      Set<String> getDisplayValuesSupported()
      JSON array containing a list of the display parameter values that the OpenID Provider supports. These values are described in Section 3.1.2.1 of OpenID Connect Core 1.0 [OpenID.Core].
      Returns:
      supported display values

    • getClaimTypesSupported

      Set<String> getClaimTypesSupported()
      JSON array containing a list of the Claim Types that the OpenID Provider supports. These Claim Types are described in Section 5.6 of OpenID Connect Core 1.0 [OpenID.Core]. Values defined by this specification are normal, aggregated, and distributed. If omitted, the implementation supports only normal Claims.
      Returns:
      supported claim types

    • getServiceDocumentation

      URI getServiceDocumentation()
      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.
      Returns:
      service documentation URI

    • getClaimsLocalesSupported

      Set<String> getClaimsLocalesSupported()
      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.
      Returns:
      supported claim locales

    • getUiLocalesSupported

      Set<String> getUiLocalesSupported()
      Languages and scripts supported for the user interface, represented as a JSON array of BCP47 [RFC5646] language tag values.
      Returns:
      supported ui locales

    • isClaimsParameterSupported

      boolean isClaimsParameterSupported()
      Boolean value specifying whether the OP supports use of the claims parameter, with true indicating support. If omitted, the default value is false.
      Returns:
      true if claims parameter is supported; else false

    • isRequestParameterSupported

      boolean isRequestParameterSupported()
      Boolean value specifying whether the OP supports use of the request parameter, with true indicating support. If omitted, the default value is false.
      Returns:
      true if request parameter is supported; else false

    • isRequestUriParameterSupported

      default boolean isRequestUriParameterSupported()
      Boolean value specifying whether the OP supports use of the request_uri parameter, with true indicating support. If omitted, the default value is true.
      Returns:
      true if request_uri parameter is supported; else false

    • isRequireRequestUriRegistration

      boolean isRequireRequestUriRegistration()
      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.
      Returns:
      true if claims parameter is supported; else false

    • getOpPolicyUri

      URI getOpPolicyUri()
      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.
      Returns:
      URI

    • getOpTosUri

      URI getOpTosUri()
      URL that the OpenID Provider provides to the person registering the Client to read about the OpenID Provider's terms of service. The registration process SHOULD display this URL to the person registering the Client if it is given.
      Returns:
      URI