obfuskit 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1bf83c6351238774e0cd0f479d2aeb033d6e06bf61a0567f461951c76ea2f551
-  data.tar.gz: b1ef6d097ab410c3266ea9ef97b7ee04dd6e9cee053f85d0cd2f3085e7dc6db0
+  metadata.gz: 07c3f052a3c4ff566890a9cb72099b7f2cc9f6eab79a865b58e2de901d0963c5
+  data.tar.gz: 93b42f3091775a71366b4f70e93ef42114f08f5eddcd0275225f0e0d14f99464
 SHA512:
-  metadata.gz: cf47193804ca3fa28838b8d33d5f8e05965665c354b94a5651d8ca7e0ce0b9515758f84571664351efeae009116dc4fc9363bc28f1599ccdd3d1e1d0506c3e8f
-  data.tar.gz: 0a809262ff81d7c6df8656088867f575003ff519e521bdc3db38a775295a938d9ca05d4834c3bb6432151d1fc33d169d8810a51a8013a20b76f58c893490b804
+  metadata.gz: 337aaf034bf4afb7d41168254472376646876aa0e30ee609256f94c3cdf7c0974e83a2853f383bcfea719aceab0c5b2cde17bf8c90e1206a9dd78329b3caae1f
+  data.tar.gz: 83047860687ac6ab90b77958495deb0c06f20f676730a5d53199798340ef0b0102795fe065c6ef9696183435acd29c59e936363a60505c5c1d898d390aecf3a9

data/README.md

@@ -29,7 +29,12 @@ Common options:
 
 ### Swift
 
-To generate Swift code run the following command:
+To generate Swift code, run the following command:
+
+```sh
+obfuskit -l swift -k SECRET_1,SECRET_2 > generated.swift
+```
+
 It will create the file `generated.swift` containing an obfuscated version of the environment variables `SECRET_1` and `SECRET_2`. 
 This file should be excluded from the git repository and generated at build time. 
 The obfuscation salt is regenerated for each run.
