obfuskit 0.1.2 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4780130a4c77f313d5ecb10479d96b739fcdc6bcc1f7199bd847b27783b89848
-  data.tar.gz: f95871c0915fcf8cbacf5c02930bda78ed39cc2dee886450857b1cc72c7324b3
+  metadata.gz: f13c1d6e89c565ef55077edab6aeadaf16396a142887df8ccb8fc9e4c1939177
+  data.tar.gz: 281bc1d8a5517df52e6f71af31edd5430d52abc5f1a01e953b431c3c5f8f4cee
 SHA512:
-  metadata.gz: a14410ebaad463c3672d1d18f447112e5e6180552977525d110b1c19ebd58a68e79685f4560849c9b86dca3573c13bb51ae98e1ea6939840045754037a8dd391
-  data.tar.gz: 87f6d65646ef72825b6bc3a4f75437ca6b26dd68ead31978ec0663bfac917669946a753ee026cfb053f4385947a1272cf9200b781ac8497461d5ff9d3664c1ea
+  metadata.gz: 30d4652e43f1440ffc36b7c90541523719d0f7bb21f8d5d405571b1021f7f763ad6f4963ad2fb8e44532af1e47a9d72da547464b028369351aa512a955982532
+  data.tar.gz: 7fe5c1cfe3eaaf5ff2a11d0fd8d40d023bf4ccf6f8a2aefee2d77288437161e8975651697ee60ca1e5bbf2930a98e5328512cf2dafba34e08eb49ed107612561

data/README.md

