class Saml::SloLogoutrequest

Overview

SAML2 Logout Request (SLO IdP initiated, Parser)

Included Modules

Defined in:

saml/slo_logoutrequest.cr

Constructors

Instance Method Summary

Instance methods inherited from module Saml::ErrorHandling

append_error(error_msg : String, soft_override : Bool | Nil = nil) append_error, errors errors, errors_messages errors_messages, errors_messages=(errors_messages) errors_messages=, reset_errors! reset_errors!

Instance methods inherited from class Saml::SamlMessage

id(document) id, valid_saml?(document, soft = true) valid_saml?, version(document) version

Constructor Detail

def self.new(request, options : Hash(Symbol, String) = {} of Symbol => String) #

Constructs the Logout Request. A Logout Request Object that is an extension of the SamlMessage class. @param request [String] A UUEncoded Logout Request from the IdP. @param options [Hash] :settings to provide the Saml::Settings object Or :allowed_clock_drift for the logout request validation process to allow a clock drift when checking dates with Or :relax_signature_validation to accept signatures if no idp certificate registered on settings

@raise [ArgumentError] If Request is nil


[View source]

Instance Method Detail

def document #

[View source]
def id #

@return [String|nil] Gets the ID attribute from the Logout Request. if exists.


[View source]
def is_valid?(collect_errors = false) #

Validates the Logout Request with the default values (soft = true) @param collect_errors [Boolean] Stop validation when first error appears or keep validating. @return [Boolean] TRUE if the Logout Request is valid


[View source]
def issuer #

@return [String] Gets the Issuer from the Logout Request.


[View source]
def name_id #

@return [String] Gets the NameID of the Logout Request.


[View source]
def name_id_format #

@return [String] Gets the NameID Format of the Logout Request.


[View source]
def nameid #

[View source]
def nameid_format #

[View source]
def not_on_or_after #

@return [Time|nil] Gets the NotOnOrAfter Attribute value if exists.


[View source]
def options : Hash(Symbol, String) #

[View source]
def request #

[View source]
def request_id #

[View source]
def session_indexes #

@return [Array] Gets the SessionIndex if exists (Supported multiple values). Empty Array if none found


[View source]
def settings #

Saml::Settings Toolkit settings


[View source]
def settings=(settings) #

Saml::Settings Toolkit settings


[View source]
def soft : Bool #

[View source]
def soft=(soft : Bool) #

[View source]