@@ -49,7 +54,7 @@ enum ObfusKit {
 
 ### Kotlin 
 
-The same concept applies for the `kotlin` language using:
+The same concept applies to the Kotlin language using:
 
 ```sh
 obfuskit -l kotlin -p com.myapp.configuration.environment -k SECRET_1,SECRET_2 > generated.kt
@@ -69,23 +74,19 @@ object ObfusKit {
 // ...
 ```
 
-## Customizations
-
-### The output type name
+#### Android Code shrinking and Obfuscation
+Proguard/R8 changes class names and method names. This will break revealing secrets at run time.
+To prevent this, add the according rules to your `proguard-rules.pro` file or use the `--keep-annotation` parameter to inject a custom annotation like `@androidx.annotation.Keep` into the generated code.
 
-The default generated type name in the target language is `ObfusKit``. Customize this name with the `-t` option.
-Which will generate the Swift type `Secrets` instead of `ObfusKit`.
+For example:
 
-```swift
-import Foundation
-
-enum Secrets {
-// ..
+```sh
+obfuskit -l kotlin -p com.myapp.configuration.environment -k SECRET_1,SECRET_2 --keep-annotation @androidx.annotation.Keep > generated.kt
 ```
 
 ### Use a custom .env file location
 
-Use the `-e` option to define the path to a different `.env` file, e.g. if you want to reuse the `fastlane/.env` file.
+Use the `-e` option to define the path to a different `.env` file, e.g., if you want to reuse the `fastlane/.env` file.
 
 ```sh
 obfuskit -l swift -k SECRET_3,SECRET_4 -e fastlane/.env > generated.swift
@@ -94,7 +95,7 @@ obfuskit -l swift -k SECRET_3,SECRET_4 -e fastlane/.env > generated.swift
 ## Features
 - [x] Generate Swift
 - [x] Generate Kotlin
-- [x] Read secrets from the Environment 
+- [x] Read Secrets from the Environment 
 - [x] Add dynamic salt for obfuscation
 - [x] Support for .env files
 - [x] Use template engine for code generation

data/lib/obfuskit/generator.rb

@@ -25,10 +25,10 @@ module Obfuskit
         values = obfuscated_values_from_env(options.env_var_keys, obfuscator)
 
         if options.output_language == :swift
-          puts generate_with_template("swift", values, nil, options.output_type_name, obfuscator)
+          puts generate_with_template("swift", values, nil, options.output_type_name, obfuscator, options.keep_annotation)
 
         elsif options.output_language == :kotlin && !options.package_name.nil?
-          puts generate_with_template("kotlin", values, options.package_name, options.output_type_name, obfuscator)
+          puts generate_with_template("kotlin", values, options.package_name, options.output_type_name, obfuscator, options.keep_annotation)
 
         else
         STDERR.puts parser.parse(%w[--help])
@@ -47,7 +47,7 @@ module Obfuskit
       end.compact.to_h
     end
 
-    def generate_with_template(template_name, values, package, type_name, obfuscator)
+    def generate_with_template(template_name, values, package, type_name, obfuscator, keep_annotation)
       file = File.expand_path("templates/#{template_name}.erb", __dir__)
       template = ERB.new(File.read(file), trim_mode: "-")
       template.result_with_hash(
@@ -55,6 +55,7 @@ module Obfuskit
         package: package,
         type_name: type_name,
         salt: obfuscator.salt,
+        keep_annotation: keep_annotation
         )
     end
 

data/lib/obfuskit/options_parser.rb

@@ -4,7 +4,7 @@ require 'optparse'
 class OptionsParser
   class ScriptOptions
 
-    attr_accessor :output_language, :env_var_keys, :package_name, :output_type_name, :dot_env_file_path
+    attr_accessor :output_language, :env_var_keys, :package_name, :output_type_name, :dot_env_file_path, :keep_annotation
 
     def initialize
       self.output_language = nil
@@ -12,6 +12,7 @@ class OptionsParser
       self.package_name = nil
       self.output_type_name = "ObfusKit"
       self.dot_env_file_path = ".env"
+      self.keep_annotation = nil
     end
 
     def define_options(parser)
@@ -25,6 +26,7 @@ class OptionsParser
       package_name_option(parser)
       output_type_name_option(parser)
       dot_env_file_path_options(parser)
+      keep_annotation_options(parser)
 
       parser.separator ""
       parser.separator "Common options:"
@@ -75,6 +77,13 @@ class OptionsParser
         self.dot_env_file_path = value
       end
     end
+
+    def keep_annotation_options(parser)
+      parser.on("--keep-annotation [Annotation]", "Annotation to prevent key class obfuscation. e.g. @androidx.annotation.Kee
+") do |value|
+        self.keep_annotation = value
+      end
+    end
   end
 
   #

data/lib/obfuskit/templates/kotlin.erb

@@ -2,6 +2,7 @@ package <%= package %>
 
 public object <%= type_name %> {
   private val _o = O(<%= salt %>::class.java.simpleName)
+  <%= keep_annotation unless keep_annotation.nil? %>
   private class <%= salt %>
 
 <% values.each do |name, values| -%>

data/lib/obfuskit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Obfuskit
-  VERSION = "0.3.0"
+  VERSION = "0.4.0"
 end

data/sig/options_parser/script_options.rbs

@@ -3,6 +3,7 @@ module OptionsParser
     attr_accessor dot_env_file_path: String
     attr_accessor dot_env_file_paths: [String]
     attr_accessor env_var_keys: [String]
+    attr_accessor keep_annotation: String?
     attr_accessor output_language: String?
     attr_accessor output_type_name: String
     attr_accessor package_name: String?
@@ -13,6 +14,7 @@ module OptionsParser
 
     def dot_env_file_path_options: -> OptionParser
     def env_var_keys_option: -> OptionParser
+    def keep_annotation_options: -> OptionParser
     def output_language_option: -> OptionParser
     def output_type_name_option: -> OptionParser
     def package_name_option: -> OptionParser

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: obfuskit
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Martin Gratzer
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-04-02 00:00:00.000000000 Z
+date: 2024-04-22 00:00:00.000000000 Z
 dependencies: []
 description: Generate Swift and Kotlin files with obfuscated environment variables.
 email: mgratzer@gmail.com