This is an automated email from the ASF dual-hosted git repository. bossenti pushed a commit to branch refactor-remove-duplicated-code in repository https://gitbox.apache.org/repos/asf/streampipes.git
commit a7603125b35636be927131231aa8226851bae60f Author: Tim Bossenmaier <[email protected]> AuthorDate: Tue Apr 9 11:47:55 2024 +0200 refactor: consolidate duplicate code used for secure string generation --- .../user/management/util/PasswordUtil.java | 14 ++---- .../management/util/SecureStringGenerator.java} | 26 +++++----- .../user/management/util/TokenUtil.java | 13 +---- ...ordUtil.java => TestSecureStringGenerator.java} | 12 ++--- .../user/management/util/TestTokenUtil.java | 57 ---------------------- 5 files changed, 23 insertions(+), 99 deletions(-) diff --git a/streampipes-user-management/src/main/java/org/apache/streampipes/user/management/util/PasswordUtil.java b/streampipes-user-management/src/main/java/org/apache/streampipes/user/management/util/PasswordUtil.java index 779636ec48..c1a8c95078 100644 --- a/streampipes-user-management/src/main/java/org/apache/streampipes/user/management/util/PasswordUtil.java +++ b/streampipes-user-management/src/main/java/org/apache/streampipes/user/management/util/PasswordUtil.java @@ -18,8 +18,6 @@ package org.apache.streampipes.user.management.util; -import org.apache.commons.text.RandomStringGenerator; - import javax.crypto.SecretKeyFactory; import javax.crypto.spec.PBEKeySpec; @@ -31,6 +29,7 @@ import java.security.spec.InvalidKeySpecException; public class PasswordUtil { private static final int DEFAULT_PASSWORD_LENGTH = 10; + private static final String SECRET_KEY_ALGORITHM_NAME = "PBKDF2WithHmacSHA1"; public static byte[] createSalt() { SecureRandom random = new SecureRandom(); @@ -46,7 +45,7 @@ public class PasswordUtil { byte[] salt = createSalt(); PBEKeySpec spec = new PBEKeySpec(chars, salt, iterations, 64 * 8); - SecretKeyFactory skf = SecretKeyFactory.getInstance("PBKDF2WithHmacSHA1"); + SecretKeyFactory skf = SecretKeyFactory.getInstance(SECRET_KEY_ALGORITHM_NAME); byte[] hash = skf.generateSecret(spec).getEncoded(); return iterations + ":" + toHex(salt) + ":" + toHex(hash); } @@ -71,7 +70,7 @@ public class PasswordUtil { PBEKeySpec spec = new PBEKeySpec(originalProperty.toCharArray(), salt, iterations, hash.length * 8); - SecretKeyFactory skf = SecretKeyFactory.getInstance("PBKDF2WithHmacSHA1"); + SecretKeyFactory skf = SecretKeyFactory.getInstance(SECRET_KEY_ALGORITHM_NAME); byte[] testHash = skf.generateSecret(spec).getEncoded(); int diff = hash.length ^ testHash.length; @@ -92,11 +91,6 @@ public class PasswordUtil { public static String generateRandomPassword() { - - // allowing all ASCII-characters from decimal id 33 to 125 - // see https://www.cs.cmu.edu/~pattis/15-1XX/common/handouts/ascii.html for full list - var pwdGenerator = new RandomStringGenerator.Builder().withinRange(33, 125) - .build(); - return pwdGenerator.generate(DEFAULT_PASSWORD_LENGTH); + return new SecureStringGenerator().generateSecureString(DEFAULT_PASSWORD_LENGTH); } } diff --git a/streampipes-user-management/src/test/java/org/apache/streampipes/user/management/util/TestPasswordUtil.java b/streampipes-user-management/src/main/java/org/apache/streampipes/user/management/util/SecureStringGenerator.java similarity index 61% copy from streampipes-user-management/src/test/java/org/apache/streampipes/user/management/util/TestPasswordUtil.java copy to streampipes-user-management/src/main/java/org/apache/streampipes/user/management/util/SecureStringGenerator.java index 62037b7131..046f0da2b0 100644 --- a/streampipes-user-management/src/test/java/org/apache/streampipes/user/management/util/TestPasswordUtil.java +++ b/streampipes-user-management/src/main/java/org/apache/streampipes/user/management/util/SecureStringGenerator.java @@ -15,24 +15,20 @@ * limitations under the License. * */ -package org.apache.streampipes.user.management.util; - -import com.google.common.base.CharMatcher; -import org.junit.jupiter.api.Assertions; -import org.junit.jupiter.api.Test; - -import static org.apache.streampipes.user.management.util.PasswordUtil.generateRandomPassword; -public class TestPasswordUtil { +package org.apache.streampipes.user.management.util; - @Test - public void testGenerateRandomPassword() { +import org.apache.commons.text.RandomStringGenerator; - String randomPassword = generateRandomPassword(); +import java.security.SecureRandom; - Assertions.assertNotNull(randomPassword); - Assertions.assertEquals(10, randomPassword.length()); - Assertions.assertTrue(CharMatcher.ascii().matchesAllOf(randomPassword)); +public class SecureStringGenerator { + public String generateSecureString(int length) { + // allowing all ASCII-characters from decimal id 33 to 125 + // see https://www.cs.cmu.edu/~pattis/15-1XX/common/handouts/ascii.html for full list + var pwdGenerator = new RandomStringGenerator.Builder().usingRandom(new SecureRandom()::nextInt) + .withinRange(33, 125) + .build(); + return pwdGenerator.generate(length); } - } diff --git a/streampipes-user-management/src/main/java/org/apache/streampipes/user/management/util/TokenUtil.java b/streampipes-user-management/src/main/java/org/apache/streampipes/user/management/util/TokenUtil.java index 2233c8c20e..2b642d82cd 100644 --- a/streampipes-user-management/src/main/java/org/apache/streampipes/user/management/util/TokenUtil.java +++ b/streampipes-user-management/src/main/java/org/apache/streampipes/user/management/util/TokenUtil.java @@ -21,7 +21,6 @@ import org.apache.streampipes.model.client.user.RawUserApiToken; import org.apache.streampipes.model.client.user.UserApiToken; import org.apache.commons.codec.digest.DigestUtils; -import org.apache.commons.text.RandomStringGenerator; import java.util.UUID; @@ -48,20 +47,12 @@ public class TokenUtil { return userApiToken; } - public static boolean validateToken(String providedToken, String hashedToken) { - return hashToken(providedToken).equals(hashedToken); - } - private static String generateToken() { return generateToken(TOKEN_LENGTH); } - public static String generateToken(int tokenLength){ - // allowing all ASCII-characters from decimal id 33 to 125 - // see https://www.cs.cmu.edu/~pattis/15-1XX/common/handouts/ascii.html for full list - var pwdGenerator = new RandomStringGenerator.Builder().withinRange(33, 125) - .build(); - return pwdGenerator.generate(tokenLength); + public static String generateToken(int tokenLength) { + return new SecureStringGenerator().generateSecureString(tokenLength); } public static String hashToken(String token) { diff --git a/streampipes-user-management/src/test/java/org/apache/streampipes/user/management/util/TestPasswordUtil.java b/streampipes-user-management/src/test/java/org/apache/streampipes/user/management/util/TestSecureStringGenerator.java similarity index 79% rename from streampipes-user-management/src/test/java/org/apache/streampipes/user/management/util/TestPasswordUtil.java rename to streampipes-user-management/src/test/java/org/apache/streampipes/user/management/util/TestSecureStringGenerator.java index 62037b7131..fc30f9b732 100644 --- a/streampipes-user-management/src/test/java/org/apache/streampipes/user/management/util/TestPasswordUtil.java +++ b/streampipes-user-management/src/test/java/org/apache/streampipes/user/management/util/TestSecureStringGenerator.java @@ -21,17 +21,17 @@ import com.google.common.base.CharMatcher; import org.junit.jupiter.api.Assertions; import org.junit.jupiter.api.Test; -import static org.apache.streampipes.user.management.util.PasswordUtil.generateRandomPassword; - -public class TestPasswordUtil { +public class TestSecureStringGenerator { @Test - public void testGenerateRandomPassword() { + public void testGenerateSecureString() { + + var stringLength = 10; - String randomPassword = generateRandomPassword(); + String randomPassword = new SecureStringGenerator().generateSecureString(stringLength); Assertions.assertNotNull(randomPassword); - Assertions.assertEquals(10, randomPassword.length()); + Assertions.assertEquals(stringLength, randomPassword.length()); Assertions.assertTrue(CharMatcher.ascii().matchesAllOf(randomPassword)); } diff --git a/streampipes-user-management/src/test/java/org/apache/streampipes/user/management/util/TestTokenUtil.java b/streampipes-user-management/src/test/java/org/apache/streampipes/user/management/util/TestTokenUtil.java deleted file mode 100644 index 75cd2d5d60..0000000000 --- a/streampipes-user-management/src/test/java/org/apache/streampipes/user/management/util/TestTokenUtil.java +++ /dev/null @@ -1,57 +0,0 @@ -/* - * 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.streampipes.user.management.util; - -import org.apache.streampipes.model.client.user.RawUserApiToken; -import org.apache.streampipes.model.client.user.UserApiToken; - -import org.junit.jupiter.api.Assertions; -import org.junit.jupiter.api.Test; - -public class TestTokenUtil { - - @Test - public void testCreateToken() { - String tokenName = "test-token"; - - RawUserApiToken rawToken = TokenUtil.createToken(tokenName); - Assertions.assertEquals("test-token", rawToken.getTokenName()); - Assertions.assertNotNull(rawToken.getTokenId()); - Assertions.assertNotNull(rawToken.getRawToken()); - Assertions.assertNotNull(rawToken.getHashedToken()); - } - - @Test - public void testToUserToken() { - RawUserApiToken rawToken = TokenUtil.createToken("test-token"); - UserApiToken token = TokenUtil.toUserToken(rawToken); - - Assertions.assertEquals(rawToken.getHashedToken(), token.getHashedToken()); - Assertions.assertEquals(rawToken.getTokenId(), token.getTokenId()); - Assertions.assertEquals(rawToken.getTokenName(), token.getTokenName()); - } - - @Test - public void testTokenValidation() { - RawUserApiToken rawToken = TokenUtil.createToken("test-token"); - String rawApiKey = rawToken.getRawToken(); - - Assertions.assertTrue(TokenUtil.validateToken(rawApiKey, rawToken.getHashedToken())); - } - -}
