secure-keys 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e1c55d0d0f427de2248176c7b637d099d707c49802d6e3ef2b726e0d3e2383a8
-  data.tar.gz: 6cbc1fcdc0a67dce1101ef372849d11f19e1ce07bd48ac52d9c3c34cf2188fed
+  metadata.gz: 9bb9a148f4ac19f7be01927996960b0020bbcacbcf7fb7b96638782103f966e1
+  data.tar.gz: 558cb14cab97a77d118ef1b21f4c45501eb98a078d05e02e1898181d9cf7c214
 SHA512:
-  metadata.gz: 2a8e5c02474072f96dd7da0b61db861c313d8575e2bca0f42c57576f3081b58b7095fb47e17db01eff9ea5b756fac0be1e7d33351e5e4a143110640850fc6e69
-  data.tar.gz: f10ab748b3c5a74d4ef3b562ae555f5f6e1e93064fe25dc8a23fcfd185ab51baa08e148169a216d5694007ed8ddc0a760037d0b8c81b1233a4c9083a37ab515a
+  metadata.gz: df3de7c5d209a1b5d6f6193b1100d09ec5bfd74fb34ad67dd0612d31d72ba12d59b8ab2d340967ebea5db2090f92ad70d2e6bb3cba9638f99351cb404be5ad8c
+  data.tar.gz: 3f0b41426c81b87caa9326b81c92ef28bd508abae330813249c37ffe6cd43c1504d2310f77b463ae51d8079fe59b72a342d5e31ea9be64d5acba77db6a43e2c3

data/README.md

@@ -15,21 +15,40 @@ Utility to generate a `xcframework` for handling secure keys in iOS projects.
 
 - Ruby 3.3.6 or higher
 - iOS 13.0 or higher
+- macOS 11.0 or higher
 
 ### Installation
 
