-
Notifications
You must be signed in to change notification settings - Fork 8.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
HADOOP-19152. Do not hard code security providers. (#6739)
- Loading branch information
Showing
7 changed files
with
209 additions
and
19 deletions.
There are no files selected for viewing
77 changes: 77 additions & 0 deletions
77
hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/crypto/CryptoUtils.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,77 @@ | ||
| /* | ||
| * 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.crypto; | ||
|
|
||
| import java.security.Provider; | ||
| import java.security.Security; | ||
|
|
||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
|
|
||
| import org.apache.hadoop.classification.InterfaceAudience; | ||
| import org.apache.hadoop.conf.Configuration; | ||
| import org.apache.hadoop.fs.CommonConfigurationKeysPublic; | ||
| import org.apache.hadoop.fs.store.LogExactlyOnce; | ||
|
|
||
| /** Utility methods for the crypto related features. */ | ||
| @InterfaceAudience.Private | ||
| public final class CryptoUtils { | ||
| static final Logger LOG = LoggerFactory.getLogger(CryptoUtils.class); | ||
| private static final LogExactlyOnce LOG_FAILED_TO_LOAD_CLASS = new LogExactlyOnce(LOG); | ||
| private static final LogExactlyOnce LOG_FAILED_TO_ADD_PROVIDER = new LogExactlyOnce(LOG); | ||
|
|
||
| private static final String BOUNCY_CASTLE_PROVIDER_CLASS | ||
| = "org.bouncycastle.jce.provider.BouncyCastleProvider"; | ||
| static final String BOUNCY_CASTLE_PROVIDER_NAME = "BC"; | ||
|
|
||
| /** | ||
| * Get the security provider value specified in | ||
| * {@link CommonConfigurationKeysPublic#HADOOP_SECURITY_CRYPTO_JCE_PROVIDER_KEY} | ||
| * from the given conf. | ||
| * | ||
| * @param conf the configuration | ||
| * @return the configured provider, if there is any; otherwise, return an empty string. | ||
| */ | ||
| public static String getJceProvider(Configuration conf) { | ||
| final String provider = conf.getTrimmed( | ||
| CommonConfigurationKeysPublic.HADOOP_SECURITY_CRYPTO_JCE_PROVIDER_KEY, ""); | ||
| final boolean autoAdd = conf.getBoolean( | ||
| CommonConfigurationKeysPublic.HADOOP_SECURITY_CRYPTO_JCE_PROVIDER_AUTO_ADD_KEY, | ||
| CommonConfigurationKeysPublic.HADOOP_SECURITY_CRYPTO_JCE_PROVIDER_AUTO_ADD_DEFAULT); | ||
|
|
||
| // For backward compatible, auto-add BOUNCY_CASTLE_PROVIDER_CLASS when the provider is "BC". | ||
| if (autoAdd && BOUNCY_CASTLE_PROVIDER_NAME.equals(provider)) { | ||
| try { | ||
| // Use reflection in order to avoid statically loading the class. | ||
| final Class<?> clazz = Class.forName(BOUNCY_CASTLE_PROVIDER_CLASS); | ||
| Security.addProvider((Provider) clazz.getConstructor().newInstance()); | ||
| LOG.debug("Successfully added security provider {}", provider); | ||
| if (LOG.isTraceEnabled()) { | ||
| LOG.trace("Trace", new Throwable()); | ||
| } | ||
| } catch (ClassNotFoundException e) { | ||
| LOG_FAILED_TO_LOAD_CLASS.warn("Failed to load " + BOUNCY_CASTLE_PROVIDER_CLASS, e); | ||
| } catch (Exception e) { | ||
| LOG_FAILED_TO_ADD_PROVIDER.warn("Failed to add security provider for {}", provider, e); | ||
| } | ||
| } | ||
| return provider; | ||
| } | ||
|
|
||
| private CryptoUtils() { } | ||
| } |
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
20 changes: 20 additions & 0 deletions
20
hadoop-common-project/hadoop-common/src/main/java/org/apache/hadoop/crypto/package-info.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,20 @@ | ||
| /* | ||
| * 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. | ||
| */ | ||
|
|
||
| /** Crypto related classes. */ | ||
| package org.apache.hadoop.crypto; |
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
89 changes: 89 additions & 0 deletions
89
...-common-project/hadoop-common/src/test/java/org/apache/hadoop/crypto/TestCryptoUtils.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,89 @@ | ||
| /* | ||
| * 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.crypto; | ||
|
|
||
| import org.apache.hadoop.conf.Configuration; | ||
| import org.apache.hadoop.test.GenericTestUtils; | ||
| import org.assertj.core.api.Assertions; | ||
| import org.bouncycastle.jce.provider.BouncyCastleProvider; | ||
| import org.junit.Assert; | ||
| import org.junit.Test; | ||
| import org.slf4j.event.Level; | ||
|
|
||
| import java.security.Provider; | ||
| import java.security.Security; | ||
|
|
||
| import static org.apache.hadoop.fs.CommonConfigurationKeysPublic.HADOOP_SECURITY_CRYPTO_JCE_PROVIDER_AUTO_ADD_DEFAULT; | ||
| import static org.apache.hadoop.fs.CommonConfigurationKeysPublic.HADOOP_SECURITY_CRYPTO_JCE_PROVIDER_AUTO_ADD_KEY; | ||
| import static org.apache.hadoop.fs.CommonConfigurationKeysPublic.HADOOP_SECURITY_CRYPTO_JCE_PROVIDER_KEY; | ||
|
|
||
| /** Test {@link CryptoUtils}. */ | ||
| public class TestCryptoUtils { | ||
| static { | ||
| GenericTestUtils.setLogLevel(CryptoUtils.LOG, Level.TRACE); | ||
| } | ||
|
|
||
| @Test(timeout = 1_000) | ||
| public void testProviderName() { | ||
| Assert.assertEquals(CryptoUtils.BOUNCY_CASTLE_PROVIDER_NAME, BouncyCastleProvider.PROVIDER_NAME); | ||
| } | ||
|
|
||
| static void assertRemoveProvider() { | ||
| Security.removeProvider(BouncyCastleProvider.PROVIDER_NAME); | ||
| Assert.assertNull(Security.getProvider(BouncyCastleProvider.PROVIDER_NAME)); | ||
| } | ||
|
|
||
| static void assertSetProvider(Configuration conf) { | ||
| conf.set(HADOOP_SECURITY_CRYPTO_JCE_PROVIDER_KEY, CryptoUtils.BOUNCY_CASTLE_PROVIDER_NAME); | ||
| final String providerFromConf = CryptoUtils.getJceProvider(conf); | ||
| Assert.assertEquals(CryptoUtils.BOUNCY_CASTLE_PROVIDER_NAME, providerFromConf); | ||
| } | ||
|
|
||
| @Test(timeout = 5_000) | ||
| public void testAutoAddDisabled() { | ||
| assertRemoveProvider(); | ||
|
|
||
| final Configuration conf = new Configuration(); | ||
| conf.setBoolean(HADOOP_SECURITY_CRYPTO_JCE_PROVIDER_AUTO_ADD_KEY, false); | ||
|
|
||
| assertSetProvider(conf); | ||
|
|
||
| Assert.assertNull(Security.getProvider(BouncyCastleProvider.PROVIDER_NAME)); | ||
| } | ||
|
|
||
| @Test(timeout = 5_000) | ||
| public void testAutoAddEnabled() { | ||
| assertRemoveProvider(); | ||
|
|
||
| final Configuration conf = new Configuration(); | ||
| Assertions.assertThat(conf.get(HADOOP_SECURITY_CRYPTO_JCE_PROVIDER_AUTO_ADD_KEY)) | ||
| .describedAs("conf: " + HADOOP_SECURITY_CRYPTO_JCE_PROVIDER_AUTO_ADD_KEY) | ||
| .isEqualToIgnoringCase("true"); | ||
| Assert.assertTrue(HADOOP_SECURITY_CRYPTO_JCE_PROVIDER_AUTO_ADD_DEFAULT); | ||
|
|
||
| conf.set(HADOOP_SECURITY_CRYPTO_JCE_PROVIDER_KEY, CryptoUtils.BOUNCY_CASTLE_PROVIDER_NAME); | ||
| final String providerFromConf = CryptoUtils.getJceProvider(conf); | ||
| Assert.assertEquals(CryptoUtils.BOUNCY_CASTLE_PROVIDER_NAME, providerFromConf); | ||
|
|
||
| final Provider provider = Security.getProvider(BouncyCastleProvider.PROVIDER_NAME); | ||
| Assertions.assertThat(provider) | ||
| .isInstanceOf(BouncyCastleProvider.class); | ||
|
|
||
| assertRemoveProvider(); | ||
| } | ||
| } |