---
title: "sdk/ruby"
description: "ネットワークレス JWT 検証、Rack/Rails リクエスト認証、webhook 署名検証用の Ruby サーバー SDK。"
locale: "ja"
---

> Documentation Index
> Fetch the locale documentation index at: https://xid.dev/ja/llms.txt
> Use this file to discover all available pages before exploring further.

# sdk/ruby

## 状態

ローカルで実装および検証済み。実際の IdP ラウンドトリップ検証（JWKS 取得、実稼働 XID インスタンスに対するトークン署名/検証）はまだ実行されておらず、本番利用前に完了する必要があります。

## インストール

```ruby
# Gemfile
gem "xid"

bundle install
```

## クイックスタート

```ruby
require "xid"

Xid.configure do |c|
  c.issuer         = "https://xid.dev"
  c.audience       = "your_client_id"
  c.webhook_secret = "whsec_AbCdEf..."
end

# Verify a token
begin
  claims = Xid.verify_token(raw_token)
  puts claims.sub    # => "usr_abc123"
  puts claims.scope  # => "openid profile email"
rescue Xid::TokenVerificationError => e
  puts "Token invalid: #{e.message}"
end
```

## Rack/Rails リクエストを認証します

```ruby
# Sinatra before-filter
before do
  auth = Xid.authenticate_request(request)
  halt 401, "Unauthorized" unless auth.signed_in?
  @current_user_id = auth.claims.sub
end

# Rack middleware (env-based)
auth = Xid.authenticate_request(env)
unless auth.signed_in?
  return [401, { "Content-Type" => "application/json" },
      [JSON.generate({ error: auth.reason })]]
end
```

## webhook を検証

```ruby
# Rails controller action
def receive
  raw_body = request.raw_post
  payload = Xid.verify_webhook(request.headers.to_h, raw_body)
  handle_event(payload["type"], payload["data"])
  head :ok
rescue Xid::WebhookVerificationError
  head :bad_request
end
```

## マルチ発行者セットアップ

```ruby
config_a = Xid::Configuration.new
config_a.issuer   = "https://tenant-a.xid.dev"
config_a.audience = "client_a"
client_a = Xid::Client.new(config_a)
claims = client_a.verify_token(token)
```

## 設定オプション

| キー | デフォルト | 説明 |
| --- | --- | --- |
| `issuer` | `https://xid.dev` | OIDC 発行者 URL |
| `audience` | `nil` | expected aud クレーム。nil は検証をスキップします |
| `jwks_ttl` | `3600` | JWKS ローカルキャッシュ TTL（秒） |
| `leeway` | `60` | JWT クロックスキュー許容値（秒） |
| `webhook_secret` | `nil` | `whsec_` プレフィックス付きの webhook 署名シークレット |
| `webhook_tolerance` | `300` | webhook リプレイウィンドウ（秒） |
| `cookie_name` | `__xid_token` | アクセストークン取得用の Cookie キー |

## プラットフォームの注意事項

- `jwt` gem（ES256/RS256 サポート）が必要です。Ruby 3.1+ が必要です。
- `Xid.authenticate_request` は Rack env ハッシュと Rack `Request` オブジェクトの両方を受け入れます。
- 例外階層：`Xid::Error` -> `ConfigurationError`、`JwksError`、`TokenVerificationError`、`WebhookVerificationError`。

Source: https://xid.dev/ja/sdks/ruby/index.mdx