Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/aldy505/phc-crypto
Hashing algorithms simplified (supports Argon2, Bcrypt, Scrypt, and PBKDF2)
https://github.com/aldy505/phc-crypto
argon2 bcrypt crypto cryptography go golang hash pbkdf2 phc scrypt
Last synced: about 1 month ago
JSON representation
Hashing algorithms simplified (supports Argon2, Bcrypt, Scrypt, and PBKDF2)
- Host: GitHub
- URL: https://github.com/aldy505/phc-crypto
- Owner: aldy505
- License: mit
- Created: 2021-05-25T11:51:42.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-06-27T11:15:43.000Z (6 months ago)
- Last Synced: 2024-10-04T12:56:42.517Z (2 months ago)
- Topics: argon2, bcrypt, crypto, cryptography, go, golang, hash, pbkdf2, phc, scrypt
- Language: Go
- Homepage:
- Size: 97.7 KB
- Stars: 25
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-indo-projects - PHC Crypto - Password hashing algorithm based on PHC standard, inspired by Upash package from Node.js. (Go)
- awesome-indonesia-repo - PHC Crypto - Password hashing algorithm based on PHC standard, inspired by Upash package from Node.js. (Go)
README
# PHC Crypto
[](https://github.com/aldy505/phc-crypto/releases) [](https://pkg.go.dev/github.com/aldy505/phc-crypto) [](https://goreportcard.com/report/github.com/aldy505/phc-crypto) [](https://github.com/aldy505/phc-crypto/blob/master/LICENSE) [](https://codecov.io/gh/aldy505/phc-crypto) [](https://www.codefactor.io/repository/github/aldy505/phc-crypto) [](https://www.codacy.com/gh/aldy505/phc-crypto/dashboard?utm_source=github.com&utm_medium=referral&utm_content=aldy505/phc-crypto&utm_campaign=Badge_Grade) [](https://github.com/aldy505/phc-crypto/actions/workflows/build.yml) [](https://github.com/aldy505/phc-crypto/actions/workflows/coverage.yml)
Inspired by [Upash](https://github.com/simonepri/upash), also
implementing [PHC string format](https://github.com/P-H-C/phc-string-format/blob/master/phc-sf-spec.md)
## Usage
Currently there are two options of using this package:
1. Import all
2. Import specific hash function
Bear in mind, these usage function might be changed in the near future.
### Currently supported formats
* Bcrypt
* Argon2i & Argon2id
* PBKDF2
* Scrypt
For details regarding configs, please refer to their own directory.
### Option 1 - Import all
```go
package main
import (
"fmt"
"github.com/aldy505/phc-crypto"
)
func main() {
// Create a crypto instance
// Change the scope name to your prefered hashing algorithm
// Available options are: Bcrypt, Scrypt, Argon2, PBKDF2
crypto, err := phccrypto.Use(phccrypto.Scrypt, phccrypto.Config{})
hash, err := crypto.Hash("password123")
if err != nil {
fmt.Println(err)
}
fmt.Println(hash) // returns string ($scrypt$v=0$p=1,ln=32768,r=8$402ffb0b23cd3d3a$62daeae2ac...)
verify, err := crypto.Verify(hash, "password123")
if err != nil {
fmt.Println(err)
}
fmt.Println(verify) // returns boolean (true/false)
}
```
### Option 2 - Import specific hash function
```go
package main
import "github.com/aldy505/phc-crypto/scrypt"
func main() {
// Change the scope name to your prefered hashing algorithm
hash, err := scrypt.Hash("password123", scrypt.Config{})
if err != nil {
fmt.Println(err)
}
fmt.Println(hash) // returns string ($scrypt$v=0$p=1,ln=32768,r=8$402ffb0b23cd3d3a$62daeae2ac...)
verify, err := scrypt.Verify(hash, "password123")
if err != nil {
fmt.Println(err)
}
fmt.Println(verify) // returns boolean (true/false)
}
```
## Contribute
Yes please! I'm still new to Go and I create this module (or package if you will) to help me fulfill a need on my
project. Feel free to refactor, add new feature, fix unknown bugs, and have fun!
## LICENSE
```
MIT License
Copyright (c) 2024 Reinaldy Rafli and PHC Crypto collaborators
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```