Skip to content

Hamdan85/onionurigen

Repository files navigation

Onionurigen

Onionurigen is a gem for creating .onion addresses considering a given patern.

Installation

Add this line to your application's Gemfile:

gem 'onionurigen'

And then execute:

$ bundle

Or install it yourself as:

$ gem install onionurigen

Usage

###Single Threading Usage

# pattern obj should be a string or a Regexp
Onionurigen.find(pattern)

###Multi-Threading Usage

In MultiThreading mode you should use workers to execute the direct method of the gem. Each worker should run:

Onionurigen::AddressFinder.new(pattern, true)

Once the hash has been found, the method .found? will be set to true, and the methods .onion_uri and .private_key will be available to this instance object.

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/hamdan85/onionurigen. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

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

Code of Conduct

Everyone interacting in the Onionurigen project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

About

This gem finds tor network .onion addresses

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published