NAME

Authen::NZRealMe::AuthenRequest - Generate a SAML2 AuthenRequest message

DESCRIPTION

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.

METHODS

new

Constructor. Should not be called directly. Instead, call the new_request method on the service provider object.

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')

service_type

Accessor for the type of service ("login" or "assertion") this request is intended for.

request_id

Accessor for the generated unique ID for this request.

entity_id

Accessor for the entity ID of the Service Provider which generated the request.

request_time

Accessor for the request creation time formatted as an ISO date/time string.

destination_url

Accessor for the URL of the Identity Provider's single signon service, to which this request will be sent.

saml_request

Accessor for the XML document containing the SAML2 AuthenRequest.

relay_state

Accessor for the relay_state parameter optionally passed to the constructor. If not provided, no relay state will be passed to the Identity Provider.

allow_create

Accessor for the allow_create parameter optionally passed to the constructor. If not provided, this parameter will default to 'false'.

force_auth

Accessor for the force_auth parameter optionally passed to the constructor. If not provided, this parameter will default to 'true'.

auth_strength

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.

as_url

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.

encoded_saml_request

Accessor for the XML SAML AuthnRequest message after deflate compression and MIME Base64 encoding have been applied.

dump_request

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.

SEE ALSO

See Authen::NZRealMe for documentation index.

LICENSE AND COPYRIGHT

Copyright (c) 2010-2019 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.