org.jboss.security.saml
Interface SingleSignOn


public interface SingleSignOn

SingleSignOn interface is used to marshal/unmarshal SSO tokens.

The interface makes no assumptions about the format of the SSO token. It is upto the implementations of this interface to produce the tokens in a format they desire.
The JBoss SSO system ships with a SingleSignOn implementation that produces the tokens in a SAML format.

Author:
Sohil Shah - sohil.shah@jboss.com

Field Summary
static java.lang.String LOGOUT_DEST
          name of the logout destination cookie
static java.lang.String LOGOUT_TOKEN
          name of the SSO logout in progress cookie
static java.lang.String SSO_PASSWORD
          name of the password request attribute
static java.lang.String SSO_SESSION
          name of the established SSO session's attribute
static java.lang.String SSO_TOKEN
          name of the SSO domain level cookie
static java.lang.String SSO_USER
          name if the SSO User authenticated on the system.
static java.lang.String SSO_USERNAME
          name of the username request attribute
 
Method Summary
 java.lang.String generateAuthRequest(java.lang.String username, java.lang.String password)
          This method generates a SAML authentication request based on the supplied username and password
 java.lang.String generateAuthResponse(java.lang.String assertingParty, java.lang.String username, boolean success)
          This method generates a SAML authentication response based on the supplied username, password, and the status of the authentication process
 java.lang.String marshalPartners(java.util.Map partners)
          This method returns a SAML (xml) representation of a map of partners that are part of this Single Sign On federation
 SSOUser parseAuthRequest(java.lang.String request)
          This method parses a SAML authentication request into a SSOUser domain object
 AuthResponse parseAuthResponse(java.lang.String response)
          This method parses a SAML authentication response and produces an AuthResponse domain object
 void setProperties(java.util.Properties properties)
          This method is used to set configuration properties on the Single Sign On implementation
 java.util.Map unmarshalPartners(java.lang.String partners)
          This method unmarshals a SAML (xml) representation of partners that are part of this Single Sign On Federation It returns a map of these partners with key - domain of the partner value - the address of the federation server of this partner
 

Field Detail

SSO_TOKEN

static final java.lang.String SSO_TOKEN
name of the SSO domain level cookie

See Also:
Constant Field Values

LOGOUT_TOKEN

static final java.lang.String LOGOUT_TOKEN
name of the SSO logout in progress cookie

See Also:
Constant Field Values

LOGOUT_DEST

static final java.lang.String LOGOUT_DEST
name of the logout destination cookie

See Also:
Constant Field Values

SSO_USERNAME

static final java.lang.String SSO_USERNAME
name of the username request attribute

See Also:
Constant Field Values

SSO_PASSWORD

static final java.lang.String SSO_PASSWORD
name of the password request attribute

See Also:
Constant Field Values

SSO_SESSION

static final java.lang.String SSO_SESSION
name of the established SSO session's attribute

See Also:
Constant Field Values

SSO_USER

static final java.lang.String SSO_USER
name if the SSO User authenticated on the system. This is used by partner applications that use a non-JAAS authentication method

See Also:
Constant Field Values
Method Detail

setProperties

void setProperties(java.util.Properties properties)
This method is used to set configuration properties on the Single Sign On implementation

Parameters:
properties -

generateAuthRequest

java.lang.String generateAuthRequest(java.lang.String username,
                                     java.lang.String password)
                                     throws SSOException
This method generates a SAML authentication request based on the supplied username and password

Parameters:
username -
password -
Returns:
Throws:
SSOException

parseAuthRequest

SSOUser parseAuthRequest(java.lang.String request)
                         throws SSOException
This method parses a SAML authentication request into a SSOUser domain object

Parameters:
request -
Returns:
Throws:
SSOException

generateAuthResponse

java.lang.String generateAuthResponse(java.lang.String assertingParty,
                                      java.lang.String username,
                                      boolean success)
                                      throws SSOException
This method generates a SAML authentication response based on the supplied username, password, and the status of the authentication process

Parameters:
assertingParty -
username -
password -
success -
Returns:
Throws:
SSOException

parseAuthResponse

AuthResponse parseAuthResponse(java.lang.String response)
                               throws SSOException
This method parses a SAML authentication response and produces an AuthResponse domain object

Parameters:
response -
Returns:
Throws:
SSOException

marshalPartners

java.lang.String marshalPartners(java.util.Map partners)
                                 throws SSOException
This method returns a SAML (xml) representation of a map of partners that are part of this Single Sign On federation

Parameters:
partners - - a map of partners belonging to the SSO Federation
Returns:
Throws:
SSOException

unmarshalPartners

java.util.Map unmarshalPartners(java.lang.String partners)
                                throws SSOException
This method unmarshals a SAML (xml) representation of partners that are part of this Single Sign On Federation It returns a map of these partners with key - domain of the partner value - the address of the federation server of this partner

Returns:
Throws:
SSOException