Skip to content

Open-source live-chat, email support, omni-channel desk. An alternative to Intercom, Zendesk, Salesforce Service Cloud etc. 🔥💬

2.7 KB
Raw Blame
# Enterprise Edition SAML SSO Provider
# This initializer adds SAML authentication support for Enterprise customers

# SAML setup proc for multi-tenant configuration
SAML_SETUP_PROC = proc do |env|
  request = ActionDispatch::Request.new(env)

  # Extract account_id from various sources
  account_id = request.params['account_id'] ||
               env['omniauth.params']&.dig('account_id')
  relay_state = request.params['RelayState'] || ''

  if account_id
    # Keep SAML request context in OmniAuth env so the callback can be processed
    # without depending on the Rails session cookie.
    env['omniauth.params'] ||= {}
    env['omniauth.params']['account_id'] = account_id
    env['omniauth.params']['RelayState'] = relay_state

    # Find SAML settings for this account
    settings = AccountSamlSettings.find_by(account_id: account_id)

    if settings
      # Refreshes during login so the triggering login uses a rotated certificate. It fetches only within 15 minutes
      # of certificate expiry, at most every 5 minutes, so earlier rotations need the "Refresh metadata" button.
      # Future: move this to a scheduled job (config/schedule.yml) for all accounts with a metadata URL. That covers
      # early rotations, keeps the fetch off logins, and removes the claim on metadata_refreshed_at.
      settings.refresh_metadata_if_needed
      # Configure the strategy options dynamically
      env['omniauth.strategy'].options[:idp_sso_service_url_runtime_params] = { RelayState: :RelayState }
      base_url = GlobalConfigService.load('FRONTEND_URL', 'http://localhost:3000')
      env['omniauth.strategy'].options[:assertion_consumer_service_url] = "#{base_url}/omniauth/saml/callback?account_id=#{account_id}"
      env['omniauth.strategy'].options[:sp_entity_id] = settings.sp_entity_id
      env['omniauth.strategy'].options[:idp_entity_id] = settings.idp_entity_id
      env['omniauth.strategy'].options[:idp_sso_service_url] = settings.sso_url
      env['omniauth.strategy'].options[:idp_cert] = settings.certificate
      signing_certificates = settings.signing_certificates
      env['omniauth.strategy'].options[:idp_cert_multi] = { signing: signing_certificates } if signing_certificates.many?
      env['omniauth.strategy'].options[:name_identifier_format] = 'urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress'
    else
      # Set a dummy certificate to avoid the error
      env['omniauth.strategy'].options[:idp_cert] = 'DUMMY'
    end
  else
    # Set a dummy certificate to avoid the error
    env['omniauth.strategy'].options[:idp_cert] = 'DUMMY'
  end
end

Rails.application.config.middleware.use OmniAuth::Builder do
  # SAML provider with setup phase for multi-tenant configuration
  provider :saml, setup: SAML_SETUP_PROC
end