lapis-yggdrasil 0.5.0

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.3
+before_install: gem install bundler -v 1.10.6

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Pull in common gem from source until it has a stable release.
+gem 'lapis-common', :github => 'lapis-mc/common', :branch => 'develop'
+
+# Gem dependencies and information defined in lapis-yggdrasil.gemspec
+gemspec
+

data/LICENSE.md

@@ -0,0 +1,16 @@
+The MIT License (MIT)
+=====================
+
+*Copyright (c) 2016 Lapis MC*
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated
+documentation files (the "Software"), to deal in the Software without restriction, including without limitation the
+rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit
+persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
+WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,130 @@
+Yggdrasil
+=========
+
+[![Travis CI](https://travis-ci.org/lapis-mc/yggdrasil.svg)](https://travis-ci.org/lapis-mc/yggdrasil)
+[![Code Climate](https://codeclimate.com/github/lapis-mc/yggdrasil/badges/gpa.svg)](https://codeclimate.com/github/lapis-mc/yggdrasil)
+[![Test Coverage](https://codeclimate.com/github/lapis-mc/yggdrasil/badges/coverage.svg)](https://codeclimate.com/github/lapis-mc/yggdrasil/coverage)
+[![Issue Count](https://codeclimate.com/github/lapis-mc/yggdrasil/badges/issue_count.svg)](https://codeclimate.com/github/lapis-mc/yggdrasil)
+[![Documentation](https://inch-ci.org/github/lapis-mc/yggdrasil.svg?branch=master)](http://www.rubydoc.info/github/lapis-mc/yggdrasil/master)
+
+Provides access to Mojang's authentication system.
+This functionality can be used to authenticate with custom game launchers.
+
+Installation
+------------
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'lapis-yggdrasil'
+```
+
+Or to your gemspec:
+
+```ruby
+spec.add_dependency 'lapis-yggdrasil'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install lapis-yggdrasil
+
+Usage
+-----
+
+### Script usage
+
+Include the gem by adding this to your scripts:
+
+```ruby
+require 'lapis/yggdrasil'
+```
+
+#### Authenticating with Yggdrasil
+
+This gem tracks authentication by using sessions.
+To create a session, you must perform an initial authentication.
+
+```ruby
+client  = Lapis::Yggdrasil::AuthenticationClient.official
+session = client.authenticate(username, password)
+```
+
+`session` will contain a tracking information for the authentication.
+The session can be reused later without prompting the user for a username and password again.
+An `AuthenticationError` will be raised if the credentials are wrong.
+
+*NOTE:* The username will be the user's email address for "Mojang accounts."
+
+#### Reusing a session
+
+To reuse the session at a later time:
+
+```ruby
+session.refresh
+```
+
+And to check if the current session is still valid:
+
+```ruby
+unless session.valid?
+  # Session has expired and needs to be refreshed.
+  session.refresh
+end
+# Proceed with valid session.
+```
+
+#### Ending a session
+
+To end the session:
+
+```ruby
+session.invalidate
+```
+
+*NOTE:* Due to the way Yggdrasil works, a session may become invalid at any time.
+The exact details aren't known, but authenticating elsewhere and timeouts seem to cause previous sessions to become invalid.
+
+#### Using a session
+
+The information needed for a Minecraft client is contained in the session information.
+The following information is available after authenticating:
+
+```ruby
+session.info.client_token # Token representing the Minecraft client.
+session.info.access_token # Token provided by Yggdrasil used with the client token to prove authentication.
+session.info.profile      # Current profile the user has selected.
+session.info.profile.name # Displayed name in the game.
+session.info.profile.id   # UUID of the player.
+```
+
+`client_token`, `access_token`, and `id` are all UUIDs.
+Lapis has its own UUID class.
+Use `#to_s` to generate a more recognizable format.
+Passing false to `#to_s` will remove dashes.
+
+### Command-line usage
+
+TODO
+
+Development
+-----------
+
+After checking out the repo, run `bin/setup` to install dependencies.
+Then, run `bundle exec rake test` to run the tests.
+It's recommended that you run `bundle exec rake inspect` to run inspections.
+You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+`bundle exec rake doc` will generate documentation.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`.
+This will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+Contributing
+------------
+
+Bug reports and pull requests are welcome on [GitHub](https://github.com/lapis-mc/yggdrasil).

data/Rakefile

@@ -0,0 +1,28 @@
+require 'bundler/gem_tasks'
+require 'reek/rake/task'
+require 'rubocop/rake_task'
+require 'rubocop'
+require 'rspec/core/rake_task'
+require 'yard'
+
+task :default => [:build, :test]
+task :inspect => [:reek, :rubocop]
+
+RSpec::Core::RakeTask.new(:spec)
+task :test => :spec
+
+Reek::Rake::Task.new do |task| # :reek
+  task.name = :reek
+  task.source_files = 'lib/**/*.rb'
+  task.fail_on_error = false
+end
+
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ['lib/**/*.rb']
+  task.fail_on_error = false
+end
+
+YARD::Rake::YardocTask.new do |task| # :yard
+  task.files = %w(lib/**/*.rb - *.md)
+end
+task :doc => :yard

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'lapis/yggdrasil'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install --path=vendor/bundle
+
+# Do any other automated setup that you need to do here

data/lapis-yggdrasil.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lapis/yggdrasil/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'lapis-yggdrasil'
+  spec.version       = Lapis::Yggdrasil::VERSION
+  spec.authors       = ['Michael Miller']
+  spec.email         = ['bluepixelmike@gmail.com']
+
+  spec.summary       = %q{Provides access to Mojang's authentication system.}
+  spec.description   = %q{Small library for authenticating accounts with Mojang's game servers.
+This functionality can be used to authenticate with custom game launchers.}
+  spec.homepage      = 'https://github.com/lapis-mc/yggdrasil'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.bindir        = 'bin'
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.executables   = spec.files.grep(%r{^bin/(lapis|minecraft|yggdrasil|mojang)-}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'httpclient', '~> 2.1'
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'factory_girl', '~> 4.0'
+  spec.add_development_dependency 'webmock', '~> 2.0'
+  spec.add_development_dependency 'reek', '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.38.0'
+  spec.add_development_dependency 'codeclimate-test-reporter'
+  spec.add_development_dependency 'yard'
+end

data/lib/lapis/yggdrasil.rb

@@ -0,0 +1,18 @@
+module Lapis
+
+  # Authentication protocol for accessing Mojang's games.
+  module Yggdrasil
+  end
+
+end
+
+require_relative 'yggdrasil/version'
+require_relative 'yggdrasil/error_codes'
+require_relative 'yggdrasil/authentication_error'
+require_relative 'yggdrasil/agent'
+require_relative 'yggdrasil/profile'
+require_relative 'yggdrasil/session_info'
+require_relative 'yggdrasil/client'
+require_relative 'yggdrasil/authentication_client'
+require_relative 'yggdrasil/session'
+require_relative 'yggdrasil/messaging'

data/lib/lapis/yggdrasil/agent.rb

@@ -0,0 +1,52 @@
+module Lapis
+  module Yggdrasil
+
+    # Information about the game to associate profiles with.
+    class Agent
+
+      # Name of the game.
+      # @return [String]
+      attr_reader :name
+
+      # Client profile version.
+      # @return [Fixnum]
+      # @note This is always 1 right now, but may be increased in the future.
+      attr_reader :version
+
+      # Creates an agent.
+      # @param name [String] Name of the game.
+      # @param version [Fixnum] Client profile version.
+      def initialize(name, version)
+        @name    = name.dup.freeze
+        @version = version
+      end
+
+      # Compares the agent to another.
+      # @param other [Agent] Agent to compare against.
+      # @return [true] The agents are the same.
+      # @return [false] The agents are different.
+      def ==(other)
+        other.name == @name &&
+            other.version == @version
+      end
+
+      # Creates an agent from a set of properties in a request.
+      # @param properties [Hash<Symbol => String, Fixnum>] Set of properties.
+      # @option properties [String] :name Name of the game.
+      # @option properties [Fixnum] :version Client profile version.
+      # @return [Agent]
+      # @note Missing properties will have their values pulled from {DefaultAgent}.
+      def self.from_properties(properties)
+        name    = (properties[:name] || DEFAULT_AGENT.name).dup.freeze
+        version = properties[:version] || DEFAULT_AGENT.version
+        new(name, version)
+      end
+
+      # Agent used for Minecraft.
+      # @return [Agent]
+      DEFAULT_AGENT = new('Minecraft', 1)
+
+    end
+
+  end
+end

data/lib/lapis/yggdrasil/authentication_client.rb

@@ -0,0 +1,106 @@
+require_relative 'client'
+require_relative 'agent'
+require_relative 'session_info'
+require_relative 'session'
+require_relative 'authentication_error'
+require_relative 'messaging'
+
+module Lapis
+  module Yggdrasil
+
+    # Provides interaction with an authentication server.
+    class AuthenticationClient < Client
+
+      # URL of the official Mojang authentication server.
+      OFFICIAL_AUTHENTICATION_URL = 'https://authserver.mojang.com'
+
+      # Creates a new interface to an authentication server.
+      # @param url [String] Base URL of the authentication server.
+      def initialize(url)
+        super(url)
+        @factory = Messaging::ResponseFactory.new
+      end
+
+      # Singleton for accessing the official Mojang authentication server.
+      # @return [AuthenticationClient]
+      def self.official
+        @official ||= new(OFFICIAL_AUTHENTICATION_URL)
+      end
+
+      # Create a new session by authenticating with the server.
+      # @param username [String] Minecraft username or Mojang account email address.
+      # @param password [String] Password for the user.
+      # @param client_token [Uuid, nil] ID for the client instance.
+      #   Provide +nil+ to have the authentication server provide one.
+      # @param agent [Agent] Game information being requested.
+      # @return [Session] Newly created session.
+      # @raise [AuthenticationError] A problem occurred while authenticating.
+      def authenticate(username, password, client_token = nil, agent = Agent::DEFAULT_AGENT)
+        request  = Messaging::AuthenticationRequest.new(username, password, agent, client_token)
+        response = send_request(request)
+        message  = @factory.parse_authentication_response(response)
+        if message.ok?
+          info = SessionInfo.new(message.client_token, message.access_token, message.selected_profile)
+          Session.new(info, self)
+        else
+          fail message.to_error
+        end
+      end
+
+      # Refresh a session that was previously used.
+      # @param session [SessionInfo] Information used in the previous session.
+      # @param profile [Profile, nil] Profile to switch to.
+      #   Set to +nil+ to keep the current profile.
+      # @return [SessionInfo] Updated session information.
+      # @note Setting +profile+ to anything other than +nil+ will result in an error.
+      #   In the current version of Yggdrasil, switching profiles is not supported.
+      # @raise [AuthenticationError] A problem occurred with authentication.
+      def refresh(session, profile = nil)
+        request  = Messaging::RefreshRequest.new(session.client_token, session.access_token, profile)
+        response = send_request(request)
+        message  = @factory.parse_refresh_response(response)
+        if message.ok?
+          SessionInfo.new(message.client_token, message.access_token, message.profile)
+        else
+          fail message.to_error
+        end
+      end
+
+      # Checks that a previously used session is still valid.
+      # @param session [SessionInfo] Information used in the previous session.
+      # @return [true] The session is still valid.
+      # @return [false] The session is no longer valid.
+      def validate(session)
+        request  = Messaging::ValidateRequest.new(session.client_token, session.access_token)
+        response = send_request(request)
+        message  = @factory.parse_validate_response(response)
+        message.ok?
+      end
+
+      # Invalidates a session by using credentials instead of authentication tokens.
+      # @param username [String] Minecraft username or Mojang account email address.
+      # @param password [String] Password for the user.
+      # @return [void]
+      # @raise [AuthenticationError] A problem occurred with authentication.
+      def signout(username, password)
+        request  = Messaging::SignoutRequest.new(username, password)
+        response = send_request(request)
+        message  = @factory.parse_signout_response(response)
+        fail message.to_error unless message.ok?
+      end
+
+      # Marks a previously used session as not valid.
+      # @param session [SessionInfo] Information used in the previous session.
+      # @return [void]
+      # @raise [AuthenticationError] A problem occurred with authentication.
+      def invalidate(session)
+        request  = Messaging::InvalidateRequest.new(session.client_token, session.access_token)
+        response = send_request(request)
+        message  = @factory.parse_invalidate_response(response)
+        fail message.to_error unless message.ok?
+      end
+
+    end
+
+  end
+end

data/lib/lapis/yggdrasil/authentication_error.rb

@@ -0,0 +1,29 @@
+module Lapis
+  module Yggdrasil
+
+    # Information about an error that occurred while interacting with an authentication server.
+    class AuthenticationError < RuntimeError
+
+      # Key used to distinguish from other error types.
+      # @return [Symbol]
+      # @see ErrorCodes
+      attr_reader :code
+
+      # Creates a new authentication error.
+      # @param code [Symbol] Key used to distinguish from other error types.
+      # @param message [String, nil] Information about why the error occurred.
+      def initialize(code, message = nil)
+        super(message)
+        @code = code
+      end
+
+      # Creates a string representation of the error.
+      # @return [String]
+      def to_s
+        "#{code} - #{super}"
+      end
+
+    end
+
+  end
+end