Class: BetterAuth::Configuration

Inherits:
Object
  • Object
show all
Defined in:
lib/better_auth/configuration.rb

Constant Summary collapse

DEFAULT_BASE_PATH = 
"/api/auth"
DEFAULT_SECRET = 
"better-auth-secret-12345678901234567890"
DEFAULT_SESSION = 
{
  update_age: 24 * 60 * 60,
  expires_in: 60 * 60 * 24 * 7,
  fresh_age: 60 * 60 * 24
}.freeze
DEFAULT_EMAIL_AND_PASSWORD = 
{
  min_password_length: 8,
  max_password_length: 128
}.freeze
DEFAULT_PASSWORD_HASHER = 
:scrypt
SUPPORTED_PASSWORD_HASHERS = 
[:scrypt, :bcrypt].freeze
DEFAULT_STATELESS_SESSION = 
{
  cookie_cache: {
    enabled: true,
    strategy: "jwe",
    refresh_cache: true
  }
}.freeze
DEFAULT_STATELESS_ACCOUNT = 
{
  store_state_strategy: "cookie",
  store_account_cookie: true
}.freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(options = {}) ⇒ Configuration

Returns a new instance of Configuration.



62
63
64
65
66
67
68
69
70
71
72
73
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
 
# File 'lib/better_auth/configuration.rb', line 62

def initialize(options = {})
  options = symbolize_keys(options)
  @explicit_options = deep_dup(options)

  @logger = options[:logger]
  @app_name = options[:app_name] || "Better Auth"
  @base_path = normalize_base_path(options.fetch(:base_path, DEFAULT_BASE_PATH))
  @database = options[:database]
  @secondary_storage = options[:secondary_storage]
  @plugins = normalize_plugins(options[:plugins])
  @advanced = deep_merge({}, symbolize_keys(options[:advanced] || {}))
  @disabled_paths = Array(options[:disabled_paths]).compact.map(&:to_s)
  @database_hooks = options[:database_hooks]
  @hooks = options[:hooks]
  @on_api_error = symbolize_keys(options[:on_api_error] || options[:on_apierror] || {})
  @telemetry = symbolize_keys(options[:telemetry] || {})
  @social_providers = symbolize_keys(options[:social_providers] || {})
  @trusted_origins_callbacks = []
  @trusted_origins_callbacks << options[:trusted_origins] if options[:trusted_origins].respond_to?(:call)
  @trusted_origins_callback = combined_trusted_origins_callback
  legacy_secret = resolve_secret(options, allow_test_default: false)
  secrets = options.key?(:secrets) ? options[:secrets] : SecretConfig.parse_env(Env.get("BETTER_AUTH_SECRETS"))
  if secrets
    @secret_config = SecretConfig.build(secrets, legacy_secret, logger: logger)
    @secret = @secret_config.current_secret
  else
    @secret = legacy_secret || (test_environment? ? DEFAULT_SECRET : nil)
    @secret_config = @secret
  end
  @base_url_config = options[:base_url]
  @base_url, @context_base_url = normalize_base_url(options[:base_url])
  @session = normalize_session(options[:session])
  @account = (options[:account])
  @user = symbolize_keys(options[:user] || {})
  @verification = symbolize_keys(options[:verification] || {})
  @email_and_password = normalize_email_and_password(options[:email_and_password])
  @password_hasher = normalize_password_hasher(options[:password_hasher])
  @email_verification = symbolize_keys(options[:email_verification] || {})
  @experimental = normalize_experimental(options[:experimental])
  @rate_limit = normalize_rate_limit(options[:rate_limit])
  @trusted_origins = normalize_trusted_origins(options[:trusted_origins])

  validate_secret
end

Instance Attribute Details

#account ⇒ Object (readonly)

Returns the value of attribute account.



33
34
35
 
# File 'lib/better_auth/configuration.rb', line 33

def 
  @account
end

#advanced ⇒ Object (readonly)

Returns the value of attribute advanced.



33
34
35
 
# File 'lib/better_auth/configuration.rb', line 33

def advanced
  @advanced
end

#app_name ⇒ Object (readonly)

Returns the value of attribute app_name.



33
34
35
 
# File 'lib/better_auth/configuration.rb', line 33

def app_name
  @app_name
end

#base_path ⇒ Object (readonly)

Returns the value of attribute base_path.



33
34
35
 
# File 'lib/better_auth/configuration.rb', line 33

def base_path
  @base_path
end

#base_url_config ⇒ Object (readonly)

Returns the value of attribute base_url_config.



33
34
35
 
# File 'lib/better_auth/configuration.rb', line 33

def base_url_config
  @base_url_config
end

#context_base_url ⇒ Object (readonly)

Returns the value of attribute context_base_url.



33
34
35
 
# File 'lib/better_auth/configuration.rb', line 33

def context_base_url
  @context_base_url
end

#database ⇒ Object (readonly)

