cocoapods-keys 0.9.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 54dc28574496b098df76d5fbb5fb61c09cb66839
-  data.tar.gz: 6037257545de31f6c89d62b740732c8174cdf3d7
+  metadata.gz: 43e284067bd4672be8b813d0f5590572156eabda
+  data.tar.gz: 42960e0f836c6b72f6e8a34869346e0c1ada5b00
 SHA512:
-  metadata.gz: 177cba97497cb4433c09e2606d2f1a9bdfb2af384bc0bd1d54f479927fcec670c26d7601fdc0c1decc56119443231b8c74d4582a6429665b1ae0ff8c8fda51a1
-  data.tar.gz: 73b33ac99ab1fa60b8be9639bb922bc213e2b7190e6bcaa70b8bc470b01090eeb740eb872a9fb97321b972c6e14c438986da3a7e975701cd2660f23eff33a8ac
+  metadata.gz: f6de3d8e783506b471617ed1b67f385376734ce85f606996f1d11b17273513a77a0cff78992aace1501b38c3a419676b7e181bc1596dfac104badffa2fa0b758
+  data.tar.gz: ab271fdb4dc0027451ae75f3e36f9097a691c3b6a30020f0b1d21b01e40bf338c2897116cc32ad02bf5718a9ec1434409a0868b8cca27261febc832cca0acfec

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    cocoapods-keys (0.9.0)
+    cocoapods-keys (1.0.0)
       osx_keychain
 
 GEM

data/README.md

