NAME

Net::SPID::SAML::In::LogoutResponse

VERSION

version 0.15

SYNOPSIS

    use Net::SPID;
    
    # initialize our SPID object
    my $spid = Net::SPID->new(...);
    
    # parse a LogoutResponse
    my $logoutres = $spid->parse_logoutresponse($payload, $url, $in_response_to);

ABSTRACT

This class represents an incoming LogoutResponse. You can use this to parse the response coming from the Identity Provider after you sent a LogoutRequest for a SP-initiated logout.

CONSTRUCTOR

This class is not supposed to be instantiated directly. You can get one by calling "parse_logoutresponse" in Net::SPID::SAML.

METHODS

xml

This method returns the raw message in XML format.

    my $xml = $logoutres->xml;

validate

This method performs validation of the incoming message according to the SPID rules. In case of success it returns a true value; in case of failure it will die with the relevant error.

    eval { $logoutres->validate(in_response_to => $logout_req_ID) };
    if ($@) {
        warn "Bad LogoutResponse: $@";
    }

The in_response_to argument is required in order to perform the mandatory security check.

status

This method returns success, failure or partial according to the status code returned by the Identity Provider.

    my $result = $logoutres->status;

AUTHOR

Alessandro Ranellucci <aar@cpan.org>

COPYRIGHT AND LICENSE

This software is Copyright (c) 2018 by Alessandro Ranellucci.

This is free software, licensed under:

  The (three-clause) BSD License