exportation 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 59620a48ca2b2f33b91e71f3f89e17005ed8070b
-  data.tar.gz: 2bd448ebeeb9db0ce4eb62a8c6a287f3610f8c22
+  metadata.gz: fa309452b28fa8fe7c2459cdd8adc644c09dbfc0
+  data.tar.gz: 67696b8b638f49165d57ccad2369acd3bab94921
 SHA512:
-  metadata.gz: bf283454025f616082913549e591ac2a512cd018393e6bb462f3ae89f2697d4c691f5eaace8e494eeef6bed71f1620fae3cf8263fb74ac75eeb8f5350c83a33d
-  data.tar.gz: f9f64013471f489cc0434ea56e3f278490b0ef475df28f37a13b834da9bd080603794d2967f0a12f463f4c82568767b95841e8f545e2403380da7bd3535b4055
+  metadata.gz: 666f9867ff1e4754cd2d5ea93152cbcb31bf2bd3f7febe7a42784b4f2e9309af2ef328a931affce03e6e16962999bb08d5fee44e2ab9f96d49c32da1ebdc70c8
+  data.tar.gz: b129a2ff9826990e9c86439b32348132580232c79815ad4c7bb4a0edb93a2d17f1aa4984637342307a9cd2d5e3497ddbee5a05ce87462115cd6082b06efdf47d

data/README.md

@@ -1,10 +1,71 @@
 # exportation
 CLI tool of easy exporting, encrypting, and decrypting of certificates and private keys.
 