Returns the value of attribute database.



33
34
35
 
# File 'lib/better_auth/configuration.rb', line 33

def database
  @database
end

#database_hooks ⇒ Object (readonly)

Returns the value of attribute database_hooks.



33
34
35
 
# File 'lib/better_auth/configuration.rb', line 33

def database_hooks
  @database_hooks
end

#disabled_paths ⇒ Object (readonly)

Returns the value of attribute disabled_paths.



33
34
35
 
# File 'lib/better_auth/configuration.rb', line 33

def disabled_paths
  @disabled_paths
end

#email_and_password ⇒ Object (readonly)

Returns the value of attribute email_and_password.



33
34
35
 
# File 'lib/better_auth/configuration.rb', line 33

def email_and_password
  @email_and_password
end

#email_verification ⇒ Object (readonly)

Returns the value of attribute email_verification.



33
34
35
 
# File 'lib/better_auth/configuration.rb', line 33

def email_verification
  @email_verification
end

#experimental ⇒ Object (readonly)

Returns the value of attribute experimental.



33
34
35
 
# File 'lib/better_auth/configuration.rb', line 33

def experimental
  @experimental
end

#hooks ⇒ Object (readonly)

Returns the value of attribute hooks.



33
34
35
 
# File 'lib/better_auth/configuration.rb', line 33

def hooks
  @hooks
end

#logger ⇒ Object (readonly)

Returns the value of attribute logger.



33
34
35
 
# File 'lib/better_auth/configuration.rb', line 33

def logger
  @logger
end

#on_api_error ⇒ Object (readonly)

Returns the value of attribute on_api_error.



33
34
35
 
# File 'lib/better_auth/configuration.rb', line 33

def on_api_error
  @on_api_error
end

#password_hasher ⇒ Object (readonly)

Returns the value of attribute password_hasher.



33
34
35
 
# File 'lib/better_auth/configuration.rb', line 33

def password_hasher
  @password_hasher
end

#plugins ⇒ Object (readonly)

Returns the value of attribute plugins.



33
34
35
 
# File 'lib/better_auth/configuration.rb', line 33

def plugins
  @plugins
end

#rate_limit ⇒ Object (readonly)

Returns the value of attribute rate_limit.



33
34
35
 
# File 'lib/better_auth/configuration.rb', line 33

def rate_limit
  @rate_limit
end

#secondary_storage ⇒ Object (readonly)

Returns the value of attribute secondary_storage.



33
34
35
 
# File 'lib/better_auth/configuration.rb', line 33

def secondary_storage
  @secondary_storage
end

#secret ⇒ Object (readonly)

Returns the value of attribute secret.



33
34
35
 
# File 'lib/better_auth/configuration.rb', line 33

def secret
  @secret
end

#secret_config ⇒ Object (readonly)

Returns the value of attribute secret_config.



33
34
35
 
# File 'lib/better_auth/configuration.rb', line 33

def secret_config
  @secret_config
end

#session ⇒ Object (readonly)

Returns the value of attribute session.



33
34
35
 
# File 'lib/better_auth/configuration.rb', line 33

def session
  @session
end

#social_providers ⇒ Object (readonly)

Returns the value of attribute social_providers.



33
34
35
 
# File 'lib/better_auth/configuration.rb', line 33

def social_providers
  @social_providers
end

#telemetry ⇒ Object (readonly)

Returns the value of attribute telemetry.



33
34
35
 
# File 'lib/better_auth/configuration.rb', line 33

def telemetry
  @telemetry
end

#trusted_origins ⇒ Object (readonly)

Returns the value of attribute trusted_origins.



33
34
35
 
# File 'lib/better_auth/configuration.rb', line 33

def trusted_origins
  @trusted_origins
end

#trusted_origins_callback ⇒ Object (readonly)

Returns the value of attribute trusted_origins_callback.



33
34
35
 
# File 'lib/better_auth/configuration.rb', line 33

def trusted_origins_callback
  @trusted_origins_callback
end

#user ⇒ Object (readonly)

Returns the value of attribute user.



33
34
35
 
# File 'lib/better_auth/configuration.rb', line 33

def user
  @user
end

#verification ⇒ Object (readonly)

Returns the value of attribute verification.



33
34
35
 
# File 'lib/better_auth/configuration.rb', line 33

def verification
  @verification
end

Class Method Details

.matches_origin_pattern?(url, pattern, allow_relative_paths: false) ⇒ Boolean

Returns:

  • (Boolean) 


178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/better_auth/configuration.rb', line 178

