Module: BetterAuth::Plugins::OAuthProtocol

Defined in:
lib/better_auth/plugins/oauth_protocol.rb

Constant Summary collapse

AUTH_CODE_GRANT = 
"authorization_code"
REFRESH_GRANT = 
"refresh_token"
CLIENT_CREDENTIALS_GRANT = 
"client_credentials"
DEVICE_CODE_GRANT = 
"urn:ietf:params:oauth:grant-type:device_code"

Class Method Summary collapse

Class Method Details

.authenticate_client!(ctx, model, store_client_secret: "plain") ⇒ Object 



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/better_auth/plugins/oauth_protocol.rb', line 135

def authenticate_client!(ctx, model, store_client_secret: "plain")
  body = stringify_keys(ctx.body || {})
  client_id = body["client_id"]
  client_secret = body["client_secret"]

  authorization = ctx.headers["authorization"]
  if authorization.to_s.start_with?("Basic ") && client_id.to_s.empty?
    decoded = Base64.decode64(authorization.delete_prefix("Basic "))
    client_id, client_secret = decoded.split(":", 2)
  end

  client = find_client(ctx, model, client_id)
  raise APIError.new("UNAUTHORIZED", message: "invalid_client") unless client

  method = stringify_keys(client)["tokenEndpointAuthMethod"] || "client_secret_basic"
  if method != "none" && !verify_client_secret(ctx, stringify_keys(client)["clientSecret"], client_secret, store_client_secret)
    raise APIError.new("UNAUTHORIZED", message: "invalid_client")
  end

  client
rescue ArgumentError
  raise APIError.new("UNAUTHORIZED", message: "invalid_client")
end

.client_logout_redirect_uris(client) ⇒ Object 



67
68
69
70
71
72
 
# File 'lib/better_auth/plugins/oauth_protocol.rb', line 67

def client_logout_redirect_uris(client)
  value = client["postLogoutRedirectUris"] || client[:post_logout_redirect_uris]
  return value if value.is_a?(Array)

  value.to_s.split(",").map(&:strip).reject(&:empty?)
end

.client_redirect_uris(client) ⇒ Object 



60
61
62
63
64
65
 
# File 'lib/better_auth/plugins/oauth_protocol.rb', line 60

def client_redirect_uris(client)
  value = client["redirectUris"] || client["redirectUrls"] || client[:redirect_uris] || client[:redirectUrls]
  return value if value.is_a?(Array)

  value.to_s.split(",").map(&:strip).reject(&:empty?)
end

.client_response(client, include_secret: true) ⇒ Object 



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
 
# File 'lib/better_auth/plugins/oauth_protocol.rb', line 111

def client_response(client, include_secret: true)
  data = stringify_keys(client || {})
  response = {
    client_id: data["clientId"],
    client_name: data["name"],
    client_uri: data["uri"],
    logo_uri: data["icon"],
    redirect_uris: client_redirect_uris(data),
    post_logout_redirect_uris: client_logout_redirect_uris(data),
    token_endpoint_auth_method: data["tokenEndpointAuthMethod"] || "client_secret_basic",
    grant_types: data["grantTypes"] || [],
    response_types: data["responseTypes"] || [],
    skip_consent: !!data["skipConsent"],
    scope: scope_string(data["scopes"]),
    metadata: data["metadata"]
  }
  response[:client_secret] = data["clientSecret"] if include_secret && data["clientSecret"]
  response
end

.consume_code!(store, code, client_id:, redirect_uri:, code_verifier: nil) ⇒ Object

Raises:



171
172
173
174
175
176
177
178
179
180
 
# File 'lib/better_auth/plugins/oauth_protocol.rb', line 171

def consume_code!(store, code, client_id:, redirect_uri:, code_verifier: nil)
  data = store[:codes].delete(code.to_s)
  raise APIError.new("BAD_REQUEST", message: "invalid_grant") unless data
  raise APIError.new("BAD_REQUEST", message: "invalid_grant") if data[:expires_at] <= Time.now
  raise APIError.new("BAD_REQUEST", message: "invalid_grant") unless data[:client_id] == client_id.to_s
  raise APIError.new("BAD_REQUEST", message: "invalid_grant") unless data[:redirect_uri] == redirect_uri.to_s
  verify_pkce!(data, code_verifier) if data[:code_challenge]

  data
end

.create_client(ctx, model:, body:, owner_session: nil, default_auth_method: "client_secret_basic", store_client_secret: "plain") ⇒ Object

Raises:



74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/better_auth/plugins/oauth_protocol.rb', line 74

