GridShibCA::ShibSignOn

GridShib-CA interface to Shibboleth functionality.

For a list of environment variables set by Shibboleth see:

https://spaces.internet2.edu/display/SHIB2/NativeSPAttributeAccess

NOTE: PERL changes dashes (-) in environment variables names to underscores (_). So Shib-Identity-Provider becomes Shib_Identity_Provider.

Attributes

This class makes the following Shibboleth-related environment variables availblle to policies in policy.conf:

Methods

getUserId()

Return the unchecked, tainted user id as reported by Shibboleth.

Arguments: None

Returns: User id as string, or undef if unknown

getIdP()

Returns the unchecked, tainted identity provider identifier.

Should be immplemented by child class.

Arguments: None

Returns: IdP as string, or undef if unknown

getShibSession()

Returns the Shibboleth session cookie as a ``variable=value'' string.

Arguments: None

Returns: Shibboleth session or undef if cannot be found

methodName

Return human-readable string identifying sign-on method.

Arguments: None

Returns: String identifying sign-on method.

getAttributes

Return reference to hash containing user attributes.

Arguments: None

Returns: Reference to hash.

getSSOResponse()

Return, as a string, the SSO Response, if provided by Shibboleth.

Arguments: None

Returns: String containing SSO Response or undef on error

Internal methods

These internal methods not intended for external use.

_init()

Check and make sure everyting is OK.

Should be overridden by child class.

Arguments: None

Returns: Nothing. Throws GridShibCA::LogonException on error.

Version

GridShib-CA version 2.0.0 =cut

# Return true for import/use 1;

###################################################################### ### Local Variables: *** ### mode:perl *** ### End: ***