keybase-core 0.1.2 → 0.1.4

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    NjZmOGQ2MWU5MzM0NmYwNTVmZjEyMGM1YzM5YjkyNmU4ZTIxZjIzMQ==
-  data.tar.gz: !binary |-
-    MTE1YzllMWE1MTMyYTQzN2M3OTAyYTQ4N2QwNzhmMjcwYTE3ZWQ4Ng==
+SHA1:
+  metadata.gz: 4b54cf8213ff3d4d2c29dda1fdc2e47f7188910e
+  data.tar.gz: e2b88377593501d0f938cbed9fe6899b2eb9e843
 SHA512:
-  metadata.gz: !binary |-
-    YTMwOTVjYTM3M2YyNzRlMTFkMzBhNmEwYTE1MTcxOWFjNTUyNDQxZjAxYzZj
-    MmU1NDNjYTc3MmI4ZWY0ZjY1ZTQ4MGIzOGJhNDZmZDI5YTMyMTkyNzhjODU5
-    MGUyNWJmMzMzNWM0NTM2YjdkMDYzYmQ3ZTAxODBmNTJmM2M4OWM=
-  data.tar.gz: !binary |-
-    N2UxOWU5NDQyMjUzZWQwZjZlMjJjN2I3MTI2YzZlMzMxODVhNTRjN2Q0NGRi
-    MzQxNDMxMmZkYTBhOGZlM2VjMjY4ZDk5YjgxMDFkMjJjNWVlOTU2ZmRjMjM5
-    Yzc4NTUyNzkwZjdhNDA0YWRlYmYxZmJiNmNhYzY0NDUwNDhiZTU=
+  metadata.gz: 018c5f57e338bb342fbcdad3fb61ac334daaae7a736be32428cccf388eabe7f9c3048c87dd76a2e85df90ff606c9ef52861009328dffb4c30bc1b0b6123bf46a
+  data.tar.gz: 0d28ca09014ce626d6e1b8d90df46bb477736bca0ee11a11f56ea445517de8edb25784acc516fd2dad829d0c146c60554ad5490b6a601d09e1511f9dde3eef1d

data/Gemfile.lock

@@ -1,29 +1,38 @@
 PATH
   remote: .
   specs:
-    keybase-core (0.1.1)
+    keybase-core (0.1.3)
       faraday (~> 0.9.0)
