Module: Fluence::Gateway::Auth::GatewayConnection::ClassMethods

Defined in:: lib/fluence/gateway/auth/gateway_connection.rb

Overview

Class-level DSL exposed on every host class through ActiveSupport::Concern. Hosts the strict-auth toggle and the resolved scope accessor (+gateway_scope+) installed by the included block.

Instance Method Summary collapse

#authenticate_connection! ⇒ true
Enables strict authentication for this connection class.
#gateway_require_auth? ⇒ Boolean
Whether #authenticate_connection! was called on this class.

Instance Method Details

#authenticate_connection! ⇒ `true`

Enables strict authentication for this connection class. When called in the class body, Fluence::Gateway::Auth::GatewayConnection#connect rejects any WebSocket upgrade that did not come with a resolvable record.

Examples:

class Connection < ActionCable::Connection::Base
  authenticate_connection!
end

Returns:

(true)

#gateway_require_auth? ⇒ `Boolean`

Whether #authenticate_connection! was called on this class. Consulted by Fluence::Gateway::Auth::GatewayConnection#connect to decide whether to reject anonymous upgrades.