apple_id_token 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4939bceeb59fbaadb045a5fb1b52285d62791ed776af45a3a93b23eaf5bb8cdc
+  data.tar.gz: 2f6d35816d03f38bb2b20bb2fa7b2dc7a576a12b2083ee213691174bff6ceded
+SHA512:
+  metadata.gz: e418ab733c53f46f448635b908f8b2784e2c73147785f1eb494b2b761c3204e81684d82364d6fc29336d39391bcb1911e7f500ec2bc5a91ce4c92e6c85403a94
+  data.tar.gz: 072ef93bf08e011f8b3fba113180fff018b2e885554367eeb42fa2aff54b4e96860644efd7dfb64c7d6cee1f09d9732822980e1977fc84b4806be6b84e621973

data/.gitignore

@@ -0,0 +1,56 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+# Ignore Byebug command history file.
+.byebug_history
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# Used by RuboCop. Remote config files pulled in from inherit_from directive.
+# .rubocop-https?--*

data/Changelog.md

@@ -0,0 +1,4 @@
+## 0.1.0
+
+* Additions
+  * Beta release

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in apple_id_token.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 Samuel Villaescusa Vinader
+
+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,49 @@
+# AppleIdToken
+
+This gem is a symple wrapper around Apple Sign In to validate provided tokens from https://developer.apple.com/documentation/sign_in_with_apple/generate_and_validate_tokens. You can also send tokens provided by official Apple library for iOS and Android applications.
+
+We make use of JWT Ruby gem -> https://github.com/jwt/ruby-jwt to decode token provided by Apple and also it makes all the validations mentioned here -> https://developer.apple.com/documentation/sign_in_with_apple/sign_in_with_apple_rest_api/verifying_a_user to ensure integrity of provided token.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'apple_id_token'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install apple_id_token
+
+## Usage
+
+To make use of the gem, just call `.validate` method of `AppleIdToken::Validator`.
+You need to provide token issued by Apple and also your APP_ID generated here -> https://help.apple.com/developer-account/#/devde676e696 as audience.
+
+```ruby
+validator = AppleIdToken::Validator
+begin
+  payload = validator.validate(token: token, aud: audience)
+  user_id = payload['sub']
+  email = payload['email']
+rescue AppleIdToken::PublicKeysError => e
+  report "Provided keys are invalid: #{e}"
+rescue AppleIdToken::ValidationError => e
+  report "Cannot validate: #{e}"
+end
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/PexegoUva/rails_apple_signin

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/apple_id_token.gemspec

@@ -0,0 +1,42 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "apple_id_token/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "apple_id_token"
+  spec.version       = AppleIdToken::VERSION
+  spec.authors       = ["Samuel Villaescusa Vinader"]
+  spec.email         = ["samuelvv22@gmail.com"]
+
+  spec.license       = 'MIT'
+  spec.summary       = 'Apple Sign In Token utilities'
+  spec.description   = 'Apple Sign In Token utilities; parse and check validity of token'
+  spec.homepage      = "https://github.com/PexegoUva/rails_apple_signin"
+
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/PexegoUva/rails_apple_signin"
+    spec.metadata["changelog_uri"] = "https://github.com/PexegoUva/rails_apple_signin/blob/master/Changelog.md"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_runtime_dependency 'jwt', '>= 2.2.1'
+  spec.add_runtime_dependency 'httparty', '>= 0.17.3'
+
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", ">= 12.3.3"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency 'fakeweb', ">= 1.3.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "apple_id_token"
+
+# 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(__FILE__)

data/bin/setup

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

data/lib/apple_id_token.rb

@@ -0,0 +1,82 @@
+require 'apple_id_token/version'
+require 'jwt'
+require 'httparty'
+require 'json'
+
+module AppleIdToken
+  class PublicKeysError < StandardError; end
+  class ValidationError < StandardError; end
+  class JWTExpiredSignatureError < ValidationError; end
+  class InvalidPublicKeyError < ValidationError; end
+  class JWTSignatureError < ValidationError; end
+  class JWTAudienceError < ValidationError; end
+
+  class Validator
+    APPLE_ISSUER = 'https://appleid.apple.com'
+    APPLE_JWKS_URI = 'https://appleid.apple.com/auth/keys'
+
+    HTTP_OK = 200
+
+    JWT_RS256 = 'RS256'
+
+    class << self
+      def validate(token:, aud:)
+        public_keys = get_public_keys
+        if public_keys
+          payload = check_against_certs(token, aud, public_keys)
+
+          unless payload
+            raise JWTSignatureError, 'Token not verified as issued by Apple'
+          end
+        else
+          raise PublicKeysError, 'Unable to retrieve Apple public keys'
+        end
+
+        payload
+      end
+
+      private
+
+      def get_public_keys
+        response = HTTParty.get(APPLE_JWKS_URI)
+        return false unless response.code == HTTP_OK
+
+        json_body = JSON.parse(response.body)
+        json_body['keys']
+      end
+
+      def check_against_certs(token, aud, public_keys)
+        payload = nil
+
+        public_keys.each do |public_key|
+          # As jwk from jwt library needs Hashes with keys as symbols.
+          public_key = public_key.transform_keys(&:to_sym)
+
+          begin
+            jwk = JWT::JWK.import(public_key)
+            decoded_token = JWT.decode(token, jwk.public_key , !!public_key, {
+                algorithm: JWT_RS256,
+                iss: APPLE_ISSUER, verify_iss: true,
+                aud: aud, verify_aud: true
+              }
+            )
+
+            payload = decoded_token.first
+          rescue JWT::JWKError
+            raise InvalidPublicKeyError, 'Provided public key was invalid'
+          rescue JWT::ExpiredSignature
+            raise JWTExpiredSignatureError, 'Token signature is expired'
+          rescue JWT::InvalidIssuerError
+            raise JWTSignatureError, 'Token not verified as issued by Apple'
+          rescue JWT::InvalidAudError
+            raise JWTAudienceError, 'Token audience mismatch'
+          rescue JWT::DecodeError
+            nil # Try another public key.
+          end
+        end
+
+        payload
+      end
+    end
+  end
+end

data/lib/apple_id_token/version.rb

@@ -0,0 +1,3 @@
+module AppleIdToken
+  VERSION = "0.1.0"
+end

metadata

@@ -0,0 +1,141 @@
+--- !ruby/object:Gem::Specification
+name: apple_id_token
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Samuel Villaescusa Vinader
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-05-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.17.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.17.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+description: Apple Sign In Token utilities; parse and check validity of token
+email:
+- samuelvv22@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Changelog.md
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- apple_id_token.gemspec
+- bin/console
+- bin/setup
+- lib/apple_id_token.rb
+- lib/apple_id_token/version.rb
+homepage: https://github.com/PexegoUva/rails_apple_signin
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/PexegoUva/rails_apple_signin
+  source_code_uri: https://github.com/PexegoUva/rails_apple_signin
+  changelog_uri: https://github.com/PexegoUva/rails_apple_signin/blob/master/Changelog.md
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Apple Sign In Token utilities
+test_files: []