dry-credentials 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 24deb6ca2d926a11c530c6e81821af802fe1ac36e4fafb8c2273619afdd4ff8e
-  data.tar.gz: 5be212ecb261ab3134b80f14d93a8ca9b7492be642b7a129b16239b0b727410f
+  metadata.gz: 80d0cd76bf93e1c24651a2f55d9b2ca8493a33aab603e97bcf68db5ad1b3d88a
+  data.tar.gz: 14e831c767bb3b4b302b6cd042af12af3ebc21402290c9311773572ffd39dbf0
 SHA512:
-  metadata.gz: a4e0f03fa13561dbc97b110b2d3f660889f0fe76d98615b981af07bf5b44481669f9b176692f77508d71d3629a8cf05c98262601cef5db4a5ee04b0d04de158a
-  data.tar.gz: a0258c2537012e92dfa82ec88d1881a740d04eb9fae617fbafc79a3dabb9e0ff526e51856218a0316c5d99a1c357edb681d404cd2f831f7f79e183659de2dde3
+  metadata.gz: 0057adafdb86c53b705125c7ef9317673010633b41a3856d1ac3cd27fd050925d0a8ded61b92b13e13bff9edbe3c7d85937445ec4a1aa9d07f627a4a6f5d135e
+  data.tar.gz: 46f17ca1795ad86c964fa78605b02c84a36c598cd1466823dac843181fb79d71b2f9a162c3cfea3482a80105d9a5543cf9da6c2b34fab5cf2facca939506afd4

data/CHANGELOG.md

@@ -2,9 +2,19 @@
 
 Nothing so far
 
+## 0.2.0
+
+#### Breaking Changes
+
+* Fall back to `APP_ENV` instead of `RACK_ENV`
+
+#### Fixes
+
+* Don't re-encrypt if credentials haven't been modified
+
 ## 0.1.0
 
-#### Initial implementation
+#### Initial Implementation
 
 * Require Ruby 3.0 or newer
 * Class mixin featuring the `credentials` macro:

data/README.md

@@ -108,7 +108,7 @@ App.credentials.otp.meta.realm
 
 Credentials are isolated into environments which most likely will, but don't necessarily have to align with the environments of the app framework you're using.
 
