kirktrue commented on a change in pull request #11284: URL: https://github.com/apache/kafka/pull/11284#discussion_r734905620
########## File path: tools/src/main/java/org/apache/kafka/tools/OAuthCompatibilityTest.java ########## @@ -0,0 +1,264 @@ +/* + * 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.kafka.tools; + +import static org.apache.kafka.common.config.SaslConfigs.SASL_LOGIN_CONNECT_TIMEOUT_MS; +import static org.apache.kafka.common.config.SaslConfigs.SASL_LOGIN_CONNECT_TIMEOUT_MS_DOC; +import static org.apache.kafka.common.config.SaslConfigs.SASL_LOGIN_READ_TIMEOUT_MS; +import static org.apache.kafka.common.config.SaslConfigs.SASL_LOGIN_READ_TIMEOUT_MS_DOC; +import static org.apache.kafka.common.config.SaslConfigs.SASL_LOGIN_RETRY_BACKOFF_MAX_MS; +import static org.apache.kafka.common.config.SaslConfigs.SASL_LOGIN_RETRY_BACKOFF_MAX_MS_DOC; +import static org.apache.kafka.common.config.SaslConfigs.SASL_LOGIN_RETRY_BACKOFF_MS; +import static org.apache.kafka.common.config.SaslConfigs.SASL_LOGIN_RETRY_BACKOFF_MS_DOC; +import static org.apache.kafka.common.config.SaslConfigs.SASL_OAUTHBEARER_CLOCK_SKEW_SECONDS; +import static org.apache.kafka.common.config.SaslConfigs.SASL_OAUTHBEARER_CLOCK_SKEW_SECONDS_DOC; +import static org.apache.kafka.common.config.SaslConfigs.SASL_OAUTHBEARER_EXPECTED_AUDIENCE; +import static org.apache.kafka.common.config.SaslConfigs.SASL_OAUTHBEARER_EXPECTED_AUDIENCE_DOC; +import static org.apache.kafka.common.config.SaslConfigs.SASL_OAUTHBEARER_EXPECTED_ISSUER; +import static org.apache.kafka.common.config.SaslConfigs.SASL_OAUTHBEARER_EXPECTED_ISSUER_DOC; +import static org.apache.kafka.common.config.SaslConfigs.SASL_OAUTHBEARER_JWKS_ENDPOINT_REFRESH_MS; +import static org.apache.kafka.common.config.SaslConfigs.SASL_OAUTHBEARER_JWKS_ENDPOINT_REFRESH_MS_DOC; +import static org.apache.kafka.common.config.SaslConfigs.SASL_OAUTHBEARER_JWKS_ENDPOINT_URL; +import static org.apache.kafka.common.config.SaslConfigs.SASL_OAUTHBEARER_JWKS_ENDPOINT_URL_DOC; +import static org.apache.kafka.common.config.SaslConfigs.SASL_OAUTHBEARER_SCOPE_CLAIM_NAME; +import static org.apache.kafka.common.config.SaslConfigs.SASL_OAUTHBEARER_SCOPE_CLAIM_NAME_DOC; +import static org.apache.kafka.common.config.SaslConfigs.SASL_OAUTHBEARER_SUB_CLAIM_NAME; +import static org.apache.kafka.common.config.SaslConfigs.SASL_OAUTHBEARER_SUB_CLAIM_NAME_DOC; +import static org.apache.kafka.common.config.SaslConfigs.SASL_OAUTHBEARER_TOKEN_ENDPOINT_URL; +import static org.apache.kafka.common.config.SaslConfigs.SASL_OAUTHBEARER_TOKEN_ENDPOINT_URL_DOC; +import static org.apache.kafka.common.security.oauthbearer.secured.OAuthBearerLoginCallbackHandler.CLIENT_ID_CONFIG; +import static org.apache.kafka.common.security.oauthbearer.secured.OAuthBearerLoginCallbackHandler.CLIENT_ID_DOC; +import static org.apache.kafka.common.security.oauthbearer.secured.OAuthBearerLoginCallbackHandler.CLIENT_SECRET_CONFIG; +import static org.apache.kafka.common.security.oauthbearer.secured.OAuthBearerLoginCallbackHandler.CLIENT_SECRET_DOC; +import static org.apache.kafka.common.security.oauthbearer.secured.OAuthBearerLoginCallbackHandler.SCOPE_CONFIG; +import static org.apache.kafka.common.security.oauthbearer.secured.OAuthBearerLoginCallbackHandler.SCOPE_DOC; + +import java.util.Arrays; +import java.util.HashMap; +import java.util.Map; +import net.sourceforge.argparse4j.ArgumentParsers; +import net.sourceforge.argparse4j.inf.ArgumentParser; +import net.sourceforge.argparse4j.inf.ArgumentParserException; +import net.sourceforge.argparse4j.inf.Namespace; +import org.apache.kafka.common.config.AbstractConfig; +import org.apache.kafka.common.config.ConfigDef; +import org.apache.kafka.common.config.ConfigException; +import org.apache.kafka.common.config.SaslConfigs; +import org.apache.kafka.common.security.oauthbearer.secured.AccessTokenRetriever; +import org.apache.kafka.common.security.oauthbearer.secured.AccessTokenRetrieverFactory; +import org.apache.kafka.common.security.oauthbearer.secured.AccessTokenValidator; +import org.apache.kafka.common.security.oauthbearer.secured.AccessTokenValidatorFactory; +import org.apache.kafka.common.security.oauthbearer.secured.CloseableVerificationKeyResolver; +import org.apache.kafka.common.security.oauthbearer.secured.OAuthBearerLoginCallbackHandler; +import org.apache.kafka.common.security.oauthbearer.secured.VerificationKeyResolverFactory; +import org.apache.kafka.common.utils.Exit; + +public class OAuthCompatibilityTest { + + public static void main(String[] args) { + String description = String.format( + "This tool is used to verify OAuth/OIDC provider compatibility.%n%n" + + "To use, first export KAFKA_OPTS with Java system properties that match%n" + + "your OAuth/OIDC configuration. Next, run the following script to%n" + + "execute the test:%n%n" + + " ./bin/kafka-run-class.sh %s" + + "%n%n" + + "Please refer to the following source files for OAuth/OIDC client and%n" + + "broker configuration options:" + + "%n%n" + + " %s%n" + + " %s", + OAuthCompatibilityTest.class.getName(), + SaslConfigs.class.getName(), + OAuthBearerLoginCallbackHandler.class.getName()); + + ArgumentParser parser = ArgumentParsers + .newArgumentParser("oauth-compatibility-test") + .defaultHelp(true) + .description(description); + + parser.addArgument("--connect-timeout-ms") + .type(Long.class) + .dest("connectTimeoutMs") + .help(SASL_LOGIN_CONNECT_TIMEOUT_MS_DOC); + parser.addArgument("--read-timeout-ms") + .type(Long.class) + .dest("readTimeoutMs") + .help(SASL_LOGIN_READ_TIMEOUT_MS_DOC); + parser.addArgument("--retry-backoff-ms") + .type(Long.class) + .dest("retryBackoffMs") + .help(SASL_LOGIN_RETRY_BACKOFF_MS_DOC); + parser.addArgument("--retry-backoff-max-ms") + .type(Long.class) + .dest("retryBackoffMax") + .help(SASL_LOGIN_RETRY_BACKOFF_MAX_MS_DOC); + parser.addArgument("--scope-claim-name") + .dest("scopeClaimName") + .help(SASL_OAUTHBEARER_SCOPE_CLAIM_NAME_DOC); + parser.addArgument("--sub-claim-name") + .dest("subClaimName") + .help(SASL_OAUTHBEARER_SUB_CLAIM_NAME_DOC); + parser.addArgument("--token-endpoint-url") + .dest("tokenEndpointUrl") + .help(SASL_OAUTHBEARER_TOKEN_ENDPOINT_URL_DOC); + parser.addArgument("--jwks-endpoint-url") + .dest("jwksEndpointUrl") + .help(SASL_OAUTHBEARER_JWKS_ENDPOINT_URL_DOC); + parser.addArgument("--jwks-endpoint-refresh-ms") + .type(Long.class) + .dest("jwksEndpointRefreshMs") + .help(SASL_OAUTHBEARER_JWKS_ENDPOINT_REFRESH_MS_DOC); + parser.addArgument("--clock-skew-seconds") + .type(Integer.class) + .dest("clockSkewSeconds") + .help(SASL_OAUTHBEARER_CLOCK_SKEW_SECONDS_DOC); + parser.addArgument("--expected-audience") + .dest("expectedAudience") + .help(SASL_OAUTHBEARER_EXPECTED_AUDIENCE_DOC); + parser.addArgument("--expected-issuer") + .dest("expectedIssuer") + .help(SASL_OAUTHBEARER_EXPECTED_ISSUER_DOC); + + parser.addArgument("--client-id") + .dest("clientId") + .help(CLIENT_ID_DOC); + parser.addArgument("--client-secret") + .dest("clientSecret") + .help(CLIENT_SECRET_DOC); + parser.addArgument("--scope") + .dest("scope") + .help(SCOPE_DOC); + + Namespace namespace; + + try { + namespace = parser.parseArgs(args); + } catch (ArgumentParserException e) { + parser.handleError(e); + Exit.exit(1); + return; + } + + Map<String, ?> configs = getConfigs(namespace); + Map<String, Object> jaasConfigs = getJaasConfigs(namespace); + + try { + String accessToken; + + { + // Client side... + try (AccessTokenRetriever atr = AccessTokenRetrieverFactory.create(configs, jaasConfigs)) { + atr.init(); + AccessTokenValidator atv = AccessTokenValidatorFactory.create(configs); + System.out.println("PASSED 1/5: client configuration"); + + accessToken = atr.retrieve(); + System.out.println("PASSED 2/5: client JWT retrieval"); + + atv.validate(accessToken); + System.out.println("PASSED 3/5: client JWT validation"); + } + } + + { + // Broker side... + try (CloseableVerificationKeyResolver vkr = VerificationKeyResolverFactory.create(configs, jaasConfigs)) { + vkr.init(); + AccessTokenValidator atv = AccessTokenValidatorFactory.create(configs, vkr); + System.out.println("PASSED 4/5: broker configuration"); + + atv.validate(accessToken); + System.out.println("PASSED 5/5: broker JWT validation"); + } + } + + System.out.println("SUCCESS"); + Exit.exit(0); + } catch (Throwable t) { + System.out.println("FAILED:"); + t.printStackTrace(); + + if (t instanceof ConfigException) { + System.out.printf("%n"); + parser.printHelp(); + } + + Exit.exit(1); + } + } + + private static Map<String, ?> getConfigs(Namespace namespace) { + Map<String, Object> c = new HashMap<>(); + maybeAddLong(namespace, "connectTimeoutMs", c, SASL_LOGIN_CONNECT_TIMEOUT_MS); Review comment: Wow! Nice catch. Changed to use `maybeAddInt` instead. -- 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: jira-unsubscr...@kafka.apache.org For queries about this service, please contact Infrastructure at: us...@infra.apache.org