-      scrypt (~> 1.2.1)
+      scrypt (~> 2.0.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     addressable (2.3.5)
+    coveralls (0.7.0)
+      multi_json (~> 1.3)
+      rest-client
+      simplecov (>= 0.7)
+      term-ansicolor
+      thor
     crack (0.4.2)
       safe_yaml (~> 1.0.0)
     docile (1.1.3)
     faraday (0.9.0)
       multipart-post (>= 1.2, < 3)
-    ffi (1.9.3)
+    ffi (1.9.6)
     ffi-compiler (0.1.3)
       ffi (>= 1.0.0)
       rake
+    mime-types (2.2)
     minitest (5.3.1)
     multi_json (1.9.2)
     multipart-post (2.0.0)
-    rake (10.1.1)
+    rake (10.3.2)
+    rest-client (1.6.7)
+      mime-types (>= 1.16)
     safe_yaml (1.0.1)
-    scrypt (1.2.1)
+    scrypt (2.0.0)
       ffi-compiler (>= 0.0.2)
       rake
     simplecov (0.8.2)
@@ -31,6 +40,10 @@ GEM
       multi_json
       simplecov-html (~> 0.8.0)
     simplecov-html (0.8.0)
+    term-ansicolor (1.3.0)
+      tins (~> 1.0)
+    thor (0.19.1)
+    tins (1.0.1)
     vcr (2.8.0)
     webmock (1.8.11)
       addressable (>= 2.2.7)
@@ -41,6 +54,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
+  coveralls (~> 0.7.0)
   keybase-core!
   minitest (~> 5.3.1)
   simplecov (~> 0.8.2)

data/README.md

@@ -1,8 +1,9 @@
-# Keybase Core Gem
+![Keybase](https://keybase.io/images/logo.png)
 
-API client gem for [keybase.io](https://keybase.io)
+Gem wrapper for [keybase.io](https://keybase.io) core API functions.
+
+[![Build Status](https://secure.travis-ci.org/keybase/ruby-core.png?branch=master)] (http://travis-ci.org/keybase/ruby-core) [![Gem Version](https://badge.fury.io/rb/keybase-core.png)](http://badge.fury.io/rb/keybase-core) [![Dependency Status](https://gemnasium.com/seanhandley/ruby-core.svg)](https://gemnasium.com/seanhandley/ruby-core) [![Coverage Status](https://coveralls.io/repos/seanhandley/ruby-core/badge.png?branch=master)](https://coveralls.io/r/seanhandley/ruby-core?branch=master) [![Code Climate](https://codeclimate.com/github/keybase/ruby-core.png)](https://codeclimate.com/github/keybase/ruby-core)
 
-[![Build Status](https://secure.travis-ci.org/keybase/ruby-core.png?branch=master)](http://travis-ci.org/keybase/ruby-core) [![Gem Version](https://badge.fury.io/rb/keybase-core.png)](http://badge.fury.io/rb/keybase-core)
 
 ## Installing
 
@@ -37,7 +38,7 @@ Upon login, you'll get back a user object. Your user object is essentially a lar
 The login will also initiate an ongoing session which allows the authenticated actions: `key/add`, `key/revoke`, `sig/post_auth`
 
 ```ruby
-me = Keybase.login('chris', 'passphrase')
+me = Keybase::Core.login('chris', 'passphrase')
 me.basics.username          #=> "chris"
 me.private_keys.primary.kid #=> "a140c70404a13370f7..."
 ```
@@ -103,7 +104,7 @@ me.post_auth('----- BEGIN PGP MESSAGE ----- ...')
 A user object is a large dictionary (wrapped as a Ruby object) and contains pretty much everything about a user that you have access to. 
 
 ```ruby
-user = Keybase.lookup('username')
+user = Keybase::Core.lookup('username')
 user.basics.username                
 #=> "chris"
 user.profile.bio                   
@@ -123,15 +124,27 @@ user.public_keys.primary.updated_at
 Dumps represent a history of the public dumps of the site. You can use it to track or mirror the site as you wish. If you have a previous dump of the site, you can apply changes to sync up without downloading the entire site.
 
 ```ruby
-dump = Keybase.dump_latest
+dump = Keybase::Core.dump_latest
 dump.full_data_sha256
 #=> "66e72ba9906e8eec544ae74ee22c249e6879ddcd856df0c9679d7a79f26ce259" 
 dump.changes_from_parent
 #=> "https://s3.amazonaws.com/keybase_data_dumps/2014-03-24-18-06-15--1b43379e593576fe395ad90e--changes.json"
 
-dumps = Keybase.dump_all #=> [#<Keybase::Dump:0x00000102584280...]
+dumps = Keybase::Core.dump_all #=> [#<Keybase::Dump:0x00000102584280...]
 ```
 
+## Signing
+
+Keybase-Core is cryptographically signed. To be sure the gem you install hasn’t been tampered with:
+
+* Add the public key as a trusted certificate, `gem cert --add <(curl -Ls https://raw.github.com/keybase/ruby-core/master/certs/seanhandley.pem)`
+
+* Install the gem with `gem install keybase-core -P HighSecurity`
+
+The HighSecurity trust profile will verify signed gems and all dependencies.
+
+You may use the MediumSecurity option if you prefer - this will allow the installation of unsigned dependencies
+
 ## Further Reading
 
 Please check out the [Keybase API Documentation](https://keybase.io/__/api-docs/1.0) for a comprehensive explanation of the API and its capabilities.

data/certs/seanhandley.pem

@@ -0,0 +1,21 @@
+-----BEGIN CERTIFICATE-----
+MIIDgDCCAmigAwIBAgIBATANBgkqhkiG9w0BAQUFADBDMRUwEwYDVQQDDAxzZWFu
+LmhhbmRsZXkxFTATBgoJkiaJk/IsZAEZFgVnbWFpbDETMBEGCgmSJomT8ixkARkW
+A2NvbTAeFw0xNDA0MTQyMDU4NTdaFw0xNTA0MTQyMDU4NTdaMEMxFTATBgNVBAMM
+DHNlYW4uaGFuZGxleTEVMBMGCgmSJomT8ixkARkWBWdtYWlsMRMwEQYKCZImiZPy
+LGQBGRYDY29tMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA4HPIH4Rf
+OT3DGY3SKNGED5JTGTppjFF1+UxxYp9TGWygK9PLRtzl4oUjg6KufdC+o4oLs8dr
+6FfmghU2TzwYiDXaPIi6Aje7QluEABMv7CIDLjfb2oyZWtXDgUfWa2ujyOg/BZht
+3+OGXrfiLWX1qniCUQpc/UGak8A/Wt+GYDgWq+zcwwNjyc2qjMOrTp6XEl/Tij+z
+J0yu2TX/I3VrRFenMe1imVDKC4G+8VW/D8nDUU2CljzBLPq7eMrX9gDKiwJ35RtO
+Edxeau1wk0d9i3DDjeGRrI2s8teVZqwQifMktg4Z6Cx2l9VFEPM/TGGe8vbbv7nk
+7zynHXUBA51ITQIDAQABo38wfTAJBgNVHRMEAjAAMAsGA1UdDwQEAwIEsDAdBgNV
+HQ4EFgQUcjDSomiyoRKqvzDaty24lxwcBrowIQYDVR0RBBowGIEWc2Vhbi5oYW5k
+bGV5QGdtYWlsLmNvbTAhBgNVHRIEGjAYgRZzZWFuLmhhbmRsZXlAZ21haWwuY29t
+MA0GCSqGSIb3DQEBBQUAA4IBAQAlbH5LrrDhbw/1BHMeyj/fINdOKhXPL3Lmr9Zu
+bLybRMMSCrjL0BhwKrorwYBwztV4fjJffw+Lb+iioVcwWefiG8WqFor5DrnpXZW2
+P+YnhEacW+DwBEy8ZV1XzwuvAZiKnmo1wh3RBpDiJaKW6cxn5/SbpiBa4DHrB6Tw
+MMM2c0XtOSba8ISf9/EzymLsUQCGXodoLjDMNDiYDOwnALSsjP/phM8LXdk04Kue
+5vYyMKBp8sXR+QZc4U1ho78vyyA02njxn+qub9oG9x5j+C+IdbFyyn78wChQ/YZA
+t9QfTw+WVknE8zEJI5EFtpDk1aGaIKJ4WhzdnWRmIwad9Y60
+-----END CERTIFICATE-----

data/{keybase.gemspec → keybase-core.gemspec}

@@ -1,19 +1,19 @@
 Gem::Specification.new do |gem|
   gem.name = 'keybase-core'
-  gem.version = '0.1.2'
-  gem.date = '2014-03-25'
+  gem.version = '0.1.4'
+  gem.date = '2014-10-16'
   gem.summary = 'keybase-core'
   gem.description = 'Core Ruby lib for keybase.io'
   gem.authors = [ 'Max Krohn', 'Sean Handley' ]
-  gem.email = 'themax@gmail.com'
+  gem.email = 'sean.handley@gmail.com'
   gem.files = `git ls-files`.split("\n")
   gem.homepage = 'https://github.com/keybase/ruby-core'
   gem.license = 'BSD-3-Clause'
   
-  gem.required_ruby_version = '~> 2.1.0'
+  gem.required_ruby_version = '> 2.0.0'
   
   # Runtime Dependencies
-  gem.add_runtime_dependency 'scrypt', '~> 1.2.1'
+  gem.add_runtime_dependency 'scrypt', '~> 2.0.0'
   gem.add_runtime_dependency 'faraday', '~> 0.9.0'
   
   # Development Dependencies
@@ -22,4 +22,9 @@ Gem::Specification.new do |gem|
   gem.add_development_dependency 'minitest', '~> 5.3.1'
   gem.add_development_dependency 'simplecov', '~> 0.8.2'
   gem.add_development_dependency 'yard', '~> 0.8.7.4'
+  gem.add_development_dependency 'coveralls', '~> 0.7.0'
+
+  # Gem Signing
+  gem.cert_chain  = ['certs/seanhandley.pem']
+  gem.signing_key = File.expand_path("~/.ssh/gem-private_key.pem") if $0 =~ /gem\z/
 end

data/lib/keybase-core.rb

@@ -0,0 +1,52 @@
+require 'faraday'
+require 'json'
+require 'date'
+require 'scrypt'
+require 'openssl'
+require 'base64'
+require 'securerandom'
+
+module Keybase
+  module Core 
+    require_relative 'keybase-core/crypto'
+    require_relative 'keybase-core/error'
+    require_relative 'keybase-core/models/user'
+    require_relative 'keybase-core/models/dump'
+    require_relative 'keybase-core/request/base'
+    require_relative 'keybase-core/request/dump/all'
+    require_relative 'keybase-core/request/dump/latest'
+    require_relative 'keybase-core/request/key/add'
+    require_relative 'keybase-core/request/key/revoke'
+    require_relative 'keybase-core/request/root/get_salt_and_login_session'
+    require_relative 'keybase-core/request/root/login'
+    require_relative 'keybase-core/request/session/kill_all'
+    require_relative 'keybase-core/request/sig/post_auth'
+    require_relative 'keybase-core/request/user/lookup'
+    require_relative 'keybase-core/response'
+    require_relative 'keybase-core/token_store'
+    
+    # Lookup a user on Keybase
+    #
+    # @param [String] username the username of the user you are searching for
+    # @raise [Keybase::UserNotFoundError] if the user is not found
+    # @raise [Keybase::InputError] if the username is empty or invalid
+    # @return [Keybase::Model::User] the user, if they exist
+    def self.lookup(username)
+      User.lookup(username)
+    end
+
+    # Retrieve the dump history from Keybase
+    #
+    # @return [[Keybase::Dump]] a collection of all Keybase dumps
+    def self.dump_all
+      Dump.all
+    end
+
+    # Retrieve the latest dump from Keybase
+    #
+    # @return [Keybase::Dump] latest Keybase dump
+    def self.dump_latest
+      Dump.latest
+    end
+  end
+end

data/lib/{keybase → keybase-core}/crypto.rb

@@ -1,4 +1,4 @@
-module Keybase
+module Keybase::Core
   # @private
   class Crypto
     SCRYPT_VARS = {'N' => 2**15, 'r' => 8, 'p' => 1, 'key_length' => 224, 'chunk' => 192..-1}

data/lib/{keybase → keybase-core}/error.rb

@@ -1,14 +1,14 @@
-module Keybase
+module Keybase::Core
   # @private
   class Error < StandardError
     def self.raise_unless_successful(status)
       return if status['code'] == 0
       message = status['fields'] ? error_with_fields(status) : status['desc']
-      err = Keybase::errors[status['code']]
+      err = Keybase::Core::errors[status['code']]
       if err
         raise err, message
       else
-        raise Keybase::Error, "Error #{status['code']}: #{message}"
+        raise Keybase::Core::Error, "Error #{status['code']}: #{message}"
       end
     end
     

data/lib/{keybase → keybase-core}/models/dump.rb

@@ -1,4 +1,4 @@
-module Keybase
+module Keybase::Core
   # A dump object containing hashes, IDs and data links
   # from which a mirror can be configured.
   class Dump
@@ -13,7 +13,7 @@ module Keybase
       @parent_dump_id = params['parent_dump_id']
       @changes_from_parent = params['changes_from_parent']
       @changes_sha256 = params['changes_sha256']
-      @created_at = Time.at(params['ctime']).to_datetime
+      @created_at = Time.at(params['ctime'])
     end
 
     # Retrieve the dump history from Keybase

data/lib/{keybase → keybase-core}/models/user.rb

@@ -1,4 +1,4 @@
-module Keybase
+module Keybase::Core
   # A Keybase user containing all attributes you have permission to see
   class User
     
@@ -42,6 +42,12 @@ module Keybase
       return new(response['me'])
     end
 
+    # Log out of Keybase
+    #
+    def logout
+      return Request::Session.kill_all
+    end
+
     # Post a self-signed authentication certificate to Keybase
     #
     # This requires login first.
@@ -129,13 +135,13 @@ module Keybase
     
     def set_basics(params)
       @basics = OpenStruct.new(params.merge(created_at: nil, updated_at: nil))
-      @basics.created_at = Time.at(@basics.ctime).to_datetime if @basics.ctime
-      @basics.updated_at = Time.at(@basics.mtime).to_datetime if @basics.mtime
+      @basics.created_at = Time.at(@basics.ctime) if @basics.ctime
+      @basics.updated_at = Time.at(@basics.mtime) if @basics.mtime
     end
     
     def set_profile(params)
       @profile = OpenStruct.new(params.merge(updated_at: nil))
-      @profile.updated_at = Time.at(@profile.mtime).to_datetime if @profile.mtime
+      @profile.updated_at = Time.at(@profile.mtime) if @profile.mtime
     end
 
     def set_emails(params)
@@ -148,20 +154,21 @@ module Keybase
     
     def set_public_keys(params)
       @public_keys = OpenStruct.new(params)
-      params.each do |k,v|
-        v.merge!('created_at' => Time.at(v['ctime']).to_datetime)
-        v.merge!('updated_at' => Time.at(v['mtime']).to_datetime)
-        @public_keys.send("#{k}=".to_sym, OpenStruct.new(v))
-      end      
+      @public_keys = update_collection(params, @public_keys)    
     end
     
     def set_private_keys(params)
       @private_keys = OpenStruct.new(params)
+      @private_keys = update_collection(params, @private_keys)       
+    end
+    
+    def update_collection(params, collection)
       params.each do |k,v|
-        v.merge!('created_at' => Time.at(v['ctime']).to_datetime)
-        v.merge!('updated_at' => Time.at(v['mtime']).to_datetime)
-        @private_keys.send("#{k}=".to_sym, OpenStruct.new(v))
+        v.merge!('created_at' => Time.at(v['ctime']))
+        v.merge!('updated_at' => Time.at(v['mtime']))
+        collection.send("#{k}=".to_sym, OpenStruct.new(v))
       end      
+      collection
     end
 
   end

data/lib/{keybase → keybase-core}/request/base.rb

@@ -1,15 +1,15 @@
-module Keybase
+module Keybase::Core
   # @private
   module Request
     API_BASE_URL = 'https://keybase.io'
     class Base
 
       def self.get(url, params={})
-        Keybase::Response.new(conn.get(url, params)).body
+        Response.new(conn.get(url, params)).body
       end
       
       def self.post(url, params={})
-        response = Keybase::Response.new(conn.post(url, params))
+        response = Response.new(conn.post(url, params))
         TokenStore.cookie = response.cookie if response.cookie
         response.body
       end

data/lib/{keybase → keybase-core}/request/dump/all.rb

@@ -1,5 +1,5 @@
 # GET dump/all.json
-module Keybase
+module Keybase::Core
   module Request
     class Dump < Base
       def self.all

data/lib/{keybase → keybase-core}/request/dump/latest.rb

@@ -1,5 +1,5 @@
 # GET dump/latest.json
-module Keybase
+module Keybase::Core
   module Request
     class Dump < Base
       def self.latest

data/lib/{keybase → keybase-core}/request/key/add.rb

@@ -2,7 +2,7 @@
 # public_key:     "-----BEGIN PGP PUBLIC..."
 # private_key:    "hKRib2R5gqRwcml2gqRkY..."
 # is_primary:     true
-module Keybase
+module Keybase::Core
   module Request
     class Key < Base
       def self.add(params)

data/lib/{keybase → keybase-core}/request/key/revoke.rb

@@ -1,7 +1,7 @@
 # POST /key/revoke.json
 # revocation_type:   0
 # kid:               "a140c70404a13370f7..."
-module Keybase
+module Keybase::Core
   module Request
     class Key < Base
       def self.revoke(kid)

data/lib/{keybase → keybase-core}/request/root/get_salt_and_login_session.rb

@@ -1,5 +1,5 @@
 # GET /getsalt.json?email_or_username=EMAIL_OR_USERNAME
-module Keybase
+module Keybase::Core
   module Request
     class Root < Base
       def self.get_salt_and_login_session(email_or_username)

data/lib/{keybase → keybase-core}/request/root/login.rb

@@ -2,7 +2,7 @@
 # email_or_username: "chris"
 # hmac_pwh:          "38902fe098f..."
 # login_session:     "lgHZIwfee99..."
-module Keybase
+module Keybase::Core
   module Request
     class Root < Base
       def self.login(email_or_username, hmac_pwh, login_session)

data/lib/keybase-core/request/session/kill_all.rb

@@ -0,0 +1,11 @@
+# POST /session/killall.json
+module Keybase::Core
+  module Request
+    class Session < Base
+      def self.kill_all
+        post('session/killall.json', csrf_token: TokenStore.csrf)
+        true
+      end
+    end
+  end
+end