def create_client(ctx, model:, body:, owner_session: nil, default_auth_method: "client_secret_basic", store_client_secret: "plain")
  body = stringify_keys(body || {})
  auth_method = body["token_endpoint_auth_method"] || default_auth_method
  public_client = auth_method == "none"
  client_id = body["client_id"] || Crypto.random_string(32)
  client_secret = public_client ? nil : (body["client_secret"] || Crypto.random_string(32))
  redirects = Array(body["redirect_uris"]).map(&:to_s)
  raise APIError.new("BAD_REQUEST", message: "redirect_uris is required") if redirects.empty?

  scopes = parse_scopes(body["scope"] || body["scopes"])
  data = {
    "clientId" => client_id,
    "clientSecret" => client_secret ? store_client_secret_value(ctx, client_secret, store_client_secret) : nil,
    "type" => public_client ? "public" : "web",
    "name" => body["client_name"] || body["name"] || "OAuth Client",
    "icon" => body["logo_uri"],
    "uri" => body["client_uri"],
    "redirectUris" => redirects,
    "redirectUrls" => redirects.join(","),
    "postLogoutRedirectUris" => Array(body["post_logout_redirect_uris"]).map(&:to_s),
    "tokenEndpointAuthMethod" => auth_method,
    "grantTypes" => Array(body["grant_types"] || [AUTH_CODE_GRANT]),
    "responseTypes" => Array(body["response_types"] || ["code"]),
    "scopes" => scopes,
    "skipConsent" => body["skip_consent"] || body["skipConsent"] || false,
    "metadata" => body["metadata"] || {},
    "disabled" => false
  }
  data["userId"] = owner_session[:user]["id"] if owner_session
  created = ctx.context.adapter.create(model: model, data: data)
  client_response(created).merge(
    client_secret: client_secret,
    client_id_issued_at: Time.now.to_i,
    client_secret_expires_at: 0
  ).compact
end

.endpoint_base(ctx) ⇒ Object 



34
35
36
 
# File 'lib/better_auth/plugins/oauth_protocol.rb', line 34

def endpoint_base(ctx)
  ctx.context.base_url
end

.find_client(ctx, model, client_id) ⇒ Object 



131
132
133
 
# File 'lib/better_auth/plugins/oauth_protocol.rb', line 131

def find_client(ctx, model, client_id)
  ctx.context.adapter.find_one(model: model, where: [{field: "clientId", value: client_id.to_s}])
end

.id_token(user, client_id, issuer_value, audience, ctx: nil, signer: nil) ⇒ Object 



281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/better_auth/plugins/oauth_protocol.rb', line 281

def id_token(user, client_id, issuer_value, audience, ctx: nil, signer: nil)
  payload = {
    sub: user["id"],
    iss: issuer_value,
    aud: audience || client_id,
    email: user["email"],
    email_verified: !!user["emailVerified"],
    name: user["name"]
  }
  return signer.call(ctx, payload) if signer.respond_to?(:call)

  Crypto.sign_jwt(
    payload,
    client_id.to_s.empty? ? "better-auth" : client_id.to_s,
    expires_in: 3600
  )
end

.issue_tokens(ctx, store, model:, client:, session:, scopes:, include_refresh: false, issuer: nil, jwt_audience: nil, access_token_expires_in: 3600, id_token_signer: nil) ⇒ Object 



193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
 
# File 'lib/better_auth/plugins/oauth_protocol.rb', line 193

def issue_tokens(ctx, store, model:, client:, session:, scopes:, include_refresh: false, issuer: nil, jwt_audience: nil, access_token_expires_in: 3600, id_token_signer: nil)
  data = stringify_keys(session || {})
  user = stringify_keys(data["user"] || data[:user] || {})
  session_data = stringify_keys(data["session"] || data[:session] || {})
  client_data = stringify_keys(client)
  access_token = "ba_at_#{Crypto.random_string(32)}"
  refresh_token = include_refresh ? "ba_rt_#{Crypto.random_string(32)}" : nil
  scope = scope_string(scopes)
  expires_at = Time.now + access_token_expires_in.to_i
  record = {
    "accessToken" => access_token,
    "token" => access_token,
    "refreshToken" => refresh_token,
    "accessTokenExpiresAt" => expires_at,
    "expiresAt" => expires_at,
    "clientId" => client_data["clientId"],
    "userId" => user["id"],
    "sessionId" => session_data["id"],
    "scope" => scope,
    "scopes" => parse_scopes(scope),
    "revoked" => nil
  }
  ctx.context.adapter.create(model: model, data: record)
  stored_record = record.merge("user" => user, "session" => session_data, "client" => client_data)
  store[:tokens][access_token] = stored_record
  store[:refresh_tokens][refresh_token] = stored_record if refresh_token

  response = {
    access_token: access_token,
    token_type: "Bearer",
    expires_in: access_token_expires_in.to_i,
    scope: scope
  }
  response[:refresh_token] = refresh_token if refresh_token
  response[:id_token] = id_token(user, client_data["clientId"], issuer || issuer(ctx), jwt_audience || client_data["clientId"], ctx: ctx, signer: id_token_signer) if parse_scopes(scope).include?("openid")
  response
