Authen::NZigovt::AuthenRequest - Generate a SAML2 AuthenRequest message
This package is used by the Authen::NZigovt::ServiceProvider to generate a SAML2 AuthnRequest message and send it to the NZ igovt logon service 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) force_auth boolean (default: true) relay_state short string (default: none) auth_strength see below (default: 'low')
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 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 force_auth parameter optionally passed to the constructor. If not provided, this parameter will default to 'true'.
force_auth
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::NZigovt::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 nzigovt dump-req command to decode and decompress the SAMLRequest parameter from a generated URL. It is provided as a diagnostic aid.
nzigovt dump-req
See Authen::NZigovt for documentation index.
Copyright (c) 2010-2011 the New Zealand Electoral Enrolment Centre
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::NZigovt, copy and paste the appropriate command in to your terminal.
cpanm
cpanm Authen::NZigovt
CPAN shell
perl -MCPAN -e shell install Authen::NZigovt
For more information on module installation, please visit the detailed CPAN module installation guide.