-
Notifications
You must be signed in to change notification settings - Fork 4.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
HIVE-28104. (2.3) Move HTTP related methods from Utils to HttpUtils in shims #5114
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
139 changes: 139 additions & 0 deletions
139
shims/common/src/main/java/org/apache/hadoop/hive/shims/HttpUtils.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,139 @@ | ||
| /** | ||
| * 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.hadoop.hive.shims; | ||
|
|
||
| import java.io.IOException; | ||
| import java.util.Arrays; | ||
| import java.util.HashSet; | ||
| import java.util.Set; | ||
|
|
||
| import javax.servlet.Filter; | ||
| import javax.servlet.FilterChain; | ||
| import javax.servlet.FilterConfig; | ||
| import javax.servlet.ServletException; | ||
| import javax.servlet.ServletRequest; | ||
| import javax.servlet.ServletResponse; | ||
| import javax.servlet.http.HttpServletRequest; | ||
| import javax.servlet.http.HttpServletResponse; | ||
|
|
||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| public class HttpUtils { | ||
|
|
||
| private static final Logger LOG = LoggerFactory.getLogger(HttpUtils.class); | ||
|
|
||
| public static final String XSRF_CUSTOM_HEADER_PARAM = "custom-header"; | ||
| public static final String XSRF_CUSTOM_METHODS_TO_IGNORE_PARAM = "methods-to-ignore"; | ||
| private static final String XSRF_HEADER_DEFAULT = "X-XSRF-HEADER"; | ||
| private static final Set<String> XSRF_METHODS_TO_IGNORE_DEFAULT = new HashSet<String>(Arrays.asList("GET", "OPTIONS", "HEAD", "TRACE")); | ||
|
|
||
| /* | ||
| * Return Hadoop-native RestCsrfPreventionFilter if it is available. | ||
| * Otherwise, construct our own copy of its logic. | ||
| */ | ||
| public static Filter getXSRFFilter() { | ||
| String filterClass = "org.apache.hadoop.security.http.RestCsrfPreventionFilter"; | ||
| try { | ||
| Class<? extends Filter> klass = (Class<? extends Filter>) Class.forName(filterClass); | ||
| Filter f = klass.newInstance(); | ||
| LOG.debug("Filter {} found, using as-is.", filterClass); | ||
| return f; | ||
| } catch (Exception e) { | ||
| // ClassNotFoundException, InstantiationException, IllegalAccessException | ||
| // Class could not be init-ed, use our local copy | ||
| LOG.debug("Unable to use {}, got exception {}. Using internal shims impl of filter.", | ||
| filterClass, e.getClass().getName()); | ||
| } | ||
| return HttpUtils.constructXSRFFilter(); | ||
| } | ||
|
|
||
| private static Filter constructXSRFFilter() { | ||
| // Note Hadoop 2.7.1 onwards includes a RestCsrfPreventionFilter class that is | ||
| // usable as-is. However, since we have to work on a multitude of hadoop versions | ||
| // including very old ones, we either duplicate their code here, or not support | ||
| // an XSRFFilter on older versions of hadoop So, we duplicate to minimize evil(ugh). | ||
| // See HADOOP-12691 for details of what this is doing. | ||
| // This method should never be called if Hadoop 2.7+ is available. | ||
|
|
||
| return new Filter() { | ||
|
|
||
| private String headerName = XSRF_HEADER_DEFAULT; | ||
| private Set<String> methodsToIgnore = XSRF_METHODS_TO_IGNORE_DEFAULT; | ||
|
|
||
| @Override | ||
| public void init(FilterConfig filterConfig) throws ServletException { | ||
| String customHeader = filterConfig.getInitParameter(XSRF_CUSTOM_HEADER_PARAM); | ||
| if (customHeader != null) { | ||
| headerName = customHeader; | ||
| } | ||
| String customMethodsToIgnore = filterConfig.getInitParameter( | ||
| XSRF_CUSTOM_METHODS_TO_IGNORE_PARAM); | ||
| if (customMethodsToIgnore != null) { | ||
| parseMethodsToIgnore(customMethodsToIgnore); | ||
| } | ||
| } | ||
|
|
||
| void parseMethodsToIgnore(String mti) { | ||
| String[] methods = mti.split(","); | ||
| methodsToIgnore = new HashSet<String>(); | ||
| for (int i = 0; i < methods.length; i++) { | ||
| methodsToIgnore.add(methods[i]); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public void doFilter( | ||
| ServletRequest request, ServletResponse response, | ||
| FilterChain chain) throws IOException, ServletException { | ||
| if (doXsrfFilter(request, response, methodsToIgnore, headerName)) { | ||
| chain.doFilter(request, response); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public void destroy() { | ||
| // do nothing | ||
| } | ||
| }; | ||
| } | ||
|
|
||
| // Method that provides similar filter functionality to filter-holder above, useful when | ||
| // calling from code that does not use filters as-is. | ||
| public static boolean doXsrfFilter(ServletRequest request, ServletResponse response, | ||
| Set<String> methodsToIgnore, String headerName) throws IOException, ServletException { | ||
| HttpServletRequest httpRequest = (HttpServletRequest) request; | ||
| if (methodsToIgnore == null) { | ||
| methodsToIgnore = XSRF_METHODS_TO_IGNORE_DEFAULT; | ||
| } | ||
| if (headerName == null) { | ||
| headerName = XSRF_HEADER_DEFAULT; | ||
| } | ||
| if (methodsToIgnore.contains(httpRequest.getMethod()) || | ||
| httpRequest.getHeader(headerName) != null) { | ||
| return true; | ||
| } else { | ||
| ((HttpServletResponse) response).sendError( | ||
| HttpServletResponse.SC_BAD_REQUEST, | ||
| "Missing Required Header for Vulnerability Protection"); | ||
| response.getWriter().println( | ||
| "XSRF filter denial, requests must contain header : " + headerName); | ||
| return false; | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure if the Hive community treats it as a public API, if there are concerns about compatibility, another approach is:
Utilsas-isHadoopUtils, copying all other methods toHadoopUtilsHadoopUtilsinstead ofUtilsto avoid initializingUtilsThere was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Sounds like a more compatible solution.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Either works for me. Looks like this method is only in one place.