Net::SAML2::SP - Net::SAML2::SP - SAML Service Provider object
version 0.58
my $sp = Net::SAML2::SP->new( id => 'http://localhost:3000', url => 'http://localhost:3000', cert => 'sign-nopw-cert.pem', key => 'sign-nopw-key.pem', );
Constructor. Create an SP object.
Arguments:
base for all SP service URLs
SP's identity URI.
path to the signing certificate
path to the private key for the signing certificate
path to the CA certificate for verification
SP organisation name
SP organisation display name
SP contact email address
SP organization url. This is optional and url will be used as in previous versions if this is not provided.
Specifies in the metadata whether the SP signs the AuthnRequest Optional (0 or 1) defaults to 1 (TRUE) if not specified.
Specifies in the metadata whether the SP wants the Assertion from the IdP to be signed Optional (0 or 1) defaults to 1 (TRUE) if not specified.
Sign the metadata, defaults to 1 (TRUE) if not specified.
The following option replaces the previous slo_url_post, slo_url_soap and slo_url_redirect constructor parameters. The former options are mapped to this new structure.
slo_url_post
slo_url_soap
slo_url_redirect
This expects an array of hash refs where you define one or more Single Logout Services
[ { Binding => BINDING_HTTP_POST, Location => https://foo.example.com/your-post-endpoint, }, { Binding => BINDING_HTTP_ARTIFACT, Location => https://foo.example.com/your-artifact-endpoint, } ]
The following option replaces the previous acs_url_post and acs_url_artifact constructor parameters. The former options are mapped to this new structure.
acs_url_post
acs_url_artifact
This expects an array of hash refs where you define one or more Assertion Consumer Services.
[ # Order decides the index if not supplied, else we assume you have an index { Binding => BINDING_HTTP_POST, Location => https://foo.example.com/your-post-endpoint, isDefault => 'false', # optionally index => 1, }, { Binding => BINDING_HTTP_ARTIFACT, Location => https://foo.example.com/your-artifact-endpoint, isDefault => 'true', index => 2, } ]
Returns an AuthnRequest object created by this SP, intended for the given destination, which should be the identity URI of the IdP.
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.
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.
Returns an ArtifactResolve request object created by this SP, intended for the given destination, which should be the identity URI of the IdP.
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.
SAMLRequest
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.
SAMLResponse
Returns a SOAP binding object for this SP, with a destination of the given URL and signing certificate.
XXX UA
Returns a POST binding object for this SP.
Returns the Net::SAML2 unique ID from Net::SAML2::Util::generate_id.
Generate the metadata XML document for this SP.
Returns the metadata XML document for this SP.
Return the assertion service which is the default
Chris Andrews <chrisa@cpan.org>
This software is copyright (c) 2022 by Chris Andrews and Others, see the git log.
This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself.
To install Net::SAML2, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Net::SAML2
CPAN shell
perl -MCPAN -e shell install Net::SAML2
For more information on module installation, please visit the detailed CPAN module installation guide.