https://github.com/cbrnrd/krypton

🔒 A CLI tool for easy cryptography
https://github.com/cbrnrd/krypton

cli command-line-tool cryptography encryption ruby security

Last synced: about 1 year ago
JSON representation

🔒 A CLI tool for easy cryptography

• Host: GitHub
• URL: https://github.com/cbrnrd/krypton
• Owner: cbrnrd
• License: mit
• Created: 2018-09-19T00:33:17.000Z (almost 8 years ago)
• Default Branch: master
• Last Pushed: 2022-10-06T06:21:10.000Z (over 3 years ago)
• Last Synced: 2025-03-28T04:47:52.755Z (about 1 year ago)
• Topics: cli, command-line-tool, cryptography, encryption, ruby, security
• Language: Ruby
• Homepage:
• Size: 173 KB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          


## Installation

You can install krypton as a standalone gem:

    $ gem install krypton

Or you can install the `periodic-cli` gem:

    

    $ gem install periodic-cli

## Usage

All krypton functions use the same basic syntax: `krypton [cmd] {[message/secret]{[key]}}`

* `encrypt` - Encrypt a string

        $ krypton encrypt "mymessage" "mykey" 

        mymessage => ckhJWXcyTE1leENLOWpBQzJWbElMdz09Cg==

* `decrypt` - Decrypt a string

        $ krypton decrypt "ckhJWXcyTE1leENLOWpBQzJWbElMdz09Cg" "mykey" 

        ckhJWXcyTE1leENLOWpBQzJWbElMdz09Cg => mymessage

* `hash` - Hash a string or piped data

        $ krypton hash "mymessage"

        mymessage => S3ONp9WM7/rCMeuUnvWDzp5dxbuSVsOV6bI5AJvRqCc=

        $ echo "mymessage" | krypton hash

        mymessage => S3ONp9WM7/rCMeuUnvWDzp5dxbuSVsOV6bI5AJvRqCc=

* `uuid` - Generate a secure [uuid](https://en.wikipedia.org/wiki/Universally_unique_identifier)

        $ krypton uuid

        b6ff36d2-3f7e-4077-8ba5-5066f0a205a5

* `totp` - Generate a [time-based one-time password](https://en.wikipedia.org/wiki/Time-based_One-time_Password_algorithm)

        $ krypton totp "myawesomesecret"

        myawesomesecret => 997820

        

* `lookup` - Look up the cracked hash from hashes.org

        $ krypton lookup 5e884898da28047151d0e56f8dc6292773603d0d6aabbdd62a11ef721d1542d8

        

        Result found: 

        Hash: 5e884898da28047151d0e56f8dc6292773603d0d6aabbdd62a11ef721d1542d8

        Plaintext: password

        Algorithm: SHA256X1PLAIN

        

## Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/cbrnrd/krypton. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.

## License

The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

## Code of Conduct

Everyone interacting in the Krypton project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/cbrnrd/krypton/blob/master/CODE_OF_CONDUCT.md).