rb_mumble_protocol 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '018b963b35ca6d2d984d41e36fccf3fca5462abbf440e35bf97fa024522b18c4'
-  data.tar.gz: a866d553b02c66764552b94b1e5328ba6f72702c053358cda933e2a39d0c6256
+  metadata.gz: 3cb4a478bc0cc5d8928902a1d4905d59182051d8c5666f70b6ae31f393b06d91
+  data.tar.gz: 26b9deba5193c57621d82665857702b15c19ba61fa4960983dddecd04cca2b94
 SHA512:
-  metadata.gz: 7fd9a9a1063dcb487e8e0a7dd0b0a2c2dcf39b48aecd046661eca1f0ce1b3a96ef228878b052ae0ae29f39d8cad40d80f6542a49b4c499422473507b06c95020
-  data.tar.gz: e4aebd2af6cfe8a78db205e4f535389515c99b3fa505c58b15f2ac6b0593089e1bd5bef506df7d1674fe8cad7c1f4441f4f77403fa0479c08e758afec9537eb9
+  metadata.gz: 397a5909f8ab0cca9fd0c303dc832e8888850811df1228eb0330c0430da1c568367da96d470271b36b243e82b5801ef2aa44e9f4e6b2cdf808659822bda8ccaf
+  data.tar.gz: 030e4c96656cbb4ac7f4401275dde69633ac0d0ff648478b62b7409b84f1b957ec37259d4db79f25073d75dc9bd808d96de96bf3d800e536f29fc7cc2185c9f4

data/Cargo.lock

