bscrypt icon indicating copy to clipboard operation
bscrypt copied to clipboard

Add documentation

Open atoponce opened this issue 3 years ago • 1 comments

The projects needs documentation discussing:

  • How to build the project.
  • Why bscrypt was created, such as comparison to other password hashing functions.
  • How to implement bscrypt along with test vectors.
  • Recommended cost settings and their different performance metrics.
  • Why being cache hard is important and how it compares to memory hardness.
  • Etc.

atoponce avatar Aug 11 '22 12:08 atoponce

I was working on this at DEFCON and on the plane home. Also most of this was planned but didn't have time. I should probably add a check list:

  • [ ] How to build the project.
  • [ ] Why bscrypt was created, such as comparison to other password hashing functions.
  • [ ] How to implement bscrypt along with test vectors.
  • [ ] Recommended cost settings and their different performance metrics.
  • [ ] Why being cache hard is important and how it compares to memory hardness.
  • [ ] AVX2
  • [ ] More code documentation
  • [ ] JS version

I'll probably commit changes tomorrow.

Sc00bz avatar Aug 16 '22 03:08 Sc00bz