class Saml::Response

• Saml::Response
• Saml::SamlMessage
• Reference
• Object

Overview

SAML2 Authentication Response. SAML Response

Everything read from the assertion (NameID, attributes, conditions, ...) comes from the canonical bytes a signature's digest covers, re-parsed on their own, never from a lookup in the received document.

Included Modules

• Saml::ErrorHandling

Defined in:

saml/response.cr

Constant Summary

ASSERTION = "urn:oasis:names:tc:SAML:2.0:assertion"

AVAILABLE_OPTIONS = [:allowed_clock_drift, :check_duplicated_attributes, :matches_request_id, :settings, :skip_audience, :skip_authnstatement, :skip_conditions, :skip_destination, :skip_recipient_check, :skip_subject_confirmation]

Response available options This is not a whitelist to allow people extending Saml:Response and pass custom options

DSIG = "http://www.w3.org/2000/09/xmldsig#"

PROTOCOL = "urn:oasis:names:tc:SAML:2.0:protocol"

SAML_NAMESPACES = {"p" => PROTOCOL, "a" => ASSERTION, "samlp" => PROTOCOL, "saml" => ASSERTION, "ds" => DSIG}

XENC = "http://www.w3.org/2001/04/xmlenc#"

XSI = "http://www.w3.org/2001/XMLSchema-instance"

Constructors

• .new(response : String | Nil, options : Hash = {} of Symbol => OptionValue)

  Constructs the SAML Response.

Instance Method Summary

• #allowed_clock_drift : Time::Span

  The allowed clock drift on timing validation (option in seconds or a Time::Span).

• #assertion_encrypted? : Bool

  Checks if the SAML Response contains or not an EncryptedAssertion element

• #assertion_id : String | Nil
• #attributes : Saml::Attributes

  Gets the Attributes from the AttributeStatement element.

• #audiences : Array(String)

  @return [Array] The Audience elements from the Contitions of the SAML Response.

• #authn_context_class_ref : String | Nil

  Gets the AuthnContextClassRef from the AuthnStatement

• #authn_instant : String | Nil

  Gets the AuthnInstant from the AuthnStatement.

• #conditions : XML::Node | Nil

  Gets the Condition Element of the SAML Response if exists.

• #decrypted_document : XMLSecurity::SignedDocument | Nil
• #destination : String | Nil

  @return [String|nil] Destination attribute from the SAML Response.

• #document : XMLSecurity::SignedDocument
• #errors : Array(String)
• #in_response_to : String | Nil

  @return [String|nil] The InResponseTo attribute from the SAML Response.

• #is_valid?(collect_errors = false) : Bool

  Validates the SAML Response with the default values (soft = true) @param collect_errors [Boolean] Stop validation when first error appears or keep validating.

• #issuers : Array(String)

  Gets the Issuers (from Response and Assertion).

• #name_id : String | Nil

  @return [String] the NameID provided by the SAML response from the IdP.

• #name_id_format : String | Nil

  @return [String] the NameID Format provided by the SAML response from the IdP.

• #name_id_namequalifier : String | Nil

  @return [String] the NameID NameQualifier provided by the SAML response from the IdP.

• #name_id_spnamequalifier : String | Nil

  @return [String] the NameID SPNameQualifier provided by the SAML response from the IdP.

• #nameid : String | Nil
• #nameid_format : String | Nil
• #not_before : Time | Nil

  Gets the NotBefore Condition Element value.

• #not_on_or_after : Time | Nil

  Gets the NotOnOrAfter Condition Element value.

• #options : Hash(Symbol, OptionValue)
• #options=(options : Hash(Symbol, OptionValue))
• #response : String
• #response_id : String | Nil
• #session_expires_at : Time | Nil

  Gets the SessionNotOnOrAfter from the AuthnStatement.

• #sessionindex : String | Nil

  Gets the SessionIndex from the AuthnStatement.

• #settings : Saml::Settings
• #settings=(settings : Saml::Settings)
• #soft : Bool
• #soft=(soft : Bool)
• #status_code : String | Nil

  @return [String] StatusCode value from a SAML Response.

• #status_message : String | Nil

  @return [String] the StatusMessage value from a SAML Response.

• #success? : Bool

  Checks if the Status has the "Success" code

Constructor Detail

Instance Method Detail