Module: Supabase::Auth::Helpers

Defined in:
lib/supabase/auth/helpers.rb

Constant Summary collapse

API_VERSION_HEADER_NAME = 
"X-Supabase-Api-Version"
API_VERSION_REGEX = 
/\A2[0-9]{3}-(0[1-9]|1[0-2])-(0[1-9]|1[0-9]|2[0-9]|3[0-1])\z/
PKCE_CHARSET = 
(("a".."z").to_a + ("A".."Z").to_a + ("0".."9").to_a + %w[- . _ ~]).freeze
API_VERSION_2024_01_01_TIMESTAMP = 
Time.new(2024, 1, 1).to_f

Class Method Summary collapse

Class Method Details

.decode_jwt(token) ⇒ Object

Raises:



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
 
# File 'lib/supabase/auth/helpers.rb', line 20

def decode_jwt(token)
  parts = token.split(".")
  raise Errors::AuthInvalidJwtError, "Invalid JWT structure" unless parts.length == 3

  parts.each do |part|
    raise Errors::AuthInvalidJwtError, "JWT not in base64url format" unless part.match?(Constants::BASE64URL_REGEX)
  end

  header = JSON.parse(str_from_base64url(parts[0]))
  payload = JSON.parse(str_from_base64url(parts[1]))
  signature = base64url_to_bytes(parts[2])

  {
    header: header,
    payload: payload,
    signature: signature,
    raw: { "header" => parts[0], "payload" => parts[1] }
  }
end

.generate_pkce_challenge(code_verifier) ⇒ Object 



56
57
58
59
 
# File 'lib/supabase/auth/helpers.rb', line 56

def generate_pkce_challenge(code_verifier)
  digest = Digest::SHA256.digest(code_verifier)
  Base64.urlsafe_encode64(digest, padding: false)
end

.generate_pkce_verifier(length = 64) ⇒ Object

Raises:

  • (ArgumentError) 


50
51
52
53
54
 
# File 'lib/supabase/auth/helpers.rb', line 50

def generate_pkce_verifier(length = 64)
  raise ArgumentError, "PKCE verifier length must be between 43 and 128 characters" if length < 43 || length > 128

  Array.new(length) { PKCE_CHARSET.sample(random: SecureRandom) }.join
end

.get_error_code(error) ⇒ Object 



72
73
74
75
76
 
# File 'lib/supabase/auth/helpers.rb', line 72

def get_error_code(error)
  return nil unless error.is_a?(Hash)

  error["error_code"] || error[:error_code]
end

.handle_exception(exception) ⇒ Object 



99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/supabase/auth/helpers.rb', line 99

def handle_exception(exception)
  unless exception.is_a?(Faraday::ClientError) || exception.is_a?(Faraday::ServerError)
    return Errors::AuthRetryableError.new(exception.message, status: 0)
  end

  begin
    response = exception.response
    status = response[:status]

    if [502, 503, 504].include?(status)
      return Errors::AuthRetryableError.new(exception.message, status: status)
    end

    data = JSON.parse(response[:body] || "{}")
    error_code = nil
    response_api_version = nil

    if response[:headers]
      mock_response = Struct.new(:headers).new(response[:headers])
      response_api_version = parse_response_api_version(mock_response)
    end

    if response_api_version &&
       response_api_version.to_f >= API_VERSION_2024_01_01_TIMESTAMP &&
       data.is_a?(Hash) && !data.empty? && data["code"].is_a?(String)
      error_code = data["code"]
    elsif data.is_a?(Hash) && !data.empty? && data["error_code"].is_a?(String)
      error_code = data["error_code"]
    end

    if error_code == "weak_password"
      reasons = data.dig("weak_password", "reasons") || []
      return Errors::AuthWeakPassword.new(
        get_error_message(data),
        status: status,
        reasons: reasons
      )
    end

    if error_code.nil? && data.is_a?(Hash) && data["weak_password"].is_a?(Hash) && !data["weak_password"].empty?
      reasons = data["weak_password"]["reasons"] || []
      return Errors::AuthWeakPassword.new(
        get_error_message(data),
        status: status,
        reasons: reasons
      )
    end

    Errors::AuthApiError.new(
      get_error_message(data),
      status: status || 500,
      code: error_code
    )
  rescue StandardError => e
    Errors::AuthUnknownError.new(exception.message, original_error: e)
  end
