Class: Saml::Kit::DefaultRegistry

Inherits:
Object
  • Object
show all
Includes:
Enumerable
Defined in:
lib/saml/kit/default_registry.rb

Overview

The default metadata registry is used to fetch the metadata associated with an issuer or entity id. The metadata associated with an issuer is used to verify trust for any SAML documents that are received.

You can replace the default registry with your own at startup.

Example:

class OnDemandRegistry
 def initialize(original)
   @original = original
 end

 def metadata_for(entity_id)
   found = @original.metadata_for(entity_id)
   return found if found

   @original.register_url(entity_id, verify_ssl: Rails.env.production?)
   @original.metadata_for(entity_id)
 end
end

Saml::Kit.configure do |configuration|
  configuration.entity_id = ENV['ENTITY_ID']
  configuration.registry = OnDemandRegistry.new(configuration.registry)
  configuration.logger = Rails.logger
end

Defined Under Namespace

Classes: HttpApi

Instance Method Summary collapse

Constructor Details

#initialize(items = {}) ⇒ DefaultRegistry

Returns a new instance of DefaultRegistry.



34
35
36
 
# File 'lib/saml/kit/default_registry.rb', line 34

def initialize(items = {})
  @items = items
end

Instance Method Details

#each ⇒ Object

Yields each registered [Saml::Kit::Metadata] to the block.



64
65
66
67
68
 
# File 'lib/saml/kit/default_registry.rb', line 64

def each
  @items.each do |key, value|
    yield value
  end
end

#metadata_for(entity_id) ⇒ Object

Returns the metadata document associated with an issuer or entityID.

Parameters:

  • entity_id (String) —

    the unique entityID/Issuer associated with metadata.



59
60
61
 
# File 'lib/saml/kit/default_registry.rb', line 59

def metadata_for(entity_id)
  @items[entity_id]
end

#register(metadata) ⇒ Object

Register a metadata document

Parameters:



41
42
43
44
 
# File 'lib/saml/kit/default_registry.rb', line 41

def register(metadata)
  Saml::Kit.logger.debug(metadata.to_xml(pretty: true))
  @items[metadata.entity_id] = metadata
end

#register_url(url, verify_ssl: true) ⇒ Object

Register metadata via a remote URL. This will attempt to connect to the remove URL to download the metadata and register it in the registry.

Parameters:

  • url (String) —

    the url to download the metadata from.

  • verify_ssl (Boolean) (defaults to: true) —

    enable/disable SSL peer verification.



51
52
53
54
 
# File 'lib/saml/kit/default_registry.rb', line 51

def register_url(url, verify_ssl: true)
  content = HttpApi.new(url, verify_ssl: verify_ssl).get
  register(Saml::Kit::Metadata.from(content))
end