+**Important:** The `export` command will take control of your "Keychain Access" app so keep all hands off your computer while that command runs
+
+### Example usage (with prompt)
+```sh
+$: exportation export
+Name: RokkinCat LLC
+Path to save to (default: './'): ./examples
+Filename to save as (default: 'export'): dist
+Password for private key (default: ''): shhh
+Info  Take all hands off your computer! exportation is going to take control of 'Keychain Access'
+```
+
+![Example of exportation](readme_assets/example.gif)
+
+### Why
+- Export **and** encrypt certificates **and** private keys **into** repos
+  - CI tools (may need these to distrubute builds to Apple TestFlight Beta :apple:)
+  - For other developers (for when you are on vacation and they need to make a distribution build :grimacing:)
+  
+### How
+- Makes use of AppleScript to control "Keychain Access"
+  - Opens "Keychain Access"
+  - Selects "Login" and "Certificates" for the left side
+  - Searches for the certificate you are looking for from `--name`
+  - Exports private key
+    - Right clicks it and selects export
+    - Changes the save path to your current directory (by default) or what was passed in through `--path`
+    - Saves the file to `exported.p12`
+    - Enters a blank password (by default) or what was passed in through `--password`
+    - Saves
+  - Exports certificate
+    - Right clicks it and selects export
+    - Changes the save path to your current directory (by default) or what was passed in through `--path`
+    - Saves the file to `exported.cer`
+    - Saves
+
 ### Features in progress
 - Integrate with [fastlane](https://github.com/KrauseFx/fastlane) :rocket:
 - Create a separate keychain with the certificates and private keys for use on CI systems :grinning:
 
+### Caveats
+- Some phases of the script might run slow due to using AppleScript
+  - Initial load may take up to 5ish seconds
+  - Waiting for private key password to be entered may take up to 7ish seconds
+- May need to give "Accessibility" access to **ARDAgent** and **Terminal**
+
+## Installation
+
+### Install gem
+```sh
+gem install exportation
+```
+
+### Give "Accessibility" access
+- Open up "Security & Privacy" preferences
+- Select "Accessibility"
+- Add **ARDAgent** and **Terminal**
+  - Click "+"
+  - Press CMD+SHIT+G (to go to specific folder)
+  - **ARDAgent** should be under `/System/Library/CoreServices/RemoteManagement/`
+  - **Terminal** should be under `/Applications/Utilities/`
+
+![](readme_assets/access.png)
+**You won't need to give Heroes, Script Editor, or Steam permissions for exportation** :wink:
+
 ## Commands
 Exportation has three different commands: `export`, `encrypt`, and `decrypt`.
 
@@ -41,3 +102,11 @@ Always put all for arguments in strings because I don't do AppleScript well :gri
 ```sh
 osascript applescript/exportation.scpt "~/directory_you_want_to_export_to/" "dist" "iPhone Distribution: Your Company LLC"  "thepassword"
 ```
+
+## Author
+
+Josh Holtz, me@joshholtz.com, [@joshdholtz](https://twitter.com/joshdholtz)
+
+## License
+
+exportation is available under the MIT license. See the LICENSE file for more info.

data/bin/exportation

@@ -6,10 +6,16 @@ require 'exportation'
 
 require 'rubygems'
 require 'commander'
+require 'colorize'
+require 'terminal-notifier'
 
 class ExportationApplication
   include Commander::Methods
 
+  def is_empty?(str)
+    str.nil? || str.length == 0
+  end
+
   def run
     program :name, 'Exportation'
     program :version, '0.1.0'
@@ -22,57 +28,98 @@ class ExportationApplication
       c.option '--filename STRING', String, 'File name to save certificate and private key as'
       c.option '--name STRING', String, 'Common name of the cert as it is displayed in Keychain Access'
       c.option '--password STRING', String, 'Password to use for the private key'
+      c.option '--noprompt', 'Do not prompt for missing options'
       c.action do |args, options|
-        options.default path: "./", filename:"exported", password: ""
-
-        raise "--name is required" unless options.name
 
-        Exportation::Export.new(
-          path: options.path,
-          filename: options.filename,
-          name: options.name,
-          password: options.password
-        ).run
+        begin
+          unless options.noprompt
+            options.name = ask("Name: ") unless options.name
+            options.path = ask("Path to save to (default: './'): ") unless options.path
+            options.filename = ask("Filename to save as (default: 'export'): ") unless options.filename
+            options.password = ask("Password for private key (default: ''): ") unless options.password
+          end
+
+          options.path = './' if is_empty?(options.path)
+          options.filename = 'exported' if is_empty?(options.filename)
+          options.password = '' if is_empty?(options.password)
+
+          raise "'name' is required" if is_empty?(options.name)
+          log "Info".blue, "Take all hands off your computer! exportation is going to take control of 'Keychain Access'".blue
+
+          Exportation::Export.new(
+            path: options.path,
+            filename: options.filename,
+            name: options.name,
+            password: options.password
+          ).run
+
+          TerminalNotifier.notify('Certificate and private key exported!', title: 'exportation')
+        rescue Exception => e
+          TerminalNotifier.notify('Export failed :(', title: 'exportation')
+          log "Error".red, e.message.red
+        end
 
       end
     end
 
     command :encrypt do |c|
-      c.syntax = 'exportation encrypt [options]'
+      c.syntax = 'exportation encrypt [file_path1] [file_path2] ... [options]'
       c.description = 'Encrypts certificates, private keys, and provisioning profiles with AES'
       c.option '--password STRING', String, 'Password to use for the encryption'
       c.option '--output STRING', String, 'Output directory for files (defaults to where original files are located)'
       c.option '--force', 'Forces all files to decrypted (will encrypt decrypted files)'
+      c.option '--noprompt', 'Do not prompt for missing options'
       c.action do |args, options|
         options.default output: nil
 
-        raise "--password is required" unless options.password
+        begin
+          unless options.noprompt
+            options.password = ask("Password: ") unless options.password
+            options.output= ask("Output path (default: location of unencrypted files): ") unless options.output
+          end
 
-        Exportation::Crypter.new(
-          files: args,
-          password: options.password,
-          output: options.output
-        ).run :en, options.force
+          raise "no files were passed through arguments" if args.empty?
+          raise "'password' is required" if is_empty?(options.password)
+
+          Exportation::Crypter.new(
+            files: args,
+            password: options.password,
+            output: options.output
+          ).run :en, options.force
+        rescue Exception => e
+          log "Error".red, e.message.red
+        end
 
       end
     end
 
     command :decrypt do |c|
-      c.syntax = 'exportation decrypt [options]'
+      c.syntax = 'exportation decrypt [file_path1] [file_path2] ... [options]'
       c.description = 'Decrypts certificates, private keys, and provisioning profiles with AES'
       c.option '--password STRING', String, 'Password to use for the decryption'
       c.option '--output STRING', String, 'Output directory for files (defaults to where original files are located)'
       c.option '--force', 'Forces all files to decrypted (will encrypt decrypted files)'
+      c.option '--noprompt', 'Do not prompt for missing options'
       c.action do |args, options|
         options.default output: nil
 
-        raise "--password is required" unless options.password
-
-        Exportation::Crypter.new(
-          files: args,
-          password: options.password,
-          output: options.output
-        ).run :de, options.force
+        begin
+          unless options.noprompt
+            options.password = ask("Password: ") unless options.password
+            options.output= ask("Output path (default: location of encrypted files): ") unless options.output
+          end
+
+          raise "no files were passed through arguments" if args.empty?
+          raise "'password' is required" if is_empty?(options.password)
+
+          Exportation::Crypter.new(
+            files: args,
+            password: options.password,
+            output: options.output
+          ).run :de, options.force
+        rescue Exception => e
+          log "Error".red, e.message.red
+        end
 
       end
     end

data/lib/exportation.rb

@@ -2,10 +2,8 @@ module Exportation
 
   def self.gem_path
     if Gem::Specification::find_all_by_name('exportation').any?
-      puts "looking in gem specification - #{Gem::Specification.find_by_name('exportation').gem_dir}"
       return Gem::Specification.find_by_name('exportation').gem_dir
     else
-      puts "using current directory"
       return './'
     end
   end
@@ -71,24 +69,25 @@ module Exportation
 
       # Does the stuff
       files.each do |file|
-          if File.exists? file
-            output_file = file
-            if output
-              output_file = File.join(output, File.basename(file))
-            end
-
-            if crypt == :en
-              output_file += '.enc'
-            elsif crypt == :de
-              output_file = output_file.gsub('.enc','')
-            end
-
-            bash = "openssl aes-256-cbc -k \"#{password}\" -in #{file} -out #{output_file} -a"
-            puts "Running: #{bash}"
-            `#{bash}`
-          else
-            puts "File does not exist - #{file}"
+        file = './' + file unless file.start_with? '/'
+        if File.exists? file
+          output_file = file
+          if !output.nil? && output.length > 0
+            output_file = File.join(output, File.basename(file))
           end
+
+          if crypt == :en
+            output_file += '.enc'
+          elsif crypt == :de
+            output_file = output_file.gsub('.enc','')
+          end
+
+          bash = "openssl aes-256-cbc -k \"#{password}\" -in #{file} -out #{output_file} -a"
+          puts "Running: #{bash}"
+          `#{bash}`
+        else
+          puts "File does not exist - #{file}"
+        end
       end
 
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: exportation
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Josh Holtz
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-18 00:00:00.000000000 Z
+date: 2015-03-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dotenv
@@ -38,6 +38,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: terminal-notifier
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
 description: CLI tool of easy exporting, encrypting, and decrypting of certificates
   and private keys using Keychain Acess and openssl
 email: me@joshholtz.com
@@ -51,7 +79,7 @@ files:
 - applescript/exportation.scpt
 - bin/exportation
 - lib/exportation.rb
-homepage: https://github.com/joshdholtz/fastlane-env-lanes
+homepage: https://github.com/joshdholtz/exportation
 licenses:
 - MIT
 metadata: {}