xoodyak 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '087e6888550b824a43b269965b1066bd4daad3d1942cc517ced8435ffcfaa21b'
-  data.tar.gz: 0cabd3ab1dfddae09c63de3040479e365e11c10726d9a3a484f7983927080173
+  metadata.gz: 13318d9467b578f9911c3e98d62aee09ac97ed77eb5d115d1c649f5374746ca7
+  data.tar.gz: 13e069990c466db0e03e21fce0e846a0fae3bd2e81b02244d4f3cb849b5e4230
 SHA512:
-  metadata.gz: ea9b1f41888eef78c4ca2e960988f7f04cc418386b2883f0cf4653be7a699b7eef0eb5d44c9b072fd0a9dbf2340bf6d5082ceb16c7f5582c7bf502bc0a90c0cb
-  data.tar.gz: 1c0a4f756035ff03478a7031c40fd505d03f7c32fb02e0e5e755ac7ed872c587dafe2b71f161cd308907c4fa183769553ede8bc3bf615fdee91c12303999bab1
+  metadata.gz: 606a31bad9694805482c9a7619678e006a8fef6c3b914409db491aa0614d32ffd744da90c8b8ee612da26bf7282d118e5a1867a3700cd31fa37f5d4519c83714
+  data.tar.gz: 613e1262ebd6bd9e3bd0ce30ca1c6b79d6aeb494b79d5f447d56c8d30e8d663dd7f6e4aadf24dc1fe64148496ba58575e2439c51763e1eb578f58dd1a6f55a4b

data/README.md

@@ -157,12 +157,12 @@ key = "my-secure-key-16"
 nonce = SecureRandom.bytes(16) # Nonces must be unique for each encryption!
 
 # Encrypt with Associated Data
-alice = Xoodyak.new(key, nonce)
+alice = Xoodyak.new(key, nonce: nonce)
 alice.absorb("Associated Data (unencrypted header)")
 ciphertext_with_tag = alice.aead_encrypt("confidential message")
 
 # Decrypt and Verify
-bob = Xoodyak.new(key, nonce)
+bob = Xoodyak.new(key, nonce: nonce)
 bob.absorb("Associated Data (unencrypted header)") # Must match Alice's AD
 
 begin
@@ -186,12 +186,12 @@ key = "my-secure-key-16"
 nonce = SecureRandom.bytes(16)
 
 # Encrypt
-alice = Xoodyak.new(key, nonce)
+alice = Xoodyak.new(key, nonce: nonce)
 alice.absorb("metadata")
 ciphertext, tag = alice.aead_encrypt_detached("confidential message")
 
 # Decrypt and Verify
-bob = Xoodyak.new(key, nonce)
+bob = Xoodyak.new(key, nonce: nonce)
 bob.absorb("metadata")
 
 begin
@@ -212,7 +212,7 @@ Xoodyak supports initializing the keyed state with a variety of optional paramet
 
 ```ruby
 # Initialize with key, nonce, key_id, and counter
-xoodyak = Xoodyak.new(key, nonce, key_id, counter)
+xoodyak = Xoodyak.new(key, nonce: nonce, key_id: key_id, counter: counter)
 ```
 
 > [!WARNING]
@@ -248,8 +248,8 @@ require 'securerandom'
 key = "session-key-1234"
 nonce = SecureRandom.bytes(16)
 
-alice = Xoodyak.new(key, nonce)
-bob = Xoodyak.new(key, nonce)
+alice = Xoodyak.new(key, nonce: nonce)
+bob = Xoodyak.new(key, nonce: nonce)
 
 # Alice sends first message
 ct1 = alice.encrypt("Message 1")
@@ -294,7 +294,7 @@ puts checkpoint.squeeze(16).unpack1("H*")   # Squeezes based on "initial setup d
 
 | Method | Signature | Mode | Description |
 | :--- | :--- | :--- | :--- |
