sourabh912 commented on a change in pull request #3006: URL: https://github.com/apache/hive/pull/3006#discussion_r822168236
########## File path: service/src/java/org/apache/hive/service/auth/jwt/JWTValidator.java ########## @@ -0,0 +1,94 @@ +/* + * 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.hive.service.auth.jwt; + +import com.nimbusds.jose.JOSEException; +import com.nimbusds.jose.JWSHeader; +import com.nimbusds.jose.JWSObject; +import com.nimbusds.jose.JWSVerifier; +import com.nimbusds.jose.crypto.factories.DefaultJWSVerifierFactory; +import com.nimbusds.jose.jwk.AsymmetricJWK; +import com.nimbusds.jose.jwk.JWK; +import com.nimbusds.jwt.JWTClaimsSet; +import com.nimbusds.jwt.SignedJWT; +import org.apache.hadoop.hive.conf.HiveConf; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import javax.security.sasl.AuthenticationException; +import java.io.IOException; +import java.security.Key; +import java.text.ParseException; +import java.util.Date; +import java.util.List; + +public class JWTValidator { + + private static final Logger LOG = LoggerFactory.getLogger(JWTValidator.class.getName()); + private final URLBasedJWKSProvider jwksProvider; + private static final DefaultJWSVerifierFactory verifierFactory = new DefaultJWSVerifierFactory(); + + public JWTValidator(HiveConf conf) throws IOException, ParseException { + this.jwksProvider = new URLBasedJWKSProvider(conf); + } + + public String validateJWTAndExtractUser(String signedJwt) throws ParseException, AuthenticationException { + final SignedJWT parsedJwt = SignedJWT.parse(signedJwt); + List<JWK> matchedJWKS = jwksProvider.getJWKs(parsedJwt.getHeader()); + + // verify signature + for (JWK matchedJWK : matchedJWKS) { + try { + JWSVerifier verifier = getVerifier(parsedJwt.getHeader(), matchedJWK); + if (parsedJwt.verify(verifier)) { + break; + } + } catch (JOSEException e) { + LOG.info("Failed to verify JWT {} by JWK {} because {}", parsedJwt.getHeader(), matchedJWK.getKeyID(), + e.getMessage()); + } + } + if (parsedJwt.getState() != JWSObject.State.VERIFIED) { + throw new AuthenticationException("Failed to verify JWT signature"); + } + + // verify claims + JWTClaimsSet claimsSet = parsedJwt.getJWTClaimsSet(); + Date expirationTime = claimsSet.getExpirationTime(); + if (expirationTime != null) { + Date now = new Date(); + if (now.after(expirationTime)) { + throw new AuthenticationException("JWT has been expired"); + } + } + + // We assume the subject of claims is the query user + return claimsSet.getSubject(); + } + + private static JWSVerifier getVerifier(JWSHeader header, JWK jwk) throws JOSEException { + Key key = null; + if (jwk instanceof AsymmetricJWK) { + key = ((AsymmetricJWK) jwk).toPublicKey(); + } else { + LOG.debug("Symmetric JWK cannot be used: kid={}, alg={}", jwk.getKeyID(), jwk.getAlgorithm()); + } + return key != null ? verifierFactory.createJWSVerifier(header, key) : null; Review comment: Instead of returning a null, shall we throw an error here? Otherwise we would get a NPE when is the code: `JWSVerifier verifier = getVerifier(parsedJwt.getHeader(), matchedJWK);` ########## File path: service/src/java/org/apache/hive/service/auth/jwt/JWTValidator.java ########## @@ -0,0 +1,94 @@ +/* + * 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.hive.service.auth.jwt; + +import com.nimbusds.jose.JOSEException; +import com.nimbusds.jose.JWSHeader; +import com.nimbusds.jose.JWSObject; +import com.nimbusds.jose.JWSVerifier; +import com.nimbusds.jose.crypto.factories.DefaultJWSVerifierFactory; +import com.nimbusds.jose.jwk.AsymmetricJWK; +import com.nimbusds.jose.jwk.JWK; +import com.nimbusds.jwt.JWTClaimsSet; +import com.nimbusds.jwt.SignedJWT; +import org.apache.hadoop.hive.conf.HiveConf; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import javax.security.sasl.AuthenticationException; +import java.io.IOException; +import java.security.Key; +import java.text.ParseException; +import java.util.Date; +import java.util.List; + +public class JWTValidator { + + private static final Logger LOG = LoggerFactory.getLogger(JWTValidator.class.getName()); + private final URLBasedJWKSProvider jwksProvider; + private static final DefaultJWSVerifierFactory verifierFactory = new DefaultJWSVerifierFactory(); + + public JWTValidator(HiveConf conf) throws IOException, ParseException { + this.jwksProvider = new URLBasedJWKSProvider(conf); + } + + public String validateJWTAndExtractUser(String signedJwt) throws ParseException, AuthenticationException { + final SignedJWT parsedJwt = SignedJWT.parse(signedJwt); + List<JWK> matchedJWKS = jwksProvider.getJWKs(parsedJwt.getHeader()); + + // verify signature + for (JWK matchedJWK : matchedJWKS) { + try { + JWSVerifier verifier = getVerifier(parsedJwt.getHeader(), matchedJWK); + if (parsedJwt.verify(verifier)) { + break; + } + } catch (JOSEException e) { + LOG.info("Failed to verify JWT {} by JWK {} because {}", parsedJwt.getHeader(), matchedJWK.getKeyID(), + e.getMessage()); + } + } + if (parsedJwt.getState() != JWSObject.State.VERIFIED) { + throw new AuthenticationException("Failed to verify JWT signature"); Review comment: Should we capture the last e.getMessage() about and append it to the exception here? That would make the error message of `AuthenticationException` more descriptive. ########## File path: service/src/java/org/apache/hive/service/auth/jwt/JWTValidator.java ########## @@ -0,0 +1,94 @@ +/* + * 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.hive.service.auth.jwt; + +import com.nimbusds.jose.JOSEException; +import com.nimbusds.jose.JWSHeader; +import com.nimbusds.jose.JWSObject; +import com.nimbusds.jose.JWSVerifier; +import com.nimbusds.jose.crypto.factories.DefaultJWSVerifierFactory; +import com.nimbusds.jose.jwk.AsymmetricJWK; +import com.nimbusds.jose.jwk.JWK; +import com.nimbusds.jwt.JWTClaimsSet; +import com.nimbusds.jwt.SignedJWT; +import org.apache.hadoop.hive.conf.HiveConf; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import javax.security.sasl.AuthenticationException; +import java.io.IOException; +import java.security.Key; +import java.text.ParseException; +import java.util.Date; +import java.util.List; + +public class JWTValidator { + + private static final Logger LOG = LoggerFactory.getLogger(JWTValidator.class.getName()); + private final URLBasedJWKSProvider jwksProvider; + private static final DefaultJWSVerifierFactory verifierFactory = new DefaultJWSVerifierFactory(); + + public JWTValidator(HiveConf conf) throws IOException, ParseException { + this.jwksProvider = new URLBasedJWKSProvider(conf); + } + + public String validateJWTAndExtractUser(String signedJwt) throws ParseException, AuthenticationException { + final SignedJWT parsedJwt = SignedJWT.parse(signedJwt); + List<JWK> matchedJWKS = jwksProvider.getJWKs(parsedJwt.getHeader()); + + // verify signature + for (JWK matchedJWK : matchedJWKS) { + try { + JWSVerifier verifier = getVerifier(parsedJwt.getHeader(), matchedJWK); + if (parsedJwt.verify(verifier)) { + break; + } + } catch (JOSEException e) { + LOG.info("Failed to verify JWT {} by JWK {} because {}", parsedJwt.getHeader(), matchedJWK.getKeyID(), + e.getMessage()); + } + } + if (parsedJwt.getState() != JWSObject.State.VERIFIED) { + throw new AuthenticationException("Failed to verify JWT signature"); + } + + // verify claims + JWTClaimsSet claimsSet = parsedJwt.getJWTClaimsSet(); + Date expirationTime = claimsSet.getExpirationTime(); + if (expirationTime != null) { + Date now = new Date(); + if (now.after(expirationTime)) { + throw new AuthenticationException("JWT has been expired"); + } + } + + // We assume the subject of claims is the query user + return claimsSet.getSubject(); + } + + private static JWSVerifier getVerifier(JWSHeader header, JWK jwk) throws JOSEException { + Key key = null; + if (jwk instanceof AsymmetricJWK) { Review comment: @hsnusonic : Couple of questions: 1. Can you explain the rationale behind this check `jwk instanceof AsymmetricJWK`? 2. Why is this method static? ########## File path: service/src/java/org/apache/hive/service/auth/jwt/JWTValidator.java ########## @@ -0,0 +1,94 @@ +/* + * 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.hive.service.auth.jwt; + +import com.nimbusds.jose.JOSEException; +import com.nimbusds.jose.JWSHeader; +import com.nimbusds.jose.JWSObject; +import com.nimbusds.jose.JWSVerifier; +import com.nimbusds.jose.crypto.factories.DefaultJWSVerifierFactory; +import com.nimbusds.jose.jwk.AsymmetricJWK; +import com.nimbusds.jose.jwk.JWK; +import com.nimbusds.jwt.JWTClaimsSet; +import com.nimbusds.jwt.SignedJWT; +import org.apache.hadoop.hive.conf.HiveConf; +import org.slf4j.Logger; +import org.slf4j.LoggerFactory; + +import javax.security.sasl.AuthenticationException; +import java.io.IOException; +import java.security.Key; +import java.text.ParseException; +import java.util.Date; +import java.util.List; + +public class JWTValidator { + + private static final Logger LOG = LoggerFactory.getLogger(JWTValidator.class.getName()); + private final URLBasedJWKSProvider jwksProvider; + private static final DefaultJWSVerifierFactory verifierFactory = new DefaultJWSVerifierFactory(); + + public JWTValidator(HiveConf conf) throws IOException, ParseException { + this.jwksProvider = new URLBasedJWKSProvider(conf); + } + + public String validateJWTAndExtractUser(String signedJwt) throws ParseException, AuthenticationException { + final SignedJWT parsedJwt = SignedJWT.parse(signedJwt); + List<JWK> matchedJWKS = jwksProvider.getJWKs(parsedJwt.getHeader()); + + // verify signature + for (JWK matchedJWK : matchedJWKS) { + try { + JWSVerifier verifier = getVerifier(parsedJwt.getHeader(), matchedJWK); + if (parsedJwt.verify(verifier)) { + break; + } + } catch (JOSEException e) { + LOG.info("Failed to verify JWT {} by JWK {} because {}", parsedJwt.getHeader(), matchedJWK.getKeyID(), Review comment: nit: Should the log level be `warn` ? -- 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]