-Install gems using bundler
+You can install the `SecureKeys` utility using Homebrew using the following command:
 
 ```bash
-bundle install
+brew tap derian-cordoba/secure-keys
+
+brew install derian-cordoba/secure-keys/secure-keys
+```
+
+For more details, you can visit the [homebrew-secure-keys](https://github.com/derian-cordoba/homebrew-secure-keys) repository.
+
+Another way, you can install the `SecureKeys` utility using `gem` command:
+
+```bash
+gem install secure-keys
+```
+
+If you using `bundler` you can add the `secure-keys` gem to the `Gemfile`:
+
+```ruby
+gem 'secure-keys'
 ```
 
-If you don't have bundler installed, you can install it using:
+Then, you can install the gem using:
 
 ```bash
-gem install bundler
+bundle install
 ```
 
+For more information about the gem, you can visit the [secure-keys](https://rubygems.org/gems/secure-keys) page.
+
 ## Usage
 
 As first step, you need to determine the keys that you want to use in your iOS project. You can define the keys from Keychain or env variables.
@@ -95,21 +114,29 @@ export SECURE_KEYS_IDENTIFIER="github-token|api_key|firebaseToken"
 
 ### Ruby script
 
-To generate the `Keys.xcframework` use the `keys.rb` script with:
+To generate the `SecureKeys.xcframework` use the `secure-keys` command in the iOS project root directory.
+
+Using global gem:
 
 ```bash
-bundle exec ruby ./bin/keys.rb
+secure-keys
+```
+
+Using bundler:
+
+```bash
+bundle exec secure-keys
 ```
 
 ### iOS project
 
-Within the iOS project, you can use the `Keys` target dependency like:
+Within the iOS project, you can use the `SecureKeys` target dependency like:
 
 ```swift
-import Keys
+import SecureKeys
 
 // Using key directly in the code
-let apiKey = Keys.apiKey.decryptedValue
+let apiKey = SecureKey.apiKey.decryptedValue
 
 // Using key from `Key` enum
 let someKey: String = key(for: .someKey)
@@ -118,7 +145,7 @@ let someKey: String = key(for: .someKey)
 let someKey: String = key(.someKey)
 
 // Using raw value from `Key` enum
-let apiKey: Keys = "apiKey".secretKey
+let apiKey: SecureKey = "apiKey".secretKey
 
 // Using raw value from `Key` enum with decrypted value
 let apiKey: String = "apiKey".secretKey.decryptedValue
@@ -127,7 +154,7 @@ let apiKey: String = "apiKey".secretKey.decryptedValue
 let apiKey: String = .key(for: .apiKey)
 ```
 
-## How to install the `Keys.xcframework` in the iOS project
+## How to install the `SecureKeys.xcframework` in the iOS project
 
 1. From the iOS project, click on the project target, select the `General` tab, and scroll down to the `Frameworks, Libraries, and Embedded Content` section.
 
@@ -137,55 +164,56 @@ let apiKey: String = .key(for: .apiKey)
 
 ![Add Files](/docs/assets/add-xcframework-to-ios-project/second-step.png)
 
-3. Navigate to the `keys` directory and select the `Keys.xcframework` folder.
+3. Navigate to the `keys` directory and select the `SecureKeys.xcframework` folder.
 
-![Select Keys.xcframework](/docs/assets/add-xcframework-to-ios-project/third-step.png)
+![Select SecureKeys.xcframework](/docs/assets/add-xcframework-to-ios-project/third-step.png)
 
-> Now the `Keys.xcframework` is added to the iOS project.
+> Now the `SecureKeys.xcframework` is added to the iOS project.
 
-![Select Keys.xcframework](/docs/assets/add-xcframework-to-ios-project/third-step-result.png)
+![Select SecureKeys.xcframework](/docs/assets/add-xcframework-to-ios-project/third-step-result.png)
 
 4. Click on the `Build settings` tab and search for the `Search Paths` section.
 
 ![Search Paths](/docs/assets/add-xcframework-to-ios-project/fourth-step.png)
 
-> Add the path to the `Keys.xcframework` in the `Framework Search Paths` section.
+> Add the path to the `SecureKeys.xcframework` in the `Framework Search Paths` section.
 
 ```bash
 $(inherited)
-$(SRCROOT)/.keys
+$(SRCROOT)/.secure-keys
 ```
 
 ## How it works
 
 The process when the script is executed is:
 
-1. Create a `.keys` directory.
-2. Create a temporary `Swift Package` in the `.keys` directory.
+1. Create a `.secure-keys` directory.
+2. Create a temporary `Swift Package` in the `.secure-keys` directory.
 3. Copy the `Keys` source code to the temporary `Swift Package`.
 
-    ```swift
-    public enum Keys {
+   ```swift
+   public enum SecureKey {
+
+       // MARK: - Cases
 
-        // MARK: - Cases
+       case apiKey
+       case someKey
+       case unknown
 
-        case apiKey
-        case someKey
-        case unknown
+       // MARK: - Properties
 
-        // MARK: - Properties
+       /// The decrypted value of the key
+       public var decryptedValue: String {
+           switch self {
+               case .apiKey: [1, 2, 4].decrypt(key: [248, 53, 26], iv: [148, 55, 47], tag: [119, 81])
+               case .someKey: [1, 2, 4].decrypt(key: [248, 53, 26], iv: [148, 55, 47], tag: [119, 81])
+               case .unknown: fatalError("Unknown key \(rawValue)")
+           }
+       }
+   }
+   ```
 
-        /// The decrypted value of the key
-        public var decryptedValue: String {
-            switch self {
-                case .apiKey: [1, 2, 4].decrypt(key: [248, 53, 26], iv: [148, 55, 47], tag: [119, 81])
-                case .someKey: [1, 2, 4].decrypt(key: [248, 53, 26], iv: [148, 55, 47], tag: [119, 81])
-                case .unknown: fatalError("Unknown key \(rawValue)")
-            }
-        }
-    }
-    ```
-4. Generate the `Keys.xcframework` using the temporary `Swift Package`.
+4. Generate the `SecureKeys.xcframework` using the temporary `Swift Package`.
 5. Remove the temporary `Swift Package`.
 
 ## License

data/bin/{keys.rb → secure-keys}

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
 
 require 'bundler/setup'
+require 'dotenv/load'
 require_relative '../lib/keys'
 
 # Generate the keys
-Keys::Generator.new.setup
+SecureKeys::Generator.new.setup

data/lib/core/environment/ci.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-module Keys
+module SecureKeys
   module Core
     module Environment
       class CI

data/lib/core/environment/keychain.rb

@@ -2,7 +2,7 @@
 
 require 'osx_keychain'
 
-module Keys
+module SecureKeys
   module Core
     module Environment
       class Keychain
@@ -20,7 +20,7 @@ module Keys
         # @param key [String] the key of the keychain access item to fetch
         # @return [String] the value of the keychain access item
         def fetch(key:)
-          keychain[key, Keys::Globals.key_access_identifier]
+          keychain[key, SecureKeys::Globals.key_access_identifier]
         rescue StandardError
           puts "❌ Error fetching the key: #{key} from Keychain."
         end

data/lib/core/globals/globals.rb

@@ -1,6 +1,6 @@
 #!/usr/bin/env ruby
 
-module Keys
+module SecureKeys
   module Globals
     module_function
 

data/lib/core/utils/openssl/cipher.rb

@@ -4,7 +4,7 @@ require 'openssl'
 require 'base64'
 require 'securerandom'
 
-module Keys
+module SecureKeys
   module OpenSSL
     class Cipher
       private

data/lib/core/utils/swift/package.rb

@@ -2,7 +2,7 @@
 
 require_relative './swift'
 
-module Keys
+module SecureKeys
   module Swift
     class Package
       # Generate the Swift Package using the configured path

data/lib/core/utils/swift/swift.rb

@@ -1,17 +1,17 @@
 #!/usr/bin/env ruby
 
-module Keys
+module SecureKeys
   module Swift
     # Constants
 
     # The name of the directory that contains the keys
-    KEYS_DIRECTORY = '.keys'.freeze
+    KEYS_DIRECTORY = '.secure-keys'.freeze
 
     # The name of the directory that contains the generated build
     BUILD_DIRECTORY = 'Build'.freeze
 
     # The name of the Swift Package
-    SWIFT_PACKAGE_NAME = 'Keys'.freeze
+    SWIFT_PACKAGE_NAME = 'SecureKeys'.freeze
 
     # The name of the directory that contains the generated Swift package
     SWIFT_PACKAGE_DIRECTORY = "#{KEYS_DIRECTORY}/Package".freeze

data/lib/core/utils/swift/writer.rb

@@ -3,7 +3,7 @@
 
 require_relative './swift'
 
-module Keys
+module SecureKeys
   module Swift
     class Writer
       private
@@ -70,7 +70,7 @@ module Keys
         ///
         /// - Returns: The decrypted value of the key
         @available(iOS 13.0, *)
-        public func key(for key: Keys) -> String { key.decryptedValue }
+        public func key(for key: SecureKey) -> String { key.decryptedValue }
 
         /// Fetch the decrypted value of the key
         ///
@@ -79,13 +79,13 @@ module Keys
         ///
         /// - Returns: The decrypted value of the key
         @available(iOS 13.0, *)
-        public func key(_ key: Keys) -> String { key.decryptedValue }
+        public func key(_ key: SecureKey) -> String { key.decryptedValue }
 
-        // MARK: - Keys enum
+        // MARK: - SecureKey enum
 
         /// Keys is a class that contains all the keys that are used in the application.
         @available(iOS 13.0, *)
-        public enum Keys: String {
+        public enum SecureKey: String {
 
             // MARK: - Cases
 
@@ -111,15 +111,15 @@ module Keys
             }
         }
 
-        // MARK: - String extension for keys
+        // MARK: - String extension for secure keys
 
         @available(iOS 13.0, *)
         extension String {
 
             // MARK: - Methods
 
-            /// Fetch the key from the keys enum
-            public var secretKey: Keys { Keys(rawValue: self) ?? .unknown }
+            /// Fetch the key from the secure keys enum
+            public var secretKey: SecureKey { SecureKey(rawValue: self) ?? .unknown }
 
             /// Fetch the decrypted value of the key
             ///
@@ -127,7 +127,7 @@ module Keys
             ///    - key: The key to fetch the decrypted value for
             ///
             /// - Returns: The decrypted value of the key
-            public static func key(for key: Keys) -> String { key.decryptedValue }
+            public static func key(for key: SecureKey) -> String { key.decryptedValue }
         }
 
         // swiftlint:enable all

data/lib/core/utils/swift/xcframework.rb

@@ -3,7 +3,7 @@
 require_relative './swift'
 require_relative '../../globals/globals'
 
-module Keys
+module SecureKeys
   module Swift
     class XCFramework
       # Generate the XCFramework from the Swift package
@@ -12,7 +12,7 @@ module Keys
         # Currently this is failling with the following error:
         # "library with the identifier 'ios-arm64' already exists."
         %w[Release].each do |configuration|
-          Keys::Globals.ios_platforms.each do |platform|
+          SecureKeys::Globals.ios_platforms.each do |platform|
             generate_key_modules(configuration:, platform:)
             generate_key_libraries(configuration:, platform: platform[:path])
           end
@@ -44,8 +44,8 @@ module Keys
       def generate_key_libraries(configuration:, platform:)
         command = <<~BASH
           cd #{KEYS_DIRECTORY} &&
-          ar -crs #{BUILD_DIRECTORY}/#{configuration}-#{platform}/libKeys.a \
-            #{BUILD_DIRECTORY}/#{configuration}-#{platform}/Keys.o
+          ar -crs #{BUILD_DIRECTORY}/#{configuration}-#{platform}/lib#{SWIFT_PACKAGE_NAME}.a \
+            #{BUILD_DIRECTORY}/#{configuration}-#{platform}/#{SWIFT_PACKAGE_NAME}.o
         BASH
 
         system(command)
@@ -71,8 +71,8 @@ module Keys
         # Currently this is failling with the following error:
         # "library with the identifier 'ios-arm64' already exists."
         %w[Release].map do |configuration|
-          Keys::Globals.ios_platforms.map do |platform|
-            "-library #{BUILD_DIRECTORY}/#{configuration}-#{platform[:path]}/libKeys.a"
+          SecureKeys::Globals.ios_platforms.map do |platform|
+            "-library #{BUILD_DIRECTORY}/#{configuration}-#{platform[:path]}/lib#{SWIFT_PACKAGE_NAME}.a"
           end.join(' ')
         end.join(' ')
       end

data/lib/keys.rb

@@ -9,7 +9,7 @@ require_relative './core/utils/swift/swift'
 require_relative './core/utils/swift/xcframework'
 require_relative './core/utils/openssl/cipher'
 
-module Keys
+module SecureKeys
   class Generator
     private
 
@@ -21,23 +21,23 @@ module Keys
       # If the secure keys identifier is not set, set it to 'secure-keys'
       ENV['SECURE_KEYS_IDENTIFIER'] = 'secure-keys' unless ENV.key?('SECURE_KEYS_IDENTIFIER')
 
-      puts "🔔 You're using a custom delimiter '#{Keys::Globals.key_delimiter}'" unless Keys::Globals.key_delimiter.eql?(Keys::Globals.default_key_delimiter)
-      puts "🔔 You're using a custom key access identifier '#{Keys::Globals.key_access_identifier}'" unless Keys::Globals.key_access_identifier.eql?(Keys::Globals.default_key_access_identifier)
+      puts "🔔 You're using a custom delimiter '#{SecureKeys::Globals.key_delimiter}'" unless SecureKeys::Globals.key_delimiter.eql?(SecureKeys::Globals.default_key_delimiter)
+      puts "🔔 You're using a custom key access identifier '#{SecureKeys::Globals.key_access_identifier}'" unless SecureKeys::Globals.key_access_identifier.eql?(SecureKeys::Globals.default_key_access_identifier)
 
       # Configure cipher
-      self.cipher = Keys::OpenSSL::Cipher.new
+      self.cipher = SecureKeys::OpenSSL::Cipher.new
 
       # Configure the secret source based on the environment
-      if Keys::Globals.ci?
-        self.secrets_source = Keys::Core::Environment::CI.new
+      if SecureKeys::Globals.ci?
+        self.secrets_source = SecureKeys::Core::Environment::CI.new
       else
-        self.secrets_source = Keys::Core::Environment::Keychain.new
+        self.secrets_source = SecureKeys::Core::Environment::Keychain.new
       end
 
       # Define the keys that we want to map
-      self.secret_keys = secrets_source.fetch(key: Keys::Globals.key_access_identifier)
+      self.secret_keys = secrets_source.fetch(key: SecureKeys::Globals.key_access_identifier)
                                        .to_s
-                                       .split(Keys::Globals.key_delimiter)
+                                       .split(SecureKeys::Globals.key_delimiter)
                                        .map(&:strip)
 
       # Add the keys that we want to map
@@ -52,14 +52,14 @@ module Keys
     def setup
       pre_actions
 
-      package = Keys::Swift::Package.new
+      package = SecureKeys::Swift::Package.new
       package.generate
 
-      writer = Keys::Swift::Writer.new(mapped_keys: mapped_keys,
-                                       secure_key_bytes: cipher.secure_key_bytes)
+      writer = SecureKeys::Swift::Writer.new(mapped_keys: mapped_keys,
+                                             secure_key_bytes: cipher.secure_key_bytes)
       writer.write
 
-      xcframework = Keys::Swift::XCFramework.new
+      xcframework = SecureKeys::Swift::XCFramework.new
       xcframework.generate
 
       post_actions
@@ -69,15 +69,15 @@ module Keys
 
     def pre_actions
       # Remove the keys directory
-      system("rm -rf #{Keys::Swift::KEYS_DIRECTORY}")
+      system("rm -rf #{SecureKeys::Swift::KEYS_DIRECTORY}")
     end
 
     def post_actions
       # Remove the keys directory
-      system("rm -rf #{Keys::Swift::SWIFT_PACKAGE_DIRECTORY}")
+      system("rm -rf #{SecureKeys::Swift::SWIFT_PACKAGE_DIRECTORY}")
 
       # Remove the build directory
-      system("rm -rf #{Keys::Swift::KEYS_DIRECTORY}/#{Keys::Swift::BUILD_DIRECTORY}")
+      system("rm -rf #{SecureKeys::Swift::KEYS_DIRECTORY}/#{SecureKeys::Swift::BUILD_DIRECTORY}")
     end
   end
 end

data/lib/version.rb

@@ -1,7 +1,8 @@
 #!/usr/bin/env ruby
 
-module Keys
-  VERSION = '1.0.0'.freeze
-  SUMMARY = 'Keys is a simple tool for managing your secret keys'.freeze
-  DESCRIPTION = 'Keys is a simple tool to manage your secret keys in iOS your project'.freeze
+module SecureKeys
+  VERSION = '1.1.1'.freeze
+  SUMMARY = 'Secure Keys is a simple tool for managing your secret keys'.freeze
+  DESCRIPTION = 'Secure Keys is a simple tool to manage your secret keys in your iOS project'.freeze
+  HOMEPAGE_URI = 'https://github.com/DerianCordobaPerez/secure-keys-generator'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: secure-keys
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Derian Córdoba
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-02-16 00:00:00.000000000 Z
+date: 2025-02-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: base64
@@ -38,6 +38,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.2.0
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.1.7
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
@@ -80,11 +94,11 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 1.71.2
-description: Keys is a simple tool to manage your secret keys in iOS your project
+description: Secure Keys is a simple tool to manage your secret keys in your iOS project
 email:
 - derianricardo451@gmail.com
 executables:
-- keys.rb
+- secure-keys
 extensions: []
 extra_rdoc_files: []
 files:
@@ -99,15 +113,20 @@ files:
 - "./lib/keys.rb"
 - "./lib/version.rb"
 - README.md
-- bin/keys.rb
+- bin/secure-keys
 homepage: https://github.com/DerianCordobaPerez/secure-keys-generator
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/DerianCordobaPerez/secure-keys-generator/issues
+  documentation_uri: https://github.com/DerianCordobaPerez/secure-keys-generator/blob/main/README.md
+  homepage_uri: https://github.com/DerianCordobaPerez/secure-keys-generator
+  source_code_uri: https://github.com/DerianCordobaPerez/secure-keys-generator
+  changelog_uri: https://github.com/DerianCordobaPerez/secure-keys-generator/releases
 post_install_message:
 rdoc_options: []
 require_paths:
-- lib
+- "*/lib"
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -122,5 +141,5 @@ requirements: []
 rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
-summary: Keys is a simple tool for managing your secret keys
+summary: Secure Keys is a simple tool for managing your secret keys
 test_files: []