@@ -13,22 +13,22 @@ dependencies = [
 
 [[package]]
 name = "bindgen"
-version = "0.62.0"
+version = "0.69.4"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "c6720a8b7b2d39dd533285ed438d458f65b31b5c257e6ac7bb3d7e82844dd722"
+checksum = "a00dc851838a2120612785d195287475a3ac45514741da670b735818822129a0"
 dependencies = [
- "bitflags",
+ "bitflags 2.4.2",
  "cexpr",
  "clang-sys",
+ "itertools",
  "lazy_static",
  "lazycell",
- "peeking_take_while",
  "proc-macro2",
  "quote",
  "regex",
  "rustc-hash",
  "shlex",
- "syn 1.0.109",
+ "syn",
 ]
 
 [[package]]
@@ -37,6 +37,12 @@ version = "1.3.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "bef38d45163c2f1dde094a7dfd33ccf595c92905c8f8f4fdc18d06fb1037718a"
 
+[[package]]
+name = "bitflags"
+version = "2.4.2"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ed570934406eb16438a4e976b1b4500774099c13b8cb96eec99f620f05090ddf"
+
 [[package]]
 name = "bytes"
 version = "1.4.0"
@@ -75,6 +81,12 @@ dependencies = [
  "libloading",
 ]
 
+[[package]]
+name = "either"
+version = "1.9.0"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a26ae43d7bcc3b814de94796a5e736d4029efb0ee900c12e2d54c993ad1a1e07"
+
 [[package]]
 name = "foreign-types"
 version = "0.3.2"
@@ -96,6 +108,15 @@ version = "0.3.1"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "d2fabcfbdc87f4758337ca535fb41a6d701b65693ce38287d856d1674551ec9b"
 
+[[package]]
+name = "itertools"
+version = "0.12.1"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "ba291022dbbd398a455acf126c1e341954079855bc60dfdda641363bd6922569"
+dependencies = [
+ "either",
+]
+
 [[package]]
 name = "lazy_static"
 version = "1.4.0"
@@ -126,24 +147,25 @@ dependencies = [
 
 [[package]]
 name = "magnus"
-version = "0.4.4"
+version = "0.6.2"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "fc87660cd7daa49fddbfd524c836de54d5c927d520cd163f43700c5087c57d6c"
+checksum = "4778544796676e8428e9c622460ebf284bea52d8b10db3aeb449d8b5e61b3a13"
 dependencies = [
  "magnus-macros",
  "rb-sys",
  "rb-sys-env",
+ "seq-macro",
 ]
 
 [[package]]
 name = "magnus-macros"
-version = "0.3.0"
+version = "0.6.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "206cb23bfeea05180c97522ef6a3e52a4eb17b0ed2f30ee3ca9c4f994d2378ae"
+checksum = "5968c820e2960565f647819f5928a42d6e874551cab9d88d75e3e0660d7f71e3"
 dependencies = [
  "proc-macro2",
  "quote",
- "syn 1.0.109",
+ "syn",
 ]
 
 [[package]]
@@ -180,7 +202,7 @@ version = "0.10.55"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "345df152bc43501c5eb9e4654ff05f794effb78d4efe3d53abc158baddc0703d"
 dependencies = [
- "bitflags",
+ "bitflags 1.3.2",
  "cfg-if",
  "foreign-types",
  "libc",
@@ -197,7 +219,7 @@ checksum = "a948666b637a0f465e8564c73e89d4dde00d72d4d473cc972f390fc3dcee7d9c"
 dependencies = [
  "proc-macro2",
  "quote",
- "syn 2.0.27",
+ "syn",
 ]
 
 [[package]]
@@ -212,12 +234,6 @@ dependencies = [
  "vcpkg",
 ]
 
-[[package]]
-name = "peeking_take_while"
-version = "0.1.2"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "19b17cddbe7ec3f8bc800887bab5e717348c95ea2ca0b1bf0837fb964dc67099"
-
 [[package]]
 name = "pkg-config"
 version = "0.3.27"
@@ -244,18 +260,18 @@ dependencies = [
 
 [[package]]
 name = "rb-sys"
-version = "0.9.79"
+version = "0.9.87"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "939fb78db3e4f26665c1d4c7b91ca66d3578335a19aba552d4a6445811d07072"
+checksum = "225103e3d69bbfe8831f9fd0d2461335f3a9dd06aa6e88bcb6d6970383494d06"
 dependencies = [
  "rb-sys-build",
 ]
 
 [[package]]
 name = "rb-sys-build"
-version = "0.9.79"
+version = "0.9.87"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "335a95eb0420d52fa94ef12019df3c2c250c6b19cbb3c60bd05cb7e9c362072c"
+checksum = "bacce8095a5167d5ede618bbd9353e9d9e2f32ddaf54be911106f0ee6baacf09"
 dependencies = [
  "bindgen",
  "lazy_static",
@@ -263,7 +279,7 @@ dependencies = [
  "quote",
  "regex",
  "shell-words",
- "syn 1.0.109",
+ "syn",
 ]
 
 [[package]]
@@ -274,7 +290,7 @@ checksum = "a35802679f07360454b418a5d1735c89716bde01d35b1560fc953c1415a0b3bb"
 
 [[package]]
 name = "rb_mumble_protocol"
-version = "0.1.0"
+version = "0.2.0"
 dependencies = [
  "bytes",
  "magnus",
@@ -316,6 +332,12 @@ version = "1.1.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "08d43f7aa6b08d49f382cde6a7982047c3426db949b1424bc4b7ec9ae12c6ce2"
 
+[[package]]
+name = "seq-macro"
+version = "0.3.5"
+source = "registry+https://github.com/rust-lang/crates.io-index"
+checksum = "a3f0bf26fd526d2a95683cd0f87bf103b8539e2ca1ef48ce002d67aad59aa0b4"
+
 [[package]]
 name = "shell-words"
 version = "1.1.0"
@@ -328,17 +350,6 @@ version = "1.1.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "43b2853a4d09f215c24cc5489c992ce46052d359b5109343cbafbf26bc62f8a3"
 
-[[package]]
-name = "syn"
-version = "1.0.109"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "72b64191b275b66ffe2469e8af2c1cfe3bafa67b529ead792a6d0160888b4237"
-dependencies = [
- "proc-macro2",
- "quote",
- "unicode-ident",
-]
-
 [[package]]
 name = "syn"
 version = "2.0.27"

data/ext/rb_mumble_protocol/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "rb_mumble_protocol"
-version = "0.1.0"
+version = "0.2.0"
 edition = "2021"
 authors = ["Mikhail Odebe <derpiranha@gmail.com>"]
 publish = false
@@ -9,6 +9,6 @@ publish = false
 crate-type = ["cdylib"]
 
 [dependencies]
-magnus = { version = "0.4" }
+magnus = { version = "0.6" }
 bytes = "1.0"
 openssl = { version = "0.10" }

data/ext/rb_mumble_protocol/src/lib.rs

@@ -3,15 +3,31 @@ use std::cell::RefCell;
 use magnus::{
     class, define_module,
     method, function, prelude::*,
-    Error, RHash,
-    value::{QTRUE, QFALSE}, Value
+    Error, RHash, RModule, Ruby,
+    value::{Lazy},
+    exception::ExceptionClass,
+    gc::register_mark_object,
 };
 
 use bytes::BytesMut;
 
+static BASE_ERROR: Lazy<ExceptionClass> = Lazy::new(|ruby| {
+    let ex = ruby
+        .class_object()
+        .const_get::<_, RModule>("RbMumbleProtocol")
+        .unwrap()
+        .const_get("Error")
+        .unwrap();
+
+    // ensure `ex` is never garbage collected (e.g. if constant is
+    // redefined) and also not moved under compacting GC.
+    register_mark_object(ex);
+    ex
+});
+
 pub mod crypt_state;
 
-#[magnus::wrap(class = "RbMumbleProtocol::CryptState", free_immediatly, size)]
+#[magnus::wrap(class = "RbMumbleProtocol::CryptState")]
 struct CryptStateRef(RefCell<crypt_state::CryptState>);
 
 impl CryptStateRef {
@@ -48,43 +64,88 @@ impl CryptStateRef {
         Self(RefCell::new(new_state))
     }
 
-    pub fn key(&self) -> Vec<u8> { self.0.try_borrow_mut().unwrap().get_key().to_vec() }
-    pub fn encrypt_nonce(&self) -> Vec<u8> { self.0.try_borrow_mut().unwrap().get_encrypt_nonce().to_vec() }
-    pub fn decrypt_nonce(&self) -> Vec<u8> { self.0.try_borrow_mut().unwrap().get_decrypt_nonce().to_vec() }
-
-    pub fn stats(&self) -> RHash {
-        let hash = RHash::new();
-        let state = self.0.try_borrow_mut().unwrap();
+    pub fn key(&self) -> Result<Vec<u8>, Error> {
+        match self.0.try_borrow() {
+            Ok(ref_) => { Ok(ref_.get_key().to_vec()) },
+            Err(_e) => { Err(Error::new(get_ruby().get_inner(&BASE_ERROR), "borrow error")) }
+        }
+    }
 
-        let _ = hash.aset("good", state.get_good());
-        let _ = hash.aset("late", state.get_late());
-        let _ = hash.aset("lost", state.get_lost());
+    pub fn encrypt_nonce(&self) -> Result<Vec<u8>, Error> {
+        match self.0.try_borrow() {
+            Ok(ref_) => { Ok(ref_.get_encrypt_nonce().to_vec()) },
+            Err(_e) => { Err(Error::new(get_ruby().get_inner(&BASE_ERROR), "borrow error")) }
+        }
+    }
 
-        hash
+    pub fn decrypt_nonce(&self) -> Result<Vec<u8>, Error> {
+        match self.0.try_borrow() {
+            Ok(ref_) => { Ok(ref_.get_decrypt_nonce().to_vec()) },
+            Err(_e) => { Err(Error::new(get_ruby().get_inner(&BASE_ERROR), "borrow error")) }
+        }
     }
 
-    pub fn encrypt(&self, src: Vec<u8>) -> Vec<u8> {
-        let mut buffer = BytesMut::new();
+    pub fn stats(&self) -> Result<RHash, Error> {
+        match self.0.try_borrow() {
+            Ok(state) => {
+                let hash = RHash::new();
 
-        self.0.try_borrow_mut().unwrap().encrypt(src, &mut buffer);
+                let _ = hash.aset("good", state.get_good());
+                let _ = hash.aset("late", state.get_late());
+                let _ = hash.aset("lost", state.get_lost());
 
-        buffer.to_vec()
+                Ok(hash)
+            },
+            Err(_e) => {
+                Err(Error::new(get_ruby().get_inner(&BASE_ERROR), "borrow error"))
+            }
+        }
     }
 
-    pub fn decrypt(&self, encrypted: Vec<u8>) -> (Value, Vec<u8>) {
-        let mut buffer = BytesMut::new();
-        buffer.extend_from_slice(&encrypted);
+    pub fn encrypt(&self, src: Vec<u8>) -> Result<Vec<u8>, Error> {
+        match self.0.try_borrow_mut() {
+            Ok(mut state) => {
+                let mut buffer = BytesMut::new();
+                state.encrypt(src, &mut buffer);
 
-        let result = self.0.try_borrow_mut().unwrap().decrypt(&mut buffer);
+                Ok(buffer.to_vec())
+            },
+            Err(_e) => { Err(Error::new(get_ruby().get_inner(&BASE_ERROR), "borrow error")) }
+        }
+    }
 
-        // TODO: raise error
-        match result {
-            Ok(_)  => (*QTRUE, buffer.to_vec()),
-            Err(_) => (*QFALSE, vec![]),
+    pub fn decrypt(&self, encrypted: Vec<u8>) -> Result<Vec<u8>, Error> {
+        match self.0.try_borrow_mut() {
+            Ok(mut state) => {
+                let mut buffer = BytesMut::new();
+                buffer.extend_from_slice(&encrypted);
+
+                match state.decrypt(&mut buffer) {
+                    Ok(_) => Ok(buffer.to_vec()),
+                    Err(crypt_state::DecryptError::Repeat) => {
+                        Err(Error::new(get_ruby().get_inner(&BASE_ERROR), "DecryptError::Repeat"))
+                    },
+                    Err(crypt_state::DecryptError::Late) => {
+                        Err(Error::new(get_ruby().get_inner(&BASE_ERROR), "DecryptError::Late"))
+                    },
+                    Err(crypt_state::DecryptError::Mac) => {
+                        Err(Error::new(get_ruby().get_inner(&BASE_ERROR), "DecryptError::Mac"))
+                    },
+                    Err(crypt_state::DecryptError::Eof) => {
+                        Err(Error::new(get_ruby().get_inner(&BASE_ERROR), "DecryptError::Eof"))
+                    }
+                }
+            },
+            Err(_e) => { Err(Error::new(get_ruby().get_inner(&BASE_ERROR), "borrow error")) }
         }
     }
 }
 
+#[inline]
+fn get_ruby() -> Ruby {
+    unsafe { Ruby::get_unchecked() }
+}
+
 #[magnus::init]
 fn init() -> Result<(), Error> {
     let module = define_module("RbMumbleProtocol")?;
@@ -103,20 +164,3 @@ fn init() -> Result<(), Error> {
 
     Ok(())
 }
-
-#[test]
-fn encrypt_and_decrypt_are_inverse() {
-    let server_state = CryptStateRef::new();
-    // swap nonce vectors side to side
-    let client_state = CryptStateRef::new_from(
-        server_state.key(),
-        server_state.decrypt_nonce(),
-        server_state.encrypt_nonce()
-    );
-
-    let src= "test".as_bytes().to_vec();
-    let encrypted= server_state.encrypt(src.clone());
-    let result= client_state.decrypt(encrypted.clone());
-
-    assert_eq!(src, result);
-}

data/lib/rb_mumble_protocol/crypt_state.rb

@@ -1,6 +1,9 @@
 # frozen_string_literal: true
 
 module RbMumbleProtocol
+  class Error < StandardError
+  end
+
   class CryptState
   end
 end

data/lib/rb_mumble_protocol/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rb_mumble_protocol
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Mikhail Odebe
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-23 00:00:00.000000000 Z
+date: 2024-02-09 00:00:00.000000000 Z
 dependencies: []
 description: Gem that providing classes for implementing Mumble-related projects.
 email: