class Saml::Settings
- Saml::Settings
- Reference
- Object
Overview
SAML2 Toolkit Settings
Defined in:
saml/settings.crConstant Summary
-
DEFAULTS =
{:assertion_consumer_service_binding => Utils::BINDINGS[:post], :single_logout_service_binding => Utils::BINDINGS[:redirect], :idp_cert_fingerprint_algorithm => XMLSecurity::Document::SHA1, :compress_request => true, :compress_response => true, :message_max_bytesize => 250000, :soft => true, :double_quote_xml_attribute_values => false, :security => {:authn_requests_signed => false, :logout_requests_signed => false, :logout_responses_signed => false, :want_assertions_signed => false, :want_assertions_encrypted => false, :want_name_id => false, :metadata_signed => false, :embed_sign => false, :digest_method => XMLSecurity::Document::SHA1, :signature_method => XMLSecurity::Document::RSA_SHA1, :check_idp_cert_expiration => false, :check_sp_cert_expiration => false, :strict_audience_validation => false, :lowercase_url_encoding => false}}
Constructors
Instance Method Summary
- #assertion_consumer_logout_service_binding
-
#assertion_consumer_logout_service_binding=(value)
@deprecated Setter for legacy Single Logout Service Binding parameter.
-
#assertion_consumer_logout_service_url
Deprecated
-
#assertion_consumer_logout_service_url=(assertion_consumer_logout_service_url)
Deprecated
- #assertion_consumer_service_binding : String | Nil
-
#assertion_consumer_service_binding=(value)
Setter for SP Assertion Consumer Service Binding @param value [String, Symbol].
- #assertion_consumer_service_url : String | Nil
- #assertion_consumer_service_url=(assertion_consumer_service_url : String | Nil)
- #attribute_consuming_service : AttributeService | Nil
- #attributes_index : Int32 | Nil
- #attributes_index=(attributes_index : Int32 | Nil)
- #authn_context : String | Array(String) | Nil
- #authn_context=(authn_context : String | Array(String) | Nil)
- #authn_context_comparison : String | Nil
- #authn_context_comparison=(authn_context_comparison : String | Nil)
- #authn_context_decl_ref : String | Nil
- #authn_context_decl_ref=(authn_context_decl_ref : String | Nil)
- #certificate : String | Nil
- #certificate=(certificate : String | Nil)
- #certificate_new : String | Nil
- #certificate_new=(certificate_new : String | Nil)
- #compress_request : Bool
- #compress_request=(compress_request : Bool)
- #compress_response : Bool
- #compress_response=(compress_response : Bool)
- #double_quote_xml_attribute_values : Bool
- #double_quote_xml_attribute_values=(double_quote_xml_attribute_values : Bool)
- #force_authn : Bool | Nil
- #force_authn=(force_authn : Bool | Nil)
- #get_binding(value) : String | Nil
-
#get_fingerprint
Calculates the fingerprint of the IdP x509 certificate.
-
#get_idp_cert
@return [OpenSSL::X509::Certificate|nil] Build the IdP certificate from the settings (previously format it)
-
#get_idp_cert_multi
@return [Hash with 2 arrays of OpenSSL::X509::Certificate] Build multiple IdP certificates from the settings.
-
#get_sp_cert
@return [OpenSSL::X509::Certificate|nil] Build the SP certificate from the settings (previously format it)
-
#get_sp_cert_new
@return [OpenSSL::X509::Certificate|nil] Build the New SP certificate from the settings (previously format it)
-
#get_sp_key
@return [OpenSSL::PKey::RSA] Build the SP private from the settings (previously format it)
- #get_sp_key_text
- #idp_attribute_names : Array(String) | Nil
- #idp_attribute_names=(idp_attribute_names : Array(String) | Nil)
- #idp_binding_from_embed_sign
- #idp_cert : String | Nil
- #idp_cert=(idp_cert : String | Nil)
- #idp_cert_fingerprint : String | Nil
- #idp_cert_fingerprint=(idp_cert_fingerprint : String | Nil)
- #idp_cert_fingerprint_algorithm : String | Nil
- #idp_cert_fingerprint_algorithm=(idp_cert_fingerprint_algorithm : String | Nil)
- #idp_cert_multi : Hash(Symbol, Array(String))
- #idp_cert_multi=(idp_cert_multi : Hash(Symbol, Array(String)))
-
#idp_entity_id : String | Nil
IdP Data
-
#idp_entity_id=(idp_entity_id : String | Nil)
IdP Data
- #idp_name_qualifier : String | Nil
- #idp_name_qualifier=(idp_name_qualifier : String | Nil)
- #idp_slo_response_service_url : String | Nil
- #idp_slo_response_service_url=(idp_slo_response_service_url : String | Nil)
-
#idp_slo_service_binding
@return [String] IdP Single Logout Service Binding
-
#idp_slo_service_binding=(value)
Setter for IdP Single Logout Service Binding @param value [String, Symbol].
-
#idp_slo_service_url
@return [String] IdP Single Logout Service URL
- #idp_slo_service_url=(idp_slo_service_url : String | Nil)
- #idp_slo_target_url : String | Nil
- #idp_slo_target_url=(idp_slo_target_url : String | Nil)
-
#idp_sso_service_binding
@return [String] IdP Single Sign On Service Binding
-
#idp_sso_service_binding=(value)
Setter for IdP Single Sign On Service Binding @param value [String, Symbol].
-
#idp_sso_service_url
@return [String] IdP Single Sign On Service URL
- #idp_sso_service_url=(idp_sso_service_url : String | Nil)
- #idp_sso_target_url : String | Nil
- #idp_sso_target_url=(idp_sso_target_url : String | Nil)
- #issuer : String | Nil
- #issuer=(issuer : String | Nil)
- #message_max_bytesize : Int32
- #message_max_bytesize=(message_max_bytesize : Int32)
- #name_identifier_format : String | Nil
- #name_identifier_format=(name_identifier_format : String | Nil)
- #name_identifier_value : String | Nil
- #name_identifier_value=(name_identifier_value : String | Nil)
- #name_identifier_value_requested : String | Nil
- #name_identifier_value_requested=(name_identifier_value_requested : String | Nil)
- #passive : Bool | Nil
- #passive=(passive : Bool | Nil)
- #private_key : String | Nil
- #private_key=(private_key : String | Nil)
- #protocol_binding : String | Nil
-
#protocol_binding=(value)
Setter for SP Protocol Binding @param value [String, Symbol].
-
#security : Hash(Symbol, Bool | Int32 | String)
Work-flow
-
#security=(security : Hash(Symbol, Bool | Int32 | String))
Work-flow
- #sessionindex : String | Nil
- #sessionindex=(sessionindex : String | Nil)
-
#single_logout_service_binding
@return [String] Single Logout Service Binding.
-
#single_logout_service_binding=(value)
Setter for Single Logout Service Binding.
-
#single_logout_service_url
@return [String] Single Logout Service URL.
- #single_logout_service_url=(single_logout_service_url : String | Nil)
- #soft : Bool
- #soft=(soft : Bool)
-
#sp_entity_id
@return [String] SP Entity ID
-
#sp_entity_id=(sp_entity_id : String | Nil)
SP Data
- #sp_name_qualifier : String | Nil
- #sp_name_qualifier=(sp_name_qualifier : String | Nil)
- #valid_until : Time | Nil
- #valid_until=(valid_until : Time | Nil)
Constructor Detail
Instance Method Detail
@deprecated Setter for legacy Single Logout Service Binding parameter.
(Currently we only support "urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect") @param value [String, Symbol]
Setter for SP Assertion Consumer Service Binding @param value [String, Symbol].
Calculates the fingerprint of the IdP x509 certificate. @return [String] The fingerprint
@return [OpenSSL::X509::Certificate|nil] Build the IdP certificate from the settings (previously format it)
@return [Hash with 2 arrays of OpenSSL::X509::Certificate] Build multiple IdP certificates from the settings.
@return [OpenSSL::X509::Certificate|nil] Build the SP certificate from the settings (previously format it)
@return [OpenSSL::X509::Certificate|nil] Build the New SP certificate from the settings (previously format it)
@return [OpenSSL::PKey::RSA] Build the SP private from the settings (previously format it)
Setter for IdP Single Logout Service Binding @param value [String, Symbol].
Setter for IdP Single Sign On Service Binding @param value [String, Symbol].
Setter for Single Logout Service Binding.
(Currently we only support "urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect") @param value [String, Symbol]