Authen::NZRealMe::AuthenRequest - Generate a SAML2 AuthenRequest message
This package is used by the Authen::NZRealMe::ServiceProvider to generate a SAML2 AuthnRequest message and send it to the NZ RealMe Login service IdP (Identity Provider) using the HTTP-Redirect binding.
Constructor. Should not be called directly. Instead, call the new_request method on the service provider object.
new_request
The following named parameters are recognised:
allow_create boolean (default: false) relay_state short string (default: none) auth_strength see below (default: 'low')
Accessor for the type of service ("login" or "assertion") this request is intended for.
Accessor for the generated unique ID for this request.
Accessor for the entity ID of the Service Provider which generated the request.
Accessor for the request creation time formatted as an ISO date/time string.
Accessor for the URL of the Identity Provider's single signon service, to which this request will be sent.
Accessor for the XML document containing the SAML2 AuthenRequest.
Accessor for the acs_index parameter optionally passed to the constructor. If not provided, the default ACS will be used.
acs_index
Accessor for the sso_binding parameter optionally passed to the constructor. This parameter is only required if there are two or more SingleSignOnService elements defined in the IdP service metadata.
sso_binding
Accessor for the relay_state parameter optionally passed to the constructor. If not provided, no relay state will be passed to the Identity Provider.
relay_state
Accessor for the allow_create parameter optionally passed to the constructor. If not provided, this parameter will default to 'false'.
allow_create
Accessor for the auth_strength parameter optionally passed to the constructor. If a value is provided, it will be passed to the constructor for Authen::NZRealMe::LogonStrength. If not provided, this parameter will default to the URN for low strength logons.
auth_strength
Accessor for the URL to be used in the redirect. The URL will be constructed from the URL of the Identity Provider's single signon service and a query string containing the SAML2 AuthnRequest message an optional relay state parameter and a digital signature.
Accessor for the XML SAML AuthnRequest message after deflate compression and MIME Base64 encoding have been applied.
This method is used by the nzrealme dump-req command to decode and decompress the SAMLRequest parameter from a generated URL. It is provided as a diagnostic aid.
nzrealme dump-req
See Authen::NZRealMe for documentation index.
Copyright (c) 2010-2022 Enrolment Services, New Zealand Electoral Commission
Written by Grant McLean <grant@catalyst.net.nz>
This program is free software; you can redistribute it and/or modify it under the terms of either: the GNU General Public License as published by the Free Software Foundation; or the Artistic License.
See http://dev.perl.org/licenses/ for more information.
To install Authen::NZRealMe, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Authen::NZRealMe
CPAN shell
perl -MCPAN -e shell install Authen::NZRealMe
For more information on module installation, please visit the detailed CPAN module installation guide.