@@ -62,5 +62,5 @@ class O{private val a:ByteArray;private val b:Int;constructor(s:String){a=s.toBy
 - [x] Read secrets from the Environment 
 - [x] Add dynamic salt for obfuscation
 - [x] Support for .env files
-- [ ] Use template engine for code generation
+- [x] Use template engine for code generation
 - [ ] Read secrets from 1Password CLI

data/lib/obfuskit/generator.rb

@@ -2,6 +2,7 @@
 require_relative 'obfuscator'
 require 'securerandom'
 require 'dotenv'
+require 'erb'
 
 module Language
   SWIFT = "Swift"
@@ -16,7 +17,7 @@ module Obfuskit
 
       Dotenv.load
       args = ARGV
-      first_arg = args.shift
+      language_key = args.shift.downcase
 
       language_map = {
         "swift" => Language::SWIFT,
@@ -24,90 +25,56 @@ module Obfuskit
         "kt" => Language::KOTLIN
       }
 
-      if first_arg != nil && language_map.key?(first_arg.downcase)
+      if language_key != nil && language_map.key?(language_key)
 
-        # Generate a random UUID and remove the hyphens
-        obfuscation_salt = SecureRandom.uuid.to_s.gsub("-", "")
-        # Create a new instance of the O class with the obfuscation salt
-        obfuscator = Obfuscator.new("_" + obfuscation_salt)
+        salt = SecureRandom.uuid.to_s.gsub("-", "")
+        obfuscator = Obfuscator.new("_" + salt)
 
-        case language_map[first_arg]
+        case language_map[language_key]
         when Language::SWIFT
           puts generate_swift(args, obfuscator)
+
         when Language::KOTLIN
           puts generate_kotlin(args, obfuscator)
         end
+
       else
-        puts "First argument is not a valid language. Use `swift` or `kotlin`."
+        STDERR.puts "Please specify a valid language."
       end
     end
 
     private
-    # Function to generate Swift code
+
     def generate_swift(args, obfuscator)
-      # Start building the Swift code
-      code = "import Foundation\n\n"
-      code += "enum ObfusKit {\n"
-      # For each argument, if it's in the environment variables, add it to the code
-      args.each_with_index do |arg, index|
-        if ENV[arg] != nil
-          code += "\tstatic let #{arg}: String = _o.r(#{obfuscator.obfuscate(ENV[arg])})\n"
-        end
-      end
-      code += "\n"
-      # Add the obfuscation salt and the obfuscator to the code
-      code += <<-STRING
-\tprivate class _#{obfuscator.salt} { }
-\tprivate static let _o = O(String(describing: _#{obfuscator.salt}.self))
-}\n\n
-STRING
-
-      # Add the obfuscator source code to the code
-      code += 'struct O { private let c: [UInt8]; private let l: Int; init(_ s: String) { self.init([UInt8](s.utf8)) }; init(_ c: [UInt8]) { self.c = c; l = c.count }; @inline(__always) func o(_ v: String) -> [UInt8] { [UInt8](v.utf8).enumerated().map { $0.element ^ c[$0.offset % l] } }; @inline(__always) func r(_ value: [UInt8]) -> String { String(bytes: value.enumerated().map { $0.element ^ c[$0.offset % l] }, encoding: .utf8) ?? "" } }'
-      # Return the generated code
-      return code
+      values = obfuscated_values_from_env(args, obfuscator)
+      generate_with_template("swift", values, nil, obfuscator)
     end
 
-    # Function to generate Kotlin code
     def generate_kotlin(args, obfuscator)
-      # Get the first argument as the package name
       package = args.shift
-      # If no package name is provided, return an empty string
       if package == nil
-        puts "No package name provided."
-        return nil
-      end
-
-      # Start building the Kotlin code
-      code = "package #{package}\n\n"
-      code += "object ObfusKit {\n"
-      # Add the obfuscation salt and the obfuscator to the code
-      code += <<-STRING
-\tprivate val _o = O(_#{obfuscator.salt}::class.java.simpleName)
-\tprivate class _#{obfuscator.salt}\n
-STRING
-
-      # For each argument, if it's in the environment variables, add it to the code
-      args.each_with_index do |arg, index|
-        if ENV[arg] != nil
-          code += "\tval #{arg}: String = _o.r(byteArrayOf(#{obfuscator.obfuscate(ENV[arg]).map { |i| i.to_s }.join(', ')}))\n"
-        end
+        STDERR.puts "No package name provided."
+      else
+        values = obfuscated_values_from_env(args, obfuscator)
+        generate_with_template("kotlin", values, package, obfuscator)
       end
-      code += "}\n\n"
+    end
 
-      # Add the obfuscator source code to the code
-      code += 'class O{private val a:ByteArray;private val b:Int;constructor(s:String){a=s.toByteArray(Charsets.UTF_8);b=a.size};fun o(v:String):ByteArray{val d=v.toByteArray(Charsets.UTF_8);return ByteArray(d.size){i->(d[i].toInt() xor a[i%b].toInt()).toByte()}};fun r(value:ByteArray):String{return String(ByteArray(value.size){i->(value[i].toInt() xor a[i%b].toInt()).toByte()},Charsets.UTF_8)}}'
-      # Return the generated code
-      return code
+    def obfuscated_values_from_env(args, obfuscator)
+      args.map { |name|
+        ENV[name] != nil ? [name, obfuscator.obfuscate(ENV[name])] : nil
+      }.compact.to_h
     end
 
-    # Function to get the source code for the obfuscator
-    def obfuscator_source(file_name)
-      # Get the full path to the file
-      source_file_path = File.expand_path(file_name, __dir__)
-      # If the file exists, read and return its contents
-      return File.read(source_file_path) if File.exist?(source_file_path)
+    def generate_with_template(template_name, values, package, obfuscator)
+      file = File.expand_path("templates/#{template_name}.erb", __dir__)
+      template = ERB.new(File.read(file), trim_mode: "-")
+      template.result_with_hash(
+        values: values,
+        package: package,
+        salt: obfuscator.salt
+      )
     end
-  end
 
+  end
 end

data/lib/obfuskit/obfuscator.rb

@@ -4,31 +4,30 @@
 
 module Obfuskit
   class Obfuscator
-      # Initializes the obfuscator with a string.
-      # The string is converted to an array of bytes and stored in @c.
-      # The size of the array is stored in @l.
-      def initialize(salt)
-        salt = salt.bytes if salt.is_a? String
-        @salt = salt
-        @length = @salt.size
-      end
 
-      def salt
-        @salt
-      end
+    attr_reader :salt
 
-      # Obfuscates a string.
-      # The string is converted to an array of bytes and each element is XORed with an element from @c.
-      # The index of the element from @c is the index of the element from the string modulo @l.
-      def obfuscate(value)
-        value.bytes.map.with_index { |b, i| b ^ @salt[i % @length] }
-      end
+    # Initializes the obfuscator with a string.
+    # The string is converted to an array of bytes and stored in @c.
+    # The size of the array is stored in @l.
+    def initialize(salt)
+      @salt = salt || ""
+      @salt_bytes = (salt.bytes || []) if salt.is_a? String
+      @salt_length = @salt_bytes.size
+    end
 
-      # Reverses the obfuscation of an array of bytes.
-      # Each element is XORed with an element from @c and the result is converted back to a string.
-      # The index of the element from @c is the index of the element from the array modulo @l.
-      def reveal(value)
-        value.map.with_index { |b, i| b ^ @salt[i % @length] }.pack('C*').force_encoding('utf-8')
-      end
+    # Obfuscates a string.
+    # The string is converted to an array of bytes and each element is XORed with an element from @c.
+    # The index of the element from @c is the index of the element from the string modulo @l.
+    def obfuscate(value)
+      value.bytes.map.with_index { |b, i| b ^ @salt_bytes[i % @salt_length] }
+    end
+
+    # Reverses the obfuscation of an array of bytes.
+    # Each element is XORed with an element from @c and the result is converted back to a string.
+    # The index of the element from @c is the index of the element from the array modulo @l.
+    def reveal(value)
+      value.map.with_index { |b, i| b ^ @salt_bytes[i % @salt_length] }.pack('C*').force_encoding('utf-8')
+    end
   end
 end

data/lib/obfuskit/templates/kotlin.erb

@@ -0,0 +1,12 @@
+package <%= package %>
+
+public object ObfusKit {
+  private val _o = O(<%= salt %>::class.java.simpleName)
+  private class <%= salt %>
+
+<% values.each do |name, values| -%>
+  public val <%= name %>: String = _o.r(byteArrayOf(<%= values.map { |i| i.to_s }.join(', ') %>))
+<% end -%>
+}
+
+private class O{private val a:ByteArray;private val b:Int;constructor(s:String){a=s.toByteArray(Charsets.UTF_8);b=a.size};fun o(v:String):ByteArray{val d=v.toByteArray(Charsets.UTF_8);return ByteArray(d.size){i->(d[i].toInt() xor a[i%b].toInt()).toByte()}};fun r(value:ByteArray):String{return String(ByteArray(value.size){i->(value[i].toInt() xor a[i%b].toInt()).toByte()},Charsets.UTF_8)}}

data/lib/obfuskit/templates/swift.erb

@@ -0,0 +1,12 @@
+import Foundation
+
+public enum ObfusKit {
+<% values.each do |name, values| -%>
+  public static let <%= name %>: String = _o.r([<%= values.map { |i| i.to_s }.join(', ') %>])
+<% end -%>
+
+  private final class <%= salt %> { }
+  private static let _o = O(String(describing: <%= salt %>.self))
+}
+
+private struct O { private let c: [UInt8]; private let l: Int; init(_ s: String) { self.init([UInt8](s.utf8)) }; init(_ c: [UInt8]) { self.c = c; l = c.count }; @inline(__always) func o(_ v: String) -> [UInt8] { [UInt8](v.utf8).enumerated().map { $0.element ^ c[$0.offset % l] } }; @inline(__always) func r(_ value: [UInt8]) -> String { String(bytes: value.enumerated().map { $0.element ^ c[$0.offset % l] }, encoding: .utf8) ?? "" } }

data/lib/obfuskit/version.rb

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

data/obfuskit.gemspec

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+require_relative "lib/obfuskit/version"
+
+Gem::Specification.new do |s|
+    s.name        = "obfuskit"
+    s.version     = Obfuskit::VERSION
+    s.summary     = "Environment variable obfuscation for Swift and Kotlin."
+    s.description = "Generate Swift and Kotlin files with obfuscated environment variables."
+    s.authors     = ["Martin Gratzer"]
+    s.email       = "mgratzer@gmail.com"
+    s.homepage    =
+      "https://github.com/mgratzer/obfuskit"
+    s.license       = "MIT"
+    s.executables << "obfuskit"
+    s.required_ruby_version = ">= 3.0.0"
+    s.metadata["homepage_uri"] = s.homepage
+
+    # Specify which files should be added to the gem when it is released.
+    # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+    s.files = Dir.chdir(__dir__) do
+        `git ls-files -z`.split("\x0").reject do |f|
+            (File.expand_path(f) == __FILE__) ||
+              f.start_with?(*%w[bin/ test/ spec/ features/ .git .github appveyor Gemfile])
+        end
+    end
+    s.bindir = "exe"
+    s.executables = s.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+    s.require_paths = ["lib"]
+  end

data/sig/obfuskit/generator.rbs

@@ -3,8 +3,9 @@ module Obfuskit
     def generate: -> void
 
     private
-    def generate_kotlin: -> String
-    def generate_swift: -> String
-    def obfuscator_source: -> String
+    def generate_kotlin: ([String], Obfuscator) -> String
+    def generate_swift: ([String], Obfuscator) -> String
+    def obfuscated_values_from_env: ([String], Obfuscator) -> Hash[String, [Integer]]
+    def generate_with_template: (String, Hash[String, [Integer]], String, Obfuscator) -> String
   end
 end

data/sig/obfuskit/obfuscator.rbs

@@ -1,7 +1,13 @@
 module Obfuskit
   class Obfuscator
-    @length: Int
-    @salt: String
-    def salt: -> String
+    attr_reader salt: String
+
+    def initialize: (salt: String) -> void
+    def obfuscate: (String) -> [Integer]
+    def reveal: ([Integer]) -> String
+
+    private
+    attr_reader salt_length: Integer
+    attr_reader salt_bytes: [Integer]
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: obfuskit
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.2.1
 platform: ruby
 authors:
 - Martin Gratzer
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-01-18 00:00:00.000000000 Z
+date: 2024-02-19 00:00:00.000000000 Z
 dependencies: []
 description: Generate Swift and Kotlin files with obfuscated environment variables.
 email: mgratzer@gmail.com
@@ -23,7 +23,10 @@ files:
 - exe/obfuskit
 - lib/obfuskit/generator.rb
 - lib/obfuskit/obfuscator.rb
+- lib/obfuskit/templates/kotlin.erb
+- lib/obfuskit/templates/swift.erb
 - lib/obfuskit/version.rb
+- obfuskit.gemspec
 - sig/obfuskit.rbs
 - sig/obfuskit/generator.rbs
 - sig/obfuskit/obfuscator.rbs
@@ -32,7 +35,7 @@ licenses:
 - MIT
 metadata:
   homepage_uri: https://github.com/mgratzer/obfuskit
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -47,8 +50,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key: 
+rubygems_version: 3.5.6
+signing_key:
 specification_version: 4
 summary: Environment variable obfuscation for Swift and Kotlin.
 test_files: []