exportation 0.2.1 → 0.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c139c57094c0c7f634a9afda6e167df8b0c643cd
-  data.tar.gz: e7249d12f8a456ffbbc20272b41558094b0d5e0c
+  metadata.gz: 0eb69604d7c56805983df50adaca88fd09073ba3
+  data.tar.gz: 0848757c3e31f1b16808165cf7ec91f86fd913c6
 SHA512:
-  metadata.gz: 9797508901d588ad634cf7d83e9a64afb1062ee1cc99f21e56bc423c495e299d71b79dd909c60ef14b129e501d87f7d105a4d6dca4fc3c1b48b35a7666b7f1e3
-  data.tar.gz: cbc708adb054e6e337fc8d47d1bbbcd0eaae6546cc2cb368403d3660e2f572576bf0ee53749801ab678391981357c583701c6920a7a4f5b00ea6d0407c7126d3
+  metadata.gz: 339cf3b94b9288cc9054b70279fb3fb4e0289890832117f5f88d4c62f31f40b4e2a0097ff1da5f20893c06ea31be72df9f80a545cc33c5e602d2192f8b139a64
+  data.tar.gz: b66e0c20cafac106853f1ad1dda6bfaa897e8074b4eaf8cf1a6a8e7a4a0592a2ec3773fe85b3071e7a9fe2818999ca5c7f08ec5817fac1c0f77651b63d9cabfd

data/README.md

@@ -1,5 +1,10 @@
 # exportation
-CLI tool of easy exporting, encrypting, and decrypting of certificates and private keys.
+[![Twitter: @KauseFx](https://img.shields.io/badge/contact-@joshdholtz-blue.svg?style=flat)](https://twitter.com/joshdholtz)
+[![License](http://img.shields.io/badge/license-MIT-green.svg?style=flat)](https://github.com/joshdholtz/exportation/blob/master/LICENSE)
+[![Gem](https://img.shields.io/gem/v/exportation.svg?style=flat)](http://rubygems.org/gems/exportation)
+[![Build Status](https://img.shields.io/travis/joshdholtz/exportation/master.svg?style=flat)](https://travis-ci.org/joshdholtz/exportation)
+
+CLI tool (and Ruby API) of easy exporting, encrypting, and decrypting of certificates and private keys. It can also add certificates and private keys to an existing or new keychain :grinning:
 
 **Important:** The `export` command will take control of your "Keychain Access" app so keep all hands off your computer while that command runs
 
@@ -19,7 +24,7 @@ Info  Take all hands off your computer! exportation is going to take control of
 - 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"
@@ -39,7 +44,6 @@ Info  Take all hands off your computer! exportation is going to take control of
 
 ### 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
@@ -66,7 +70,7 @@ gem install exportation
 ![](readme_assets/access.png)
 **You won't need to give Heroes, Script Editor, or Steam permissions for exportation** :wink:
 
-## Commands
+## CLI Commands
 Exportation has three different commands: `export`, `encrypt`, and `decrypt`.
 
 ### Export from Keychain Access
@@ -87,6 +91,62 @@ exportation encrypt exported.cer exported.p12 --password dudethis
 exportation decrypt exported.cer.enc exported.p12.enc --password dudethis
 ```
 
+## Ruby API
+
+### Exportation::Export
+```ruby
+Exportation::Export.new(
+  path: "/path/to/export/to",
+  filename: "base_exported_file_name", #dist.cer and dist.p12
+  name: "YourCompany LLC",
+  password: "shhhh"
+).run
+```
+
+### Exportation::Crypter
+
+#### Encrypt
+```ruby
+Exportation::Crypter.new(
+  files: ["dist.cer","dist.p12"],
+  password: "shhhh",
+  output: "./"
+).run :en
+```
+
+#### Decrypt
+```ruby
+Exportation::Crypter.new(
+  files: ["dist.cer.enc","dist.p12.enc"],
+  password: "shhhh",
+  output: "./"
+).run :de
+```
+
+### Exportation::Keychain
+```ruby
+# Create keychain - name of chain, password, output directory
+keychain = Exportation::Keychain.find_or_create_keychain('JoshChain', 'joshiscool', './example')
+
+# Get login keychain
+keychain = Exportation::Keychain.login_keychain("password")
+
+# Import a certificate into keychain
+keychain.import_certificate './example/dist.cer'
+
+# Import a private key into keychain
+keychain.import_private_key './example/dist.p12', 'da_password'
+
+# Unlock keychain
+keychain.unlock!
+
+# Adds keychain to search list
+keychain.add_to_keychain_list!
+
+# Removes keychain from search list
+keychain.remove_keychain_from_list!
+```
+
 ## Using the internals
 
 ### Compiling and running the AppleScript directly

data/bin/exportation

@@ -39,10 +39,6 @@ class ExportationApplication
             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
 

data/lib/exportation.rb

@@ -12,6 +12,10 @@ module Exportation
     File.join(gem_path, 'applescript', 'exportation.scpt')
   end
 
+  def self.is_empty?(str)
+    str.nil? || str.length == 0
+  end
+
   class Export
 
     attr_accessor :path, :filename, :name, :password
@@ -21,9 +25,20 @@ module Exportation
       @filename = options[:filename]
       @name = options[:name]
       @password = options[:password]
+
+      @path = './' if Exportation.is_empty?(@path)
+      @filename = 'exported' if Exportation.is_empty?(@filename)
+      @password = '' if Exportation.is_empty?(@password)
     end
 
     def run
+      bash = run_command
+      puts "Running: #{bash}"
+      `#{bash}`
+    end
+
+    def run_command
+      raise "name is required" if Exportation.is_empty?(@name)
 
       abs_path = File.expand_path path
       abs_path += '/' unless abs_path.end_with? '/'
@@ -32,11 +47,7 @@ module Exportation
         "\"#{abs_path}\" " +
         "\"#{filename}\" " +
         "\"#{name}\" " +
-        "\"#{password}\" "
-
-      puts "Running: #{bash}"
-      `#{bash}`
-
+        "\"#{password}\""
     end
 
   end
@@ -52,6 +63,14 @@ module Exportation
     end
 
     def run(crypt, force = false)
+      run_commands(crypt, force).each do |bash|
+        puts "Running: #{bash}"
+        `#{bash}`
+      end
+    end
+
+    def run_commands(crypt, force = false)
+      raise "password is required" if Exportation.is_empty?(@password)
 
       unless force
         if crypt == :en
@@ -68,6 +87,7 @@ module Exportation
       end
 
       # Does the stuff
+      commands = []
       files.each do |file|
         file = './' + file unless file.start_with? '/'
         if File.exists? file
@@ -82,14 +102,13 @@ module Exportation
             output_file = output_file.gsub('.enc','')
           end
 
-          bash = "openssl aes-256-cbc -k \"#{password}\" -in #{file} -out #{output_file} -a"
-          puts "Running: #{bash}"
-          `#{bash}`
+          commands << "openssl aes-256-cbc -k \"#{password}\" -in #{file} -out #{output_file} -a"
         else
-          puts "File does not exist - #{file}"
+          raise "File does not exist - #{file}"
         end
       end
 
+      commands
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: exportation
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.2
 platform: ruby
 authors:
 - Josh Holtz
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: CLI tool of easy exporting, encrypting, and decrypting of certificates
   and private keys using Keychain Acess and openssl
 email: me@joshholtz.com