obfuskit 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64dba62899b6d17faac7cb64e3797074bf7d532bda2ed2541b7eaf0a7e831be4
-  data.tar.gz: eb181aeb2d05fffc68a2c7bc1229ed9524aa5bceebbf648e4ae80d342d8c3e52
+  metadata.gz: 95df1da20d19fbbd42f0573e3373d1c08831f65f5a49365418fb98569a3d4c57
+  data.tar.gz: 43964e64f7175109de2e033f538a1a42632ff4be5330fa30513fb53651f45a17
 SHA512:
-  metadata.gz: 152431909ff9df68577645f73f68cb267662291b3e4ac8e13c95a34dd204718951a238f2d01c5d16d335a69083e79091e420b4103e0f6a35f151e0be8d09890d
-  data.tar.gz: 3167acf2e668dc3fd4b5eb0a6d1b2d31f6f1d0eeaa98316f8375212baae9b56e0254b22a8a610d77d0b0238d2a832323734381dba8352d9df92e117e063f35ae
+  metadata.gz: d2e3716d091ee82c00a397a2d17bd610220bef2678c0402e75582b81c8f5491915b0003196e4e72951aa29a3634eb30223b7c83463a31635f87a3e68c3f47600
+  data.tar.gz: 3086262688ba6c838a649a9bcbef677578a6001d5a716748ff0974046f511a58e4e556cd127bc316edfe5bf4e41f4cfde3e5791e9a9b475a2ca5f8fd545c562d

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Martin Gratzer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,66 @@
+# ObfusKit
+
+ObfusKit is a ruby script to generate obfuscated secrets for `Swift` and `Kotlin`.
+
+## Installation and usage
+
+Install the latest version of the gem using:
+
+```
+gem install obfuskit
+```
+
+To generate Swift code run the following command:
+
+```sh
+obfuskit swift SECRET_1 SECRET_2 > generated.swift
+```
+
+It will 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.
+
+```swift
+import Foundation
+
+enum ObfusKit {
+	static let SECRET_1: String = _o.r([30, 113, 37, 119, 32, 37, 36])
+	static let SECRET_2: String = _o.r([24, 117, 35, 119, 38, 33, 34])
+
+	private class _3f3eccd2e5ea46b39738e5502bda6bef { }
+	private static let _o = O(String(describing: _3f3eccd2e5ea46b39738e5502bda6bef.self))
+}
+
+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) ?? "" } }
+```
+
+The same concept applies for the `kotlin` language using:
+
+```sh
+obfuskit kotlin com.myapp.configuration.environment SECRET_1 SECRET_2 > generated.kt
+```
+It will create the Kotlin version `generated.kt`.
+
+```kotlin
+package com.myapp.configuration.environment
+
+object ObfusKit {
+        private val _o = O(_6572131328ef462d9d4a05cf4b2a2516::class.java.simpleName)
+        private class _6572131328ef462d9d4a05cf4b2a2516
+
+        val SECRET_1: String = _o.r(byteArrayOf(30, 116, 118, 115, 119, 119, 116))
+        val SECRET_2: String = _o.r(byteArrayOf(24, 112, 112, 115, 113, 115, 114))
+}
+
+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)}}
+
+```
+
+## Features
+- [x] Generate Swift
+- [x] Generate Kotlin
+- [x] Read secrets from the Environment 
+- [x] Add dynamic salt for obfuscation
+- [x] Support for .env files
+- [x] Use template engine for code generation
+- [ ] Read secrets from 1Password CLI

data/Rakefile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/exe/obfuskit

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'obfuskit/generator'
+generator = Obfuskit::Generator.new
+generator.generate()