@@ -14,7 +14,7 @@ Requires CocoaPods 0.34+.
 
 Key names are stored in `~/cocoapods/keys/` and key values in the OS X keychain. When you run `pod install` or `pod update`, an Objective-C class is created with scrambled versions of the keys, making it difficult to just [dump](https://github.com/stefanesser/dumpdecrypted) the contents of the decrypted binary and extract the keys. At runtime, the keys are unscrambled for use in your app.
 
-The generated Objective-C classes are stored in the `Pods/Keys` directory, so if you're checking in your [Pods folder](http://guides.cocoapods.org/using/using-cocoapods.html#should-i-ignore-the-pods-directory-in-source-control), just add `Pods/Keys` to your `.gitignore` file.
+The generated Objective-C classes are stored in the `Pods/Keys` directory, so if you're checking in your [Pods folder](http://guides.cocoapods.org/using/using-cocoapods.html#should-i-ignore-the-pods-directory-in-source-control), just add `Pods/Keys` to your `.gitignore` file. CocoaPods-Keys supports integration in Swift or Objective-C projects.
 
 ## Usage
 
@@ -45,12 +45,12 @@ For example:
    └ redditAPIToken & mixpanelAPIToken
 ```
 
-After the next `pod install` or `pod update` keys will add a new Objective-C class to your Pods xcworkspace. This provides an API to your keys from Cocoa code. For example the application code above would look like:
+After the next `pod install` or `pod update` keys will add a new `Keys` framework to your Pods project. This provides an API to your keys from Cocoa code. For example the application code above would look like:
 
 ``` objc
 
 #import "ORAppDelegate.h"
-#import <CocoaPods-Keys/MyApplicationKeys.h>
+#import <Keys/MyApplicationKeys.h>
 #import <ARAnalytics/ARAnalytics.h>
 
 @implementation ORAppDelegate
@@ -67,6 +67,38 @@ After the next `pod install` or `pod update` keys will add a new Objective-C cla
 
 ```
 
+## Usage via CocoaPods 0.36
+
+Using the new Plugin API in CocoaPods we can automate a lot of the fiddly bits away. You define what keys you want inside your [Podfile](https://github.com/artsy/eidolon/blob/0a9f5947914eb637fd4abf364fa3532b56da3c52/Podfile#L6-L21) and Keys will detect what keys are not yet set. If you need to specify a different project name from the target name, use the key `:target` to specify it. 
+
+```
+plugin 'cocoapods-keys', {
+  :project => "Eidolon",
+  :keys => [
+    "ArtsyAPIClientSecret",
+    "ArtsyAPIClientKey",
+    "HockeyProductionSecret",
+    "HockeyBetaSecret",
+    "MixpanelProductionAPIClientKey",
+    ...
+  ]}
+```
+
+Then running `pod install` will prompt for the keys not yet set and you can ensure everyone has the same setup.
+
+#### Other commands
+
+CocoaPods-keys has 3 other commands:
+
+ * `pod keys get [key] [optional project]`
+   Which will output the value of the key to STDOUT, useful for scripting.
+
+ * `pod keys rm [key] [optional project]`
+   Will remove a key from a project.
+
+ * `pod keys generate [optional project]`
+   Will generate the obfuscated Objective-C keys class (mainly used internally).
+
 #### Security
 
 Key security is difficult. Right now even the biggest apps get their keys [leaked](https://threatpost.com/twitter-oauth-api-keys-leaked-030713/77597). This is neatly summed up by John Adams of the Twitter Security Team on [Quora](http://www.quora.com/Twitter-1/How-were-the-Twitter-iPhone-and-Android-OAuth-keys-leaked).

data/lib/cocoapods_keys.rb

@@ -1,3 +1,3 @@
 module CocoaPodsKeys
-  VERSION = "0.9.5"
+  VERSION = "1.0.0"
 end

data/lib/key_master.rb

@@ -21,7 +21,8 @@ module CocoaPodsKeys
 
       @data_length = @keys.values.map(&:length).reduce(:+) * (20 + rand(10))
       data = `head -c #{@data_length} /dev/random | base64 | head -c #{@data_length}`
-      length = data.length
+      data = data + '\\"'
+      @data_length = data.length
 
       # Swap the characters within the hashed string with the characters from
       # the keyring values. Then store that index in a index-ed copy of the values.
@@ -32,15 +33,20 @@ module CocoaPodsKeys
         value.chars.each_with_index do |char, char_index|
           loop do
 
-            index = rand data.length
-            unless @used_indexes.include?(index)
-              data[index] = char
-
-              @used_indexes << index
+            if char == '"'
+              index = data.delete('\\').length - 1
               @indexed_keys[key][char_index] = index
               break
+            else
+              index = rand data.length
+              unless @used_indexes.include?(index)
+                data[index] = char
+
+                @used_indexes << index
+                @indexed_keys[key][char_index] = index
+                break
+              end
             end
-
           end
         end
       end
@@ -79,6 +85,7 @@ SOURCE
 //
 
 #import <objc/runtime.h>
+#import <Foundation/NSDictionary.h>
 #import "<%= @name %>.h"
 
 #pragma clang diagnostic push
@@ -121,6 +128,20 @@ static NSString *_podKeys<%= Digest::MD5.hexdigest(key) %>(<%= name %> *self, SE
 
 static char <%= name %>Data[<%= @data_length %>] = "<%= @data %>";
 
+- (NSString *)description
+{
+  return [@{
+<%- @keys.each do |key, value| -%>
+            @"<%= key %>": self.<%= key %>,
+<%- end -%>
+  } description];
+}
+
+- (id)debugQuickLookObject
+{
+  return [self description];
+}
+
 @end
 SOURCE
 
@@ -131,7 +152,7 @@ SOURCE
 
     def render_erb(erb)
       require 'erb'
-      ERB.new(erb).result(binding)
+      ERB.new(erb, nil, '-').result(binding)
     end
 
     def key_data_arrays

data/lib/keyring.rb

@@ -22,21 +22,21 @@ module CocoaPodsKeys
       name.split(/[^a-zA-Z0-9_]/).map { |s| s[0].upcase + s[1..-1] }.join('')
     end
 
+    def self.keychain_prefix
+      "cocoapods-keys-"
+    end
+
     def save(key, value)
       keychain = OSXKeychain.new
-      keychain[keychain_prefix + name, key] = value
+      keychain[self.class.keychain_prefix + name, key] = value
     end
 
     def keychain_data
       keychain = OSXKeychain.new
       Hash[
-        @keys.map { |key| [key, keychain[keychain_prefix + name, key]] }
+        @keys.map { |key| [key, keychain[self.class.keychain_prefix + name, key]] }
       ]
     end
 
-    def keychain_prefix
-      "cocoapods-keys-"
-    end
-
   end
 end

data/lib/keyring_liberator.rb

@@ -20,6 +20,10 @@ module CocoaPodsKeys
       def self.get_keyring(path)
         get_keyring_at_path(yaml_path_for_path(path))
       end
+      
+      def self.get_keyring_named(name)
+        self.get_all_keyrings.find { |k| k.name == name }
+      end
 
       def self.save_keyring(keyring)
         `mkdir -p #{keys_dir}`

data/lib/plugin.rb

@@ -1,8 +1,72 @@
+require 'cocoapods-core'
+
 module CocoaPodsKeys
+  class << self
+    def podspec_for_current_project(spec_contents)
+      keyring = KeyringLiberator.get_keyring_named(user_options["project"]) || KeyringLiberator.get_keyring(Dir.getwd)
+      raise Informative, "Could not load keyring" unless keyring 
+      key_master = KeyMaster.new(keyring)
+
+      spec_contents.gsub!(/%%SOURCE_FILES%%/, "#{key_master.name}.{h,m}")
+      spec_contents.gsub!(/%%PROJECT_NAME%%/, user_options["project"])
+    end
+
+    def setup
+      require 'preinstaller'
+
+      PreInstaller.new(user_options).setup
+      # Add our template podspec (needs to be remote, not local).
+      podfile.pod 'Keys', :git => 'https://github.com/ashfurrow/empty-podspec.git'
+    end
+
+    private
+
+    def podfile
+      Pod::Config.instance.podfile
+    end
+
+    def user_options
+      podfile.plugins["cocoapods-keys"]
+    end
+  end
+end
+
+module Pod
+  class Installer
+    alias_method :install_before_cocoapods_keys!, :install!
+
+    def install!
+      CocoaPodsKeys.setup
+      install_before_cocoapods_keys!
+    end
+
+    class Analyzer
+      class SandboxAnalyzer
+        alias_method :pod_state_before_cocoapods_keys, :pod_state
+
+        def pod_state(pod) 
+          if pod == 'Keys'
+            # return :added if we were, otherwise assume the Keys have :changed since last install, following my mother's "Better Safe than Sorry" principle.
+            return :added if pod_added?(pod)
+            :changed
+          else
+            pod_state_before_cocoapods_keys(pod)
+          end
+        end
+      end
+    end
+  end
 
-  Pod::HooksManager.register(:post_install) do |options|
-    require 'installer'
+  class Specification
+    class << self 
+      alias_method :from_string_before_cocoapods_keys, :from_string
 
-    Installer.new(options.sandbox_root).install!
+      def from_string(spec_contents, path, subspec_name = nil)
+        if path.to_s.include? "Keys.podspec"
+          CocoaPodsKeys.podspec_for_current_project(spec_contents)
+        end
+        from_string_before_cocoapods_keys(spec_contents, path, subspec_name)
+      end
+    end
   end
 end

data/lib/pod/command/keys.rb

@@ -4,6 +4,9 @@ module Pod
     class Keys < Command
       require 'pod/command/keys/list'
       require 'pod/command/keys/set'
+      require 'pod/command/keys/get'
+      require 'pod/command/keys/rm'
+      require 'pod/command/keys/generate'
 
       self.summary = "A key value store for environment settings in Cocoa Apps."
 

data/lib/pod/command/keys/generate.rb

@@ -0,0 +1,43 @@
+require 'keyring_liberator'
+require 'key_master'
+
+module Pod
+  class Command
+    class Keys
+      class Generate < Keys
+        include CocoaPodsKeys
+
+        self.summary = "Generates the .h and .m files representing the keys."
+
+        self.description = <<-DESC
+          Generates the Objective-C class containing obfuscated keys for the project
+          in the current working directory (if it exists). The .h and .m files are
+          generated in the current working directory.
+        DESC
+
+        def initialize(argv)
+          @project_name = argv.shift_argument
+          super
+        end
+
+        def run
+          key_master = KeyMaster.new(@keyring)
+
+          interface_file = key_master.name + '.h'
+          implementation_file = key_master.name + '.m'
+       
+          File.write(interface_file, key_master.interface)
+          File.write(implementation_file, key_master.implementation)
+        end
+
+        def validate!
+          super
+          verify_podfile_exists!
+
+          @keyring = KeyringLiberator.get_keyring_named(@project_name) || KeyringLiberator.get_keyring(Dir.getwd)
+          help! "No keys associated with this directory or project name." unless @keyring
+        end
+      end
+    end
+  end
+end

data/lib/pod/command/keys/get.rb

@@ -0,0 +1,59 @@
+require "keyring_liberator"
+require "name_whisperer"
+
+module Pod
+  class Command
+    class Keys
+
+      class Get < Keys
+        self.summary = "Print a values of a key."
+
+        self.description = <<-DESC
+            Outputs the value of a key to SDTOUT
+
+            A second optional operator can be done to force a project name.
+        DESC
+
+        self.arguments = [CLAide::Argument.new('key', true),
+                          CLAide::Argument.new('project_name', false)]
+
+        def initialize(argv)
+          @key_name = argv.shift_argument
+          @project_name = argv.shift_argument
+          super
+        end
+
+        def validate!
+          super
+          verify_podfile_exists!
+          help! "A key name is required for lookup." unless @key_name
+        end
+
+        def run
+          keyring = get_current_keyring
+          if !keyring
+            $stderr.puts "Could not find a project for this folder"
+            return
+          end
+
+          if keyring.keys.include? @key_name
+            data = keyring.keychain_data
+            $stderr.puts data[@key_name]
+          else 
+            $stderr.puts "Could not find value"
+          end
+        end
+
+        def get_current_keyring
+          current_dir = Dir.getwd
+          keyring = CocoaPodsKeys::KeyringLiberator.get_keyring current_dir
+          if !keyring && @project_name
+            return CocoaPodsKeys::KeyringLiberator.get_keyring_named @project_name
+          end
+          keyring
+        end
+
+      end
+    end
+  end
+end

data/lib/pod/command/keys/rm.rb

@@ -0,0 +1,71 @@
+require "keyring_liberator"
+require "keyring"
+require "name_whisperer"
+
+module Pod
+  class Command
+    class Keys
+
+      class Rm < Keys
+        self.summary = "Remove a key-value pair from a project."
+
+        self.description = <<-DESC
+            Remove a key, and it's value from a project
+
+            A second optional operator can be done to force a project name.
+        DESC
+
+        self.arguments = [CLAide::Argument.new('key', true), CLAide::Argument.new('project_name', false)]
+
+        def initialize(argv)
+          @key_name = argv.shift_argument
+          @project_name = argv.shift_argument
+          super
+        end
+
+        def validate!
+          super
+          verify_podfile_exists!
+          help! "A key name is required for lookup." unless @key_name
+        end
+
+        def run
+          keyring = get_current_keyring
+          if !keyring
+            $stderr.puts "Could not find a project to remove the key from."
+            return
+          end
+
+          if keyring.keys.include? @key_name
+            keyring.save(@key_name, "")
+            keyring.keys.delete @key_name
+            CocoaPodsKeys::KeyringLiberator.save_keyring(keyring)
+
+            prefix = CocoaPodsKeys::Keyring.keychain_prefix
+            delete_generic = `security delete-generic-password -a #{@key_name} -l #{prefix+keyring.name} 2>&1`
+
+            if delete_generic.include? "security: SecKeychainSearchCopyNext: The specified item could not be found in the keychain."
+              $stderr.puts "Removed value for #{@key_name}, but could not delete from Keychain."
+            elsif delete_generic.include? "password has been deleted."
+              $stderr.puts "Removed value for #{@key_name}, and deleted associated key in Keychain."
+            else
+              $stderr.puts "Removed value for #{@key_name}."
+            end
+          else
+            $stderr.puts "Could not find key named #{@key_name}."
+          end
+        end
+
+        def get_current_keyring
+          current_dir = Dir.getwd
+          keyring = CocoaPodsKeys::KeyringLiberator.get_keyring current_dir
+          if !keyring && @project_name
+            return CocoaPodsKeys::KeyringLiberator.get_keyring_named @project_name
+          end
+          keyring
+        end
+
+      end
+    end
+  end
+end

data/lib/preinstaller.rb

@@ -0,0 +1,47 @@
+module CocoaPodsKeys
+  class PreInstaller
+    def initialize(user_options)
+      @options = user_options
+    end
+
+    def setup
+      require 'key_master'
+      require 'keyring_liberator'
+      require 'pod/command/keys/set'
+
+      current_dir = Dir.getwd
+      keyring = KeyringLiberator.get_keyring_named(@options["project"]) || KeyringLiberator.get_keyring(current_dir)
+      unless keyring
+        name = @options["project"] || CocoaPodsKeys::NameWhisperer.get_project_name
+        keyring = CocoaPodsKeys::Keyring.new(name, current_dir, [])
+      end
+      
+      data = keyring.keychain_data
+      has_shown_intro = false
+      @options["keys"].each do |key|
+        unless data.keys.include? key
+          
+          unless has_shown_intro
+            puts "\n CocoaPods-Keys has detected a keys mismatch for your setup."
+            has_shown_intro = true
+          end
+          
+          puts " What is the key for " + key.green
+          answer = ""
+          loop do
+            print " > "
+            answer = STDIN.gets.chomp
+            break if answer.length > 0
+          end
+          
+          puts ""
+          args = CLAide::ARGV.new([key, answer, keyring.name])
+          setter = Pod::Command::Keys::Set.new(args)
+          setter.run
+          
+        end
+      end
+      
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: cocoapods-keys
 version: !ruby/object:Gem::Version
-  version: 0.9.5
+  version: 1.0.0
 platform: ruby
 authors:
 - Orta Therox
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-17 00:00:00.000000000 Z
+date: 2015-02-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: osx_keychain
@@ -70,15 +70,18 @@ files:
 - cocoapods_keys.gemspec
 - lib/cocoapods_keys.rb
 - lib/cocoapods_plugin.rb
-- lib/installer.rb
 - lib/key_master.rb
 - lib/keyring.rb
 - lib/keyring_liberator.rb
 - lib/name_whisperer.rb
 - lib/plugin.rb
 - lib/pod/command/keys.rb
+- lib/pod/command/keys/generate.rb
+- lib/pod/command/keys/get.rb
 - lib/pod/command/keys/list.rb
+- lib/pod/command/keys/rm.rb
 - lib/pod/command/keys/set.rb
+- lib/preinstaller.rb
 homepage: https://github.com/cocoapods/cocoapods-keys
 licenses:
 - MIT

data/lib/installer.rb

@@ -1,53 +0,0 @@
-module CocoaPodsKeys
-  class Installer
-    def initialize(sandbox_root)
-      @sandbox_root = sandbox_root
-    end
-
-    def install!
-      require 'key_master'
-      require 'keyring_liberator'
-
-      keyring = KeyringLiberator.get_keyring(Dir.getwd)
-
-      return unless keyring
-
-      Pod::UI.section 'Adding keys' do
-        key_master = KeyMaster.new(keyring)
-
-        keys_folder = File.join(@sandbox_root, 'Keys')
-        keys_headers_folder = File.join(@sandbox_root, 'Headers', 'Public', 'CocoaPods-Keys')
-        interface_name = key_master.name + '.h'
-        interface_file = File.join(keys_headers_folder, interface_name)
-        implementation_file = File.join(keys_folder, key_master.name + '.m')
-     
-        Dir.mkdir keys_folder unless Dir.exists? keys_folder
-        Dir.mkdir keys_headers_folder unless Dir.exists? keys_headers_folder
-        File.open(interface_file, 'w') { |f| f.write(key_master.interface) }
-        File.open(implementation_file, 'w') { |f| f.write(key_master.implementation) }
-
-        project = Xcodeproj::Project.open File.join(@sandbox_root, 'Pods.xcodeproj')
-
-        group = project.new_group('Keys')
-        interface = group.new_file(interface_file)
-        implementation = group.new_file(implementation_file)
-
-        pods_target = project.targets.detect { |t| t.name == 'Pods' }
-        unless pods_target
-          pods_target = project.targets.detect { |t| t.name == 'Pods-' + keyring.name }
-        end
-
-        pods_target.add_file_references [implementation]
-
-        # Swift Pod support
-        if pods_target.product_type == "com.apple.product-type.framework"
-          pods_target.add_file_references [interface]
-          header_ref = pods_target.headers_build_phase.files[-1]
-          header_ref.settings = { "ATTRIBUTES" => ["Public"] }
-        end
-
-        project.save
-      end
-    end
-  end
-end