genotrance / nimssl Goto Github PK

Nimssl is a Nim wrapper for the OpenSSL library.

Nimssl is distributed as a Nimble package and depends on Nimterop to generate the wrappers. The OpenSSL source code is downloaded using Git so having git in the path is required.

Installation

Nimssl can be installed via Nimble:

> nimble install nimssl

This will download, wrap and install nimssl in the standard Nimble package location, typically ~/.nimble. Once installed, its libraries can be imported into any Nim program.

Usage

To get started, here is an example:

import nimssl/crypto

var test = "Hello, world!"
var hash = SHA256(addr test[0], cast[uint](test.len()), nil)

echo hash.toArray(32).toHex()

When compiling with nimssl/crypto, include the -d:cryptoStd command line flag, and -d:sslStd when compiling with nimssl/ssl. The first compile will be slow, but those after should be much faster. If you are experiencing consistently slow compile times, try including the -f:off flag.

Nimssl currently wraps almost everything from OpenSSL's libcrypto and libssl, but few things are tested (refer to tests). Contributions to the tests pool are appreciated!

Credits

Nimssl wraps the OpenSSL source code and all licensing terms of OpenSSL apply to the usage of this package.

Feedback

Nimssl is a work in progress and any feedback or suggestions are welcome. It is hosted on GitHub with an MIT license so issues, forks and PRs are most appreciated.