end

.issuer(ctx) ⇒ Object 



30
31
32
 
# File 'lib/better_auth/plugins/oauth_protocol.rb', line 30

def issuer(ctx)
  ctx.context.options.base_url.to_s.empty? ? origin_for(ctx.context.base_url) : ctx.context.options.base_url
end

.normalize_secret_storage_mode(mode) ⇒ Object 



325
326
327
328
329
 
# File 'lib/better_auth/plugins/oauth_protocol.rb', line 325

def normalize_secret_storage_mode(mode)
  return stringify_keys(mode).transform_keys(&:to_sym) if mode.is_a?(Hash)

  mode.to_s
end

.origin_for(url) ⇒ Object 



38
39
40
41
42
43
 
# File 'lib/better_auth/plugins/oauth_protocol.rb', line 38

def origin_for(url)
  uri = URI.parse(url.to_s)
  port = uri.port
  default_port = (uri.scheme == "http" && port == 80) || (uri.scheme == "https" && port == 443)
  default_port ? "#{uri.scheme}://#{uri.host}" : "#{uri.scheme}://#{uri.host}:#{port}"
end

.parse_scopes(value) ⇒ Object 



17
18
19
20
21
22
23
24
 
# File 'lib/better_auth/plugins/oauth_protocol.rb', line 17

def parse_scopes(value)
  case value
  when Array
    value.map(&:to_s).reject(&:empty?)
  else
    value.to_s.split(/\s+/).reject(&:empty?)
  end
end

.redirect_uri_with_params(uri, params) ⇒ Object 



45
46
47
48
49
50
51
 
# File 'lib/better_auth/plugins/oauth_protocol.rb', line 45

def redirect_uri_with_params(uri, params)
  parsed = URI.parse(uri.to_s)
  existing = URI.decode_www_form(parsed.query.to_s)
  params.each { |key, value| existing << [key.to_s, value.to_s] unless value.nil? }
  parsed.query = URI.encode_www_form(existing)
  parsed.to_s
end

.refresh_tokens(ctx, store, model:, client:, refresh_token:, scopes: nil, issuer: nil, access_token_expires_in: 3600, id_token_signer: nil) ⇒ Object

Raises:



231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
 
# File 'lib/better_auth/plugins/oauth_protocol.rb', line 231

def refresh_tokens(ctx, store, model:, client:, refresh_token:, scopes: nil, issuer: nil, access_token_expires_in: 3600, id_token_signer: nil)
  data = store[:refresh_tokens].delete(refresh_token.to_s)
  raise APIError.new("BAD_REQUEST", message: "invalid_grant") unless data
  requested = scopes ? parse_scopes(scopes) : data["scopes"]
  unless requested.all? { |scope| data["scopes"].include?(scope) }
    raise APIError.new("BAD_REQUEST", message: "invalid_scope")
  end

  issue_tokens(
    ctx,
    store,
    model: model,
    client: client,
    session: {"user" => data["user"], "session" => data["session"]},
    scopes: requested,
    include_refresh: true,
    issuer: issuer,
    access_token_expires_in: access_token_expires_in,
    id_token_signer: id_token_signer
  )
end

.scope_string(value) ⇒ Object 



26
27
28
 
# File 'lib/better_auth/plugins/oauth_protocol.rb', line 26

def scope_string(value)
  parse_scopes(value).join(" ")
end

.store_client_secret_value(ctx, secret, mode) ⇒ Object 



299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/better_auth/plugins/oauth_protocol.rb', line 299

def store_client_secret_value(ctx, secret, mode)
  mode = normalize_secret_storage_mode(mode)
  return Crypto.sha256(secret, encoding: :base64url) if mode == "hashed"
  return Crypto.symmetric_encrypt(key: ctx.context.secret, data: secret) if mode == "encrypted"

  if mode.is_a?(Hash)
    return mode[:hash].call(secret) if mode[:hash].respond_to?(:call)
    return mode[:encrypt].call(secret) if mode[:encrypt].respond_to?(:call)
  end

  secret
end

.store_code(store, code:, client_id:, redirect_uri:, session:, scopes:, code_challenge: nil, code_challenge_method: nil) ⇒ Object 



