mneethiraj commented on code in PR #928: URL: https://github.com/apache/ranger/pull/928#discussion_r3175444379
########## authz-remote/src/main/java/org/apache/ranger/authz/remote/RangerRemoteAuthzConfig.java: ########## @@ -0,0 +1,299 @@ +/* + * 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.ranger.authz.remote; + +import org.apache.commons.lang3.StringUtils; +import org.apache.ranger.authz.api.RangerAuthzException; + +import java.util.AbstractMap; +import java.util.Collections; +import java.util.LinkedHashMap; +import java.util.Map; +import java.util.Properties; +import java.util.stream.Collectors; + +import static org.apache.ranger.authz.remote.RangerRemoteAuthzErrorCode.INVALID_PROPERTY_VALUE; +import static org.apache.ranger.authz.remote.RangerRemoteAuthzErrorCode.MISSING_AUTH_CONFIG; +import static org.apache.ranger.authz.remote.RangerRemoteAuthzErrorCode.MISSING_PDP_URL; +import static org.apache.ranger.authz.remote.RangerRemoteAuthzErrorCode.UNSUPPORTED_AUTH_TYPE; + +public class RangerRemoteAuthzConfig { + public static final String PROP_REMOTE_URL = "ranger.authz.remote.pdp.url"; + public static final String PROP_REMOTE_CONNECT_TIMEOUT_MS = "ranger.authz.remote.pdp.connect.timeout.ms"; + public static final String PROP_REMOTE_READ_TIMEOUT_MS = "ranger.authz.remote.pdp.read.timeout.ms"; + public static final String PROP_REMOTE_HEADER_PREFIX = "ranger.authz.remote.header."; + public static final String PROP_REMOTE_SSL_KEYSTORE_FILE = "ranger.authz.remote.ssl.keystore.file"; + public static final String PROP_REMOTE_SSL_KEYSTORE_PASSWORD = "ranger.authz.remote.ssl.keystore.password"; + public static final String PROP_REMOTE_SSL_KEYSTORE_TYPE = "ranger.authz.remote.ssl.keystore.type"; + public static final String PROP_REMOTE_SSL_TRUSTSTORE_FILE = "ranger.authz.remote.ssl.truststore.file"; + public static final String PROP_REMOTE_SSL_TRUSTSTORE_PASSWORD = "ranger.authz.remote.ssl.truststore.password"; + public static final String PROP_REMOTE_SSL_TRUSTSTORE_TYPE = "ranger.authz.remote.ssl.truststore.type"; + public static final String PROP_REMOTE_SSL_DISABLE_HOSTNAME_VERIFICATION = "ranger.authz.remote.ssl.disable.hostname.verification"; + public static final String PROP_REMOTE_AUTH_TYPE = "ranger.authz.remote.authn.type"; + public static final String PROP_REMOTE_AUTH_JWT_SOURCE = "ranger.authz.remote.authn.jwt.source"; + public static final String PROP_REMOTE_AUTH_JWT_ENV = "ranger.authz.remote.authn.jwt.env"; + public static final String PROP_REMOTE_AUTH_JWT_FILE = "ranger.authz.remote.authn.jwt.file"; + public static final String PROP_REMOTE_AUTH_KERBEROS_PRINCIPAL = "ranger.authz.remote.authn.kerberos.principal"; + public static final String PROP_REMOTE_AUTH_KERBEROS_KEYTAB = "ranger.authz.remote.authn.kerberos.keytab"; + public static final String PROP_REMOTE_AUTH_KERBEROS_DEBUG = "ranger.authz.remote.authn.kerberos.debug"; + public static final String PROP_REMOTE_AUTH_KERBEROS_JAAS_CONTEXT_NAME = "ranger.authz.remote.authn.kerberos.jaas.context.name"; + public static final String PROP_REMOTE_AUTH_KERBEROS_JAAS_LOGIN_MODULE = "ranger.authz.remote.authn.kerberos.jaas.login.module"; + public static final String PROP_REMOTE_AUTH_KERBEROS_JAAS_STORE_KEY = "ranger.authz.remote.authn.kerberos.jaas.store.key"; + public static final String PROP_REMOTE_AUTH_KERBEROS_JAAS_IS_INITIATOR = "ranger.authz.remote.authn.kerberos.jaas.is.initiator"; + public static final String PROP_REMOTE_AUTH_KERBEROS_JAAS_DO_NOT_PROMPT = "ranger.authz.remote.authn.kerberos.jaas.do.not.prompt"; + public static final String PROP_REMOTE_AUTH_KERBEROS_JAAS_USE_TICKET_CACHE = "ranger.authz.remote.authn.kerberos.jaas.use.ticket.cache"; + public static final String PROP_REMOTE_AUTH_KERBEROS_JAAS_REFRESH_KRB5_CONFIG = "ranger.authz.remote.authn.kerberos.jaas.refresh.krb5.config"; + public static final String PROP_REMOTE_AUTH_KERBEROS_SPNEGO_STRIP_PORT = "ranger.authz.remote.authn.kerberos.spnego.strip.port"; + public static final String PROP_REMOTE_AUTH_KERBEROS_SPNEGO_USE_CANONICAL_HOST = "ranger.authz.remote.authn.kerberos.spnego.use.canonical.hostname"; + + private static final String AUTHZ_PATH_PREFIX = "/authz/v1"; + + private static final int DEFAULT_CONNECT_TIMEOUT_MS = 5_000; + private static final int DEFAULT_READ_TIMEOUT_MS = 30_000; + private static final String DEFAULT_STORE_TYPE = "PKCS12"; + private static final String DEFAULT_KERBEROS_JAAS_CONTEXT_NAME = "RangerRemoteClientKerberos"; + private static final String DEFAULT_KERBEROS_JAAS_LOGIN_MODULE = "com.sun.security.auth.module.Krb5LoginModule"; + + private final Properties properties; + private final Map<String, String> headers; + + public RangerRemoteAuthzConfig(Properties properties) { + this.properties = properties != null ? properties : new Properties(); + + this.headers = Collections.unmodifiableMap( + this.properties.stringPropertyNames().stream() + .filter(propName -> propName.startsWith(PROP_REMOTE_HEADER_PREFIX)) + .map(propName -> new AbstractMap.SimpleEntry<>( + propName.substring(PROP_REMOTE_HEADER_PREFIX.length()), + this.properties.getProperty(propName))) + .filter(e -> StringUtils.isNotBlank(e.getKey()) && StringUtils.isNotBlank(e.getValue())) + .collect(Collectors.toMap(Map.Entry::getKey, Map.Entry::getValue, (a, b) -> a, LinkedHashMap::new))); + } + + public String getPdpUrl() throws RangerAuthzException { + String value = normalizeBaseUrl(properties.getProperty(PROP_REMOTE_URL)); + + if (StringUtils.isBlank(value)) { + throw new RangerAuthzException(MISSING_PDP_URL, PROP_REMOTE_URL); + } + + return value; + } + + public String getEndpointUrl(String path) throws RangerAuthzException { + String baseUrl = getPdpUrl(); + + if (baseUrl.endsWith(AUTHZ_PATH_PREFIX)) { + return baseUrl + path; + } + + return baseUrl + AUTHZ_PATH_PREFIX + path; + } + + public int getConnectTimeoutMs() throws RangerAuthzException { + return getIntProperty(PROP_REMOTE_CONNECT_TIMEOUT_MS, DEFAULT_CONNECT_TIMEOUT_MS); + } + + public int getReadTimeoutMs() throws RangerAuthzException { + return getIntProperty(PROP_REMOTE_READ_TIMEOUT_MS, DEFAULT_READ_TIMEOUT_MS); + } + + public RangerRemoteAuthType getAuthType() throws RangerAuthzException { + String value = StringUtils.defaultIfBlank(properties.getProperty(PROP_REMOTE_AUTH_TYPE), RangerRemoteAuthType.HEADER.name()); + + try { + return RangerRemoteAuthType.valueOf(value.trim().toUpperCase()); + } catch (IllegalArgumentException e) { + throw new RangerAuthzException(UNSUPPORTED_AUTH_TYPE, e, value); + } + } + + public String getJwtSource() throws RangerAuthzException { + String ret = trimToNull(properties.getProperty(PROP_REMOTE_AUTH_JWT_SOURCE)); + + if (ret == null) { + throw new RangerAuthzException(MISSING_AUTH_CONFIG, PROP_REMOTE_AUTH_JWT_SOURCE); + } + + return ret; + } + + public String getJwtEnvVar() throws RangerAuthzException { + return getRequiredProperty(PROP_REMOTE_AUTH_JWT_ENV); + } + + public String getJwtFile() throws RangerAuthzException { + return getRequiredProperty(PROP_REMOTE_AUTH_JWT_FILE); + } + + public String getKerberosPrincipal() throws RangerAuthzException { + String ret = trimToNull(properties.getProperty(PROP_REMOTE_AUTH_KERBEROS_PRINCIPAL)); + + if (ret == null) { + throw new RangerAuthzException(MISSING_AUTH_CONFIG, PROP_REMOTE_AUTH_KERBEROS_PRINCIPAL); + } + + return ret; + } + + public String getKerberosKeytab() throws RangerAuthzException { + String ret = trimToNull(properties.getProperty(PROP_REMOTE_AUTH_KERBEROS_KEYTAB)); + + if (ret == null) { + throw new RangerAuthzException(MISSING_AUTH_CONFIG, PROP_REMOTE_AUTH_KERBEROS_KEYTAB); + } + + return ret; + } + + public boolean isKerberosDebugEnabled() throws RangerAuthzException { + return getBooleanProperty(PROP_REMOTE_AUTH_KERBEROS_DEBUG, false); + } + + public String getKerberosJaasContextName() { + return StringUtils.defaultIfBlank(properties.getProperty(PROP_REMOTE_AUTH_KERBEROS_JAAS_CONTEXT_NAME), DEFAULT_KERBEROS_JAAS_CONTEXT_NAME).trim(); + } + + public String getKerberosJaasLoginModuleClass() { + return StringUtils.defaultIfBlank(properties.getProperty(PROP_REMOTE_AUTH_KERBEROS_JAAS_LOGIN_MODULE), DEFAULT_KERBEROS_JAAS_LOGIN_MODULE).trim(); + } + + public boolean isKerberosJaasStoreKey() throws RangerAuthzException { + return getBooleanProperty(PROP_REMOTE_AUTH_KERBEROS_JAAS_STORE_KEY, true); + } + + public boolean isKerberosJaasIsInitiator() throws RangerAuthzException { + return getBooleanProperty(PROP_REMOTE_AUTH_KERBEROS_JAAS_IS_INITIATOR, true); + } + + public boolean isKerberosJaasDoNotPrompt() throws RangerAuthzException { + return getBooleanProperty(PROP_REMOTE_AUTH_KERBEROS_JAAS_DO_NOT_PROMPT, true); + } + + public boolean isKerberosJaasUseTicketCache() throws RangerAuthzException { + return getBooleanProperty(PROP_REMOTE_AUTH_KERBEROS_JAAS_USE_TICKET_CACHE, false); + } + + public boolean isKerberosJaasRefreshKrb5Config() throws RangerAuthzException { + return getBooleanProperty(PROP_REMOTE_AUTH_KERBEROS_JAAS_REFRESH_KRB5_CONFIG, true); + } + + public boolean isKerberosSpnegoStripPort() throws RangerAuthzException { + return getBooleanProperty(PROP_REMOTE_AUTH_KERBEROS_SPNEGO_STRIP_PORT, true); + } + + public boolean isKerberosSpnegoUseCanonicalHostname() throws RangerAuthzException { + return getBooleanProperty(PROP_REMOTE_AUTH_KERBEROS_SPNEGO_USE_CANONICAL_HOST, true); + } + + public String getSslKeyStoreFile() { + return trimToNull(properties.getProperty(PROP_REMOTE_SSL_KEYSTORE_FILE)); + } + + public String getSslKeyStorePassword() { + return properties.getProperty(PROP_REMOTE_SSL_KEYSTORE_PASSWORD); + } + + public String getSslKeyStoreType() { + return StringUtils.defaultIfBlank(properties.getProperty(PROP_REMOTE_SSL_KEYSTORE_TYPE), DEFAULT_STORE_TYPE).trim(); + } + + public String getSslTrustStoreFile() { + return trimToNull(properties.getProperty(PROP_REMOTE_SSL_TRUSTSTORE_FILE)); + } + + public String getSslTrustStorePassword() { + return properties.getProperty(PROP_REMOTE_SSL_TRUSTSTORE_PASSWORD); + } + + public String getSslTrustStoreType() { + return StringUtils.defaultIfBlank(properties.getProperty(PROP_REMOTE_SSL_TRUSTSTORE_TYPE), DEFAULT_STORE_TYPE).trim(); + } + + public boolean isHostnameVerificationDisabled() throws RangerAuthzException { + return getBooleanProperty(PROP_REMOTE_SSL_DISABLE_HOSTNAME_VERIFICATION, false); + } + + public Map<String, String> getHeaders() { + return headers; + } + + private boolean getBooleanProperty(String propertyName, boolean defaultValue) throws RangerAuthzException { + String propertyValue = properties.getProperty(propertyName); + + if (StringUtils.isBlank(propertyValue)) { + return defaultValue; + } + + if ("true".equalsIgnoreCase(propertyValue.trim())) { + return true; + } + + if ("false".equalsIgnoreCase(propertyValue.trim())) { + return false; + } + + throw new RangerAuthzException(INVALID_PROPERTY_VALUE, propertyName, propertyValue); + } + + private int getIntProperty(String propertyName, int defaultValue) throws RangerAuthzException { + String propertyValue = properties.getProperty(propertyName); + + if (StringUtils.isBlank(propertyValue)) { + return defaultValue; + } + + try { + int ret = Integer.parseInt(propertyValue.trim()); + + if (ret < 0) { + throw new RangerAuthzException(INVALID_PROPERTY_VALUE, propertyName, propertyValue); + } + + return ret; + } catch (NumberFormatException e) { + throw new RangerAuthzException(INVALID_PROPERTY_VALUE, e, propertyName, propertyValue); + } + } + + private String getRequiredProperty(String propertyName) throws RangerAuthzException { + String ret = trimToNull(properties.getProperty(propertyName)); + + if (ret == null) { + throw new RangerAuthzException(MISSING_AUTH_CONFIG, propertyName); + } + + return ret; + } + + private static String normalizeBaseUrl(String url) { + String ret = StringUtils.trimToEmpty(url); + + while (ret.endsWith("/")) { + ret = ret.substring(0, ret.length() - 1); + } + + return ret; + } + + private static String trimToNull(String value) { Review Comment: Consider replacing this method with the callers directly calling `StringUtils.trimToNull` ########## ranger-examples/sample-client/src/main/resources/request.json: ########## @@ -0,0 +1,22 @@ +{ + "requestId": "hive-access-request", + "user": { + "name": "hive", + "groups": [ + "public" Review Comment: everyone is implicitly part of `public` group. Please remove line 6 to avoid unnecessary confusion. ########## authz-remote/src/main/java/org/apache/ranger/authz/remote/RangerPdpClient.java: ########## @@ -0,0 +1,274 @@ +/* + * 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.ranger.authz.remote; + +import com.fasterxml.jackson.databind.DeserializationFeature; +import com.fasterxml.jackson.databind.JsonNode; +import com.fasterxml.jackson.databind.ObjectMapper; +import org.apache.http.HttpEntity; +import org.apache.http.client.config.RequestConfig; +import org.apache.http.client.methods.CloseableHttpResponse; +import org.apache.http.client.methods.HttpPost; +import org.apache.http.config.Registry; +import org.apache.http.config.RegistryBuilder; +import org.apache.http.conn.socket.ConnectionSocketFactory; +import org.apache.http.conn.socket.PlainConnectionSocketFactory; +import org.apache.http.conn.ssl.DefaultHostnameVerifier; +import org.apache.http.conn.ssl.NoopHostnameVerifier; +import org.apache.http.conn.ssl.SSLConnectionSocketFactory; +import org.apache.http.entity.ContentType; +import org.apache.http.entity.StringEntity; +import org.apache.http.impl.client.CloseableHttpClient; +import org.apache.http.impl.client.HttpClientBuilder; +import org.apache.http.impl.client.HttpClients; +import org.apache.http.impl.conn.PoolingHttpClientConnectionManager; +import org.apache.http.ssl.SSLContextBuilder; +import org.apache.http.util.EntityUtils; +import org.apache.ranger.authz.api.RangerAuthzException; +import org.apache.ranger.authz.model.RangerAuthzRequest; +import org.apache.ranger.authz.model.RangerAuthzResult; +import org.apache.ranger.authz.model.RangerMultiAuthzRequest; +import org.apache.ranger.authz.model.RangerMultiAuthzResult; +import org.apache.ranger.authz.model.RangerResourcePermissions; +import org.apache.ranger.authz.model.RangerResourcePermissionsRequest; +import org.apache.ranger.authz.remote.authn.RangerRemoteJwtProvider; +import org.apache.ranger.authz.remote.authn.RangerRemoteKerberosContext; + +import javax.net.ssl.HostnameVerifier; +import javax.net.ssl.SSLContext; + +import java.io.Closeable; +import java.io.FileInputStream; +import java.io.IOException; +import java.security.KeyStore; +import java.security.PrivilegedActionException; +import java.security.PrivilegedExceptionAction; +import java.util.Map; + +import static org.apache.ranger.authz.remote.RangerRemoteAuthType.JWT; +import static org.apache.ranger.authz.remote.RangerRemoteAuthType.KERBEROS; +import static org.apache.ranger.authz.remote.RangerRemoteAuthzErrorCode.FAILED_TO_DESERIALIZE_RESPONSE; +import static org.apache.ranger.authz.remote.RangerRemoteAuthzErrorCode.FAILED_TO_SERIALIZE_REQUEST; +import static org.apache.ranger.authz.remote.RangerRemoteAuthzErrorCode.REMOTE_CALL_UNSUCCESSFUL; +import static org.apache.ranger.authz.remote.RangerRemoteAuthzErrorCode.REMOTE_REQUEST_FAILED; +import static org.apache.ranger.authz.remote.RangerRemoteAuthzErrorCode.TLS_CONFIGURATION_FAILED; + +class RangerPdpClient implements Closeable { + private static final ObjectMapper OBJECT_MAPPER = new ObjectMapper().configure(DeserializationFeature.FAIL_ON_UNKNOWN_PROPERTIES, false); + + private static final String PATH_AUTHORIZE = "/authorize"; + private static final String PATH_AUTHORIZE_MULTI = "/authorizeMulti"; + private static final String PATH_RESOURCE_PERMISSIONS = "/permissions"; + + private final RangerRemoteAuthzConfig config; + private final CloseableHttpClient httpClient; + private final RangerRemoteAuthType authType; Review Comment: `authType` doesn't need to be a field; `jwtProvider` and `kerberosContext` are initialized in the constructor based on `authType` value. Use value of `jwtProvider` and `kerberosContext` to determine the path later, in `post()`: ``` if (jwtProvider != null) { jwtProvider.setAuthnHeader(request); } if (kerberosContext != null) { responseBody = kerberosContext.doAs((PrivilegedExceptionAction<String>) () -> execute(request, endpoint)); } else { responseBody = execute(request, endpoint); } ``` ########## authz-remote/src/main/java/org/apache/ranger/authz/remote/RangerRemoteAuthzErrorCode.java: ########## @@ -0,0 +1,64 @@ +/* + * 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.ranger.authz.remote; + +import org.apache.ranger.authz.api.RangerAuthzErrorCode; + +public enum RangerRemoteAuthzErrorCode implements RangerAuthzErrorCode { + MISSING_PDP_URL(500, "00-001", "missing property {0}"), + INVALID_PROPERTY_VALUE(500, "00-002", "invalid value for property {0}: {1}"), + REMOTE_REQUEST_FAILED(500, "00-003", "failed to call Ranger PDP endpoint {0}"), + REMOTE_CALL_UNSUCCESSFUL(502, "00-004", "Ranger PDP endpoint {0} returned HTTP {1}: {2}"), + MISSING_AUTH_CONFIG(500, "00-005", "missing property {0}"), Review Comment: `MISSING_PDP_URL` and `MISSING_AUTH_CONFIG` have the same error message. Consider replacing both with: `MISSING_MANDATORY_CONFIGURATION`. ########## authz-remote/src/main/java/org/apache/ranger/authz/remote/RangerRemoteAuthzErrorCode.java: ########## @@ -0,0 +1,64 @@ +/* + * 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.ranger.authz.remote; + +import org.apache.ranger.authz.api.RangerAuthzErrorCode; + +public enum RangerRemoteAuthzErrorCode implements RangerAuthzErrorCode { + MISSING_PDP_URL(500, "00-001", "missing property {0}"), + INVALID_PROPERTY_VALUE(500, "00-002", "invalid value for property {0}: {1}"), + REMOTE_REQUEST_FAILED(500, "00-003", "failed to call Ranger PDP endpoint {0}"), + REMOTE_CALL_UNSUCCESSFUL(502, "00-004", "Ranger PDP endpoint {0} returned HTTP {1}: {2}"), + MISSING_AUTH_CONFIG(500, "00-005", "missing property {0}"), + UNSUPPORTED_AUTH_TYPE(500, "00-006", "unsupported auth type {0}"), Review Comment: `auth` => `authentication` to make it clear that this is not about authorization. -- 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]
