OSID Logo
OSID Specifications
authentication process package
Version 3.0.0
Release Candidate Preview
Interfaceosid.authentication.process.AuthenticationValidationSession
Implementsosid.OsidSession
Description

This session is the remote end of a transport link from the acquisition session and validates authentication credentials sent to it. The basic method, authenticate() accepts a credential, validates it and returns an Authentication containing the identity of the authenticated user.

This OSID does not define any root interface for credentials and challenge data. The object representing these are completely defined within their Type, providing flexibility in adapting to a variety of application environments.

MethodgetAuthenticationInput
Description

Gets an interface for authentication input.

Returnosid.authentication.process.AuthenticationInputauthentication input
CompliancemandatoryThis method is must be implemented.
Methodauthenticate
Description

Validates and returns the authentication credential from the given data.

Parametersosid.authentication.process.AuthenticationInputinputthe authentication input to be validated
Returnosid.authentication.process.Authenticationthe resulting authentication
ErrorsNULL_ARGUMENT input is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNSUPPORTED input is not of this service
CompliancemandatoryThis method is must be implemented.
MethodgetChallengeData
Description

Gets data that can be used for a challenge to the peer attempting authentication.

Parametersosid.authentication.process.AuthenticationInputinputauthentication input
Returnosid.authentication.process.Challengethe acquired challenge data
ErrorsNULL_ARGUMENT input is null
OPERATION_FAILEDunable to complete request
PERMISSION_DENIEDauthorization failure
UNIMPLEMENTEDchallenge response not available
UNSUPPORTED input is not of this service
ComplianceoptionalThis method must be implemented if AuthenticationProcessManager.supportsChallenge() is true.