diff --git a/README.md b/README.md index a3d8e92..79c4404 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,4 @@ -BouncyScrypt -=== +# BouncyScrypt A facade for salted password hashing with scrypt using Bouncy Castle. @@ -11,7 +10,9 @@ The result looks like: -```$919553$mshp5K/vaKkdSzbRqqMTLwr76eSurBsTuVCIIDxuZEE6u093MHBk0Miaq3Qp/Vd7QdP/WeOglVg6W/omiNfC8g==$eV7FfnHnmwyCU8i4rAHQ6NO5RZp53/V1Wr3jsFCc1BqM6yvmGp6BfG7VFrmz21cFlzf4F/aPkgRuO5DRBHgIPQ==$``` +``` +$919553$mshp5K/vaKkdSzbRqqMTLwr76eSurBsTuVCIIDxuZEE6u093MHBk0Miaq3Qp/Vd7QdP/WeOglVg6W/omiNfC8g==$eV7FfnHnmwyCU8i4rAHQ6NO5RZp53/V1Wr3jsFCc1BqM6yvmGp6BfG7VFrmz21cFlzf4F/aPkgRuO5DRBHgIPQ==$ +``` The salts are generated using Java's SHA1PRNG secure psuedo-random number generator. @@ -23,7 +24,7 @@ Both the generated salt and the derived hash (`dkLen`) are 64 bytes. The generated output is 186 characters. -#API +# API ```java // generate a hash @@ -33,7 +34,7 @@ public static boolean check(CharSequence mcfHash, CharSequence password) ``` -#Usage +# Usage The API uses `CharSequence` objects as input and `CharBuffer` objects as output. This gives us a couple of choices: @@ -89,4 +90,4 @@ FreeBSD License (BSD-2-Clause) -https://opensource.org/licenses/BSD-2-Clause \ No newline at end of file +https://opensource.org/licenses/BSD-2-Clause