data/lib/obfuskit/generator.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+require_relative 'obfuscator'
+require 'securerandom'
+require 'dotenv'
+require 'erb'
+
+module Language
+  SWIFT = "Swift"
+  KOTLIN = "Kotlin"
+end
+
+module Obfuskit
+
+  class Generator
+
+    def generate()
+
+      Dotenv.load
+      args = ARGV
+      language_key = args.shift.downcase
+
+      language_map = {
+        "swift" => Language::SWIFT,
+        "kotlin" => Language::KOTLIN,
+        "kt" => Language::KOTLIN
+      }
+
+      if language_key != nil && language_map.key?(language_key)
+
+        salt = SecureRandom.uuid.to_s.gsub("-", "")
+        obfuscator = Obfuscator.new("_" + salt)
+
+        case language_map[language_key]
+        when Language::SWIFT
+          puts generate_swift(args, obfuscator)
+
+        when Language::KOTLIN
+          puts generate_kotlin(args, obfuscator)
+        end
+
+      else
+        STDERR.puts "Please specify a valid language."
+      end
+    end
+
+    private
+
+    def generate_swift(args, obfuscator)
+      values = obfuscated_values_from_env(args, obfuscator)
+      generate_with_template("swift", values, nil, obfuscator)
+    end
+
+    def generate_kotlin(args, obfuscator)
+      package = args.shift
+      if package == nil
+        STDERR.puts "No package name provided."
+      else
+        values = obfuscated_values_from_env(args, obfuscator)
+        generate_with_template("kotlin", values, package, obfuscator)
+      end
+    end
+
+    def obfuscated_values_from_env(args, obfuscator)
+      args.map { |name|
+        ENV[name] != nil ? [name, obfuscator.obfuscate(ENV[name])] : nil
+      }.compact.to_h
+    end
+
+    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

data/lib/{O.rb → obfuskit/obfuscator.rb}

@@ -1,25 +1,33 @@
+# frozen_string_literal: true
+
 # A class representing an obfuscator.
-class O
+
+module Obfuskit
+  class Obfuscator
+
+    attr_reader :salt
+
     # 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(s)
-      s = s.bytes if s.is_a? String
-      @c = s
-      @l = @c.size
+    def initialize(salt)
+      salt = salt.bytes if salt.is_a? String
+      @salt = salt
+      @length = @salt.size
     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 o(v)