159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/better_auth/plugins/oauth_protocol.rb', line 159

def store_code(store, code:, client_id:, redirect_uri:, session:, scopes:, code_challenge: nil, code_challenge_method: nil)
  store[:codes][code] = {
    client_id: client_id,
    redirect_uri: redirect_uri,
    session: session,
    scopes: parse_scopes(scopes),
    code_challenge: code_challenge,
    code_challenge_method: code_challenge_method,
    expires_at: Time.now + 600
  }
end

.stores ⇒ Object 



331
332
333
334
335
336
337
338
 
# File 'lib/better_auth/plugins/oauth_protocol.rb', line 331

def stores
  {
    codes: {},
    tokens: {},
    refresh_tokens: {},
    consents: {}
  }
end

.stringify_keys(value) ⇒ Object 



340
341
342
343
344
345
 
# File 'lib/better_auth/plugins/oauth_protocol.rb', line 340

def stringify_keys(value)
  return value.each_with_object({}) { |(key, object_value), result| result[key.to_s] = stringify_keys(object_value) } if value.is_a?(Hash)
  return value.map { |entry| stringify_keys(entry) } if value.is_a?(Array)

  value
end

.token_record(store, token) ⇒ Object 



253
254
255
256
257
258
259
260
 
# File 'lib/better_auth/plugins/oauth_protocol.rb', line 253

def token_record(store, token)
  data = store[:tokens][token.to_s]
  return nil unless data
  return nil if data["revoked"]
  return nil if data["expiresAt"] && data["expiresAt"] <= Time.now

  data
end

.userinfo(store, authorization, additional_claim: nil) ⇒ Object

Raises:



262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/better_auth/plugins/oauth_protocol.rb', line 262

def userinfo(store, authorization, additional_claim: nil)
  token = authorization.to_s.delete_prefix("Bearer ").strip
  record = token_record(store, token)
  raise APIError.new("UNAUTHORIZED", message: "invalid_token") unless record
  user = stringify_keys(record["user"])
  scopes = parse_scopes(record["scope"] || record["scopes"])
  response = {sub: user["id"]}
  response[:name] = user["name"] if scopes.include?("profile")
  if scopes.include?("email")
    response[:email] = user["email"]
    response[:email_verified] = !!user["emailVerified"]
  end
  if additional_claim.respond_to?(:call)
    extra = additional_claim.call(user, scopes, stringify_keys(record["client"] || {}))
    response.merge!(extra) if extra.is_a?(Hash)
  end
  response
end

.validate_redirect_uri!(client, redirect_uri) ⇒ Object

Raises:



53
54
55
56
57
58
 
# File 'lib/better_auth/plugins/oauth_protocol.rb', line 53

def validate_redirect_uri!(client, redirect_uri)
  redirects = client_redirect_uris(client)
  return if redirects.include?(redirect_uri.to_s)

  raise APIError.new("BAD_REQUEST", message: "invalid redirect_uri")
end

.verify_client_secret(ctx, stored_secret, provided_secret, mode) ⇒ Object 



312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/better_auth/plugins/oauth_protocol.rb', line 312

def verify_client_secret(ctx, stored_secret, provided_secret, mode)
  mode = normalize_secret_storage_mode(mode)
  return Crypto.constant_time_compare(Crypto.sha256(provided_secret, encoding: :base64url), stored_secret.to_s) if mode == "hashed"
  return Crypto.symmetric_decrypt(key: ctx.context.secret, data: stored_secret) == provided_secret.to_s if mode == "encrypted"

  if mode.is_a?(Hash)
    return mode[:hash].call(provided_secret).to_s == stored_secret.to_s if mode[:hash].respond_to?(:call)
    return mode[:decrypt].call(stored_secret).to_s == provided_secret.to_s if mode[:decrypt].respond_to?(:call)
  end

  Crypto.constant_time_compare(stored_secret.to_s, provided_secret.to_s)
end

.verify_pkce!(code_data, verifier) ⇒ Object

Raises:



182
183
184
185
186
187
188
189
190
191
 
# File 'lib/better_auth/plugins/oauth_protocol.rb', line 182

def verify_pkce!(code_data, verifier)
  raise APIError.new("BAD_REQUEST", message: "invalid_grant") if verifier.to_s.empty?

  challenge = if code_data[:code_challenge_method].to_s == "S256"
    Base64.urlsafe_encode64(OpenSSL::Digest.digest("SHA256", verifier.to_s), padding: false)
  else
    verifier.to_s
  end
  raise APIError.new("BAD_REQUEST", message: "invalid_grant") unless challenge == code_data[:code_challenge]
end