Module: BetterAuth::Passkey::Utils

Defined in:
lib/better_auth/passkey/utils.rb

Class Method Summary collapse

Class Method Details

.after_registration_verification_user_id(config, ctx, credential, challenge, response, session) ⇒ Object 



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/better_auth/passkey/utils.rb', line 137

def after_registration_verification_user_id(config, ctx, credential, challenge, response, session)
  user_data = challenge.fetch("userData")
  target_user_id = user_data.fetch("id")
  callback = config.dig(:registration, :after_verification)
  return target_user_id unless callback.respond_to?(:call)

  result = normalize_hash(call_callback(callback, {
    ctx: ctx,
    verification: credential,
    user: {
      id: user_data.fetch("id"),
      name: user_data["name"] || user_data.fetch("id"),
      display_name: user_data["displayName"] || user_data["display_name"]
    },
    client_data: response,
    context: challenge["context"]
  }) || {})
  returned_user_id = result[:user_id]
  return target_user_id if returned_user_id.nil? || returned_user_id == ""

  unless returned_user_id.is_a?(String) && returned_user_id.length.positive?
    raise APIError.new("BAD_REQUEST", message: BetterAuth::Passkey::ErrorCodes::PASSKEY_ERROR_CODES.fetch("RESOLVED_USER_INVALID"))
  end

  if session && returned_user_id != session.fetch(:user).fetch("id")
    raise APIError.new("UNAUTHORIZED", message: BetterAuth::Passkey::ErrorCodes::PASSKEY_ERROR_CODES.fetch("YOU_ARE_NOT_ALLOWED_TO_REGISTER_THIS_PASSKEY"))
  end

  returned_user_id
end

.allowed_origins(config, ctx, origin: nil) ⇒ Object 



27
28
29
30
31
32
 
# File 'lib/better_auth/passkey/utils.rb', line 27

def allowed_origins(config, ctx, origin: nil)
  _request_origin = origin
  configured = config.key?(:origin) ? config[:origin] : nil
  origins = configured || context_base_url(ctx)
  Array(origins).compact.map { |value| origin_for(value) }
end

.authenticator_selection(config, query) ⇒ Object 



47
48
49
50
51
52
53
54
55
56
 
# File 'lib/better_auth/passkey/utils.rb', line 47

def authenticator_selection(config, query)
  selection = normalize_hash(config[:authenticator_selection] || {})
  attachment = query[:authenticator_attachment]
  selection[:authenticator_attachment] = attachment if attachment
  {
    resident_key: selection[:resident_key] || "preferred",
    user_verification: selection[:user_verification] || "preferred",
    authenticator_attachment: selection[:authenticator_attachment]
  }.compact
end

.call_callback(callback, data) ⇒ Object 



168
169
170
171
172
173
174
175
176
 
# File 'lib/better_auth/passkey/utils.rb', line 168

def call_callback(callback, data)
  return nil unless callback.respond_to?(:call)

  if callback.parameters.any? { |kind, _name| [:key, :keyreq, :keyrest].include?(kind) }
    callback.call(**data)
  else
    callback.call(data)
  end
end

.context_base_url(ctx) ⇒ Object 



178
179
180
181
182
183
184
 
# File 'lib/better_auth/passkey/utils.rb', line 178

def context_base_url(ctx)
  if ctx.context.respond_to?(:base_url)
    ctx.context.base_url
  else
    ctx.context.options.base_url
  end
end

.normalize_hash(value) ⇒ Object 



11
12
13
 
# File 'lib/better_auth/passkey/utils.rb', line 11

def normalize_hash(value)
  BetterAuth::Passkey::Schema.normalize_hash(value)
end

.origin(config, ctx) ⇒ Object 



23
24
25
 
# File 'lib/better_auth/passkey/utils.rb', line 23

def origin(config, ctx)
  config[:origin] || ctx.headers["origin"]
end

.origin_for(value) ⇒ Object 



192
193
194
195
196
197
198
199
200
201
 
# File 'lib/better_auth/passkey/utils.rb', line 192

def origin_for(value)
  uri = URI.parse(value.to_s)
  if uri.scheme && uri.host
    BetterAuth::Configuration.origin_for(uri) || value.to_s
  else
    value.to_s
  end
rescue URI::InvalidURIError
  value.to_s
end

.registration_user_data(id:, name:, display_name: nil, email: nil) ⇒ Object 



122
123
124
125
126
127
128
129
 
# File 'lib/better_auth/passkey/utils.rb', line 122

def registration_user_data(id:, name:, display_name: nil, email: nil)
  {
    "id" => id,
    "name" => name,
    "displayName" => display_name,
    "email" => email
  }.compact
end

.relying_party(config, ctx, origin: nil) ⇒ Object 



15
16
17
18
19
20
21
 
