Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cedarcode/openssl-signature_algorithm
ECDSA, EdDSA, RSA-PSS and RSA-PKCS#1 signature algorithms for ruby
https://github.com/cedarcode/openssl-signature_algorithm
ecdsa eddsa gem library openssl pss rsa-pkcs1 ruby signature-verification signing verify
Last synced: 9 days ago
JSON representation
ECDSA, EdDSA, RSA-PSS and RSA-PKCS#1 signature algorithms for ruby
- Host: GitHub
- URL: https://github.com/cedarcode/openssl-signature_algorithm
- Owner: cedarcode
- License: apache-2.0
- Created: 2020-01-28T19:54:36.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-02-15T14:44:07.000Z (almost 2 years ago)
- Last Synced: 2024-04-24T13:45:06.511Z (7 months ago)
- Topics: ecdsa, eddsa, gem, library, openssl, pss, rsa-pkcs1, ruby, signature-verification, signing, verify
- Language: Ruby
- Homepage: https://rubygems.org/gems/openssl-signature_algorithm
- Size: 104 KB
- Stars: 9
- Watchers: 4
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# OpenSSL::SignatureAlgorithm
> ECDSA, EdDSA, RSA-PSS and RSA-PKCS#1 signature algorithms for ruby
Sign and verify using signature algorithm wrappers, instead of key objects.
Provides `OpenSSL::SignatureAlgorithm::ECDSA`, `OpenSSL::SignatureAlgorithm::EdDSA`, `OpenSSL::SignatureAlgorithm::RSAPSS`
and `OpenSSL::SignatureAlgorithm::RSAPKCS1` ruby object wrappers on top of `OpenSSL::PKey::EC`
and `OpenSSL::PKey::RSA`, so that you can reason in terms of the algorithms and do less when
signing or verifying signatures.
Loosely inspired by [rbnacl](https://github.com/RubyCrypto/rbnacl)'s [Digital Signatures](https://github.com/RubyCrypto/rbnacl/wiki/Digital-Signatures) interface.
[](https://rubygems.org/gems/openssl-signature_algorithm)
[](https://github.com/cedarcode/openssl-signature_algorithm/actions)
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'openssl-signature_algorithm'
```
And then execute:
$ bundle install
Or install it yourself as:
$ gem install openssl-signature_algorithm
## Usage
### ECDSA
```ruby
to_be_signed = "to-be-signed"
# Signer
algorithm = OpenSSL::SignatureAlgorithm::ECDSA.new
signing_key = algorithm.generate_signing_key
signature = algorithm.sign(to_be_signed)
# Signer sends verify key to Verifier
verify_key_string = signing_key.verify_key.serialize
# Verifier
verify_key = OpenSSL::SignatureAlgorithm::ECDSA::VerifyKey.deserialize(verify_key_string)
algorithm = OpenSSL::SignatureAlgorithm::ECDSA.new
algorithm.verify_key = verify_key
algorithm.verify(signature, to_be_signed)
```
### EdDSA
Requires adding the `ed25519` gem to your `Gemfile`
```ruby
require "openssl/signature_algorithm/eddsa"
to_be_signed = "to-be-signed"
# Signer
algorithm = OpenSSL::SignatureAlgorithm::EdDSA.new
signing_key = algorithm.generate_signing_key
signature = algorithm.sign(to_be_signed)
# Signer sends verify key to Verifier
verify_key_string = signing_key.verify_key.serialize
# Verifier
verify_key = OpenSSL::SignatureAlgorithm::EdDSA::VerifyKey.deserialize(verify_key_string)
algorithm = OpenSSL::SignatureAlgorithm::EdDSA.new
algorithm.verify_key = verify_key
algorithm.verify(signature, to_be_signed)
```
### RSA-PSS
```ruby
to_be_signed = "to-be-signed"
# Signer
algorithm = OpenSSL::SignatureAlgorithm::RSAPSS.new
signing_key = algorithm.generate_signing_key
signature = algorithm.sign(to_be_signed)
# Signer sends verify key to Verifier
verify_key_string = signing_key.verify_key.serialize
# Verifier
verify_key = OpenSSL::SignatureAlgorithm::RSAPSS::VerifyKey.deserialize(verify_key_string)
algorithm = OpenSSL::SignatureAlgorithm::RSAPSS.new
algorithm.verify_key = verify_key
algorithm.verify(signature, to_be_signed)
```
### RSA-PKCS1_v1.5
```ruby
to_be_signed = "to-be-signed"
# Signer
algorithm = OpenSSL::SignatureAlgorithm::RSAPKCS1.new
signing_key = algorithm.generate_signing_key
signature = algorithm.sign(to_be_signed)
# Signer sends verify key to Verifier
verify_key_string = signing_key.verify_key.serialize
# Verifier
verify_key = OpenSSL::SignatureAlgorithm::RSAPKCS1::VerifyKey.deserialize(verify_key_string)
algorithm = OpenSSL::SignatureAlgorithm::RSAPKCS1.new
algorithm.verify_key = verify_key
algorithm.verify(signature, to_be_signed)
```
## 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](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/cedarcode/openssl-signature_algorithm.