class Saml::Logoutresponse

Overview

SAML2 Logout Response (SLO SP initiated, Parser)

The signature is only checked when :get_params carry a Signature (the HTTP-Redirect binding), as in ruby-saml.

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) : Bool append_error, errors : Array(String) errors, reset_errors! reset_errors!

Instance methods inherited from class Saml::SamlMessage

id(document) : String | Nil id, valid_saml?(document, soft = true, check_malformed_doc = true) : Bool valid_saml?, version(document) : String | Nil version

Constructor Detail

def self.new(response : String | Nil, settings : Settings | Nil = nil, options : Hash = {} of Symbol => RedirectSignature::OptionValue) #

@param response [String] A base64 encoded (and maybe deflated) logout response from the IdP. @param settings [Settings|nil] Toolkit settings @param options [Hash] :matches_request_id, :get_params / :raw_get_params, :relax_signature_validation @raise [ArgumentError] if response is nil


[View source]

Instance Method Detail

def document : XMLSecurity::SignedDocument #

[View source]
def in_response_to : String | Nil #

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


[View source]
def issuer : String | Nil #

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


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

[View source]
def response : String #

[View source]
def response_id : String | Nil #

[View source]
def settings : Settings | Nil #

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

[View source]
def soft : Bool #

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

[View source]
def status_code : String | Nil #

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


[View source]
def status_message : String | Nil #

[View source]
def success? : Bool #

Checks if the Status has the "Success" code


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

Validates the Logout Response @raise [ValidationError] if soft == false and validation fails


[View source]