secret_string 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f912f9e56675854f647fb6a965c6e3cfac83e999827249cdac00bbe096c3fc8
-  data.tar.gz: dc352220e6220adc7555be9064855990f6171938621634db7eca177bf6ede15f
+  metadata.gz: 6a3f2a2c2ed72f290759aaa09d8319f2b8493ad872f2842b9b00f93db0f3023c
+  data.tar.gz: 1db00c50a1469d3851b8e0e90dcb56fe5a75a031a3662ffb615bb4db13fb5c77
 SHA512:
-  metadata.gz: 18344af3842f3a6e1198bb29b85165ac8dd72a5b9de990a6c4d690882792b63b8cd29c2440293bbdefc7b3b1980334b0fba3da053f302d708ee1348451a9d4f7
-  data.tar.gz: 20a5236e50e545c04df1e8de38187c92386dde543b76888681d3209fe9a05e46aa2dc38faa24b806523c034e899e250ecac9a7f351c91339f693001393b69f5c
+  metadata.gz: 99b41639952e0dad4f9e79c64481c80d824d70458e13943ea35ddc7db89a4fa543cc50190b6b1d8ea055977c09a78d15beb042316fbb2ed4008281825c150ab3
+  data.tar.gz: 82dfaf0c8dda03b3f411be18d542123c4caca4faed322cfe3034ca785788c08305c0a44860fd558e5affa680cc5cae77bb1af5f33247cc38b025a42f4655a2a7

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+# [v1.1.1](https://github.com/Muriel-Salvan/secret_string/compare/v1.1.0...v1.1.1) (2021-08-13 09:59:55)
+
+### Patches
+
+* [[Fix] [#2] Handle frozen strings with correct exception messages before using them](https://github.com/Muriel-Salvan/secret_string/commit/b3e21e57613a6d39feca2118d272264cb77bdb5f)
+
 # [v1.1.0](https://github.com/Muriel-Salvan/secret_string/compare/v1.0.1...v1.1.0) (2021-07-07 10:21:42)
 
 ### Features

data/lib/secret_string.rb

@@ -12,6 +12,8 @@ class SecretString
     # Parameters::
     # * *secret* (String): The secret to erase from memory
     def erase(secret)
+      raise 'Can\'t erase a frozen string' if secret.frozen?
+
       secret_size = secret.bytesize
       io = StringIO.new("\0" * secret_size)
       io.read(secret_size, secret)
@@ -21,16 +23,20 @@ class SecretString
     # Make sure the String will be erased at the end of its access.
     #
     # Parameters::
-    # * *str* (String): String to protect
+    # * *str* (String): String to protect, unfrozen
     # * *silenced_str* (String): The protected representation of this string [default: 'XXXXX']
     # * Proc: Code called with the string secured
     #   * Parameters::
     #     * *secretstring* (SecretString): The secret string
     def protect(str, silenced_str: 'XXXXX')
-      secret_string = SecretString.new(str, silenced_str: silenced_str)
-      yield secret_string
-    ensure
-      secret_string.erase
+      raise 'Can\'t protect a frozen string' if str.frozen?
+
+      begin
+        secret_string = SecretString.new(str, silenced_str: silenced_str)
+        yield secret_string
+      ensure
+        secret_string.erase
+      end
     end
 
   end
@@ -38,9 +44,11 @@ class SecretString
   # Constructor
   #
   # Parameters::
-  # * *str* (String): The original string to protect
+  # * *str* (String): The original string to protect, unfrozen
   # * *silenced_str* (String): The silenced representation of this string [default: 'XXXXX']
   def initialize(str, silenced_str: 'XXXXX')
+    raise 'Can\'t silence a frozen string' if str.frozen?
+
     @str = str
     # Make sure we manipulate @str without cloning or modifying it from now on.
     @silenced_str = silenced_str

data/lib/secret_string/version.rb

@@ -1,5 +1,5 @@
 class SecretString
 
-  VERSION = '1.1.0'
+  VERSION = '1.1.1'
 
 end

data/spec/secret_string_test/tests/secret_string_spec.rb

@@ -39,6 +39,14 @@ describe SecretString do
 
   end
 
+  context 'with a silenced frozen string' do
+
+    it 'fails to initialize a secret string frozen' do
+      expect { described_class.new('MySecret'.freeze, silenced_str: 'SilencedString') }.to raise_error 'Can\'t silence a frozen string'
+    end
+
+  end
+
   describe 'erase' do
 
     it 'erases a String' do
@@ -47,6 +55,11 @@ describe SecretString do
       expect(str).not_to eq 'MySecret'
     end
 
+    it 'fails to erase a frozen String' do
+      str = 'MySecret'.freeze
+      expect { described_class.erase(str) }.to raise_error 'Can\'t erase a frozen string'
+    end
+
   end
 
   describe 'protect' do
@@ -61,6 +74,17 @@ describe SecretString do
       expect(str.to_s).not_to eq 'MySecret'
     end
 
+    it 'fails to protect a frozen String' do
+      str = 'MySecret'.freeze
+      called = false
+      expect do
+        described_class.protect(str, silenced_str: 'SilencedString') do
+          called = true
+        end
+      end.to raise_error 'Can\'t protect a frozen string'
+      expect(called).to eq false
+    end
+
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: secret_string
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Muriel Salvan
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-07 00:00:00.000000000 Z
+date: 2021-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -72,9 +72,9 @@ email:
 executables: []
 extensions: []
 extra_rdoc_files:
+- CHANGELOG.md
 - README.md
 - LICENSE.md
-- CHANGELOG.md
 files:
 - CHANGELOG.md
 - LICENSE.md