liboqs 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: c43a5969249e429523544d9b233f4e8d9a1cbc9996ccfc5eab7abd38cf2b38da
+  data.tar.gz: f95847ce06ab42130cda0897d3841e94971c3981ea4381001647c7ebc81dc105
+SHA512:
+  metadata.gz: af3ccdcdd6d00dc37285e49e405640aa6240d2e3d189986fd2cb5500a32d1c9a1a7d068c84399d3a3d1327d7f1779d8448b36113a8a98129a5178e93e897be7f
+  data.tar.gz: 6739b5aaafe7b1ee875599e1cfb1045f9b2627da8f503c2603d49f41a2d5a5658cab099431a476493e555435a22d8a6e019b90c46e837bcc24fdf684feded801

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+*.log
+*.gem
+
+

data/.gitlab-ci.yml

@@ -0,0 +1,9 @@
+image: ruby:3.0.2
+
+before_script:
+  - gem install bundler -v 2.2.22
+  - bundle install
+
+example_job:
+  script:
+    - bundle exec rake

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 2.4
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-08-12
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at chrisliaw@antrapol.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in oqs.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "rspec", "~> 3.0"
+
+gem "rubocop", "~> 1.7"

data/Gemfile.lock

@@ -0,0 +1,86 @@
+PATH
+  remote: .
+  specs:
+    liboqs (0.1.0)
+      tlogger
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    devops_helper (0.3.1)
+      git_cli (>= 0.6.0)
+      gvcs (>= 0.1.0)
+      tlogger (>= 0.22.0)
+      toolrack (>= 0.4.0)
+      tty-prompt (= 0.22.0)
+    diff-lcs (1.4.4)
+    git_cli (0.8.0)
+      gvcs (>= 0.1.0)
+      ptools (~> 1.4.0)
+      tlogger (>= 0.21)
+      toolrack (>= 0.4.0)
+    gvcs (0.1.0)
+    parallel (1.20.1)
+    parser (3.0.2.0)
+      ast (~> 2.4.1)
+    pastel (0.8.0)
+      tty-color (~> 0.5)
+    ptools (1.4.2)
+    rainbow (3.0.0)
+    rake (13.0.6)
+    regexp_parser (2.1.1)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    rubocop (1.18.4)
+      parallel (~> 1.10)
+      parser (>= 3.0.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml
+      rubocop-ast (>= 1.8.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 3.0)
+    rubocop-ast (1.8.0)
+      parser (>= 3.0.1.1)
+    ruby-progressbar (1.11.0)
+    tlogger (0.25.0)
+    toolrack (0.6.0)
+      tlogger (~> 0.21)
+    tty-color (0.6.0)
+    tty-cursor (0.7.1)
+    tty-prompt (0.22.0)
+      pastel (~> 0.8)
+      tty-reader (~> 0.8)
+    tty-reader (0.9.0)
+      tty-cursor (~> 0.7)
+      tty-screen (~> 0.8)
+      wisper (~> 2.0)
+    tty-screen (0.8.1)
+    unicode-display_width (2.0.0)
+    wisper (2.0.1)
+
+PLATFORMS
+  x86_64-linux
+
+DEPENDENCIES
+  devops_helper
+  liboqs!
+  rake (~> 13.0)
+  rspec (~> 3.0)
+  rubocop (~> 1.7)
+
+BUNDLED WITH
+   2.2.22

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Chris Liaw
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,130 @@
+# liboqs-ruby
+
+liboqs-ruby is the Ruby wrapper to the [Open Quantum Safe library](https://openquantumsafe.org). The native library was tested against the liboqs at [liboqs](https://github.com/open-quantum-safe/liboqs)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'oqs'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install liboqs-ruby
+
+## Usage
+
+OQS mainly only has two group of functions: Key Encapsulation Mechanism (KEM) and Signature (SIG). 
+
+Therefore the Ruby wrapper abstraction is following the liboqs C version as baseline. 
+
+### Key Encapsulation Mechanism (KEM)
+
+For KEM, the API is simple:
+
+1. List all supported KEM PQ algorithms - PQ algorithms can be enable or disabled at compile time so it all depends on the liboqs native library. This API listed down the algorithms which are *supported* as reported by the native library. If you're using your own version of the library, you might have different output. 
+```ruby
+require 'oqs'
+
+supported_algo = Oqs::KEM.supported_kem_algo
+supported_algo.each do |al|
+  # al is the algorithm name (string) which is required by subsequent API
+  ...
+end
+```
+
+2. Generate keypair
+```ruby
+require 'oqs'
+
+ntru = Oqs::KEM.new('NTRU-HPS-4096-821')
+pubKey, secretKey = ntru.genkeypair
+# note pubKey and secretKey (or private key) is Fiddle::Pointer type and 
+# is required to be used by the C API in the subsequent phase.
+# Note that pubKey and secretKey are required to be free manually
+# Refer spec file for usage
+```
+
+3. Key encapsulation - KEM is meant for key encapsulation which similar with Diffie-Hellman kind of key exchange
+```ruby
+require 'oqs'
+
+sessionKey, cipher = ntru.derive_encapsulation_key(pubKey)
+# cipher is required to be sent to recipient end to re-generate the sessionKey at recipient end.
+# Returned sessionKey is meant to convert into the final AES (or any other symmetric key) 
+# for the actual data encryption
+```
+
+4. Key decapsulation - Re-generate the session key from the private key
+```ruby
+require 'oqs'
+
+sessionKey = ntru.derive_decapsulation_key(cipher, secretKey)
+# cipher is given by sender and privKey is the recipient own private key
+```
+
+The idea is the sessionKey from derive\_encapsulation\_key() shall be same as the sessionKey from derive\_decapsulation\_key(). That session key shall be the AES key (any other symmetric key) for the data encryption.
+
+
+### Signature mechanism
+
+Signature mechanism is similar with KEM.
+
+1. List all supported Signature PQ algorithms - It is same as KEM as algorithm can be turned on or off during compile time 
+```ruby
+require 'oqs'
+
+supported_algo = Oqs::SIG.supported_signature_algo
+supported_algo.each do |al|
+  # al is the algorithm name (string) which is required by subsequent API
+  ...
+end
+```
+
+2. Generate keypair
+```ruby
+require 'oqs'
+
+dili = Oqs::SIG.new('Dilithium5')
+pubKey, secretKey = dili.genkeypair
+# note pubKey and secretKey (or private key) is Fiddle::Pointer type and 
+# is required to be used by the C API in the subsequent phase.
+# Note that pubKey and secretKey are required to be free manually
+# Refer spec file for usage
+```
+
+3. Generate data signature 
+```ruby
+require 'oqs'
+
+# sign data using sender secretKey/private key
+signature = dili.sign("this is message", secretKey)
+```
+
+4. Verify data signature
+```ruby
+require 'oqs'
+
+# verify signature with given data using sender public key
+res = dili.verify("this is message", signature, pubKey)
+# res is boolean to indicate the signature verification is passed or failed
+```
+
+spec folder has the necessary API example usage.
+
+## Development Environment
+
+The source code was tested on 
+* Ruby MRI 3.0.2p107 (2021-07-07 revision 0db68f0233) [x86\_64-linux], Linux Mint 20.2 x86\_64, Kernel 5.4.0-81-generic, CMake version 3.16.3, Ninja 1.10.0
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+require 'devops_helper'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "oqs"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/oqs.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+require_relative "oqs/version"
+require_relative "oqs/struct"
+require_relative "oqs/global"
+require_relative "oqs/kem"
+require_relative "oqs/sig"
+
+module Oqs
+  class Error < StandardError; end
+  # Your code goes here...
+
+  # OQS_STATUS
+  OQS_ERROR = -1
+  OQS_SUCCESS = 0
+  OQS_EXTERNAL_LIB_ERROR_OPENSSL = 50
+
+end

data/lib/oqs/common_wrapper.rb

@@ -0,0 +1,20 @@
+
+require 'fiddle'
+require 'fiddle/import'
+
+module Oqs
+  module CommonWrapper
+   extend Fiddle::Importer
+   include Oqs::Wrapper
+
+   #dlload File.join(File.dirname(__FILE__),"..","..","native","linux","x86_64","liboqs.so.0.7.0")
+   load_oqs_lib
+
+   extern 'int OQS_MEM_secure_bcmp(const void *a, const void *b, size_t len)'
+   extern 'int OQS_MEM_cleanse(const void *ptr, size_t len)'
+   extern 'int OQS_MEM_secure_free(void *ptr, size_t len)'
+   extern 'int OQS_MEM_insecure_free(void *ptr)'
+
+
+  end
+end

data/lib/oqs/global.rb

@@ -0,0 +1,19 @@
+
+require 'tlogger'
+require 'singleton'
+
+module Oqs
+  class Global
+    include Singleton
+
+    attr_accessor :logger
+    def initialize
+      logPath = ENV['OQS_LOG_PATH']
+      if not (logPath.nil? or logPath.empty?)
+        @logger = Tlogger.new(logPath,10,1024*1024*10)
+      else
+        @logger = Tlogger.new
+      end
+    end
+  end
+end

data/lib/oqs/kem.rb

@@ -0,0 +1,146 @@
+
+require_relative 'struct'
+require_relative 'kem_wrapper'
+require_relative 'common_wrapper'
+
+module Oqs
+  class KEM
+   
+   def self.supported_kem_algo
+     ttl = KEMWrapper.OQS_KEM_alg_count
+     supported = []
+     (0...ttl).each do |i|
+        pName = KEMWrapper.OQS_KEM_alg_identifier(i)
+        name = pName.to_s
+        st = KEMWrapper.OQS_KEM_alg_is_enabled(name)
+        if st
+          supported << name
+        end
+     end
+
+     supported
+   end
+
+   def initialize(name)
+     @algo = name
+     oqsKem = KEMWrapper.OQS_KEM_new(@algo) 
+     raise Error, "Unable to create object '#{@algo}'. It is either the algorithm not supported or it is disabled at compile time." if oqsKem.null?
+     @struct = OQS_KEM.new(oqsKem)
+   end
+
+   def cleanup
+     KEMWrapper.OQS_KEM_free(@struct) if not @struct.nil?
+   end
+
+   def free(obj)
+     obj.free if not (obj.nil? and obj.null?)
+   end
+
+   def intrinsic_name
+     @struct.intrinsic_name.to_s
+   end
+
+   def algo_version
+     @struct.algo_version.to_s
+   end
+
+   def method_missing(mtd, *args, &block)
+     @struct.send(mtd) if not @struct.nil? and @struct.respond_to?(mtd)
+   end
+
+   def genkeypair
+     pubKey = Fiddle::Pointer.malloc(@struct.length_public_key, Fiddle::RUBY_FREE)
+     raise Error, "Unable to allocate memory for public key size #{@struct.length_public_key}" if pubKey.null?
+     privKey = Fiddle::Pointer.malloc(@struct.length_secret_key, Fiddle::RUBY_FREE)
+     raise Error, "Unable to allocate memory for secret key size #{@struct.length_secret_key}" if privKey.null?
+
+     rv = KEMWrapper.OQS_KEM_keypair(@struct, pubKey, privKey)
+     raise Error, "Error in generation of keypair" if rv != Oqs::OQS_SUCCESS
+
+     #pubKeyBin = pubKey[0, pubKey.size]
+     #privKeyBin = privKey[0, privKey.size]
+
+     [pubKey, privKey]
+   end
+
+   def derive_encapsulation_key(pubKey)
+
+     cipher = Fiddle::Pointer.malloc(@struct.length_ciphertext, Fiddle::RUBY_FREE)
+     raise Error, "Unable to allocate memory for ciphertext size #{@struct.length_ciphertext}" if cipher.null?
+
+     encpKey = Fiddle::Pointer.malloc(@struct.length_shared_secret, Fiddle::RUBY_FREE)
+     raise Error, "Unable to allocate memory for shared secret size #{@struct.length_shared_secret}" if encpKey.null?
+     
+     rv = KEMWrapper.OQS_KEM_encaps(@struct, cipher, encpKey, pubKey)
+     raise Error, "Error in encapsulation" if rv != Oqs::OQS_SUCCESS
+
+     encpKeyBin = encpKey[0,encpKey.size]
+     cipherBin = cipher[0,cipher.size]
+
+     cipher.free
+     encpKey.free
+
+     [encpKeyBin, cipherBin]
+
+   end
+
+   def derive_decapsulation_key(cipherBin, privKey)
+
+     raise Error, "Cipher cannot be empty" if cipherBin.nil?
+     raise Error, "Private key cannot be nil" if privKey.nil?
+
+     encpKey = Fiddle::Pointer.malloc(@struct.length_shared_secret, Fiddle::RUBY_FREE)
+     raise Error, "Unable to allocate memory for shared secret size #{@struct.length_shared_secret}" if encpKey.null?
+     
+     rv = KEMWrapper.OQS_KEM_decaps(@struct, encpKey , cipherBin, privKey)
+     raise Error, "Error in decapsulation" if rv != Oqs::OQS_SUCCESS
+
+     encpKeyBin = encpKey[0,encpKey.size]
+
+     encpKey.free
+
+     encpKeyBin
+     
+   end
+
+   #def test
+
+   #  @cipher = Fiddle::Pointer.malloc(@struct.length_ciphertext, Fiddle::RUBY_FREE)
+   #  raise Error, "Unable to allocate memory for ciphertext size #{@struct.length_ciphertext}" if @cipher.null?
+
+   #  shared_e = Fiddle::Pointer.malloc(@struct.length_shared_secret, Fiddle::RUBY_FREE)
+   #  raise Error, "Unable to allocate memory for shared secret size #{@struct.length_shared_secret}" if shared_e.null?
+   #  
+   #  shared_d = Fiddle::Pointer.malloc(@struct.length_shared_secret, Fiddle::RUBY_FREE)
+   #  raise Error, "Unable to allocate memory for shared secret size #{@struct.length_shared_secret}" if shared_d.null?
+
+   #  shared_x = Fiddle::Pointer.malloc(@struct.length_shared_secret, Fiddle::RUBY_FREE)
+   # 
+   #  p shared_e.ptr == shared_d.ptr
+
+   #  rb = shared_e[0, shared_e.size]
+   #  p rb
+
+   #  rv = KEMWrapper.OQS_KEM_encaps(@struct, @cipher, shared_e, @pubKey)
+   #  raise Error, "Error in encapsulation" if rv != KEMWrapper::OQS_SUCCESS
+
+   #  rb = shared_e[0, shared_e.size]
+   #  p rb
+
+   #  p shared_e.ptr == shared_d.ptr
+
+   #  rv = KEMWrapper.OQS_KEM_decaps(@struct, shared_d, @cipher, @privKey)
+   #  raise Error, "Error in decapsulation" if rv != KEMWrapper::OQS_SUCCESS
+
+   #  p shared_e.ptr == shared_d.ptr
+
+   #  p shared_d.size
+   #  rb = shared_d[0, shared_d.size]
+   #  p rb
+
+
+   #end
+
+  end
+  
+end

data/lib/oqs/kem_wrapper.rb

@@ -0,0 +1,28 @@
+
+require 'fiddle'
+require 'fiddle/import'
+
+require_relative 'wrapper'
+
+module Oqs
+  module KEMWrapper
+   extend Fiddle::Importer
+   include Oqs::Wrapper
+
+   #dlload File.join(File.dirname(__FILE__),"..","..","native","linux","x86_64","liboqs.so.0.7.0")
+   load_oqs_lib
+
+   extern 'const char * OQS_KEM_alg_identifier(size_t i)'
+   extern 'int OQS_KEM_alg_count(void)'
+   extern 'int OQS_KEM_alg_is_enabled(const char * name)'
+
+   extern 'OQS_KEM * OQS_KEM_new(const char * algo)'
+   extern 'void OQS_KEM_free(OQS_KEM * kem)'
+
+   extern 'int OQS_KEM_keypair(const OQS_KEM *kem, uint8_t *public_key, uint8_t *secret_key)'
+   
+   extern 'int OQS_KEM_encaps(const OQS_KEM *kem, uint8_t * ciphertext, uint8_t *shared_secret, uint8_t *public_key)'
+   extern 'int OQS_KEM_decaps(const OQS_KEM *kem, uint8_t * shared_secret, uint8_t *ciphertext, uint8_t *secret_key)'
+
+  end
+end

data/lib/oqs/sig.rb

@@ -0,0 +1,99 @@
+
+require_relative 'struct'
+require_relative 'sig_wrapper'
+require_relative 'common_wrapper'
+
+module Oqs
+  class SIG
+
+   def self.supported_signature_algo
+     ttl = SIGWrapper.OQS_SIG_alg_count
+     supported = []
+     (0...ttl).each do |i|
+        pName = SIGWrapper.OQS_SIG_alg_identifier(i)
+        name = pName.to_s
+        st = SIGWrapper.OQS_SIG_alg_is_enabled(name)
+        if st
+          supported << name
+        end
+     end
+
+     supported
+   end
+
+   def initialize(name)
+     @algo = name
+     oqsSig = SIGWrapper.OQS_SIG_new(@algo) 
+     raise Error, "Unable to create object '#{@algo}'. It is either the algorithm not supported or it is disabled at compile time." if oqsSig.null?
+     @struct = OQS_SIG.new(oqsSig)
+   end
+
+   def cleanup
+     SIGWrapper.OQS_SIG_free(@struct) if not @struct.nil?
+   end
+
+   def free(obj)
+     obj.free if not (obj.nil? and obj.null?)
+   end
+
+   def intrinsic_name
+     @struct.intrinsic_name.to_s
+   end
+
+   def algo_version
+     @struct.algo_version.to_s
+   end
+
+   def method_missing(mtd, *args, &block)
+     @struct.send(mtd) if not @struct.nil? and @struct.respond_to?(mtd)
+   end
+
+   def genkeypair
+     pubKey = Fiddle::Pointer.malloc(@struct.length_public_key, Fiddle::RUBY_FREE)
+     raise Error, "Unable to allocate memory for public key size #{@struct.length_public_key}" if pubKey.null?
+     privKey = Fiddle::Pointer.malloc(@struct.length_secret_key, Fiddle::RUBY_FREE)
+     raise Error, "Unable to allocate memory for secret key size #{@struct.length_secret_key}" if privKey.null?
+
+     rv = SIGWrapper.OQS_SIG_keypair(@struct, pubKey, privKey)
+     raise Error, "Error in generation of keypair" if rv != Oqs::OQS_SUCCESS
+
+     [pubKey, privKey]
+   end
+
+   def verify(message,signature,pubKey)
+
+     pMessage = Fiddle::Pointer.to_ptr(message)
+     pSignature = Fiddle::Pointer.to_ptr(signature)
+     
+     rv = SIGWrapper.OQS_SIG_verify(@struct, pMessage, message.length, pSignature, signature.length, pubKey)
+
+     rv == Oqs::OQS_SUCCESS
+
+   end
+
+   def sign(message, privKey)
+
+     raise Error, "Private key cannot be nil" if privKey.nil?
+
+     signature = Fiddle::Pointer.malloc(@struct.length_signature, Fiddle::RUBY_FREE)
+     raise Error, "Unable to allocate memory for signature size #{@struct.length_signature}" if signature.null?
+     signLen = Fiddle::Pointer.malloc(Fiddle::SIZEOF_SIZE_T, Fiddle::RUBY_FREE)
+     raise Error, "Unable to allocate memory for signature length size #{Fiddle::SIZEOF_SIZE_T}" if signLen.null?
+   
+     pMessage = Fiddle::Pointer.to_ptr(message)
+
+     rv = SIGWrapper.OQS_SIG_sign(@struct, signature, signLen, pMessage, message.length, privKey)
+     raise Error, "Error in signing" if rv != Oqs::OQS_SUCCESS
+
+     signBin = signature[0, signLen.ptr.to_i]
+
+     signLen.free
+     signature.free
+
+     signBin
+     
+   end
+
+  end
+  
+end

data/lib/oqs/sig_wrapper.rb

@@ -0,0 +1,31 @@
+
+require 'fiddle'
+require 'fiddle/import'
+
+module Oqs
+  module SIGWrapper
+   extend Fiddle::Importer
+   include Oqs::Wrapper
+
+   ## OQS_STATUS
+   #OQS_ERROR = -1
+   #OQS_SUCCESS = 0
+   #OQS_EXTERNAL_LIB_ERROR_OPENSSL = 50
+    
+   #dlload File.join(File.dirname(__FILE__),"..","..","native","linux","x86_64","liboqs.so.0.7.0")
+   load_oqs_lib
+
+   extern 'const char * OQS_SIG_alg_identifier(size_t i)'
+   extern 'int OQS_SIG_alg_count(void)'
+   extern 'int OQS_SIG_alg_is_enabled(const char * name)'
+
+   extern 'OQS_SIG * OQS_SIG_new(const char * algo)'
+   extern 'void OQS_SIG_free(OQS_SIG * sig)'
+
+   extern 'int OQS_SIG_keypair(const OQS_SIG *sig, uint8_t *public_key, uint8_t *secret_key)'
+   
+   extern 'int OQS_SIG_sign(const OQS_SIG *sig, uint8_t * signature, size_t *signature_len, uint8_t *message, size_t message_len, uint8_t *secret_key)'
+   extern 'int OQS_SIG_verify(const OQS_SIG *sig, uint8_t * message, size_t message_len, uint8_t *signature, size_t signature_len, uint8_t *public_key)'
+
+  end
+end

data/lib/oqs/struct.rb

@@ -0,0 +1,35 @@
+
+require 'fiddle'
+require 'fiddle/import'
+
+module Oqs
+  extend Fiddle::Importer
+
+  OQS_KEM = struct [
+    "const char * intrinsic_name",
+    "const char * algo_version",
+    "uint8_t claimed_nist_level",
+    "int ind_cca",
+    "size_t length_public_key",
+    "size_t length_secret_key",
+    "size_t length_ciphertext",
+    "size_t length_shared_secret",
+    "int (*keypair)(uint8_t *pubKey, uint8_t* secretKey)",
+    "int (*encaps)(uint8_t *cipher_text, uint8_t* shared_secret, const unit8_t * pubKey)",
+    "int (*decaps)(uint8_t *shared_secret, uint8_t* cipher_text, const unit8_t * secretKey)"
+  ]
+
+  OQS_SIG = struct [
+    "const char * intrinsic_name",
+    "const char * algo_version",
+    "uint8_t claimed_nist_level",
+    "int euf_cma",
+    "size_t length_public_key",
+    "size_t length_secret_key",
+    "size_t length_signature",
+    "int (*keypair)(uint8_t *pubKey, uint8_t* secretKey)",
+    "int (*sign)(uint8_t *signature, size_t signature_len, const uint8_t* message, size_t message_len, const unit8_t * secretKey)",
+    "int (*verify)(uint8_t *message, size_t message_len, const uint8_t* signature, size_t signature_len, const unit8_t * pubKey)"
+  ]
+ 
+end

data/lib/oqs/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module Oqs
+  VERSION = "0.1.0"
+end

data/lib/oqs/wrapper.rb

@@ -0,0 +1,58 @@
+
+require 'fiddle'
+
+require_relative "global"
+
+module Oqs
+  module Wrapper
+    class WrapperError < StandardError; end
+
+    module ClassMethods
+      def load_oqs_lib
+        os = detect_os
+        logger.tdebug :wrapper, "Found OS #{os}"
+        load_arch_lib(os)          
+      end
+
+      def detect_os
+        plat = RUBY_PLATFORM
+        if plat =~ /linux/
+          :linux
+        elsif plat =~ /darwin/
+          :macos
+        elsif plat =~ /mingw/
+          :windows
+        else
+          raise WrapperError, "Unknown platform detected. [#{plat}]"
+        end
+      end
+
+      def load_arch_lib(os)
+        plat = RUBY_PLATFORM
+        pplat = plat.split('-')[0]
+        logger.tdebug :wrapper, "OS architecture is #{pplat}"
+        drvDir = File.join(File.dirname(__FILE__),"..","..","native","#{os}",pplat)
+        if File.exist?(drvDir)
+          Dir.glob(File.join(drvDir,"liboqs*")) do |f|
+            logger.tdebug :wrapper, "Loading #{f} from system"
+            dlload f
+          end
+        else
+          raise WrapperError, "Directory '#{pplat}' not found at #{drvDir}"
+        end
+      end
+
+      def logger
+        Oqs::Global.instance.logger
+      end
+    end
+    def self.included(klass)
+      klass.extend(ClassMethods)
+    end
+
+    def logger
+      self.class.logger
+    end
+
+  end
+end

data/oqs.gemspec

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require_relative "lib/oqs/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "liboqs"
+  spec.version       = Oqs::VERSION
+  spec.authors       = ["Chris Liaw"]
+  spec.email         = ["chrisliaw@antrapol.com"]
+
+  spec.summary       = "Ruby wrapper for Open Quantum Safe library"
+  spec.description   = "Ruby wrapper for liboqs from Open Quantum Safe library. This version included platform binary of Linux, MacOS and Windows based on git commit b803b54179c1cea9091d9331cc8085fc235e1be4"
+  spec.homepage      = "https://github.com/chrisliaw/liboqs-ruby"
+  spec.license       = "MIT"
+  spec.required_ruby_version = ">= 2.4.0"
+
+  #spec.metadata["allowed_push_host"] = "TODO: Set to 'https://mygemserver.com'"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/chrisliaw/liboqs-ruby.git"
+  #spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.files += Dir.glob(File.join(__dir__,"native","**/*oqs*"))
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'tlogger'
+
+  spec.add_development_dependency "devops_helper"
+
+  # Uncomment to register a new dependency of your gem
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification
+name: liboqs
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Liaw
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-08-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: tlogger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: devops_helper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Ruby wrapper for liboqs from Open Quantum Safe library. This version
+  included platform binary of Linux, MacOS and Windows based on git commit b803b54179c1cea9091d9331cc8085fc235e1be4
+email:
+- chrisliaw@antrapol.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitlab-ci.yml"
+- ".rspec"
+- ".rubocop.yml"
+- "/mnt/Vault/08.Dev/01.Workspaces/cryptolib.rebooted/liboqs/oqs/native/linux/x86_64/liboqs.so.0.7.0"
+- "/mnt/Vault/08.Dev/01.Workspaces/cryptolib.rebooted/liboqs/oqs/native/macos/x86_64/liboqs.0.7.0.dylib"
+- "/mnt/Vault/08.Dev/01.Workspaces/cryptolib.rebooted/liboqs/oqs/native/windows/x64/liboqs.dll"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/oqs.rb
+- lib/oqs/common_wrapper.rb
+- lib/oqs/global.rb
+- lib/oqs/kem.rb
+- lib/oqs/kem_wrapper.rb
+- lib/oqs/sig.rb
+- lib/oqs/sig_wrapper.rb
+- lib/oqs/struct.rb
+- lib/oqs/version.rb
+- lib/oqs/wrapper.rb
+- native/linux/x86_64/liboqs.so.0.7.0
+- native/macos/x86_64/liboqs.0.7.0.dylib
+- native/windows/x64/liboqs.dll
+- oqs.gemspec
+homepage: https://github.com/chrisliaw/liboqs-ruby
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/chrisliaw/liboqs-ruby
+  source_code_uri: https://github.com/chrisliaw/liboqs-ruby.git
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.4.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.22
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for Open Quantum Safe library
+test_files: []