keybase-core 0.1.2

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    NjZmOGQ2MWU5MzM0NmYwNTVmZjEyMGM1YzM5YjkyNmU4ZTIxZjIzMQ==
+  data.tar.gz: !binary |-
+    MTE1YzllMWE1MTMyYTQzN2M3OTAyYTQ4N2QwNzhmMjcwYTE3ZWQ4Ng==
+SHA512:
+  metadata.gz: !binary |-
+    YTMwOTVjYTM3M2YyNzRlMTFkMzBhNmEwYTE1MTcxOWFjNTUyNDQxZjAxYzZj
+    MmU1NDNjYTc3MmI4ZWY0ZjY1ZTQ4MGIzOGJhNDZmZDI5YTMyMTkyNzhjODU5
+    MGUyNWJmMzMzNWM0NTM2YjdkMDYzYmQ3ZTAxODBmNTJmM2M4OWM=
+  data.tar.gz: !binary |-
+    N2UxOWU5NDQyMjUzZWQwZjZlMjJjN2I3MTI2YzZlMzMxODVhNTRjN2Q0NGRi
+    MzQxNDMxMmZkYTBhOGZlM2VjMjY4ZDk5YjgxMDFkMjJjNWVlOTU2ZmRjMjM5
+    Yzc4NTUyNzkwZjdhNDA0YWRlYmYxZmJiNmNhYzY0NDUwNDhiZTU=

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+coverage
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/
+.DS_Store

data/.ruby-version

@@ -0,0 +1 @@
+2.1.0

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.0

data/Gemfile

@@ -0,0 +1,2 @@
+source 'https://rubygems.org'
+gemspec

data/Gemfile.lock

