roqs 0.1.1 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4aad68168732a609b5e02c8727e292338d9f3a6db3df0736d50a79bcccddca8a
-  data.tar.gz: 376daa40d6fc87de14ac64d5f70ff4f87c7e3485bc870133eff2c081a704bb04
+  metadata.gz: bb4196f529b63380781840381c6ba75df6546a0e179a0e46aa8ec62200ccba22
+  data.tar.gz: 4f871c35b07b8f2dd362ef7670e3a07ccec259249e1b0d9dea8f2b95c0ea2d0b
 SHA512:
-  metadata.gz: 0220ca4bf7dca5a19a38f4371c0433f794bd74b3e8d4ef417cd003697b77f380f4425ed7f377058a93c9dd6294482c6fffb557ec8d8c31426dd116ff44efe0eb
-  data.tar.gz: e86a50e4dbca76973674b93a92c94eb9c4d74a19b3a7c9f37af4ebcd9406f191de0631a5cb0461ecded875dcb144e5695a303ea8874d26b3e7b70a34c14d13e4
+  metadata.gz: 1fefb69be1c948a373155c37ec0f42fc7c9582233cda8dd5ef9b2d2fa24683502e34e08d7fc52059cf9d6e1c58122c736fe4b11d82ccc652a5e45443020d55d9
+  data.tar.gz: 5bbb379f8d71561ac6d5c9625dedd9fa078d4db611b600183eed2189a8b79530191cf0a504d6bc03ab621089f3bff99676fd3f8ca15a921a8b265c5a26fdaad8

data/Dockerfile

@@ -0,0 +1,11 @@
+
+FROM --platform=linux/x86_64 ubuntu:jammy
+
+RUN apt-get update && apt-get install -y git curl build-essential software-properties-common gnupg2
+
+RUN apt-add-repository -y ppa:rael-gc/rvm && apt-get update && apt-get install -y rvm
+RUN /bin/bash -l -c ". /usr/share/rvm/scripts/rvm && rvm install ruby-3.2.1"
+
+WORKDIR /opt
+
+CMD ["/bin/bash","--login"]

data/README.md

@@ -1,6 +1,9 @@
 # Roqs
 
 Roqs 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)
+
+Due to the direct invocation of the shared library via the libffi toolkit, unless there are major API changes at the liboqs side, this library will keep working as the library is just a bridge between liboqs and Ruby runtime via the API called. Any new supported algorithms internal to the liboqs can be just immediately utilized by the Ruby runtime.
+
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -11,23 +14,24 @@ gem 'roqs'
 
 And then execute:
 
-    $ bundle install
+    bundle install
 
 Or install it yourself as:
 
-    $ gem install roqs
+    gem install roqs
 
 ## Usage
 
-OQS mainly only has two group of functions: Key Encapsulation Mechanism (KEM) and Signature (SIG). 
+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. 
+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. 
+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 'roqs'
 
@@ -39,6 +43,7 @@ end
 ```
 
 2. Generate keypair
+
 ```ruby
 require 'roqs'
 
@@ -51,6 +56,7 @@ pubKey, secretKey = kyber.genkeypair
 ```
 
 3. Key encapsulation - KEM is meant for key encapsulation which similar with Diffie-Hellman kind of key exchange
+
 ```ruby
 require 'roqs'
 
@@ -61,6 +67,7 @@ sessionKey, cipher = kyber.derive_encapsulation_key(pubKey)
 ```
 
 4. Key decapsulation - Re-generate the session key from the private key
+
 ```ruby
 require 'roqs'
 
@@ -68,14 +75,14 @@ sessionKey = kyber.derive_decapsulation_key(cipher, secretKey)
 # cipher is given by sender and privKey is the recipient own private key
 ```
 
-_sessionKey_ returned 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.
-
+*sessionKey* returned 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 
+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 'roqs'
 
@@ -87,6 +94,7 @@ end
 ```
 
 2. Generate keypair
+
 ```ruby
 require 'roqs'
 
@@ -98,8 +106,9 @@ pubKey, secretKey = dili.genkeypair
 # Refer spec file for usage
 ```
 
-3. Generate data signature 
-```rubyion 
+3. Generate data signature
+
+```rubyion
 require 'roqs'
 
 # sign data using sender secretKey/private key
@@ -107,6 +116,7 @@ signature = dili.sign("this is message", secretKey)
 ```
 
 4. Verify data signature
+
 ```ruby
 require 'roqs'
 
@@ -117,7 +127,6 @@ res = dili.verify("this is message", signature, pubKey)
 
 spec folder has the necessary API example usage.
 
-
 ## Test Results
 
 Refer to [test result](https://github.com/chrisliaw/liboqs-ruby/blob/master/TEST-RESULT.md) for details.
@@ -125,4 +134,3 @@ Refer to [test result](https://github.com/chrisliaw/liboqs-ruby/blob/master/TEST
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
-

data/lib/roqs/sig.rb

@@ -67,6 +67,7 @@ module Roqs
      
      rv = SIGWrapper.OQS_SIG_verify(@struct, pMessage, message.length, pSignature, signature.length, pubKey)
 
+     logger.debug "Verify result : #{rv}"
      rv == Roqs::OQS_SUCCESS
 
    end
@@ -94,6 +95,11 @@ module Roqs
      
    end
 
+   private
+   def logger
+    Roqs.logger(:sig)
+   end
+
   end
   
 end

data/lib/roqs/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Roqs
-  VERSION = "0.1.1"
+  VERSION = "0.1.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: roqs
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors:
 - Chris
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-11-24 00:00:00.000000000 Z
+date: 2025-06-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: teLogger
@@ -52,7 +52,10 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.3.3
-description: ''
+description: Ruby wrapper for liboqs via direct shared library method invocation.
+  The wrapper is pretty stable since it is direct method invocation from shared library.
+  Any upgrade to the liboqs, after compiled to a shred library, roqs can immediately
+  utilize the upgraded library without any modification.
 email:
 - chris@antrapol.com
 executables: []
@@ -61,6 +64,7 @@ extra_rdoc_files: []
 files:
 - ".rspec"
 - ".rubocop.yml"
+- Dockerfile
 - README.md
 - Rakefile
 - TEST-RESULT.md
@@ -74,12 +78,15 @@ files:
 - lib/roqs/struct.rb
 - lib/roqs/version.rb
 - lib/roqs/wrapper.rb
-- native/linux/x86_64/liboqs.so.0.9.0
-- native/windows/x64/liboqs.dll
+- native/linux/x86_64/liboqs.so.0.10.0
+- native/macos/.DS_Store
+- native/macos/arm64/liboqs.0.13.0.dylib
 - sig/roqs.rbs
-homepage: ''
+homepage: https://github.com/chrisliaw/roqs
 licenses: []
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/chrisliaw/roqs
+  source_code_uri: https://github.com/chrisliaw/roqs
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -95,8 +102,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.6
+rubygems_version: 3.5.14
 signing_key:
 specification_version: 4
-summary: ''
+summary: Ruby wrapper for liboqs
 test_files: []