standard_id-apple 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a77a4c61dc7a649544a240e29a318dd89b3973a429fb796992214f043bdd176b
+  data.tar.gz: a119c315995c98edac369d3d1c96d645b1871811c343e81a3f30e90480d354b8
+SHA512:
+  metadata.gz: 04a5fc1120b372888042832a64c3508f4dd2e85e6807da34365186ba77ed54846641c58c04880d0f2652776f0429d2abc57c8f613bd21ca417b19750723cc764
+  data.tar.gz: 609d9235c817d7e9d6805b8b9f91f19f7f213d7475b3d48578cbc4d28065b9a20762fa68968c6634db454bb3e53d842edb5699037b811f6214c29cebb1a7b489

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,8 @@
+# Omakase Ruby styling for Rails
+inherit_gem: { rubocop-rails-omakase: rubocop.yml }
+
+# Overwrite or add rules to create your own house style
+
+# Use `[a, [b, c]]` not `[ a, [ b, c ] ]`
+Layout/SpaceInsideArrayLiteralBrackets:
+  EnforcedStyle: no_space

data/.ruby-version

@@ -0,0 +1 @@
+3.4.4

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2025-12-20
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement at
+[INSERT CONTACT METHOD].
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

data/LICENSE.txt

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) Jaryl Sim
+
+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,59 @@
+# StandardId Apple Provider
+
+This gem extracts the Apple OAuth provider from the core [`standard_id`](https://github.com/rarebit-one/standard_id) engine so installations can opt into Apple login independently of the base gem.
+
+## Installation
+
+Add the gem next to `standard_id`:
+
+```ruby
+# Gemfile
+gem "standard_id"
+gem "standard_id-apple"
+```
+
+Then install:
+
+```bash
+bundle install
+```
+
+The gem automatically registers itself with StandardId when it is required.
+
+## Configuration
+
+Configure Apple credentials via the StandardId configuration block:
+
+```ruby
+StandardId.configure do |config|
+  config.social.apple_client_id = ENV["APPLE_CLIENT_ID"]
+  config.social.apple_mobile_client_id = ENV["APPLE_MOBILE_CLIENT_ID"] # optional
+  config.social.apple_team_id = ENV["APPLE_TEAM_ID"]
+  config.social.apple_key_id = ENV["APPLE_KEY_ID"]
+  config.social.apple_private_key = ENV["APPLE_PRIVATE_KEY_PEM"]
+end
+```
+
+With those values in place, StandardId routes such as `/auth/callback/apple` continue to function using this provider gem.
+
+## Testing
+
+Run the spec suite:
+
+```bash
+bundle exec rspec
+```
+
+## Development
+
+1. `bin/setup`
+2. `bundle exec rspec`
+
+To release a new version:
+
+1. Update the version in `lib/standard_id/apple/version.rb`.
+2. Run `bundle exec rake release` to tag, push, and publish to RubyGems.
+
+## License
+
+MIT — see [LICENSE.txt](LICENSE.txt).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/lib/standard_id/apple/providers/apple.rb

@@ -0,0 +1,228 @@
+require "uri"
+require "net/http"
+require "json"
+require "jwt"
+
+module StandardId
+  module Providers
+    class Apple < Base
+      ISSUER = "https://appleid.apple.com".freeze
+      AUTH_ENDPOINT = "#{ISSUER}/auth/authorize".freeze
+      TOKEN_ENDPOINT = "#{ISSUER}/auth/token".freeze
+      JWKS_URI = "#{ISSUER}/auth/keys".freeze
+      DEFAULT_SCOPE = "name email".freeze
+      DEFAULT_RESPONSE_MODE = "form_post".freeze
+
+      class << self
+        def provider_name
+          "apple"
+        end
+
+        def authorization_url(state:, redirect_uri:, **options)
+          scope = options[:scope] || DEFAULT_SCOPE
+          response_mode = options[:response_mode] || DEFAULT_RESPONSE_MODE
+
+          ensure_basic_credentials!
+
+          query = {
+            client_id: StandardId.config.social.apple_client_id,
+            redirect_uri: redirect_uri,
+            response_type: "code",
+            scope: scope,
+            response_mode: response_mode,
+            state: state
+          }
+
+          "#{AUTH_ENDPOINT}?#{URI.encode_www_form(query)}"
+        end
+
+        def get_user_info(code: nil, id_token: nil, access_token: nil, redirect_uri: nil, **options)
+          client_id = options[:client_id] || StandardId.config.social.apple_client_id
+
+          if id_token.present?
+            build_response(
+              verify_id_token(id_token: id_token, client_id: client_id),
+              tokens: { id_token: id_token }
+            )
+          elsif code.present?
+            exchange_code_for_user_info(code: code, redirect_uri: redirect_uri, client_id: client_id)
+          elsif access_token.present?
+            raise StandardId::InvalidRequestError, "Access token login flow is not supported for Apple"
+          else
+            raise StandardId::InvalidRequestError, "Either code or id_token must be provided"
+          end
+        end
+
+        def config_schema
+          {
+            apple_client_id: { type: :string, default: nil },
+            apple_mobile_client_id: { type: :string, default: nil },
+            apple_private_key: { type: :string, default: nil },
+            apple_key_id: { type: :string, default: nil },
+            apple_team_id: { type: :string, default: nil }
+          }
+        end
+
+        def default_scope
+          DEFAULT_SCOPE
+        end
+
+        def skip_csrf?
+          true
+        end
+
+        def supports_mobile_callback?
+          true
+        end
+
+        def resolve_params(params, context: {})
+          flow = context[:flow] || :web
+          client_id = flow == :mobile ? StandardId.config.social.apple_mobile_client_id : StandardId.config.social.apple_client_id
+
+          params.merge(client_id: client_id)
+        end
+
+        def exchange_code_for_user_info(code:, redirect_uri:, client_id: StandardId.config.social.apple_client_id)
+          ensure_full_credentials!(client_id: client_id)
+          raise StandardId::InvalidRequestError, "Missing authorization code" if code.blank?
+
+          token_response = HttpClient.post_form(TOKEN_ENDPOINT, {
+                                                  client_id: client_id,
+                                                  client_secret: generate_client_secret(client_id: client_id),
+                                                  code: code,
+                                                  grant_type: "authorization_code",
+                                                  redirect_uri: redirect_uri
+                                                })
+
+          unless token_response.is_a?(Net::HTTPSuccess)
+            error_body = begin
+              JSON.parse(token_response.body)
+            rescue StandardError
+              {}
+            end
+            raise StandardId::InvalidRequestError, "Failed to exchange Apple authorization code: #{error_body["error"]}"
+          end
+
+          parsed_token = JSON.parse(token_response.body)
+          id_token = parsed_token["id_token"]
+          raise StandardId::InvalidRequestError, "Apple response missing id_token" if id_token.blank?
+
+          tokens = extract_token_payload(parsed_token)
+          user_info = verify_id_token(id_token: id_token, client_id: client_id)
+
+          build_response(user_info, tokens: tokens)
+        rescue StandardError => e
+          raise e if e.is_a?(StandardId::OAuthError)
+
+          raise StandardId::OAuthError, e.message, cause: e
+        end
+
+        def verify_id_token(id_token:, client_id: StandardId.config.social.apple_client_id)
+          raise StandardId::InvalidRequestError, "Missing id_token" if id_token.blank?
+          raise StandardId::InvalidRequestError, "Apple client_id is not configured" if client_id.blank?
+
+          decoded_token = JWT.decode(id_token, nil, false)
+          header = decoded_token[1]
+
+          jwk = fetch_jwk(kid: header["kid"])
+
+          verified_payload, = JWT.decode(
+            id_token,
+            jwk.public_key,
+            true,
+            algorithm: "RS256",
+            iss: ISSUER,
+            verify_iss: true,
+            aud: client_id,
+            verify_aud: true
+          )
+
+          {
+            "sub" => verified_payload["sub"],
+            "email" => verified_payload["email"],
+            "email_verified" => verified_payload["email_verified"],
+            "is_private_email" => verified_payload["is_private_email"]
+          }.compact
+        rescue JWT::InvalidAudError => e
+          raise StandardId::InvalidRequestError, "Invalid Apple ID token audience: #{e.message}"
+        rescue JWT::DecodeError => e
+          raise StandardId::InvalidRequestError, "Invalid Apple ID token: #{e.message}"
+        rescue StandardError => e
+          raise e if e.is_a?(StandardId::OAuthError)
+
+          raise StandardId::OAuthError, e.message, cause: e
+        end
+
+        private
+
+        def ensure_basic_credentials!(client_id: StandardId.config.social.apple_client_id)
+          return if client_id.present?
+
+          raise StandardId::InvalidRequestError, "Apple OAuth is not configured"
+        end
+
+        def ensure_full_credentials!(client_id: nil)
+          ensure_basic_credentials!(client_id: client_id)
+
+          required = [
+            StandardId.config.social.apple_private_key,
+            StandardId.config.social.apple_key_id,
+            StandardId.config.social.apple_team_id
+          ]
+
+          return unless required.any?(&:blank?)
+
+          raise StandardId::InvalidRequestError, "Apple OAuth credentials are incomplete"
+        end
+
+        def generate_client_secret(client_id: StandardId.config.social.apple_client_id)
+          header = {
+            alg: "ES256",
+            kid: StandardId.config.social.apple_key_id
+          }
+
+          payload = {
+            iss: StandardId.config.social.apple_team_id,
+            iat: Time.current.to_i,
+            exp: Time.current.to_i + 3600,
+            aud: ISSUER,
+            sub: client_id
+          }
+
+          private_key = OpenSSL::PKey::EC.new(StandardId.config.social.apple_private_key)
+          JWT.encode(payload, private_key, "ES256", header)
+        end
+
+        def fetch_jwk(kid:)
+          uri = URI(JWKS_URI)
+          jwks_response = Net::HTTP.get_response(uri)
+
+          unless jwks_response.is_a?(Net::HTTPSuccess)
+            raise StandardId::InvalidRequestError, "Failed to fetch Apple JWKS"
+          end
+
+          jwks_data = JSON.parse(jwks_response.body)
+          jwk_data = jwks_data["keys"].find { |key| key["kid"] == kid }
+
+          raise StandardId::InvalidRequestError, "JWK with kid '#{kid}' not found in Apple's JWKS" unless jwk_data
+
+          JWT::JWK.import(jwk_data)
+        rescue StandardError => e
+          raise e if e.is_a?(StandardId::OAuthError)
+
+          raise StandardId::OAuthError, "Failed to fetch JWK: #{e.message}"
+        end
+
+        def extract_token_payload(parsed_token)
+          {
+            access_token: parsed_token["access_token"],
+            refresh_token: parsed_token["refresh_token"],
+            id_token: parsed_token["id_token"]
+          }.compact
+        end
+      end
+    end
+  end
+end
+
+StandardId::ProviderRegistry.register(:apple, StandardId::Providers::Apple)

data/lib/standard_id/apple/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module StandardId
+  module Apple
+    VERSION = "0.1.0"
+  end
+end

data/lib/standard_id/apple.rb

@@ -0,0 +1,4 @@
+require "active_support/core_ext/numeric/time"
+require "active_support/core_ext/hash/indifferent_access"
+require "standard_id"
+require "standard_id/apple/providers/apple"

metadata

@@ -0,0 +1,103 @@
+--- !ruby/object:Gem::Specification
+name: standard_id-apple
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jaryl Sim
+bindir: exe
+cert_chain: []
+date: 1980-01-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '8.0'
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.7'
+- !ruby/object:Gem::Dependency
+  name: standard_id
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.7
+description: Extracted StandardId::Providers::Apple implementation packaged as a standalone
+  gem so StandardId installations can opt into Sign in with Apple independently.
+email:
+- code@jaryl.dev
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- ".rubocop.yml"
+- ".ruby-version"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/standard_id/apple.rb
+- lib/standard_id/apple/providers/apple.rb
+- lib/standard_id/apple/version.rb
+homepage: https://github.com/rarebit-one/standard_id_apple
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/rarebit-one/standard_id_apple
+  source_code_uri: https://github.com/rarebit-one/standard_id_apple
+  changelog_uri: https://github.com/rarebit-one/standard_id_apple/blob/main/CHANGELOG.md
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.2.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.6.7
+specification_version: 4
+summary: Apple Sign In provider plugin for the StandardId engine.
+test_files: []