# File 'lib/better_auth/passkey/utils.rb', line 15

def relying_party(config, ctx, origin: nil)
  WebAuthn::RelyingParty.new(
    id: rp_id(config, ctx),
    name: config[:rp_name] || ctx.context.app_name,
    allowed_origins: allowed_origins(config, ctx, origin: origin)
  )
end

.require_key!(body, key) ⇒ Object

Raises:

  • (APIError) 


64
65
66
67
68
 
# File 'lib/better_auth/passkey/utils.rb', line 64

def require_key!(body, key)
  return if body.key?(key)

  raise APIError.new("BAD_REQUEST", message: BASE_ERROR_CODES.fetch("VALIDATION_ERROR"))
end

.require_string!(body, key) ⇒ Object

Raises:

  • (APIError) 


70
71
72
73
74
75
 
# File 'lib/better_auth/passkey/utils.rb', line 70

def require_string!(body, key)
  require_key!(body, key)
  return if body[key].is_a?(String)

  raise APIError.new("BAD_REQUEST", message: BASE_ERROR_CODES.fetch("VALIDATION_ERROR"))
end

.resolve_extensions(extensions, ctx) ⇒ Object 



131
132
133
134
135
 
# File 'lib/better_auth/passkey/utils.rb', line 131

def resolve_extensions(extensions, ctx)
  return nil unless extensions

  normalize_hash(extensions.respond_to?(:call) ? call_callback(extensions, {ctx: ctx}) : extensions)
end

.resolve_registration_user(config, ctx, query) ⇒ Object 



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
110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/better_auth/passkey/utils.rb', line 77

def resolve_registration_user(config, ctx, query)
  require_session = config.dig(:registration, :require_session) != false
  if require_session
    session = BetterAuth::Routes.current_session(ctx, allow_nil: true, sensitive: true, fresh: true)
    unless session&.dig(:user, "id")
      raise APIError.new("UNAUTHORIZED", message: BetterAuth::Passkey::ErrorCodes::PASSKEY_ERROR_CODES.fetch("SESSION_REQUIRED"))
    end
    user = session.fetch(:user)
    return registration_user_data(
      id: user.fetch("id"),
      name: user["email"] || user["id"],
      display_name: user["email"] || user["id"],
      email: user["email"]
    )
  end

  session = BetterAuth::Routes.current_session(ctx, allow_nil: true)
  if session
    user = session.fetch(:user)
    return registration_user_data(
      id: user.fetch("id"),
      name: user["email"] || user["id"],
      display_name: user["email"] || user["id"],
      email: user["email"]
    )
  end

  resolver = config.dig(:registration, :resolve_user)
  unless resolver.respond_to?(:call)
    raise APIError.new("BAD_REQUEST", message: BetterAuth::Passkey::ErrorCodes::PASSKEY_ERROR_CODES.fetch("RESOLVE_USER_REQUIRED"))
  end

  resolved = normalize_hash(call_callback(resolver, {ctx: ctx, context: query[:context]}) || {})
  unless resolved[:id].to_s != "" && resolved[:name].to_s != ""
    raise APIError.new("BAD_REQUEST", message: BetterAuth::Passkey::ErrorCodes::PASSKEY_ERROR_CODES.fetch("RESOLVED_USER_INVALID"))
  end

  registration_user_data(
    id: resolved[:id],
    name: resolved[:name],
    display_name: resolved[:display_name],
    email: resolved[:email]
  )
end

.rp_id(config, ctx) ⇒ Object 



34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'lib/better_auth/passkey/utils.rb', line 34

def rp_id(config, ctx)
  return config[:rp_id] if config[:rp_id]

  base_url = context_base_url(ctx).to_s
  return "localhost" if base_url.empty?

  URI.parse(base_url).host || "localhost"
rescue URI::InvalidURIError
  raise APIError.new("BAD_REQUEST", message: ErrorCodes::PASSKEY_ERROR_CODES.fetch("FAILED_TO_VERIFY_REGISTRATION")) if strict_base_url?(ctx)

  "localhost"
end

.strict_base_url?(ctx) ⇒ Boolean

Returns:

  • (Boolean) 


186
187
188
189
190
 
# File 'lib/better_auth/passkey/utils.rb', line 186

def strict_base_url?(ctx)
  return ctx.context.passkey_strict_base_url? if ctx.context.respond_to?(:passkey_strict_base_url?)

  true
end

.validate_authenticator_attachment!(value) ⇒ Object

Raises:

  • (APIError) 


58
59
60
61
62
 
# File 'lib/better_auth/passkey/utils.rb', line 58

def validate_authenticator_attachment!(value)
  return if value.nil? || ["platform", "cross-platform"].include?(value)

  raise APIError.new("BAD_REQUEST", message: BASE_ERROR_CODES.fetch("VALIDATION_ERROR"))
end