Skip to content

Commit 9f83938

Browse files
committed
Use non-redundant ids in password4j docs
Documentation ids no longer need to be globally unique, so they do not need to include the path. This makes the ids less verbose and integrates with include-code extension better. Issue gh-17706
1 parent 11bec09 commit 9f83938

File tree

2 files changed

+11
-11
lines changed

2 files changed

+11
-11
lines changed

docs/modules/ROOT/pages/features/authentication/password-storage.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -463,7 +463,7 @@ There are a significant number of other `PasswordEncoder` implementations that e
463463
They are all deprecated to indicate that they are no longer considered secure.
464464
However, there are no plans to remove them, since it is difficult to migrate existing legacy systems.
465465

466-
[[authentication-password-storage-password4j]]
466+
[[password4j]]
467467
== Password4j-based Password Encoders
468468

469469
Spring Security 7.0 introduces alternative password encoder implementations based on the https://github.com/Password4j/password4j[Password4j] library.
@@ -474,7 +474,7 @@ These encoders are particularly useful when you need specific algorithm configur
474474

475475
All Password4j-based encoders are thread-safe and can be shared across multiple threads.
476476

477-
[[authentication-password-storage-password4j-argon2]]
477+
[[password4j-argon2]]
478478
=== Argon2Password4jPasswordEncoder
479479

480480
The `Argon2Password4jPasswordEncoder` implementation uses the https://en.wikipedia.org/wiki/Argon2[Argon2] algorithm via the Password4j library to hash passwords.
@@ -515,7 +515,7 @@ val customEncoder = Argon2Password4jPasswordEncoder(customArgon2)
515515
----
516516
======
517517

518-
[[authentication-password-storage-password4j-bcrypt]]
518+
[[password4j-bcrypt]]
519519
=== BcryptPassword4jPasswordEncoder
520520

521521
The `BcryptPassword4jPasswordEncoder` implementation uses the https://en.wikipedia.org/wiki/Bcrypt[BCrypt] algorithm via the Password4j library to hash passwords.
@@ -556,7 +556,7 @@ val customEncoder = BcryptPassword4jPasswordEncoder(customBcrypt)
556556
----
557557
======
558558

559-
[[authentication-password-storage-password4j-scrypt]]
559+
[[password4j-scrypt]]
560560
=== ScryptPassword4jPasswordEncoder
561561

562562
The `ScryptPassword4jPasswordEncoder` implementation uses the https://en.wikipedia.org/wiki/Scrypt[SCrypt] algorithm via the Password4j library to hash passwords.
@@ -597,7 +597,7 @@ val customEncoder = ScryptPassword4jPasswordEncoder(customScrypt)
597597
----
598598
======
599599

600-
[[authentication-password-storage-password4j-pbkdf2]]
600+
[[password4j-pbkdf2]]
601601
=== Pbkdf2Password4jPasswordEncoder
602602

603603
The `Pbkdf2Password4jPasswordEncoder` implementation uses the https://en.wikipedia.org/wiki/PBKDF2[PBKDF2] algorithm via the Password4j library to hash passwords.
@@ -639,7 +639,7 @@ val customEncoder = Pbkdf2Password4jPasswordEncoder(customPbkdf2, 32)
639639
----
640640
======
641641

642-
[[authentication-password-storage-password4j-balloon]]
642+
[[password4j-ballooning]]
643643
=== BalloonHashingPassword4jPasswordEncoder
644644

645645
The `BalloonHashingPassword4jPasswordEncoder` implementation uses the Balloon hashing algorithm via the Password4j library to hash passwords.

docs/modules/ROOT/pages/whats-new.adoc

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,11 @@ http.csrf((csrf) -> csrf.spa());
3838
== Crypto
3939

4040
* Added Password4j-based password encoders providing alternative implementations for popular hashing algorithms:
41-
** `Argon2Password4jPasswordEncoder` - xref:features/authentication/password-storage.adoc#authentication-password-storage-password4j-argon2[Argon2 implementation using Password4j]
42-
** `BcryptPassword4jPasswordEncoder` - xref:features/authentication/password-storage.adoc#authentication-password-storage-password4j-bcrypt[BCrypt implementation using Password4j]
43-
** `ScryptPassword4jPasswordEncoder` - xref:features/authentication/password-storage.adoc#authentication-password-storage-password4j-scrypt[SCrypt implementation using Password4j]
44-
** `Pbkdf2Password4jPasswordEncoder` - xref:features/authentication/password-storage.adoc#authentication-password-storage-password4j-pbkdf2[PBKDF2 implementation using Password4j]
45-
** `BalloonHashingPassword4jPasswordEncoder` - xref:features/authentication/password-storage.adoc#authentication-password-storage-password4j-balloon[Balloon Hashing implementation using Password4j]
41+
** `Argon2Password4jPasswordEncoder` - xref:features/authentication/password-storage.adoc#password4j-argon2[Argon2]
42+
** `BcryptPassword4jPasswordEncoder` - xref:features/authentication/password-storage.adoc#password4j-bcrypt[BCrypt]
43+
** `ScryptPassword4jPasswordEncoder` - xref:features/authentication/password-storage.adoc#password4j-scrypt[SCrypt]
44+
** `Pbkdf2Password4jPasswordEncoder` - xref:features/authentication/password-storage.adoc#password4j-pbkdf2[PBKDF2]
45+
** `BalloonHashingPassword4jPasswordEncoder` - xref:features/authentication/password-storage.adoc#password4j-balloon[Balloon Hashing]
4646

4747
== Data
4848

0 commit comments

Comments
 (0)