-By default, the current environment is read from `RACK_ENV`.
+By default, the current environment is read from `APP_ENV`. You shouldn't use `RACK_ENV` for this, [here's why](https://github.com/rack/rack/issues/1546).
 
 ⚠️ For safety reasons, don't share the same key across multiple environments!
 
@@ -148,7 +148,7 @@ App.credentials[:env]   # => "production"
 
 Setting | Default | Description
 --------|---------|------------
-`env` | `-> { ENV["RACK_ENV"] }` | environment such as `development`
+`env` | `-> { ENV["APP_ENV"] }` | environment such as `development`
 `dir` | `"config/credentials"` | directory where encrypted credentials are stored
 `cipher` | `"aes-256-gcm"` | any of `OpenSSL::Cipher.ciphers`
 `digest` | `"sha256"` | sign digest used if the cipher doesn't support AEAD
@@ -164,4 +164,4 @@ bundle exec rake    # run tests once
 bundle exec guard   # run tests whenever files are modified
 ```
 
-You're welcome to [submit issues](https://github.com/svoop/dry-credentials/issues) and contribute code by [forking the project and submitting pull requests](https://docs.github.com/en/get-started/quickstart/fork-a-repo).
+You're welcome to join the [discussion forum](https://github.com/svoop/dry-credentials/discussions) to ask questions or drop feature ideas, [submit issues](https://github.com/svoop/dry-credentials/issues) you may encounter or contribute code by [forking this project and submitting pull requests](https://docs.github.com/en/get-started/quickstart/fork-a-repo).

data/lib/dry/credentials/encryptor.rb

@@ -12,8 +12,6 @@ module Dry
       DEFAULT_SERIALIZER = Marshal
       SEPARATOR = '--'
 
-      attr_reader :cipher
-
       # @param cipher [String] any of +OpenSSL::Cipher.ciphers+
       # @param digest [String] any of +openssl list+
       # @param serializer [Class] must respond to +dump+ and +load+
@@ -22,12 +20,12 @@ module Dry
         @digest, @serializer = digest, serializer
       end
 
-      # Generate a random key with the length requird by the current cipher,
+      # Generate a random key with the length required by the current cipher,
       # then Base64 encodes and unpacks all bytes to hex.
       #
       # @return [String] key
       def generate_key
-        unpack(encode(SecureRandom.bytes(cipher.key_len)))
+        unpack(encode(SecureRandom.bytes(@cipher.key_len)))
       end
 
       # Encrypts the object
@@ -39,15 +37,15 @@ module Dry
       # @param key [String] key (Base64 encoded and unpacked to hex)
       # @return [String] encrypted and authenticated/signed string
       def encrypt(object, key:)
-        cipher.encrypt
-        cipher.key = decoded_key = decode(pack(key.strip))
-        iv = cipher.random_iv
-        cipher.auth_data = '' if aead?
-        cipher.update(@serializer.dump(object)).then do |data|
-          data << cipher.final
+        @cipher.encrypt
+        @cipher.key = decoded_key = decode(pack(key.strip))
+        iv = @cipher.random_iv
+        @cipher.auth_data = '' if aead?
+        @cipher.update(@serializer.dump(object)).then do |data|
+          data << @cipher.final
           data = encode(data) + SEPARATOR + encode(iv)
           data << SEPARATOR + if aead?
-            encode(cipher.auth_tag)
+            encode(@cipher.auth_tag)
           else
             hmac(decoded_key, data)
           end
@@ -60,8 +58,8 @@ module Dry
       # @param key [String] key (Base64 encoded and unpacked to hex)
       # @return [Object] verified and decrypted object
       def decrypt(encrypted_object, key:)
-        cipher.decrypt
-        cipher.key = decoded_key = decode(pack(key.strip))
+        @cipher.decrypt
+        @cipher.key = decoded_key = decode(pack(key.strip))
         payload, iv, auth_tag = encrypted_object.strip.split(SEPARATOR)
         if auth_tag.nil? ||
           (aead? && decode(auth_tag).bytes.length != auth_tag_length) ||
@@ -69,13 +67,13 @@ module Dry
         then
           fail Dry::Credentials::InvalidEncryptedObjectError
         end
-        cipher.iv = decode(iv)
+        @cipher.iv = decode(iv)
         if aead?
-          cipher.auth_tag = decode(auth_tag)
-          cipher.auth_data = ''
+          @cipher.auth_tag = decode(auth_tag)
+          @cipher.auth_data = ''
         end
-        cipher.update(decode(payload)).then do |data|
-          data << cipher.final
+        @cipher.update(decode(payload)).then do |data|
+          data << @cipher.final
           @serializer.load(data)
         end
       rescue OpenSSL::Cipher::CipherError, TypeError, ArgumentError
@@ -112,7 +110,7 @@ module Dry
       # Associated Data) or not - in which case a HMAC signature using the
       # +digest+ is used instead
       def aead?
-        @auth ||= cipher.authenticated?
+        @auth ||= @cipher.authenticated?
       end
 
       def hmac(key, string)

data/lib/dry/credentials/extension.rb

@@ -36,13 +36,15 @@ module Dry
       def edit!(env=nil)
         helpers = Dry::Credentials::Helpers.new(self, env)
         create = helpers.create?
-        yaml = helpers.read_yaml
+        yaml = read_yaml = helpers.read_yaml
         begin
           yaml = helpers.edit_yaml yaml
         end until helpers.yaml_valid? yaml
-        helpers.write_yaml yaml
-        puts [helpers.key_ev, ENV[helpers.key_ev]].join('=') if create
-        reload!
+        unless yaml == read_yaml
+          helpers.write_yaml yaml
+          puts [helpers.key_ev, ENV[helpers.key_ev]].join('=') if create
+          reload!
+        end
       end
 
       # Query settings

data/lib/dry/credentials/helpers.rb

@@ -75,7 +75,7 @@ module Dry
         if create?
           ENV[key_ev] = encryptor.generate_key
         else
-          ENV[key_ev]  or fail Dry::Credentials::KeyNotSetError
+          ENV[key_ev] or fail Dry::Credentials::KeyNotSetError
         end
       end
 

data/lib/dry/credentials/settings.rb

@@ -5,7 +5,7 @@ module Dry
     class Settings
 
       DEFAULT_SETTINGS = {
-        env: -> { ENV['RACK_ENV'] },
+        env: -> { ENV['APP_ENV'] },
         dir: 'config/credentials',
         cipher: 'aes-256-gcm',
         digest: 'sha256',

data/lib/dry/credentials/version.rb

@@ -2,6 +2,6 @@
 
 module Dry
   module Credentials
-    VERSION = "0.1.0"
+    VERSION = "0.2.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dry-credentials
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Sven Schwyn
@@ -29,7 +29,7 @@ cert_chain:
   kAyiRqgxF4dJviwtqI7mZIomWL63+kXLgjOjMe1SHxfIPo/0ji6+r1p4KYa7o41v
   fwIwU1MKlFBdsjkd
   -----END CERTIFICATE-----
-date: 2023-02-22 00:00:00.000000000 Z
+date: 2023-10-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: debug
@@ -74,7 +74,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest-sound
+  name: minitest-flash
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -203,7 +203,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.7
+rubygems_version: 3.4.21
 signing_key:
 specification_version: 4
 summary: A mixin to use encrypted credentials in your classes