Go to file
Andrew Hamon 0755096341
Merge pull request #3 from taylorfinnell/crystal-0.24.1-updates
fixes for 0.24.1
2018-02-13 19:46:49 -05:00
spec Initial commit 2017-07-11 22:15:35 -05:00
src fixes for 0.24.1 2018-02-13 19:39:15 -05:00
.editorconfig Initial commit 2017-07-11 22:15:35 -05:00
.gitignore Initial commit 2017-07-11 22:15:35 -05:00
.travis.yml Initial commit 2017-07-11 22:15:35 -05:00
LICENSE Initial commit 2017-07-11 22:15:35 -05:00
README.md Update README.md 2017-07-11 22:30:58 -05:00
shard.yml change crystal version in shard.yml 2018-02-13 19:40:14 -05:00

README.md

cox

Crystal bindings for the libsodium box API

Given a recipients public key, you can encrypt and sign a message for them. Upon receipt, they can decrypt and authenticate the message as having come from you.

Installation

Install libsodium, then:

Add this to your application's shard.yml:

dependencies:
  cox:
    github: andrewhamon/cox

Usage

require "cox"

data = "Hello World!"

# Alice is the sender
alice = Cox::KeyPair.new

# Bob is the recipient
bob = Cox::KeyPair.new

# Encrypt a message for Bob using his public key, signing it with Alice's
# secret key
nonce, encrypted = Cox.encrypt(data, bob.public, alice.secret)

# Decrypt the message using Bob's secret key, and verify its signature against
# Alice's public key
decrypted = Cox.decrypt(encrypted, nonce, alice.public, bob.secret)

String.new(decrypted) # => "Hello World!"

Contributing

  1. Fork it ( https://github.com/andrewhamon/cox/fork )
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create a new Pull Request

Contributors