-| `initialize` | `(key=nil, nonce=nil, key_id=nil, counter=nil)` | Any | Creates a Xoodyak instance. Enters keyed mode if a key is provided. |
+| `initialize` | `(key=nil, nonce: nil, key_id: nil, counter: nil)` | Any | Creates a Xoodyak instance. Enters keyed mode if a key is provided. |
 | `absorb` | `(bin: String) -> void` | Any | Absorbs binary data into the state. |
 | `squeeze` | `(len: Integer) -> String` | Any | Squeezes `len` bytes from the state. |
 | `squeeze_key` | `(len: Integer) -> String` | Any | Squeezes `len` key bytes from the state. |

data/ext/xoodyak/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
-name = "xoodyak"
-version = "0.1.0"
+name = "xoodyakrb"
+version = "0.1.1"
 edition = "2021"
 publish = false
 

data/ext/xoodyak/extconf.rb

@@ -18,6 +18,6 @@ digest_use_rb_ext_resolve_symbol = try_compile(<<~C)
 C
 puts("digest_use_rb_ext_resolve_symbol=#{digest_use_rb_ext_resolve_symbol}")
 
-create_rust_makefile("xoodyak/xoodyak") do |r|
+create_rust_makefile("xoodyak/xoodyakrb") do |r|
   r.extra_rustflags = ["--cfg digest_use_rb_ext_resolve_symbol"] if digest_use_rb_ext_resolve_symbol
 end

data/ext/xoodyak/src/lib.rs

@@ -3,7 +3,9 @@ use std::ffi::{c_int, c_uchar, c_void};
 use std::mem::MaybeUninit;
 use std::os::raw::c_char;
 use magnus::{
-    prelude::*, scan_args::scan_args, Error, ExceptionClass, RString, Ruby, Value,
+    prelude::*,
+    scan_args::{get_kwargs, scan_args},
+    Error, ExceptionClass, RHash, RString, Ruby, Value,
 };
 use rb_sys::{VALUE, size_t};
 use xoodyak::{XoodyakHash, XoodyakKeyed, XoodyakCommon, XoodyakError, XOODYAK_AUTH_TAG_BYTES};
@@ -242,8 +244,14 @@ impl magnus::DataTypeFunctions for Xoodyak {}
 
 impl Xoodyak {
     fn initialize(rb_self: magnus::typed_data::Obj<Self>, args: &[Value]) -> Result<(), Error> {
-        let args = scan_args::<(), (Option<Option<RString>>, Option<Option<RString>>, Option<Option<RString>>, Option<Option<RString>>), (), (), (), ()>(args)?;
-        let (key, nonce, key_id, counter) = args.optional;
+        let args = scan_args::<(), (Option<Option<RString>>,), (), (), RHash, ()>(args)?;
+        let (key,) = args.optional;
+        let kw = get_kwargs::<_, (), (Option<Option<RString>>, Option<Option<RString>>, Option<Option<RString>>), ()>(
+            args.keywords,
+            &[],
+            &["nonce", "key_id", "counter"],
+        )?;
+        let (nonce, key_id, counter) = kw.optional;
         let key = key.flatten();
         let nonce = nonce.flatten();
         let key_id = key_id.flatten();

data/lib/xoodyak/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class Xoodyak
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

data/lib/xoodyak.rb

@@ -13,12 +13,12 @@ require_relative "xoodyak/version"
 
 begin
   RUBY_VERSION =~ /(\d+\.\d+)/
-  require "xoodyak/#{Regexp.last_match(1)}/xoodyak"
+  require "xoodyak/#{Regexp.last_match(1)}/xoodyakrb"
 rescue LoadError
   begin
-    require_relative "xoodyak/xoodyak"
+    require_relative "xoodyak/xoodyakrb"
   rescue LoadError
-    require "xoodyak/xoodyak"
+    require "xoodyak/xoodyakrb"
   end
 end
 

data/sig/xoodyak.rbs

@@ -19,7 +19,7 @@ class Xoodyak
   class Digest < ::Digest::Base
   end
 
-  def initialize: (?String? key, ?String? nonce, ?String? key_id, ?String? counter) -> void
+  def initialize: (?String? key, ?nonce: String?, ?key_id: String?, ?counter: String?) -> void
   def initialize_copy: (Xoodyak other) -> void
   def absorb: (String bin) -> void
   def squeeze: (Integer len) -> String

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: xoodyak
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Sarun Rattanasiri