Skip to content

Commit

Permalink
Update build and install instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
dreezey committed Dec 7, 2019
1 parent 61713d5 commit 75ab47f
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,11 +6,16 @@ Build the project once with `mvn install`, this will generate the `target/jboss-
* de.mkammerer.argon2-jvm
* net.java.dev.jna

In your Keycloak installation, go to `modules/system/layers/custom` and modify the layers.conf:
In your Keycloak installation, go to `./modules/` and modify the `layers.conf`:
```
layers=keycloak,custom
```

And create the directory in `./modules/`:
```
mkdir -p ./modules/system/layers/custom
```

Now simply copy the 2 jboss modules folders into the `custom` directory in Keycloak modules.

# Module deployment
Expand All @@ -24,11 +29,11 @@ Further tuning can be done by the other Policy Providers:
* `Argon2 Variant` --> you can choose which Argon2 variant to use, either: ARGON2i, ARGON2d or ARGON2id
* `Argon2 Iterations` --> tune the number of iterations the provider will perform
* `Argon2 Memory Usage` --> tune the memory limitation of the provider
* `Argon2 Paralellism` --> tune the number of threads and memory lanes
* `Argon2 Parallelism` --> tune the number of threads and memory lanes
* `Argon2 Salt Length` --> tune the length of the salt
* `Argon2 Hash Length` --> tune the length of the hash

For security purposes, there's also the possibility to configure the maximum runtime of the hashing, by default it's 1000 milliseconds, however it can be configured via the `Argon2 Max Time` policy.
For security purposes, there's also the possibility to configure the desired maximum runtime of the hashing, by default it's 1000 milliseconds, however it can be configured via the `Argon2 Max Time` policy.
In case the hashing exceeds this time, it will generate a `WARN` in the console.

For parameter optimization, check the [project's benchmark](https://github.com/phxql/argon2-jvm#recommended-parameters) or the [Argon2 whitepaper recommendations](https://github.com/P-H-C/phc-winner-argon2/blob/master/argon2-specs.pdf#section.9).
For parameter optimization, check the [project's benchmark](https://github.com/phxql/argon2-jvm#recommended-parameters) or the [Argon2 whitepaper recommendations](https://github.com/P-H-C/phc-winner-argon2/blob/master/argon2-specs.pdf#section.9).

0 comments on commit 75ab47f

Please sign in to comment.