end

.is_http_url(url) ⇒ Object 



78
79
80
81
82
83
84
85
 
# File 'lib/supabase/auth/helpers.rb', line 78

def is_http_url(url)
  return false if url.nil? || url.empty?

  uri = URI.parse(url)
  %w[http https].include?(uri.scheme)
rescue URI::InvalidURIError
  false
end

.is_valid_uuid(value) ⇒ Object 



87
88
89
90
91
 
# File 'lib/supabase/auth/helpers.rb', line 87

def is_valid_uuid(value)
  return false unless value.is_a?(String)

  /\A[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}\z/i.match?(value)
end

.parse_auth_otp_response(data) ⇒ Object 



177
178
179
 
# File 'lib/supabase/auth/helpers.rb', line 177

def parse_auth_otp_response(data)
  Types::AuthOtpResponse.from_hash(data)
end

.parse_auth_response(data) ⇒ Object 



167
168
169
170
171
172
173
174
175
 
# File 'lib/supabase/auth/helpers.rb', line 167

def parse_auth_response(data)
  session = nil
  if data["access_token"] && data["refresh_token"] && data["expires_in"]
    session = Types::Session.from_hash(data)
  end
  user_data = data["user"] || data
  user = user_data ? Types::User.from_hash(user_data) : nil
  Types::AuthResponse.new(session: session, user: user)
end

.parse_jwks(response) ⇒ Object 



203
204
205
206
207
208
209
 
# File 'lib/supabase/auth/helpers.rb', line 203

def parse_jwks(response)
  if !response.key?("keys") || response["keys"].empty?
    raise Errors::AuthInvalidJwtError, "JWKS is empty"
  end

  { "keys" => response["keys"] }
end

.parse_link_identity_response(data) ⇒ Object 



181
182
183
 
# File 'lib/supabase/auth/helpers.rb', line 181

def parse_link_identity_response(data)
  Types::LinkIdentityResponse.from_hash(data)
end

.parse_link_response(data) ⇒ Object 



185
186
187
188
189
190
191
192
 
# File 'lib/supabase/auth/helpers.rb', line 185

def parse_link_response(data)
  link_keys = Types::GenerateLinkProperties.members.map(&:to_s)
  props_hash = link_keys.each_with_object({}) { |k, h| h[k.to_sym] = data[k] }
  properties = Types::GenerateLinkProperties.new(**props_hash)
  user_data = data.reject { |k, _| link_keys.include?(k) }
  user = Types::User.from_hash(user_data)
  Types::GenerateLinkResponse.new(properties: properties, user: user)
end

.parse_response_api_version(response) ⇒ Object 



61
62
63
64
65
66
67
68
69
70
 
# File 'lib/supabase/auth/helpers.rb', line 61

def parse_response_api_version(response)
  headers = response.respond_to?(:headers) ? response.headers : {}
  api_version = headers[API_VERSION_HEADER_NAME]
  return nil if api_version.nil? || api_version.empty?
  return nil unless api_version.match?(API_VERSION_REGEX)

  Date.strptime(api_version, "%Y-%m-%d").to_time
rescue ArgumentError, TypeError, Date::Error
  nil
end

.parse_sso_response(data) ⇒ Object 



199
200
201
 
# File 'lib/supabase/auth/helpers.rb', line 199

def parse_sso_response(data)
  Types::SSOResponse.from_hash(data)
end

.parse_user_response(data) ⇒ Object 



194
195
196
197
 
# File 'lib/supabase/auth/helpers.rb', line 194

def parse_user_response(data)
  data = { "user" => data } unless data.key?("user")
  Types::UserResponse.from_hash(data)
end

.validate_exp(exp) ⇒ Object

Raises:



93
94
95
96
97
 
# File 'lib/supabase/auth/helpers.rb', line 93

def validate_exp(exp)
  raise Errors::AuthInvalidJwtError, "JWT has no expiration time" if exp.nil? || exp == 0

  raise Errors::AuthInvalidJwtError, "JWT has expired" if exp <= Time.now.to_f
end