edu.wisc.cae.service

Interface CAEAuthService

All Known Implementing Classes:

CAEAuthServiceImpl

public interface CAEAuthService

This interface defines the methods that are exposed for the CAE Auth Web Service.

This service is used to Grant and Revoke a CAE SAML Assertion that can be used for authentication to other CAE Web Services.

Version:

$Id: CAEAuthService.java 8 2012-10-04 16:08:04Z drews $

Author:

James Drews

Method Summary

Methods

Modifier and Type	Method and Description
String	getSAMLTokenFromShib(String shibbolethString) Generate a token that represents a SAML Assertion for use in other CAE Web Services for Authentication.
String	getSAMLTokenFromUsernamePassword(String username, String password, String requestingIP) Generate a token that represents a SAML Assertion for use in other CAE Web Services for Authentication.
CAESamlInfo	getVerificationInfo(String guid) This will return a CAESamlInfo about an issued CAE SAML Assertion
RevokeResponse	revokeSAMLToken(String guid) Revoke a SAML Assertion

Method Detail

getSAMLTokenFromShib

String getSAMLTokenFromShib(String shibbolethString)

Generate a token that represents a SAML Assertion for use in other CAE Web Services for Authentication. This method will take a Shibboleth Assertion from known IDP's (login.engr.wisc.edu) and use this as the authentication. From this assertion, a CAE Assertion will be generated.

The input to this method is string of the Shibboleth Assertion that has first been URL Encoded, and then base64 encoded.

If successful, the return is a string of the CAE SAML Assertion that has also been URL Encoded and then base64 encoded. Before it can be used as a WS-Security token, it will need to be base64 decoded, and then URL Decoded. Do not modify this decoded string in any way or the signed signature of the assertion will not validate.

Parameters:

shibbolethString - - base64 uncoded string of a shibboleth assertion

Returns:

Since:

1.0

getSAMLTokenFromUsernamePassword

String getSAMLTokenFromUsernamePassword(String username,
                                      String password,
                                      String requestingIP)

Generate a token that represents a SAML Assertion for use in other CAE Web Services for Authentication.

This method will take a username/password pair for authentication. The username/password must match a username/password pair in the CAE Authentication system.

If successful, the return is a string of the CAE SAML Assertion that has also been URL Encoded and then base64 encoded. Before it can be used as a WS-Security token, it will need to be base64 decoded, and then URL Decoded. Do not modify this decoded string in any way or the signed signature of the assertion will not validate.

Parameters:

username - - the CAE Login name to authenticate with

password - - the password for the CAE Account specified

requestingIP - - This is filled in by the web service call, the IP Address of the calling client. It is not part of the endpoint request

Returns:

Since:

1.0

getVerificationInfo

CAESamlInfo getVerificationInfo(String guid)

This will return a CAESamlInfo about an issued CAE SAML Assertion

The GUID needed is the value from inside the CAE SAML Assertion.

Parameters:

guid - - The token to get the information about

Returns:

Since:

1.0

revokeSAMLToken

RevokeResponse revokeSAMLToken(String guid)

Revoke a SAML Assertion

The GUID needed is the value from inside the CAE SAML Assertion.

Upon success, the assertion specified will be marked as revoked. Any call to the getVerificationInfo will return that it is no longer a valid assertion.

Parameters:

guid -

Returns:

Since:

1.0