class Saml::Logoutresponse

Overview

SAML2 Logout Response (SLO IdP initiated, Parser)

Included Modules

Defined in:

saml/logoutresponse.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(response, settings : Settings | Nil = nil, options : Hash(Symbol, String) = {} of Symbol => String) #

Constructs the Logout Response. A Logout Response Object that is an extension of the SamlMessage class. @param response [String] A UUEncoded logout response from the IdP. @param settings [::Settings|nil] Toolkit settings @param options [Hash] Extra parameters. :matches_request_id It will validate that the logout response matches the ID of the request. :get_params GET Parameters, including the SAMLResponse :relax_signature_validation to accept signatures if no idp certificate registered on settings

@raise [ArgumentError] if response is nil


[View source]

Instance Method Detail

def document : XMLSecurity::SignedDocument #

[View source]
def in_response_to #

@return [String|nil] Gets the InResponseTo attribute from the Logout Response if exists.


[View source]
def issuer #

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


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

[View source]
def response #

[View source]
def response_id #

[View source]
def settings : Saml::Settings? #

Saml::Settings Toolkit settings


[View source]
def settings=(settings : Nil | Saml::Settings) #

Saml::Settings Toolkit settings


[View source]
def soft : Bool #

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

[View source]
def status_code #

@return [String] Gets the StatusCode from a Logout Response.


[View source]
def status_message #

[View source]
def success? #

Checks if the Status has the "Success" code @return [Boolean] True if the StatusCode is Sucess @raise [ValidationError] if soft == false and validation fails


[View source]
def validate(collect_errors = false) #

Aux function to validate the Logout Response @param collect_errors [Boolean] Stop validation when first error appears or keep validating. (if soft=true) @return [Boolean] TRUE if the SAML Response is valid @raise [ValidationError] if soft == false and validation fails


[View source]