Browse Source

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
pull/17825/head
Rob Winch 3 months ago
parent
commit
9f839384e9
No known key found for this signature in database
  1. 12
      docs/modules/ROOT/pages/features/authentication/password-storage.adoc
  2. 10
      docs/modules/ROOT/pages/whats-new.adoc

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

@ -463,7 +463,7 @@ There are a significant number of other `PasswordEncoder` implementations that e
They are all deprecated to indicate that they are no longer considered secure. They are all deprecated to indicate that they are no longer considered secure.
However, there are no plans to remove them, since it is difficult to migrate existing legacy systems. However, there are no plans to remove them, since it is difficult to migrate existing legacy systems.
[[authentication-password-storage-password4j]] [[password4j]]
== Password4j-based Password Encoders == Password4j-based Password Encoders
Spring Security 7.0 introduces alternative password encoder implementations based on the https://github.com/Password4j/password4j[Password4j] library. 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
All Password4j-based encoders are thread-safe and can be shared across multiple threads. All Password4j-based encoders are thread-safe and can be shared across multiple threads.
[[authentication-password-storage-password4j-argon2]] [[password4j-argon2]]
=== Argon2Password4jPasswordEncoder === Argon2Password4jPasswordEncoder
The `Argon2Password4jPasswordEncoder` implementation uses the https://en.wikipedia.org/wiki/Argon2[Argon2] algorithm via the Password4j library to hash passwords. 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)
---- ----
====== ======
[[authentication-password-storage-password4j-bcrypt]] [[password4j-bcrypt]]
=== BcryptPassword4jPasswordEncoder === BcryptPassword4jPasswordEncoder
The `BcryptPassword4jPasswordEncoder` implementation uses the https://en.wikipedia.org/wiki/Bcrypt[BCrypt] algorithm via the Password4j library to hash passwords. 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)
---- ----
====== ======
[[authentication-password-storage-password4j-scrypt]] [[password4j-scrypt]]
=== ScryptPassword4jPasswordEncoder === ScryptPassword4jPasswordEncoder
The `ScryptPassword4jPasswordEncoder` implementation uses the https://en.wikipedia.org/wiki/Scrypt[SCrypt] algorithm via the Password4j library to hash passwords. 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)
---- ----
====== ======
[[authentication-password-storage-password4j-pbkdf2]] [[password4j-pbkdf2]]
=== Pbkdf2Password4jPasswordEncoder === Pbkdf2Password4jPasswordEncoder
The `Pbkdf2Password4jPasswordEncoder` implementation uses the https://en.wikipedia.org/wiki/PBKDF2[PBKDF2] algorithm via the Password4j library to hash passwords. 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)
---- ----
====== ======
[[authentication-password-storage-password4j-balloon]] [[password4j-ballooning]]
=== BalloonHashingPassword4jPasswordEncoder === BalloonHashingPassword4jPasswordEncoder
The `BalloonHashingPassword4jPasswordEncoder` implementation uses the Balloon hashing algorithm via the Password4j library to hash passwords. The `BalloonHashingPassword4jPasswordEncoder` implementation uses the Balloon hashing algorithm via the Password4j library to hash passwords.

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

@ -38,11 +38,11 @@ http.csrf((csrf) -> csrf.spa());
== Crypto == Crypto
* Added Password4j-based password encoders providing alternative implementations for popular hashing algorithms: * Added Password4j-based password encoders providing alternative implementations for popular hashing algorithms:
** `Argon2Password4jPasswordEncoder` - xref:features/authentication/password-storage.adoc#authentication-password-storage-password4j-argon2[Argon2 implementation using Password4j] ** `Argon2Password4jPasswordEncoder` - xref:features/authentication/password-storage.adoc#password4j-argon2[Argon2]
** `BcryptPassword4jPasswordEncoder` - xref:features/authentication/password-storage.adoc#authentication-password-storage-password4j-bcrypt[BCrypt implementation using Password4j] ** `BcryptPassword4jPasswordEncoder` - xref:features/authentication/password-storage.adoc#password4j-bcrypt[BCrypt]
** `ScryptPassword4jPasswordEncoder` - xref:features/authentication/password-storage.adoc#authentication-password-storage-password4j-scrypt[SCrypt implementation using Password4j] ** `ScryptPassword4jPasswordEncoder` - xref:features/authentication/password-storage.adoc#password4j-scrypt[SCrypt]
** `Pbkdf2Password4jPasswordEncoder` - xref:features/authentication/password-storage.adoc#authentication-password-storage-password4j-pbkdf2[PBKDF2 implementation using Password4j] ** `Pbkdf2Password4jPasswordEncoder` - xref:features/authentication/password-storage.adoc#password4j-pbkdf2[PBKDF2]
** `BalloonHashingPassword4jPasswordEncoder` - xref:features/authentication/password-storage.adoc#authentication-password-storage-password4j-balloon[Balloon Hashing implementation using Password4j] ** `BalloonHashingPassword4jPasswordEncoder` - xref:features/authentication/password-storage.adoc#password4j-balloon[Balloon Hashing]
== Data == Data

Loading…
Cancel
Save