Module esaml_sp

SAML Service Provider (SP) routines.

Description

SAML Service Provider (SP) routines

Data Types

dupe_fun()

dupe_fun() = fun((esaml:assertion(), Digest::binary()) -> ok | term())

nameid_format()

nameid_format() = undefined | string()

xml()

xml() = #xmlElement{} | #xmlDocument{}

Function Index

generate_authn_request/2(Deprecated.) Return an AuthnRequest as an XML element.
generate_authn_request/3Return an AuthnRequest as an XML element.
generate_logout_request/3(Deprecated.) Return a LogoutRequest as an XML element.
generate_logout_request/4Return a LogoutRequest as an XML element.
generate_logout_response/3Return a LogoutResponse as an XML element.
generate_metadata/1Return the SP metadata as an XML element.
setup/1Initialize and validate an esaml_sp record.
validate_assertion/2Validate and decode an assertion envelope in parsed XML.
validate_assertion/3Validate and decode an assertion envelope in parsed XML.
validate_logout_request/2Validate and parse a LogoutRequest element.
validate_logout_response/2Validate and parse a LogoutResponse element.

Function Details

generate_authn_request/2

generate_authn_request(IdpURL::string(), SP::esaml:sp()) -> #xmlElement{}

This function is deprecated: Use generate_authn_request/3

Return an AuthnRequest as an XML element

generate_authn_request/3

generate_authn_request(IdpURL::string(), SP::esaml:sp(), Format::nameid_format()) -> #xmlElement{}

Return an AuthnRequest as an XML element

generate_logout_request/3

generate_logout_request(IdpURL::string(), NameID::string(), SP::esaml:sp()) -> #xmlElement{}

This function is deprecated: Use generate_logout_request/4

Return a LogoutRequest as an XML element

generate_logout_request/4

generate_logout_request(IdpURL::string(), SessionIndex::string(), Subject::esaml:subject(), SP::esaml:sp()) -> #xmlElement{}

Return a LogoutRequest as an XML element

generate_logout_response/3

generate_logout_response(IdpURL::string(), Status::esaml:status_code(), SP::esaml:sp()) -> #xmlElement{}

Return a LogoutResponse as an XML element

generate_metadata/1

generate_metadata(SP::esaml:sp()) -> #xmlElement{}

Return the SP metadata as an XML element

setup/1

setup(SP::esaml:sp()) -> esaml:sp()

Initialize and validate an esaml_sp record

validate_assertion/2

validate_assertion(Xml::xml(), SP::esaml:sp()) -> {ok, esaml:assertion()} | {error, Reason::term()}

Validate and decode an assertion envelope in parsed XML

validate_assertion/3

validate_assertion(Xml::xml(), DuplicateFun::dupe_fun(), SP::esaml:sp()) -> {ok, esaml:assertion()} | {error, Reason::term()}

Validate and decode an assertion envelope in parsed XML

The dupe_fun argument is intended to detect duplicate assertions in the case of a replay attack.

validate_logout_request/2

validate_logout_request(Xml::xml(), SP::esaml:sp()) -> {ok, esaml:logoutreq()} | {error, Reason::term()}

Validate and parse a LogoutRequest element

validate_logout_response/2

validate_logout_response(Xml::xml(), SP::esaml:sp()) -> {ok, esaml:logoutresp()} | {error, Reason::term()}

Validate and parse a LogoutResponse element


Generated by EDoc