@@ -0,0 +1,49 @@
+PATH
+  remote: .
+  specs:
+    keybase-core (0.1.1)
+      faraday (~> 0.9.0)
+      scrypt (~> 1.2.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.3.5)
+    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-compiler (0.1.3)
+      ffi (>= 1.0.0)
+      rake
+    minitest (5.3.1)
+    multi_json (1.9.2)
+    multipart-post (2.0.0)
+    rake (10.1.1)
+    safe_yaml (1.0.1)
+    scrypt (1.2.1)
+      ffi-compiler (>= 0.0.2)
+      rake
+    simplecov (0.8.2)
+      docile (~> 1.1.0)
+      multi_json
+      simplecov-html (~> 0.8.0)
+    simplecov-html (0.8.0)
+    vcr (2.8.0)
+    webmock (1.8.11)
+      addressable (>= 2.2.7)
+      crack (>= 0.1.7)
+    yard (0.8.7.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  keybase-core!
+  minitest (~> 5.3.1)
+  simplecov (~> 0.8.2)
+  vcr (~> 2.8.0)
+  webmock (~> 1.8.0)
+  yard (~> 0.8.7.4)

data/LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2014, keybase
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,137 @@
+# Keybase Core Gem
+
+API client gem for [keybase.io](https://keybase.io)
+
+[![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
+
+```
+gem install keybase-core
+```
+
+or
+
+(in Gemfile or .gemspec)
+```ruby
+gem 'keybase-core'
+```
+
+then
+
+```ruby
+require 'keybase-core'
+```
+
+## Usage
+
+Keybase is two things.
+
+1. A public, publicly-auditable directory of keys and identity proofs.
+2. A protocol for accessing the directory.
+
+### Login
+
+Upon login, you'll get back a user object. Your user object is essentially a large dictionary (wrapped as a Ruby object) and contains pretty much everything about you and your account. (See the [user objects](https://keybase.io/__/api-docs/1.0#user-objects) page in the API documentation for more info.)
+
+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.basics.username          #=> "chris"
+me.private_keys.primary.kid #=> "a140c70404a13370f7..."
+```
+
+### Key Add
+
+An uploaded public key should be an armored PGP key. An uploaded private key should be in [P3SKB](https://keybase.io/__/api-docs/1.0#p3skb-format) format.
+
+Note: You can't upload the private before the public.
+
+```ruby
+me.add_public_key("-----BEGIN PGP PUBLIC...") 
+#=> "0101d9d962be6ee38cdadedd6..." (key_id)
+me.add_private_key("hKRib2R5gqRwcml2gqRkY...")
+#=> "a140c70404a13370f7..." (key_id)
+```
+
+### Key Revoke
+
+Currently, the only acceptable type of revocation is a simple delete, which means you just delete the key from Keybase. It's technically not a revocation at all. In the near future, you will be able to post revocations to the server, too.
+
+```ruby
+me.revoke_key("a140c70404a13370f7...") #=> true
+```
+
+### Signature Post Auth
+
+Post a self-signed authentication certificate, so that future attempts to load a user session can succeed.
+
+The payload of the signature should take the form of other keybase signatures, like self-signing keys, or proving ownership of remote accounts.
+
+An example looks like:
+
+```json
+{
+    "body": {
+        "key": {
+            "fingerprint": "da99a6ebeca98b14d944cb6e1ca9bfeab344f0fc",
+            "host": "keybase.io",
+            "key_id": "1ca9bfeab344f0fc",
+            "uid": "15a9e2826313eaf005291a1ae00c3f00",
+            "username": "taco422107"
+        },
+        "nonce": null,
+        "type": "auth",
+        "version": 1
+    },
+    "ctime": 1386537779,
+    "expire_in": 86400,
+    "tag": "signature"
+}
+```
+
+The client can provide an optional nonce to randomize the signatures. The server will check the signature for validatity, and on success, will return an auth_token, which is the SHA-256 hash of the full signature body, from the "---- BEGIN" through to the ---- END PGP MESSAGE ----.
+
+```ruby
+me.post_auth('----- BEGIN PGP MESSAGE ----- ...')
+#=> "fd2667b9b396150603ea0b567eaf3334c3..." (auth_token)
+```
+
+### Get User Information
+
+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.basics.username                
+#=> "chris"
+user.profile.bio                   
+#=> "I am the terror that flaps in the night."
+user.emails.primary                 
+#=> "chris@okcupid.com"
+user.emails.primary.is_verified?    
+#=> false
+user.public_keys.primary.kid        
+#=> "d028ac1542b24a5f77f123ba467873e3ce96a992570a"
+user.public_keys.primary.updated_at
+#=> #<DateTime: 2013-11-05T21:00:12+00:00 ((2456602j,75612s,0n),+0s,2299161j)>
+```
+
+### Dumps
+
+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.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...]
+```
+
+## 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/Rakefile

@@ -0,0 +1,20 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+namespace :test do
+  Rake::TestTask.new("unit") do |t|
+    t.libs << 'test'
+    t.pattern = "#{File.dirname(__FILE__)}/test/all.rb"
+  end
+
+  Rake::TestTask.new("integration") do |t|
+    t.libs << 'test'
+    t.pattern = "#{File.dirname(__FILE__)}/test/integration/*_test.rb"
+  end
+end
+
+desc "Run tests"
+task :test => ["test:integration", "test:unit"]
+
+task :default => :test

data/keybase.gemspec

@@ -0,0 +1,25 @@
+Gem::Specification.new do |gem|
+  gem.name = 'keybase-core'
+  gem.version = '0.1.2'
+  gem.date = '2014-03-25'
+  gem.summary = 'keybase-core'
+  gem.description = 'Core Ruby lib for keybase.io'
+  gem.authors = [ 'Max Krohn', 'Sean Handley' ]
+  gem.email = 'themax@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'
+  
+  # Runtime Dependencies
+  gem.add_runtime_dependency 'scrypt', '~> 1.2.1'
+  gem.add_runtime_dependency 'faraday', '~> 0.9.0'
+  
+  # Development Dependencies
+  gem.add_development_dependency 'vcr', '~> 2.8.0'
+  gem.add_development_dependency 'webmock', '~> 1.8.0'
+  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'
+end

data/lib/keybase.rb

@@ -0,0 +1,49 @@
+require 'faraday'
+require 'json'
+require 'date'
+require 'scrypt'
+require 'openssl'
+require 'base64'
+require 'securerandom'
+
+module Keybase 
+  require_relative 'keybase/crypto'
+  require_relative 'keybase/error'
+  require_relative 'keybase/models/user'
+  require_relative 'keybase/models/dump'
+  require_relative 'keybase/request/base'
+  require_relative 'keybase/request/dump/all'
+  require_relative 'keybase/request/dump/latest'
+  require_relative 'keybase/request/key/add'
+  require_relative 'keybase/request/key/revoke'
+  require_relative 'keybase/request/root/get_salt_and_login_session'
+  require_relative 'keybase/request/root/login'
+  require_relative 'keybase/request/sig/post_auth'
+  require_relative 'keybase/request/user/lookup'
+  require_relative 'keybase/response'
+  require_relative 'keybase/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

data/lib/keybase/crypto.rb

@@ -0,0 +1,20 @@
+module Keybase
+  # @private
+  class Crypto
+    SCRYPT_VARS = {'N' => 2**15, 'r' => 8, 'p' => 1, 'key_length' => 224, 'chunk' => 192..-1}
+    def self.scrypt(passphrase, salt)
+      SCrypt::Engine.scrypt(passphrase, hex2bin(salt),
+                                   SCRYPT_VARS['N'], SCRYPT_VARS['r'],
+                                   SCRYPT_VARS['p'], SCRYPT_VARS['key_length']
+                                 )[SCRYPT_VARS['chunk']]
+    end
+    
+    def self.hmac_sha512(key, data)
+      OpenSSL::HMAC.hexdigest(OpenSSL::Digest::SHA512.new, key, Base64.decode64(data))
+    end
+    
+    def self.hex2bin(hex)
+      [hex].pack("H*")
+    end
+  end
+end

data/lib/keybase/error.rb

@@ -0,0 +1,37 @@
+module Keybase
+  # @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']]
+      if err
+        raise err, message
+      else
+        raise Keybase::Error, "Error #{status['code']}: #{message}"
+      end
+    end
+    
+    def self.error_with_fields(status)
+      "#{status['desc']}. #{status['fields'].map{|k,v| "#{k.to_s}: #{v.to_s}"}.join(',')}"
+    end
+  end
+  
+  class UserNotFoundError < StandardError; end
+  class InputError < StandardError; end
+  class BadPasswordError < StandardError; end
+  class BadSessionError < StandardError; end
+  class CSRFVerificationError < StandardError; end
+  
+  private
+    
+  def self.errors
+    {
+      100 => InputError,
+      202 => BadSessionError,
+      205 => UserNotFoundError,
+      204 => BadPasswordError,
+      222 => CSRFVerificationError
+    }
+  end 
+end

data/lib/keybase/models/dump.rb

@@ -0,0 +1,33 @@
+module Keybase
+  # A dump object containing hashes, IDs and data links
+  # from which a mirror can be configured.
+  class Dump
+    
+    attr_reader :id, :full_data, :full_data, :full_data_sha256, :parent_dump_id, :changes_from_parent,
+                :changes_sha256, :created_at
+
+    def initialize(params)
+      @id = params['dump_id']
+      @full_data = params['full_data']
+      @full_data_sha256 = params['full_data_sha256']
+      @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
+    end
+
+    # Retrieve the dump history from Keybase
+    #
+    # @return [[Keybase::Dump]] a collection of all Keybase dumps  
+    def self.all
+      Request::Dump.all.map{|dump| new(dump)}
+    end
+
+    # Retrieve the latest dump from Keybase
+    #
+    # @return [Keybase::Dump] latest Keybase dump 
+    def self.latest
+      new(Request::Dump.latest)
+    end
+  end
+end