feat(auth): Add Argon2 Hashing Algorithm support #637
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,175 @@ | ||
| /* | ||
| * Copyright 2022 Google Inc. | ||
| * | ||
| * Licensed 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 com.google.firebase.auth.hash; | ||
|
|
||
| import static com.google.common.base.Preconditions.checkArgument; | ||
|
|
||
| import com.google.common.collect.ImmutableMap; | ||
| import com.google.common.io.BaseEncoding; | ||
| import com.google.firebase.auth.UserImportHash; | ||
| import java.util.Map; | ||
|
|
||
| /** | ||
| * Represents the Argon2 password hashing algorithm. Can be used as an instance of {@link | ||
| * com.google.firebase.auth.UserImportHash} when importing users. | ||
| */ | ||
| public final class Argon2 extends UserImportHash { | ||
|
|
||
| private static final int MIN_HASH_LENGTH_BYTES = 4; | ||
| private static final int MAX_HASH_LENGTH_BYTES = 1024; | ||
| private static final int MIN_PARALLELISM = 1; | ||
| private static final int MAX_PARALLELISM = 16; | ||
| private static final int MIN_ITERATIONS = 1; | ||
| private static final int MAX_ITERATIONS = 16; | ||
| private static final int MIN_MEMORY_COST_KIB = 1; | ||
| private static final int MAX_MEMORY_COST_KIB = 32768; | ||
|
|
||
| private final int hashLengthBytes; | ||
| private final Argon2HashType hashType; | ||
| private final int parallelism; | ||
| private final int iterations; | ||
| private final int memoryCostKib; | ||
| private final Argon2Version version; | ||
| private final String associatedData; | ||
|
|
||
| private Argon2(Builder builder) { | ||
| super("ARGON2"); | ||
| checkArgument(intShouldBeBetweenLimitsInclusive(builder.hashLengthBytes, MIN_HASH_LENGTH_BYTES, | ||
| MAX_HASH_LENGTH_BYTES), | ||
| "hashLengthBytes is required for Argon2 and must be between %s and %s", | ||
| MIN_HASH_LENGTH_BYTES, MAX_HASH_LENGTH_BYTES); | ||
| checkArgument(builder.hashType != null, | ||
| "A hashType is required for Argon2"); | ||
| checkArgument( | ||
| intShouldBeBetweenLimitsInclusive(builder.parallelism, MIN_PARALLELISM, MAX_PARALLELISM), | ||
| "parallelism is required for Argon2 and must be between %s and %s", MIN_PARALLELISM, | ||
| MAX_PARALLELISM); | ||
| checkArgument( | ||
| intShouldBeBetweenLimitsInclusive(builder.iterations, MIN_ITERATIONS, MAX_ITERATIONS), | ||
| "iterations is required for Argon2 and must be between %s and %s", MIN_ITERATIONS, | ||
| MAX_ITERATIONS); | ||
| checkArgument(intShouldBeBetweenLimitsInclusive(builder.memoryCostKib, MIN_MEMORY_COST_KIB, | ||
| MAX_MEMORY_COST_KIB), | ||
| "memoryCostKib is required for Argon2 and must be less than or equal to %s", | ||
| MAX_MEMORY_COST_KIB); | ||
| this.hashLengthBytes = builder.hashLengthBytes; | ||
| this.hashType = builder.hashType; | ||
| this.parallelism = builder.parallelism; | ||
| this.iterations = builder.iterations; | ||
| this.memoryCostKib = builder.memoryCostKib; | ||
| if (builder.version != null) { | ||
| this.version = builder.version; | ||
| } else { | ||
| this.version = null; | ||
| } | ||
| if (builder.associatedData != null) { | ||
| this.associatedData = BaseEncoding.base64Url().encode(builder.associatedData); | ||
| } else { | ||
| this.associatedData = null; | ||
| } | ||
| } | ||
|
|
||
| private static boolean intShouldBeBetweenLimitsInclusive(int property, int fromInclusive, | ||
| int toInclusive) { | ||
| return property >= fromInclusive && property <= toInclusive; | ||
| } | ||
|
|
||
| @Override | ||
| protected Map<String, Object> getOptions() { | ||
| ImmutableMap.Builder<String, Object> builder = ImmutableMap.<String, Object>builder() | ||
| .put("hashLengthBytes", hashLengthBytes) | ||
| .put("hashType", hashType.toString()) | ||
| .put("parallelism", parallelism) | ||
| .put("iterations", iterations) | ||
| .put("memoryCostKib", memoryCostKib); | ||
| if (this.associatedData != null) { | ||
| builder.put("associatedData", associatedData); | ||
| } | ||
| if (this.version != null) { | ||
| builder.put("version", version.toString()); | ||
| } | ||
| return builder.build(); | ||
| } | ||
|
|
||
| public static Builder builder() { | ||
| return new Builder(); | ||
| } | ||
|
|
||
| public static class Builder { | ||
|
|
||
| private int hashLengthBytes; | ||
| private Argon2HashType hashType; | ||
| private int parallelism; | ||
| private int iterations; | ||
| private int memoryCostKib; | ||
| private Argon2Version version; | ||
| private byte[] associatedData; | ||
|
|
||
| private Builder() { | ||
| } | ||
|
|
||
| public Builder setHashLengthBytes(int hashLengthBytes) { | ||
| this.hashLengthBytes = hashLengthBytes; | ||
| return this; | ||
| } | ||
|
|
||
| public Builder setHashType(Argon2HashType hashType) { | ||
| this.hashType = hashType; | ||
| return this; | ||
| } | ||
|
|
||
| public Builder setParallelism(int parallelism) { | ||
| this.parallelism = parallelism; | ||
| return this; | ||
| } | ||
|
|
||
| public Builder setIterations(int iterations) { | ||
| this.iterations = iterations; | ||
| return this; | ||
| } | ||
|
|
||
| public Builder setMemoryCostKib(int memoryCostKib) { | ||
| this.memoryCostKib = memoryCostKib; | ||
| return this; | ||
| } | ||
|
|
||
| public Builder setVersion(Argon2Version version) { | ||
| this.version = version; | ||
| return this; | ||
| } | ||
|
|
||
| public Builder setAssociatedData(byte[] associatedData) { | ||
| this.associatedData = associatedData; | ||
| return this; | ||
| } | ||
|
|
||
| public Argon2 build() { | ||
| return new Argon2(this); | ||
| } | ||
| } | ||
|
|
||
| public enum Argon2HashType { | ||
| ARGON2_D, | ||
| ARGON2_ID, | ||
| ARGON2_I | ||
| } | ||
|
|
||
| public enum Argon2Version { | ||
| VERSION_10, | ||
| VERSION_13 | ||
|
Comment on lines
+214
to
+215
There was a problem hiding this comment. They are the supported versions, as per the API: https://cloud.google.com/identity-platform/docs/reference/rest/v1/Argon2Parameters#version |
||
| } | ||
| } | ||
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
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 wonder if this could use another layer of abstraction. Similar to what we have done with
HmacandRepeatableHash. We could introduce an abstract class forARGON2Hashand implementations forARGON2d,ARGON2i, andARGON2id. WDYT?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 think that's unnecessary here. For HMAC, it makes sense to add a layer of abstraction since the algorithms are identified as different from one another (
HMAC_SHA256HMAC_SHA1HMAC_MD5, etc). HereARGON2is the algorithm, the hash-types are an additional configuration for the same algorithm.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 see. That makes sense. Thanks, Sam!