-
Bug
-
Resolution: Done
-
Undefined
-
None
-
False
-
-
False
-
-
Before reporting an issue
[x] I have read and understood the above terms for submitting issues, and I understand that my issue may be closed without action if I do not follow them.
Area
docs
Describe the bug
The argon2 password SPI has a configuration for the hash-length. This configuration's documentation is wrong.
The hash-length is documented to be set via the spi-password-hashing-argon2-type property, but it should be spi-password-hashing-argon2-hash-length.
The documentation comes from the getConfigMetaData() method, from the Argon2PasswordHashProviderFactory class.
What needs to change is:
builder.property()
.name(TYPE_KEY)
.type("int")
.helpText("Hash length")
.defaultValue(Argon2Parameters.DEFAULT_HASH_LENGTH)
.add();
into
builder.property()
.name(HASH_LENGTH_KEY)
.type("int")
.helpText("Hash length")
.defaultValue(Argon2Parameters.DEFAULT_HASH_LENGTH)
.add();
I can create a PR for this.
Version
26.2.5
Regression
[ ] The issue is a regression
Expected behavior
The documentation should be correct.
Actual behavior
The documentation shows spi-password-hashing-argon2-type instead of spi-password-hashing-argon2-hash-length.
How to Reproduce?
See the argon2 documentation at https://www.keycloak.org/server/all-provider-config#_argon2
Anything else?
No response
- links to