zindosteg 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 01ac48210a386fca7fec50d18a609ced3f2122f0087f1fc6ead5a14970e89968
-  data.tar.gz: 4d11432c88bb155006a58f9f9dda92d292afb7dd5a4b671cf086b5a54467cc69
+  metadata.gz: da3d49d90deedb647630359804b4e4084cffd09aafd7303ff2a665d4fe8362af
+  data.tar.gz: 9d3a191d8902d02b76a01fb71305d2775182dfde70442ba0587205426e193b17
 SHA512:
-  metadata.gz: '06884588dc026719a0e8f86774075432e18a459f7aa586677499bfcce31d5664705e1d06eeab09f52ddf4f8126a50e15fc26acda500c852309d7532ae87285d9'
-  data.tar.gz: c860ce6d6f4c160fcf6d5b02066b661777fd41abde8189b5affc9a0b8eef3785e8a608f1a09079001ce3d94d2bb20d346ab92557d7836ca25cd3d66003b4ba24
+  metadata.gz: 3466eb92d860d7313d91ed171c79ee4054c2a96ed3aef6eaa00948516ebfb77ddd3d517c322284f347c4f64d8e134e52d8cad5a51b7272d98c97adc378c34768
+  data.tar.gz: 6babf9e1c764d6d6d67a49be513818f156031360cafb85e6397f6fb2f8391c11097d76c11358e2f72570e8dd1cd8a6eb7452acb2e52dfed807b462996420d906

data/README.md

@@ -13,6 +13,7 @@ This gem is a Ruby interface to the Zindosteg C++ library, which uses a variant
 Zindosteg supports JPEG, PNG, and BMP carrier files. PNG files must have at least 8 bit depth, and not be "palette" type. BMP files must be 24-bit.
 
 ## Installation
+Note: To compile the native extensions, you may need to install JPEG, PNG, and OpenSSL development packages.
 
 Add this line to your application's Gemfile:
 
@@ -28,13 +29,11 @@ Or install it yourself as:
 
     $ gem install zindosteg
 
-Note: To compile the native extensions, you may need to install JPEG, PNG, and OpenSSL development packages.
-
 ## Usage
 Zindosteg is designed to mimic Ruby's `File` class as closely as possible. The basic idea is that you get a `Zindosteg` instance by "opening" the carrier file with a password. Then you can read and write to the `Zindosteg` object in the same way you normally would to a `File` object, using the same methods (e.g. `read`, `write`, `readlines`, `eof?`, `seek`, `tell`, etc.). You can even pass the `Zindosteg` instance to functions that expect `File` objects and everything should work.
 
 ### Examples
-```
+```ruby
 # Open a new carrier for writing (overwriting any existing payload)
 file = ::Zindosteg::File.open("carrier.jpeg", "secretpassword", "w")
 
@@ -63,7 +62,7 @@ file.size
 file.eof?
 # etc
 
-# Use the `capacity` method to see the maximum number of bytes that the carrier file can hide.
+# Use the 'capacity' method to see the maximum number of bytes that the carrier file can hide.
 file.capacity
 
 # All the standard modes for opening files are supported:
@@ -73,8 +72,18 @@ file = ::Zindosteg::File.open("carrier.jpeg", "secretpassword", "a") # Opens for
 
 # etc
 
-# If you open for reading (or appending) and either (1) an incorrect password is given, or (2) there is no existing payload, or (3) the carrier file has been corrupted or tampered with, then a exception will be thrown.
+# If you open for reading (or appending) and either
+#  (1) an incorrect password is given, or
+#  (2) there is no existing payload, or
+#  (3) the carrier file has been corrupted or tampered with
+# then a "RuntimeError (HMAC verification failure.)" exception will be thrown.
+
+# Shortcuts
+# Insert a payload file into a carrier file in one line:
+::Zindosteg.insert(carrier_path, password, payload_path)
 
+# Extract a payload from a carrier in one line:
+::Zindosteg.extract(carrier_path, password, payload_path)
 ```
 
 ## Development

data/ext/zindosteg/zindosteg.cpp

@@ -661,9 +661,10 @@ namespace {
 extern "C" void Init_zindosteg()
 {
   Module rb_cModule = define_module("Zindosteg");
+  register_handler<rubyError>(handle_ruby_error);
+
   Data_Type<device_interface> rb_cZindosteg =
     define_class_under<device_interface>(rb_cModule, "File")
-    .add_handler<rubyError>(handle_ruby_error)
     .define_constructor(Constructor<device_interface, std::string, std::string, std::string>(), Arg("carrier"), Arg("password"), Arg("mode") = "r"s)
     .define_method("<<", &device_interface::write)
     .define_method("autoclose?", &device_interface::autoclose)

data/lib/zindosteg/version.rb

@@ -1,3 +1,3 @@
 module Zindosteg
-  VERSION = "1.0.0"
+  VERSION = "1.0.1"
 end

data/zindosteg.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |spec|
   spec.email         = ["nephi.allred@gmail.com"]
 
   spec.summary       = %q{Basic steganography}
-  spec.description   = %q{Hide and encrypt data inside JPG, PNG, and BMP files.}
+  spec.description   = %q{Use steganography to hide and encrypt data inside JPG, PNG, and BMP files.}
   spec.homepage      = "https://github.com/zindorsky/zindosteg-ruby"
   spec.license       = "MIT"
   spec.required_ruby_version = Gem::Requirement.new(">= 2.7.0")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: zindosteg
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Nephi Allred
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-01-22 00:00:00.000000000 Z
+date: 2023-08-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake-compiler
@@ -38,7 +38,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.0'
-description: Hide and encrypt data inside JPG, PNG, and BMP files.
+description: Use steganography to hide and encrypt data inside JPG, PNG, and BMP files.
 email:
 - nephi.allred@gmail.com
 executables: []
@@ -101,7 +101,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.4.10
 signing_key:
 specification_version: 4
 summary: Basic steganography