danielcweeks commented on code in PR #15703: URL: https://github.com/apache/iceberg/pull/15703#discussion_r3639147509
########## core/src/main/java/org/apache/iceberg/rest/auth/oauth2/BasicConfig.java: ########## @@ -0,0 +1,318 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one + * or more contributor license agreements. See the NOTICE file + * distributed with this work for additional information + * regarding copyright ownership. The ASF licenses this file + * to you under the Apache License, Version 2.0 (the + * "License"); you may not use this file except in compliance + * with the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, + * software distributed under the License is distributed on an + * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + * KIND, either express or implied. See the License for the + * specific language governing permissions and limitations + * under the License. + */ +package org.apache.iceberg.rest.auth.oauth2; + +import com.nimbusds.oauth2.sdk.GrantType; +import com.nimbusds.oauth2.sdk.Scope; +import com.nimbusds.oauth2.sdk.auth.ClientAuthenticationMethod; +import com.nimbusds.oauth2.sdk.auth.Secret; +import com.nimbusds.oauth2.sdk.id.ClientID; +import com.nimbusds.oauth2.sdk.token.AccessToken; +import com.nimbusds.oauth2.sdk.token.BearerAccessToken; +import java.net.URI; +import java.time.Duration; +import java.util.List; +import java.util.Map; +import java.util.Optional; +import java.util.stream.Collectors; +import org.apache.iceberg.rest.RESTUtil; +import org.immutables.value.Value; + +/** + * Basic OAuth2 properties. These properties are used to configure the basic OAuth2 options such as + * the issuer URL, token endpoint, client ID, and client secret. + */ [email protected] [email protected](redactedMask = "****") +@SuppressWarnings({"ImmutablesStyle", "SafeLoggingPropagation"}) +interface BasicConfig { + + String PREFIX = OAuth2Config.PREFIX; + + String TOKEN = PREFIX + "token"; + String ISSUER_URL = PREFIX + "issuer-url"; + String TOKEN_ENDPOINT = PREFIX + "token-endpoint"; + String GRANT_TYPE = PREFIX + "grant-type"; + String CLIENT_ID = PREFIX + "client-id"; + String CLIENT_AUTH = PREFIX + "client-auth"; + String CLIENT_SECRET = PREFIX + "client-secret"; + String SCOPE = PREFIX + "scope"; + String EXTRA_PARAMS = PREFIX + "extra-params"; + String TIMEOUT = PREFIX + "timeout"; + String SESSION_CACHE_TIMEOUT = PREFIX + "session-cache.timeout"; + + GrantType DEFAULT_GRANT_TYPE = GrantType.CLIENT_CREDENTIALS; + ClientAuthenticationMethod DEFAULT_CLIENT_AUTH = ClientAuthenticationMethod.CLIENT_SECRET_BASIC; + Duration DEFAULT_TIMEOUT = Duration.parse("PT5M"); + Duration DEFAULT_SESSION_CACHE_TIMEOUT = Duration.parse("PT1H"); + + Duration MIN_TIMEOUT = Duration.parse("PT30S"); + + /** + * The initial access token to use. Optional. If this is set, the OAuth2 client will not attempt + * to fetch an initial token from the Authorization server, but will use this token instead. + * + * <p>This option should be avoided as in most cases, the token cannot be refreshed. + */ + @Value.Redacted + Optional<AccessToken> token(); + + /** + * The root URL of the Authorization server, which will be used for discovering supported + * endpoints and their locations. + * + * <p>Two "well-known" paths are supported for endpoint discovery: {@code + * .well-known/openid-configuration} and {@code .well-known/oauth-authorization-server}. The full + * metadata discovery URL will be constructed by appending these paths to the issuer URL. + * + * <p>Optional. Either this property or {@link #TOKEN_ENDPOINT} must be set, unless a {@linkplain + * #TOKEN static token} is provided. + * + * @see <a + * href="https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata";>OpenID + * Connect Discovery 1.0</a> + * @see <a href="https://tools.ietf.org/html/rfc8414#section-5";>RFC 8414 Section 5</a> + */ + Optional<URI> issuerUrl(); + + /** + * URL of the OAuth2 token endpoint. If not set, the token endpoint will be discovered from the + * {@link #ISSUER_URL issuer URL}, using the OpenID Connect Discovery metadata published by the + * issuer. + * + * <p>Optional. Either this property or {@link #ISSUER_URL} must be set, unless a {@linkplain + * #TOKEN static token} is provided. + */ + Optional<URI> tokenEndpoint(); + + /** + * The grant type to use when authenticating against the OAuth2 server. Valid values are: + * + * <ul> + * <li>{@link GrantType#CLIENT_CREDENTIALS client_credentials} + * <li>{@link GrantType#TOKEN_EXCHANGE urn:ietf:params:oauth:grant-type:token-exchange} + * </ul> + * + * Defaults to {@link #DEFAULT_GRANT_TYPE}. + */ + @Value.Default + default GrantType grantType() { + return DEFAULT_GRANT_TYPE; + } + + /** + * Client ID to use when authenticating against the OAuth2 server. + * + * <p>Optional. Required unless a {@linkplain #TOKEN static token} is provided. + */ + Optional<ClientID> clientId(); + + /** + * The OAuth2 client authentication method to use. Valid values are: + * + * <ul> + * <li>{@link ClientAuthenticationMethod#NONE none}: the client does not authenticate itself at + * the token endpoint, because it is a public client with no client secret or other + * authentication mechanism. + * <li>{@link ClientAuthenticationMethod#CLIENT_SECRET_BASIC client_secret_basic}: client secret + * is sent in the HTTP Basic Authorization header. + * <li>{@link ClientAuthenticationMethod#CLIENT_SECRET_POST client_secret_post}: client secret + * is sent in the request body as a form parameter. + * </ul> + * + * Defaults to {@link #DEFAULT_CLIENT_AUTH}. + */ + @Value.Default + default ClientAuthenticationMethod clientAuthenticationMethod() { + return DEFAULT_CLIENT_AUTH; + } + + /** + * Client secret to use when authenticating against the OAuth2 server. Optional. Rquired when the + * client is private and is authenticated using the standard "client-secret" methods. + */ + @Value.Redacted + Optional<Secret> clientSecret(); + + /** + * Space-separated list of scopes to include in each request to the OAuth2 server. + * + * <p>Optional. If absent, no scopes are sent. + * + * <p>The scope names will not be validated by the OAuth2 client; make sure they are valid + * according to <a href="https://datatracker.ietf.org/doc/html/rfc6749#section-3.3";>RFC 6749 + * Section 3.3</a>. + */ + Optional<Scope> scope(); + + /** + * Extra parameters to include in each request to the token endpoint. This is useful for custom + * parameters that are not covered by the standard OAuth2 specification. Defaults to an empty map. + * + * <p>This is a prefix property, and multiple values can be set, each with a different key and + * value. The values must NOT be URL-encoded. Example: + * + * <pre>{@code + * rest.auth.oauth2.extra-params.custom_param1=custom_value1 + * rest.auth.oauth2.extra-params.custom_param2=custom_value2 + * }</pre> + * + * For example, Auth0 requires the {@code audience} parameter to be set to the API identifier. + * This can be done by setting the following configuration: + * + * <pre>{@code + * rest.auth.oauth2.extra-params.audience=https://iceberg-rest-catalog/api + * }</pre> + */ + Map<String, String> extraRequestParameters(); + + /** + * The token acquisition timeout. Defaults to {@link #DEFAULT_TIMEOUT}. The default timeout is + * intentionally large, in order to accommodate for long-running flows that require human + * intervention (e.g. Authorization Code flow). + * + * <p>Must be a valid <a href="https://en.wikipedia.org/wiki/ISO_8601#Durations";>ISO-8601 + * duration</a>. + */ + @Value.Default + default Duration tokenAcquisitionTimeout() { + return DEFAULT_TIMEOUT; + } + + /** + * The session cache timeout. Cached sessions will become eligible for eviction after this + * duration of inactivity. Defaults to 1 hour. Must be a valid <a + * href="https://en.wikipedia.org/wiki/ISO_8601#Durations";>ISO-8601 duration</a>. + * + * <p>This value is used for housekeeping; it does not mean that cached sessions will stop working + * after this time, but that the session cache will evict the session after this time of + * inactivity. If the context is used again, a new session will be created and cached. + * + * <p>This property can only be specified at catalog session level. It is ignored if present in + * other levels. + */ + @Value.Default + default Duration sessionCacheTimeout() { + return DEFAULT_SESSION_CACHE_TIMEOUT; + } + + /** + * The minimum timeout for token acquisition. + * + * <p>This option is not exposed as a public configuration property, and is intended for testing + * purposes only. + */ + @Value.Default + default Duration minTokenAcquisitionTimeout() { + return MIN_TIMEOUT; + } + + @Value.Check + default void validate() { + ConfigValidator validator = new ConfigValidator(); + + if (token().isEmpty()) { + + validator.check( + ConfigUtil.SUPPORTED_INITIAL_GRANT_TYPES.contains(grantType()), + GRANT_TYPE, + "grant type must be one of: %s", + ConfigUtil.SUPPORTED_INITIAL_GRANT_TYPES.stream() + .map(GrantType::getValue) + .collect(Collectors.joining("', '", "'", "'"))); + + validator.check( + ConfigUtil.SUPPORTED_CLIENT_AUTH_METHODS.contains(clientAuthenticationMethod()), + CLIENT_AUTH, + "client authentication method must be one of: %s", + ConfigUtil.SUPPORTED_CLIENT_AUTH_METHODS.stream() + .map(ClientAuthenticationMethod::getValue) + .collect(Collectors.joining("', '", "'", "'"))); + + validator.check( + issuerUrl().isPresent() || tokenEndpoint().isPresent(), + List.of(ISSUER_URL, TOKEN_ENDPOINT), + "either issuer URL or token endpoint must be set"); + + validator.check(clientId().isPresent(), CLIENT_ID, "client ID must not be empty"); + + if (ConfigUtil.requiresClientSecret(clientAuthenticationMethod())) { + validator.check( + clientSecret().isPresent(), + List.of(CLIENT_AUTH, CLIENT_SECRET), + "client secret must not be empty when client authentication is '%s'", + clientAuthenticationMethod().getValue()); + } else if (clientAuthenticationMethod().equals(ClientAuthenticationMethod.NONE)) { + validator.check( + clientSecret().isEmpty(), + List.of(CLIENT_AUTH, CLIENT_SECRET), + "client secret must not be set when client authentication is '%s'", + ClientAuthenticationMethod.NONE.getValue()); + validator.check( + !grantType().equals(DEFAULT_GRANT_TYPE), + List.of(CLIENT_AUTH, GRANT_TYPE), + "grant type must not be '%s' when client authentication is '%s'", + DEFAULT_GRANT_TYPE.getValue(), + ClientAuthenticationMethod.NONE.getValue()); + } + } + + if (issuerUrl().isPresent()) { + validator.checkEndpoint(issuerUrl().get(), ISSUER_URL, "Issuer URL"); + } + + if (tokenEndpoint().isPresent()) { + validator.checkEndpoint(tokenEndpoint().get(), TOKEN_ENDPOINT, "Token endpoint"); + } + + validator.check( + tokenAcquisitionTimeout().compareTo(minTokenAcquisitionTimeout()) >= 0, + TIMEOUT, + "timeout must be greater than or equal to %s", Review Comment: ```suggestion "Timeout must be greater than or equal to %s", ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
