HDFS-15765. WebHdfs: add support for basic auth and custom API path #5447
There are no files selected for viewing
This file contains hidden or 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 hidden or 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,80 @@ | ||
| /** | ||
| * 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.hdfs.web; | ||
|
|
||
| import org.apache.hadoop.security.authentication.client.ConnectionConfigurator; | ||
|
|
||
| import java.io.IOException; | ||
| import java.net.HttpURLConnection; | ||
| import java.nio.charset.StandardCharsets; | ||
| import java.util.Base64; | ||
|
|
||
| /** | ||
| * This class adds basic authentication to the connection, | ||
| * allowing users to access webhdfs over HTTP with basic authentication, | ||
| * for example when using Apache Knox. | ||
| */ | ||
| public class BasicAuthConfigurator implements ConnectionConfigurator { | ||
| private final ConnectionConfigurator parent; | ||
| private final String credentials; | ||
|
|
||
| static public ConnectionConfigurator getConfigurator( | ||
| ConnectionConfigurator configurator, String basicAuthCred | ||
| ) { | ||
| if (basicAuthCred != null && !basicAuthCred.isEmpty()) { | ||
| return new BasicAuthConfigurator(configurator, basicAuthCred); | ||
| } else { | ||
| return configurator; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * @param credentials a string of the form "username:password" | ||
| */ | ||
| public BasicAuthConfigurator( | ||
| ConnectionConfigurator parent, | ||
| String credentials | ||
| ) { | ||
| this.parent = parent; | ||
| this.credentials = credentials; | ||
| } | ||
|
|
||
| @Override | ||
| public HttpURLConnection configure(HttpURLConnection conn) throws IOException { | ||
| if (parent != null) { | ||
| parent.configure(conn); | ||
| } | ||
|
|
||
| if (credentials != null && !credentials.equals("")) { | ||
| conn.setRequestProperty( | ||
| "AUTHORIZATION", | ||
| "Basic " + Base64.getEncoder().encodeToString( | ||
| credentials.getBytes(StandardCharsets.UTF_8) | ||
| ) | ||
| ); | ||
| } | ||
|
|
||
| return conn; | ||
| } | ||
|
|
||
| public void destroy() { | ||
| if (parent != null && parent instanceof SSLConnectionConfigurator) { | ||
| ((SSLConnectionConfigurator)parent).destroy(); | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or 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 hidden or 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 hidden or 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,83 @@ | ||
| /** | ||
| * 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.hdfs.web; | ||
|
|
||
| import org.apache.hadoop.security.authentication.client.ConnectionConfigurator; | ||
| import org.junit.Test; | ||
| import org.mockito.Mockito; | ||
|
|
||
| import java.io.IOException; | ||
| import java.net.HttpURLConnection; | ||
| import java.nio.charset.StandardCharsets; | ||
| import java.util.Base64; | ||
|
|
||
| public class TestBasicAuthConfigurator { | ||
| @Test | ||
| public void testNullCredentials() throws IOException { | ||
| ConnectionConfigurator conf = new BasicAuthConfigurator(null, null); | ||
| HttpURLConnection conn = Mockito.mock(HttpURLConnection.class); | ||
| conf.configure(conn); | ||
| Mockito.verify(conn, Mockito.never()).setRequestProperty(Mockito.any(), Mockito.any()); | ||
| } | ||
|
|
||
| @Test | ||
| public void testEmptyCredentials() throws IOException { | ||
| ConnectionConfigurator conf = new BasicAuthConfigurator(null, ""); | ||
| HttpURLConnection conn = Mockito.mock(HttpURLConnection.class); | ||
| conf.configure(conn); | ||
| Mockito.verify(conn, Mockito.never()).setRequestProperty(Mockito.any(), Mockito.any()); | ||
| } | ||
|
|
||
| @Test | ||
| public void testCredentialsSet() throws IOException { | ||
| String credentials = "user:pass"; | ||
| ConnectionConfigurator conf = new BasicAuthConfigurator(null, credentials); | ||
| HttpURLConnection conn = Mockito.mock(HttpURLConnection.class); | ||
| conf.configure(conn); | ||
| Mockito.verify(conn, Mockito.times(1)).setRequestProperty( | ||
| "AUTHORIZATION", | ||
| "Basic " + Base64.getEncoder().encodeToString(credentials.getBytes(StandardCharsets.UTF_8)) | ||
| ); | ||
| } | ||
|
|
||
| @Test | ||
| public void testParentConfigurator() throws IOException { | ||
| ConnectionConfigurator parent = Mockito.mock(ConnectionConfigurator.class); | ||
| String credentials = "user:pass"; | ||
| ConnectionConfigurator conf = new BasicAuthConfigurator(parent, credentials); | ||
| HttpURLConnection conn = Mockito.mock(HttpURLConnection.class); | ||
| conf.configure(conn); | ||
| Mockito.verify(conn, Mockito.times(1)).setRequestProperty( | ||
| "AUTHORIZATION", | ||
| "Basic " + Base64.getEncoder().encodeToString(credentials.getBytes(StandardCharsets.UTF_8)) | ||
| ); | ||
| Mockito.verify(parent, Mockito.times(1)).configure(conn); | ||
| } | ||
|
|
||
| @Test | ||
| public void testCredentialsSetWithUtfAndSpecialCharacters() throws IOException { | ||
| String credentials = "\uD80C\uDD04@ą:pass"; | ||
| ConnectionConfigurator conf = new BasicAuthConfigurator(null, credentials); | ||
| HttpURLConnection conn = Mockito.mock(HttpURLConnection.class); | ||
| conf.configure(conn); | ||
| Mockito.verify(conn, Mockito.times(1)).setRequestProperty( | ||
| "AUTHORIZATION", | ||
| "Basic " + Base64.getEncoder().encodeToString(credentials.getBytes(StandardCharsets.UTF_8)) | ||
| ); | ||
| } | ||
| } |
This file contains hidden or 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
Oops, something went wrong.
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.
Since this method has to be called by URLConnectionFactory which is in same package. Lets have it package-protected and remove
publicThere 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.
Should this method be moved to
URLConnectionFactoryclass only?Reason being, when external class calls
BasicAuthConfigurator.getConfigurator, to developer it can look that we want something out ofBasicAuthConfigurator, but instead it either gives BasicAuthConfigurator object or parent-configurator object. What you feel?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.
Good point, we might as well move it to
URLConnectionFactoryand make it private there. I've made the change.