Skip to content

Latest commit

 

History

History
47 lines (26 loc) · 1.17 KB

README.md

File metadata and controls

47 lines (26 loc) · 1.17 KB
Raw

IrcDH1080

A Ruby module for handling DH1080 key exchange for IRC.

Installation

Add this line to your application's Gemfile:

gem 'ircdh1080'

And then execute:

$ bundle

Or install it yourself as:

$ gem install ircdh1080

Usage

dh = IrcDH1080.new
pub_key = dh.pub_key

# IRC DH1080 Base64 encoded public key
peer_key = '...'

shared_secret = dh.compute_key peer_key

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/IceN9ne/ircdh1080-ruby.

License

The gem is available as open source under the terms of the MIT License.