-      v.bytes.map.with_index { |b, i| b ^ @c[i % @l] }
+    def obfuscate(value)
+      value.bytes.map.with_index { |b, i| b ^ @salt[i % @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 r(value)
-      value.map.with_index { |b, i| b ^ @c[i % @l] }.pack('C*').force_encoding('utf-8')
+    def reveal(value)
+      value.map.with_index { |b, i| b ^ @salt[i % @length] }.pack('C*').force_encoding('utf-8')
     end
-  end
+  end
+end

data/lib/obfuskit/templates/kotlin.erb

@@ -0,0 +1,12 @@
+package <%= package %>
+
+public object ObfusKit {
+  private val _o = O(_6572131328ef462d9d4a05cf4b2a2516::class.java.simpleName)
+  private class _6572131328ef462d9d4a05cf4b2a2516
+
+<% 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

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

data/sig/obfuskit/generator.rbs

@@ -0,0 +1,11 @@
+module Obfuskit
+  class Generator
+    def generate: -> void
+
+    private
+    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

@@ -0,0 +1,10 @@
+module Obfuskit
+  class Obfuscator
+    @length: Integer
+    @salt: String
+
+    def salt: -> String
+    def obfuscate: (String) -> [Integer]
+    def reveal: ([Integer]) -> String
+  end
+end

data/sig/obfuskit.rbs

@@ -0,0 +1,3 @@
+module Obfuskit
+  VERSION: String
+end

metadata

@@ -1,32 +1,40 @@
 --- !ruby/object:Gem::Specification
 name: obfuskit
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Martin Gratzer
-autorequire:
-bindir: bin
+autorequire: 
+bindir: exe
 cert_chain: []
-date: 2024-01-16 00:00:00.000000000 Z
+date: 2024-01-19 00:00:00.000000000 Z
 dependencies: []
-description: Environment variable obfuscation for Swift and Kotlin
+description: Generate Swift and Kotlin files with obfuscated environment variables.
 email: mgratzer@gmail.com
 executables:
 - obfuskit
 extensions: []
 extra_rdoc_files: []
 files:
-- bin/obfuskit
-- lib/O.rb
-- lib/Omin.kt
-- lib/Omin.swift
-- lib/obfuskit.rb
+- LICENSE.txt
+- README.md
+- Rakefile
+- exe/obfuskit
+- lib/obfuskit/generator.rb
+- lib/obfuskit/obfuscator.rb
+- lib/obfuskit/templates/kotlin.erb
+- lib/obfuskit/templates/swift.erb
+- lib/obfuskit/version.rb
+- sig/obfuskit.rbs
+- sig/obfuskit/generator.rbs
+- sig/obfuskit/obfuscator.rbs
 homepage: https://github.com/mgratzer/obfuskit
 licenses:
 - MIT
-metadata: {}
-post_install_message:
+metadata:
+  homepage_uri: https://github.com/mgratzer/obfuskit
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -34,15 +42,15 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
-signing_key:
+rubygems_version: 3.5.3
+signing_key: 
 specification_version: 4
-summary: Environment variable obfuscation for Swift and Kotlin
+summary: Environment variable obfuscation for Swift and Kotlin.
 test_files: []

data/bin/obfuskit

@@ -1,2 +0,0 @@
-#!/usr/bin/env ruby
-require 'obfuskit'

data/lib/Omin.kt

@@ -1 +0,0 @@
-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/Omin.swift

@@ -1 +0,0 @@
-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.rb

@@ -1,107 +0,0 @@
-#!/usr/bin/env ruby
-
-# Import the necessary modules and files
-require_relative 'O'
-require 'securerandom'
-require 'dotenv'
-
-# Define a module for language constants
-module Language
-    SWIFT = "Swift"
-    KOTLIN = "Kotlin"
-end
-
-# Function to generate Swift code
-def generate_swift(args)
-    # Get the source code for the obfuscator
-    obfuscator_source = obfuscator_source('Omin.swift')
-    # 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
-    o = O.new("_" + obfuscation_salt)
-
-    # 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(#{o.o(ENV[arg])})\n"
-        end
-    end
-    code += "\n"
-    # Add the obfuscation salt and the obfuscator to the code
-    code += <<-STRING
-\tprivate class _#{obfuscation_salt} { }
-\tprivate static let _o = O(String(describing: _#{obfuscation_salt}.self))
-}\n\n
-STRING
-
-    # Add the obfuscator source code to the code
-    code += obfuscator_source
-    # Return the generated code
-    return code
-end
-
-# Function to generate Kotlin code
-def generate_kotlin(args)
-    # Get the source code for the obfuscator
-    obfuscator_source = obfuscator_source('Omin.kt')
-    # 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
-    o = O.new("_" + obfuscation_salt)
-    
-    # Start building the Kotlin code
-    code = "object ObfusKit {\n"
-    # Add the obfuscation salt and the obfuscator to the code
-    code += <<-STRING
-\tprivate val _o = O(_#{obfuscation_salt}::class.java.simpleName)
-\tprivate class _#{obfuscation_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(#{o.o(ENV[arg]).map { |i| i.to_s }.join(', ')}))\n"
-        end
-    end
-    code += "}\n\n"
-
-    # Add the obfuscator source code to the code
-    code += obfuscator_source
-    # Return the generated code
-    return code
-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)
-end
-
-# MAIN
-
-language_map = {
-    "swift" => Language::SWIFT,
-    "kotlin" => Language::KOTLIN,
-    "kt" => Language::KOTLIN
-}
-
-Dotenv.load
-
-args = ARGV
-first_arg = args.shift
-
-if first_arg != nil && language_map.key?(first_arg.downcase)    
-    case language_map[first_arg]
-    when Language::SWIFT
-        puts generate_swift(args)
-    when Language::KOTLIN
-        puts generate_kotlin(args)
-    end
-else
-    puts "First argument is not a valid language. Use `swift` or `kotlin`."
-end