Skip to content

Commit d7e7513

Browse files
committed
Document that Scrypt is used by default
1 parent a8ca851 commit d7e7513

File tree

2 files changed

+22
-1
lines changed

2 files changed

+22
-1
lines changed

src/main/java/com/google/firebase/auth/hash/Scrypt.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
* Represents the Scrypt password hashing algorithm. This is the
2727
* <a href="https://github.com/firebase/scrypt">modified Scrypt algorithm</a> used by
2828
* Firebase Auth. See {@link StandardScrypt} for the standard Scrypt algorithm. Can be used as an
29-
* instance of {@link com.google.firebase.auth.UserImportHash} when importing users.
29+
* instance of {@link com.google.firebase.auth.UserImportHash} when importing users. This is the default algorithm for passwords.
3030
*/
3131
public final class Scrypt extends RepeatableHash {
3232

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
/*
2+
* Copyright 2021 Google Inc.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
17+
package com.google.firebase.auth.hash;
18+
19+
/**
20+
* 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 <href="https://firebase.google.com/docs/auth/admin/import-users">reimporting</href> existing users.
21+
*/

0 commit comments

Comments
 (0)