def self.matches_origin_pattern?(url, pattern, allow_relative_paths: false)
  return relative_path_allowed?(url) if url.start_with?("/") && allow_relative_paths
  return false if url.start_with?("/")

  uri = parse_uri(url)
  return false unless uri

  if pattern.include?("*") || pattern.include?("?")
    if pattern.include?("://")
      origin = origin_for(uri)
      return true if origin && wildcard_match?(pattern, origin)

      return wildcard_match?(pattern, url)
    end

    return wildcard_match?(pattern, uri.host.to_s)
  end

  protocol = uri.scheme&.then { |scheme| "#{scheme}:" }
  if protocol == "http:" || protocol == "https:" || protocol.nil?
    pattern == origin_for(uri)
  else
    url.start_with?(pattern)
  end
end

.origin_for(uri) ⇒ Object 



214
215
216
217
218
219
220
221
222
223
 
# File 'lib/better_auth/configuration.rb', line 214

def self.origin_for(uri)
  return nil unless uri.scheme && uri.host

  port = uri.port
  default_port = (uri.scheme == "http" && port == 80) || (uri.scheme == "https" && port == 443)
  host = uri.host
  host = "[#{host}]" if host.include?(":") && !host.start_with?("[")
  origin = "#{uri.scheme}://#{host}"
  default_port ? origin : "#{origin}:#{port}"
end

.parse_uri(url) ⇒ Object 



208
209
210
211
212
 
# File 'lib/better_auth/configuration.rb', line 208

def self.parse_uri(url)
  URI.parse(url)
rescue URI::InvalidURIError
  nil
end

.relative_path_allowed?(url) ⇒ Boolean

Returns:

  • (Boolean) 


204
205
206
 
# File 'lib/better_auth/configuration.rb', line 204

def self.relative_path_allowed?(url)
  %r{\A/(?!/|\\|%2f|%5c)[\w\-.+/@]*(?:\?[\w\-.+/=&%@]*)?\z}i.match?(url)
end

.wildcard_match?(pattern, value) ⇒ Boolean

Returns:

  • (Boolean) 


225
226
227
228
 
# File 'lib/better_auth/configuration.rb', line 225

def self.wildcard_match?(pattern, value)
  regex = Regexp.escape(pattern).gsub("\\*", ".*").gsub("\\?", ".")
  /\A#{regex}\z/.match?(value)
end

Instance Method Details

#base_url ⇒ Object 



113
114
115
 
# File 'lib/better_auth/configuration.rb', line 113

def base_url
  Thread.current[base_url_runtime_key] || @base_url
end

#clear_runtime_base_url! ⇒ Object 



121
122
123
 
# File 'lib/better_auth/configuration.rb', line 121

def clear_runtime_base_url!
  Thread.current[base_url_runtime_key] = nil
end

#dynamic_base_url? ⇒ Boolean

Returns:

  • (Boolean) 


129
130
131
 
# File 'lib/better_auth/configuration.rb', line 129

def dynamic_base_url?
  URLHelpers.dynamic_config?(base_url_config)
end

#merge_defaults!(defaults) ⇒ Object 



163
164
165
166
167
168
169
170
171
172
173
174
175
176
 
# File 'lib/better_auth/configuration.rb', line 163

def merge_defaults!(defaults)
  normalized = symbolize_keys(defaults || {})
  normalized.each do |key, value|
    next unless respond_to?(key)
    next if key == :database_hooks

    if key == :trusted_origins
      merge_trusted_origins_default(value)
      next
    end

    instance_variable_set("@#{key}", merge_default_value([key], public_send(key), value))
  end
end

#production? ⇒ Boolean

Returns:

  • (Boolean) 


125
126
127
 
# File 'lib/better_auth/configuration.rb', line 125

def production?
  production_environment?
end

#set_runtime_base_url(value) ⇒ Object 



117
118
119
 
# File 'lib/better_auth/configuration.rb', line 117

def set_runtime_base_url(value)
  Thread.current[base_url_runtime_key] = value
end

#to_h ⇒ Object 



133
134
135
136
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
 
# File 'lib/better_auth/configuration.rb', line 133

def to_h
  {
    app_name: app_name,
    base_url: base_url,
    base_path: base_path,
    secret: secret,
    secret_config: secret_config,
    database: database,
    plugins: plugins,
    trusted_origins: trusted_origins,
    rate_limit: rate_limit,
    session: session,
    account: ,
    user: user,
    verification: verification,
    advanced: advanced,
    email_and_password: email_and_password,
    password_hasher: password_hasher,
    email_verification: email_verification,
    social_providers: social_providers,
    experimental: experimental,
    secondary_storage: secondary_storage,
    database_hooks: database_hooks,
    hooks: hooks,
    on_api_error: on_api_error,
    disabled_paths: disabled_paths,
    telemetry: telemetry
  }
end

#trusted_origin?(url, allow_relative_paths: false) ⇒ Boolean

Returns:

  • (Boolean) 


107
108
109
110
111
 
# File 'lib/better_auth/configuration.rb', line 107

def trusted_origin?(url, allow_relative_paths: false)
  trusted_origins.any? do |origin|
    self.class.matches_origin_pattern?(url, origin, allow_relative_paths: allow_relative_paths)
  end
end