class
Saml::SloLogoutrequest
- Saml::SloLogoutrequest
- Saml::SamlMessage
- Reference
- Object
Overview
SAML2 Logout Request (SLO IdP initiated, Parser)
The signature is only checked when :get_params carry a Signature (the HTTP-Redirect binding), as in ruby-saml; an unsigned request is accepted.
Included Modules
Defined in:
saml/slo_logoutrequest.crConstructors
-
.new(request : String | Nil, options : Hash = {} of Symbol => RedirectSignature::OptionValue)
@param request [String] A base64 encoded (and maybe deflated) Logout Request from the IdP.
Instance Method Summary
-
#decrypt_nameid(encrypted_id_node : XML::Node) : XML::Node | Nil
Decrypts an EncryptedID element with the SP keys.
- #document : XMLSecurity::SignedDocument
-
#id : String | Nil
@return [String|nil] Gets the ID attribute from the Logout Request.
- #is_valid?(collect_errors = false) : Bool
-
#issuer : String | Nil
@return [String] Gets the Issuer from the Logout Request.
-
#name_id : String | Nil
@return [String] Gets the NameID of the Logout Request.
-
#name_id_format : String | Nil
@return [String] Gets the NameID Format of the Logout Request.
- #name_id_node : XML::Node | Nil
- #nameid : String | Nil
- #nameid_format : String | Nil
-
#not_on_or_after : Time | Nil
@return [Time|nil] Gets the NotOnOrAfter Attribute value if exists.
- #options : Hash(Symbol, RedirectSignature::OptionValue)
- #request : String
- #request_id : String | Nil
-
#session_indexes : Array(String)
@return [Array] Gets the SessionIndex if exists (Supported multiple values).
- #settings : Settings | Nil
- #settings=(settings : Settings | Nil)
- #soft : Bool
- #soft=(soft : Bool)
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
@param request [String] A base64 encoded (and maybe deflated) Logout Request from the IdP. @param options [Hash] :settings, :allowed_clock_drift, :get_params / :raw_get_params (to check a redirect binding signature), :relax_signature_validation @raise [ArgumentError] If Request is nil
Instance Method Detail
Decrypts an EncryptedID element with the SP keys.
@return [String|nil] Gets the ID attribute from the Logout Request. if exists.
@return [Time|nil] Gets the NotOnOrAfter Attribute value if exists.
@return [Array] Gets the SessionIndex if exists (Supported multiple values). Empty Array if none found