Castle adds real-time monitoring of your authentication stack, instantly notifying you and your users on potential account hijacks.
Add the castle-rb
gem to your Gemfile
gem 'castle-rb'
Load and configure the library with your Castle API secret in an initializer or similar.
Castle.api_secret = 'YOUR_API_SECRET'
A Castle client instance will be made available as castle
in your
-
Rails controllers when you add
require 'castle/support/rails'
-
Padrino controllers when you add
require 'castle/support/padrino'
-
Sinatra app when you add
require 'castle/support/sinatra'
(and additionally explicitly addregister Sinatra::Castle
to yourSinatra::Base
class if you have a modular application)
require 'castle/support/sinatra'
class ApplicationController < Sinatra::Base
register Sinatra::Castle
end
- Hanami when you add
require 'castle/support/hanami'
and includeCastle::Hanami
to your Hanami application
require 'castle/support/hanami'
module Web
class Application < Hanami::Application
include Castle::Hanami
end
end
The client will automatically configure the request context for each request.
Castle::Error
will be thrown if the Castle API returns a 400 or a 500 level HTTP response. You can also choose to catch a more finegrained error.
begin
castle.track(
event: '$login.succeeded',
user_id: user.id
)
rescue Castle::Error => e
puts e.message
end
Castle.configure do |config|
# Same as setting it through Castle.api_secret
config.api_secret = 'secret'
# For authenticate method you can set failover strategies: allow(default), deny, challenge, throw
config.failover_strategy = :deny
# Castle::RequestError is raised when timing out in seconds (default: 500 milliseconds)
config.request_timeout = 2000
# Whitelisted and Blacklisted headers are case insensitive and allow to use _ and - as a separator, http prefixes are removed
# Whitelisted headers
config.whitelisted = ['X_HEADER']
# or append to default
config.whitelisted += ['http-x-header']
# Blacklisted headers take advantage over whitelisted elements
config.blacklisted = ['HTTP-X-header']
# or append to default
config.blacklisted += ['X_HEADER']
end
Castle::SecureMode.signature(user_id)
will create a signed user_id.