Chris Andrews > Net-SAML2-0.17 > Net::SAML2::SP

Download:
Net-SAML2-0.17.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  5
Open  6
View/Report Bugs
Source  

NAME ^

Net::SAML2::SP - SAML Service Provider object

SYNOPSIS ^

  my $sp = Net::SAML2::SP->new(
    id   => 'http://localhost:3000',
    url  => 'http://localhost:3000',
    cert => 'sign-nopw-cert.pem',
  );

METHODS ^

new( ... )

Constructor. Create an SP object.

Arguments:

 * url    - the base for all SP service URLs
 * id     - the SP's identity URI. 
 * cert   - path to the signing certificate
 * cacert - path to the CA certificate for verification

 * org_name         - the SP organisation name
 * org_display_name - the SP organisation display name
 * org_contact      - an SP contact email address

authn_request($destination)

Returns an AuthnRequest object created by this SP, intended for the given destination, which should be the identity URI of the IdP.

logout_request($destination, $nameid, $nameid_format, $session)

Returns a LogoutRequest object created by this SP, intended for the given destination, which should be the identity URI of the IdP.

Also requires the nameid (+format) and session to be logged out.

logout_response($destination, $status, $response_to)

Returns a LogoutResponse object created by this SP, intended for the given destination, which should be the identity URI of the IdP.

Also requires the status and the ID of the corresponding LogoutRequest.

artifact_request($destination, $artifact)

Returns an ArtifactResolve request object created by this SP, intended for the given destination, which should be the identity URI of the IdP.

sso_redirect_binding($idp, $param)

Returns a Redirect binding object for this SP, configured against the given IDP for Single Sign On. $param specifies the name of the query parameter involved - typically SAMLRequest.

slo_redirect_binding

Returns a Redirect binding object for this SP, configured against the given IDP for Single Log Out. $param specifies the name of the query parameter involved - typically SAMLRequest or SAMLResponse.

soap_binding

Returns a SOAP binding object for this SP, with a destination of the given URL and signing certificate.

XXX UA

post_binding

Returns a POST binding object for this SP.

metadata

Returns the metadata XML document for this SP.

syntax highlighting: