Class: Shamu::Security::Principal

Inherits:

Object

• Object
• Shamu::Security::Principal

Defined in:

lib/shamu/security/principal.rb

Overview

...

Direct Known Subclasses

DelegatePrincipal

Attributes

• #elevated ⇒ Boolean (also: #elevated?)

  True if the user has elevated this session by providing their credentials.

• #parent_principal ⇒ Principal

  The parent principal when a user or service is impersonating another user.

• #remote_ip ⇒ String

  The IP address of the remote user.

• #user_id ⇒ Object

  Id of the currently authenticated user.

Instance Method Summary

• #impersonate(user_id) ⇒ Principal

  Create a new impersonation Principal, cloning relevant principal to the new instance.

• #impersonated? ⇒ Boolean

  True if the [#user_id] is being impersonated.

• #initialize(user_id: nil, parent_principal: nil, remote_ip: nil, elevated: false) ⇒ Principal constructor

  A new instance of Principal.

• #service_delegate? ⇒ Boolean

  True if the principal was offered by one service to another and requesting that the downstream service delegate security checks to the calling service.

• #user_id_chain ⇒ Array<Object>

  All of the user ids in the security principal chain, starting from the root.

Constructor Details

#initialize(user_id: nil, parent_principal: nil, remote_ip: nil, elevated: false) ⇒ Principal

# File 'lib/shamu/security/principal.rb', line 34

def initialize( user_id: nil, parent_principal: nil, remote_ip: nil, elevated: false )
  @user_id          = user_id
  @parent_principal = parent_principal
  @remote_ip        = remote_ip
  @elevated         = elevated
end

Instance Attribute Details

#elevated ⇒ Boolean Also known as: elevated?

# File 'lib/shamu/security/principal.rb', line 28

def elevated
  @elevated
end

#parent_principal ⇒ Principal

# File 'lib/shamu/security/principal.rb', line 19

def parent_principal
  @parent_principal
end

#remote_ip ⇒ String

# File 'lib/shamu/security/principal.rb', line 23

def remote_ip
  @remote_ip
end

#user_id ⇒ Object

# File 'lib/shamu/security/principal.rb', line 14

def user_id
  @user_id
end

Instance Method Details

#impersonate(user_id) ⇒ Principal

Create a new impersonation Shamu::Security::Principal, cloning relevant principal to the new instance.

# File 'lib/shamu/security/principal.rb', line 66

def impersonate( user_id )
  self.class.new( user_id: user_id, parent_principal: self, remote_ip: remote_ip, elevated: elevated )
end

#impersonated? ⇒ Boolean

# File 'lib/shamu/security/principal.rb', line 57

def impersonated?
  !!parent_principal
end

#service_delegate? ⇒ Boolean

# File 'lib/shamu/security/principal.rb', line 73

def service_delegate?
end

#user_id_chain ⇒ Array<Object>

# File 'lib/shamu/security/principal.rb', line 43

def user_id_chain
  @user_ids ||= begin
    user_ids = []
    principal = self
    while principal
      user_ids << principal.user_id
      principal = principal.parent_principal
    end

    user_ids.reverse
  end
end