keycloak-sdk 0.1.0.rc1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4eb3a4588a71244645523375b79cbdbef40d27a027facea631d923f1f75b6fb8
+  data.tar.gz: c54cb3c59bd0c5064210a5c87feeeb6b9b56a7870c033faaf27ab767dade080f
+SHA512:
+  metadata.gz: 212c4c09ee351c966aa96ee9c6727056faab13dbc7865d969613f9ecfc7eae503071354f7da283c439cce5135428f9647a71949b06e1777765ff19fba1beb490
+  data.tar.gz: 4d7e28fa1428d4b6b3237b21a523d072f698b142a763f5160a2fa414dd030b0e2b42c37d97f653ed642282e3734d07422df3e80771aa337738b394a2148b33e9

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or Derivative
+          Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 xzawed
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,88 @@
+# Keycloak SDK for Ruby
+
+Authentication (OIDC / OAuth2) and the Admin REST API for [Keycloak](https://www.keycloak.org/) behind one consistent facade, with hardened JWT validation.
+
+English · [한국어](https://github.com/xzawed/KeyCloakSDK/blob/main/ruby/README.ko.md)
+
+Part of a **nine-language polyglot SDK** (Java · Python · Node · Go · C# · PHP · Rust · Ruby · Kotlin) — one API surface, isomorphic across all of them: [github.com/xzawed/KeyCloakSDK](https://github.com/xzawed/KeyCloakSDK).
+
+> **Pre-release** — the first release candidate (`0.1.0.rc1`) is on RubyGems; there is no stable release yet. ⚠️ **RubyGems does not install a pre-release by default**: a bare `gem install keycloak-sdk` finds nothing until a stable version exists. Ask for it explicitly — `gem install keycloak-sdk --pre`, or pin the exact version as shown below.
+
+## Requirements
+
+- Ruby **3.2+**
+- Sync-only (every wrapped gem is synchronous); exception-based error handling under `KeycloakSdk::Error`
+
+## Install
+
+```bash
+gem install keycloak-sdk -v 0.1.0.rc1
+```
+
+Or in a `Gemfile`:
+
+```ruby
+gem "keycloak-sdk", "0.1.0.rc1"
+```
+
+While `0.1.0.rc1` is the only release, the version must be explicit — `gem install keycloak-sdk` and a bare `gem "keycloak-sdk"` both skip pre-releases and resolve nothing. Drop the pin once a stable release exists.
+
+> **Name mismatch, on purpose:** the gem is `keycloak-sdk` (hyphen) but the require path and module are `keycloak_sdk` / `KeycloakSdk` (underscore) — this avoids colliding with the existing `keycloak` gem's `Keycloak` module.
+
+## Quickstart
+
+```ruby
+require "keycloak_sdk"
+
+config = KeycloakSdk::Config.new(
+  server_url: "https://kc.example.com",
+  realm: "myrealm",
+  client_id: "admin-cli",
+  client_secret: "changeme" # load the real value from an env var / secrets manager
+)
+
+client = KeycloakSdk::KeycloakClient.new(config)
+
+# 1) Issue a token via the client-credentials grant. TokenSet#inspect masks every token value.
+token = client.auth.client_credentials_token
+
+# 2) Validate it — algorithm pinning, exact iss, aud containment, mandatory exp, nbf, clock skew.
+validated = client.auth.validate(token.access_token)
+puts "subject=#{validated.subject} aud=#{validated.audience}"
+
+# 3) Admin API — admin is created lazily on first access. create() returns the new user id.
+user_id = client.admin.users.create({ username: "alice", enabled: true })
+client.admin.users.delete(user_id)
+
+client.close
+```
+
+> **Audience:** validation requires the token's `aud` to contain `client_id`. A stock realm does *not* put the client id in a client-credentials token's `aud`, so on a default realm either pass `expected_audience: "my-api"` (the audience your realm actually issues), or add an *Audience* protocol mapper to the client in Keycloak.
+
+The five admin resources — `users` / `clients` / `roles` / `groups` / `realms` — offer symmetric CRUD, and `client.admin.raw` is the escape hatch to the underlying bearer-authenticated `Faraday::Connection`.
+
+## Security defaults
+
+The SDK replaces the unsafe library defaults rather than inheriting them:
+
+- **Algorithm pinning** — the header-supplied `alg` is never trusted, so `alg: none` and HS/RS confusion are rejected structurally: the pin is applied before key lookup and signature verification, not after.
+- **Strict claim checks** — exact `iss` match, `aud` containment, mandatory `exp`, `nbf`, and a bounded clock skew.
+- **DoS-safe JWKS** — a refetch is triggered only by an unresolved key ID and never by a bad signature, and is rate-limited to a minimum interval (`jwks_min_refetch`, 30s by default). The gate applies on a cold cache too, so it cannot be sidestepped by hitting the SDK before its first successful fetch — no volume of forged tokens makes the SDK issue more than one JWKS request per interval.
+- **Secret handling** — `Config`, `TokenSet`, and `AuthorizationRequest` mask secrets and tokens in `#inspect` (`***`, no prefix leak), TLS verification is on by default, timeouts are always applied, and redirect-following middleware is never installed (SSRF hardening).
+
+Masking covers this SDK's own `#inspect`; it cannot cover what your logging framework or a backtrace does with a value you hand it. Ruby has no erasable string type, so the client secret lives in an ordinary `String` for its lifetime — masking is defence in depth, not an erasure guarantee.
+
+## Versioning and support
+
+This SDK is **pre-1.0**. Under SemVer a `0.x` **minor** bump may carry breaking changes, so read the release notes before upgrading. Only the newest released version of each language SDK receives security fixes — there are no LTS lines, and older `0.x` releases are not backported to. Full policy: [SECURITY.md](https://github.com/xzawed/KeyCloakSDK/blob/main/SECURITY.md).
+
+## Documentation
+
+- [Getting started](https://github.com/xzawed/KeyCloakSDK/blob/main/docs/guides/getting-started.md#ruby) — install, quickstart, and the compatibility matrix
+- [Deploying a Keycloak server](https://github.com/xzawed/KeyCloakSDK/blob/main/docs/guides/deploying-keycloak-server.md) — the server this SDK talks to
+- [Security policy](https://github.com/xzawed/KeyCloakSDK/blob/main/SECURITY.md)
+- Full example: [`examples/quickstart.rb`](https://github.com/xzawed/KeyCloakSDK/blob/main/ruby/examples/quickstart.rb)
+
+## License
+
+[Apache-2.0](https://github.com/xzawed/KeyCloakSDK/blob/main/ruby/LICENSE)

data/lib/keycloak_sdk/admin/admin_client.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+module KeycloakSdk
+  module Admin
+    # Admin REST 파사드. gem 없이 Faraday로 직접 래핑하고, bearer는 주입된 TokenProvider에서 소싱한다.
+    # representation은 plain hash로 통과한다(문서화된 은닉성 예외).
+    class AdminClient
+      def initialize(config:, token_provider:)
+        @config = config
+        @conn = build_conn(config, token_provider)
+      end
+
+      def users
+        Users.new(@conn, @config.realm)
+      end
+
+      def clients
+        Clients.new(@conn, @config.realm)
+      end
+
+      def realms
+        Realms.new(@conn)
+      end
+
+      def roles
+        Roles.new(@conn, @config.realm)
+      end
+
+      def groups
+        Groups.new(@conn, @config.realm)
+      end
+
+      # 탈출구: 내부 Faraday 커넥션(base = {server_url}/, bearer 자동).
+      def raw
+        @conn
+      end
+
+      # 자원 정리: 내부 Faraday 커넥션을 닫는다(§4 close 계약 — KeycloakClient#close가 위임).
+      def close
+        @conn.close if @conn.respond_to?(:close)
+      end
+
+      private
+
+      def build_conn(config, token_provider)
+        Http.build(config, base_url: "#{config.server_url}/") do |f|
+          f.request :json
+          f.response :json, content_type: /\bjson$/
+          f.use BearerAuth, token_provider
+        end
+      end
+    end
+  end
+end

data/lib/keycloak_sdk/admin/bearer_auth.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "faraday"
+
+module KeycloakSdk
+  module Admin
+    # 매 요청마다 TokenProvider에서 bearer 토큰을 소싱해 Authorization 헤더를 설정한다.
+    class BearerAuth < Faraday::Middleware
+      def initialize(app, token_provider)
+        super(app)
+        @token_provider = token_provider
+      end
+
+      def on_request(env)
+        env.request_headers["Authorization"] = "Bearer #{@token_provider.access_token}"
+      end
+    end
+  end
+end

data/lib/keycloak_sdk/admin/call.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module KeycloakSdk
+  module Admin
+    # 리소스 공용: 요청 실행 + 오류 경계 변환 + Location 헤더 id 추출.
+    module Call
+      private
+
+      def request
+        resp = yield
+        return resp if resp.success?
+
+        raise AdminError.from_status(resp.status, "admin request failed: HTTP #{resp.status}")
+      rescue Faraday::Error => e
+        raise TransportError, "admin transport error: #{e.message}"
+      end
+
+      def id_from_location(resp)
+        loc = resp.headers["location"]
+        loc&.split("/")&.last
+      end
+    end
+  end
+end

data/lib/keycloak_sdk/admin/clients.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module KeycloakSdk
+  module Admin
+    class Clients
+      include Call
+
+      def initialize(conn, realm)
+        @conn = conn
+        @realm = realm
+      end
+
+      def create(representation)
+        id_from_location(request { @conn.post("admin/realms/#{@realm}/clients", representation) })
+      end
+
+      def get(id)
+        request { @conn.get("admin/realms/#{@realm}/clients/#{id}") }.body
+      end
+
+      # client_id로 조회: 목록 + 필터(admin은 내부 uuid 키).
+      def list(**params)
+        request { @conn.get("admin/realms/#{@realm}/clients", params) }.body
+      end
+
+      def update(id, representation)
+        request { @conn.put("admin/realms/#{@realm}/clients/#{id}", representation) }
+        nil
+      end
+
+      def delete(id)
+        request { @conn.delete("admin/realms/#{@realm}/clients/#{id}") }
+        nil
+      end
+    end
+  end
+end

data/lib/keycloak_sdk/admin/groups.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module KeycloakSdk
+  module Admin
+    class Groups
+      include Call
+
+      def initialize(conn, realm)
+        @conn = conn
+        @realm = realm
+      end
+
+      def create(representation)
+        id_from_location(request { @conn.post("admin/realms/#{@realm}/groups", representation) })
+      end
+
+      def get(id)
+        request { @conn.get("admin/realms/#{@realm}/groups/#{id}") }.body
+      end
+
+      def list(**params)
+        request { @conn.get("admin/realms/#{@realm}/groups", params) }.body
+      end
+
+      def update(id, representation)
+        request { @conn.put("admin/realms/#{@realm}/groups/#{id}", representation) }
+        nil
+      end
+
+      def delete(id)
+        request { @conn.delete("admin/realms/#{@realm}/groups/#{id}") }
+        nil
+      end
+    end
+  end
+end

data/lib/keycloak_sdk/admin/realms.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module KeycloakSdk
+  module Admin
+    # top-level — name 키.
+    class Realms
+      include Call
+
+      def initialize(conn)
+        @conn = conn
+      end
+
+      # POST /admin/realms — master realm 전용(realm SA는 403). 반환: realm 이름.
+      def create(representation)
+        request { @conn.post("admin/realms", representation) }
+        representation[:realm] || representation["realm"]
+      end
+
+      def get(realm)
+        request { @conn.get("admin/realms/#{realm}") }.body
+      end
+
+      def list
+        request { @conn.get("admin/realms") }.body
+      end
+
+      def update(realm, representation)
+        request { @conn.put("admin/realms/#{realm}", representation) }
+        nil
+      end
+
+      def delete(realm)
+        request { @conn.delete("admin/realms/#{realm}") }
+        nil
+      end
+    end
+  end
+end

data/lib/keycloak_sdk/admin/roles.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module KeycloakSdk
+  module Admin
+    class Roles
+      include Call
+
+      def initialize(conn, realm)
+        @conn = conn
+        @realm = realm
+      end
+
+      def create(representation)
+        id_from_location(request { @conn.post("admin/realms/#{@realm}/roles", representation) })
+      end
+
+      def get(name)
+        request { @conn.get("admin/realms/#{@realm}/roles/#{name}") }.body
+      end
+
+      def list(**params)
+        request { @conn.get("admin/realms/#{@realm}/roles", params) }.body
+      end
+
+      def update(name, representation)
+        request { @conn.put("admin/realms/#{@realm}/roles/#{name}", representation) }
+        nil
+      end
+
+      def delete(name)
+        request { @conn.delete("admin/realms/#{@realm}/roles/#{name}") }
+        nil
+      end
+    end
+  end
+end

data/lib/keycloak_sdk/admin/users.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module KeycloakSdk
+  module Admin
+    class Users
+      include Call
+
+      def initialize(conn, realm)
+        @conn = conn
+        @realm = realm
+      end
+
+      def create(representation)
+        id_from_location(request { @conn.post("admin/realms/#{@realm}/users", representation) })
+      end
+
+      def get(id)
+        request { @conn.get("admin/realms/#{@realm}/users/#{id}") }.body
+      end
+
+      def list(**params)
+        request { @conn.get("admin/realms/#{@realm}/users", params) }.body
+      end
+
+      def update(id, representation)
+        request { @conn.put("admin/realms/#{@realm}/users/#{id}", representation) }
+        nil
+      end
+
+      def delete(id)
+        request { @conn.delete("admin/realms/#{@realm}/users/#{id}") }
+        nil
+      end
+    end
+  end
+end