/BCryptSwift

BCryptSwift is an implementation of bcrypt written in Swift. It currently is able to generate the salt and hash a phrase using a generated salt.

Primary LanguageSwiftApache License 2.0Apache-2.0

BCryptSwift

BCryptSwift is an implementation of bcrypt written in Swift. It currently is able to generate the salt and hash a phrase using a generated salt.

CI Status Version License Platform

Using the Code

BCryptSwift.generateSaltWithNumberOfRounds(rounds: UInt) -> String
BCryptSwift.generateSalt() -> String
BCryptSwift.hashPassword(password: String, withSalt salt: String) -> String?
BCryptSwift.verifyPassword(password: String, matchesHash hash: String) -> Bool?

The generateSaltWithNumberOfRounds() class function will generate a random salt using the number of rounds provided. The number of rounds must be between 4 and 31 inclusively.

The generateSalt() class convenience function will generate a random salt using a default 10 rounds. This number can be adjusted based on your specific needs.

The hashPassword(withSalt:) class function will hash the password phrase using the salt. If there is an issue during processing, nil will be returned. Check the function documentation for details.

The verifyPassword(matchesHash:) class convenience function will hash the password phrase using the hash, then return the comparison between the new hash and the given hash. If there is an issue during processing, nil will be returned. Check the function documentation for details.

Example

There is an example Xcode project that uses the BCryptSwift functions to calculate salts, hashes, and compare hashes. See the example project for a better understanding on how to use the functions.

To run the example project, clone the repo, and run pod install from the Example directory first.

Requirements

Swift 4.0 or higher.

Installation

BCryptSwift is available through CocoaPods and Swift Package Manager To install via CocoaPods, simply add the following line to your Podfile:

pod "BCryptSwift"

To install via Swift Package Manager, use https://github.com/felipeflorencio/BCryptSwift.git as the URL and use the .branch("master") tag.

Roadmap

Testing

TO-DO Provide suitable unit tests for the functions in the BCryptSwift and BCryptSwiftRandom classes.

Issues, Bugs, etc.

If you have any issues, bugs, or feature suggestions, please create an issue.

Author

Felipe F Garcia, felipeflorencio@me.com

Twitter: @dr_nerd

License

Apache License Version 2.0

Credits

This project was inspired by and based on the Objective-C port by Jay Fuerstenberg (Git Repo).

The Objective-C port is based on the original Java implementation by Damien Miller found here.

The Swift port was made originaly by Joe Kramer (Git Repo).