Grant McLean > Authen-NZigovt-1.05 > Authen::NZigovt::LogonStrength

Download:
Authen-NZigovt-1.05.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 1.05   Source   Latest Release: Authen-NZigovt-1.07

NAME ^

Authen::NZigovt::LogonStrength - Manipulate NZ igovt logon service AuthnContextClassRef values

DESCRIPTION ^

The NZ igovt logon service supports the notion of logon strength. For example a user session authenticated with a username and password is a 'low strength' logon. Whereas authenticating with a user, password and SecurID token will result in a moderate strength logon. The different logon strengths are represented by URNs which will be present in the initial SAML AuthnRequest message as well as the assertion in the resulting ArtifactResponse.

This class is used to encapsulate the URNs and to provide methods for comparing the strength of one URN to another.

CONSTANTS ^

The following constants are defined for referring to URNs:

Authen::NZigovt::LogonStrength::STRENGTH_LOW
Authen::NZigovt::LogonStrength::STRENGTH_MODERATE
Authen::NZigovt::LogonStrength::STRENGTH_MODERATE_SID
Authen::NZigovt::LogonStrength::STRENGTH_MODERATE_SMS

METHODS ^

new( strength )

Creates an object from the named strength identifier which might be a word (e.g.: 'low'), a URN (see the igovt logon service SAML v2.0 Messaging Specification), or a URN fragment matching the last portion of a URN (e.g.: 'OTP:Token:SID').

urn( )

Returns the URN for the selected logon strength.

score( )

Returns the strength score (currently either 10 or 20) which is used when comparing strengths using the 'minimum' match type.

assert_match( required_strength, strength_match )

This method returns if the provided logon strength matches the required strength, or dies if the strength does not meet the specified requirement.

The required_strength will default to 'low' if not provided.

The strength_match parameter must be 'exact' or 'minimum' (default 'minimum'). When comparing different logon strengths, the rules outlined in the igovt logon service SAML v2.0 Messaging Specification are used.

SEE ALSO ^

See Authen::NZigovt for documentation index.

LICENSE AND COPYRIGHT ^

Copyright (c) 2010-2011 the New Zealand Electoral Enrolment Centre

Written by Grant McLean <grant@catalyst.net.nz>

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

syntax highlighting: