From d7e7513d6da69440cbe3ea6d88d8abd7f8a02725 Mon Sep 17 00:00:00 2001 From: Rachel Myers Date: Fri, 25 Jun 2021 12:51:55 -0700 Subject: [PATCH 1/2] Document that Scrypt is used by default --- .../com/google/firebase/auth/hash/Scrypt.java | 2 +- .../firebase/auth/hash/package-info.java | 21 +++++++++++++++++++ 2 files changed, 22 insertions(+), 1 deletion(-) create mode 100644 src/main/java/com/google/firebase/auth/hash/package-info.java diff --git a/src/main/java/com/google/firebase/auth/hash/Scrypt.java b/src/main/java/com/google/firebase/auth/hash/Scrypt.java index 1c9612285..7634d91c2 100644 --- a/src/main/java/com/google/firebase/auth/hash/Scrypt.java +++ b/src/main/java/com/google/firebase/auth/hash/Scrypt.java @@ -26,7 +26,7 @@ * Represents the Scrypt password hashing algorithm. This is the * modified Scrypt algorithm used by * Firebase Auth. See {@link StandardScrypt} for the standard Scrypt algorithm. Can be used as an - * instance of {@link com.google.firebase.auth.UserImportHash} when importing users. + * instance of {@link com.google.firebase.auth.UserImportHash} when importing users. This is the default algorithm for passwords. */ public final class Scrypt extends RepeatableHash { diff --git a/src/main/java/com/google/firebase/auth/hash/package-info.java b/src/main/java/com/google/firebase/auth/hash/package-info.java new file mode 100644 index 000000000..bb0a3e5af --- /dev/null +++ b/src/main/java/com/google/firebase/auth/hash/package-info.java @@ -0,0 +1,21 @@ +/* + * Copyright 2021 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; + +/** + * By default, passwords are stored as Scrypt hashes. The hashing algorithm used to store passwords can be changed to any supported algorithm by changing the project config via the API or by reimporting existing users. + */ \ No newline at end of file From 75791ee9eef3f08c77d510b9321add54d79174d3 Mon Sep 17 00:00:00 2001 From: Rachel Myers Date: Fri, 25 Jun 2021 14:23:35 -0700 Subject: [PATCH 2/2] Removing top-level doc, after conversation --- .../firebase/auth/hash/package-info.java | 21 ------------------- 1 file changed, 21 deletions(-) delete mode 100644 src/main/java/com/google/firebase/auth/hash/package-info.java diff --git a/src/main/java/com/google/firebase/auth/hash/package-info.java b/src/main/java/com/google/firebase/auth/hash/package-info.java deleted file mode 100644 index bb0a3e5af..000000000 --- a/src/main/java/com/google/firebase/auth/hash/package-info.java +++ /dev/null @@ -1,21 +0,0 @@ -/* - * Copyright 2021 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; - -/** - * By default, passwords are stored as Scrypt hashes. The hashing algorithm used to store passwords can be changed to any supported algorithm by changing the project config via the API or by reimporting existing users. - */ \ No newline at end of file