org.openid4java.message.pape.PapeMessage Maven / Gradle / Ivy
Show all versions of openid4java-shaded Show documentation
/*
* Copyright 2006-2008 Sxip Identity Corporation
*/
package org.openid4java.message.pape;
import org.openid4java.message.*;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import java.util.Map;
import java.util.HashMap;
import java.util.Iterator;
/**
* Base class for the OpenID Provider Authentication Policy extension
* implementation.
*
* Encapsulates:
*
* - the Type URI that identifies the OpenID Provider Authentication Policy
* extension
*
- a list of extension-specific parameters, with the
* openid.
prefix removed
*
*
* @see Message MessageExtension
* @author Marius Scurtescu, Johnny Bufu
*/
public class PapeMessage implements MessageExtension, MessageExtensionFactory
{
private static Log _log = LogFactory.getLog(PapeMessage.class);
private static final boolean DEBUG = _log.isDebugEnabled();
public static final String PAPE_POLICY_PHISHING_RESISTANT =
"http://schemas.openid.net/pape/policies/2007/06/phishing-resistant";
public static final String PAPE_POLICY_MULTI_FACTOR =
"http://schemas.openid.net/pape/policies/2007/06/multi-factor";
public static final String PAPE_POLICY_MULTI_FACTOR_PHYSICAL =
"http://schemas.openid.net/pape/policies/2007/06/multi-factor-physical";
protected static final String AUTH_LEVEL_PREFIX = "auth_level.";
protected static final String AUTH_LEVEL_NS_PREFIX = "auth_level.ns.";
private static final String AUTH_LEVEL_ALIAS_PREFIX = "papeauthlevel";
protected Map authLevelAliases = new HashMap(); // auth level URL -> alias
private int authLevelAliasCounter = 0;
/**
* The OpenID Provider Authentication Policy extension URI.
*/
public static final String OPENID_NS_PAPE = "http://specs.openid.net/extensions/pape/1.0";
/**
* The OpenID Provider Authentication Policy extension-specific parameters.
*
* The openid. prefix is not part of the parameter names
*/
protected ParameterList _parameters;
/**
* Constructs an empty (no parameters) OpenID Provider Authentication
* Policy extension.
*/
public PapeMessage()
{
_parameters = new ParameterList();
if (DEBUG) _log.debug("Created empty PapeMessage.");
}
/**
* Constructs an OpenID Provider Authentication Policy extension
* with a specified list of parameters.
*
* The parameter names in the list should not contain the
* openid..
*/
public PapeMessage(ParameterList params)
{
setParameters(params);
if (DEBUG)
_log.debug("Created PapeMessage from parameter list:\n" + params);
}
/**
* Gets the Type URI that identifies the OpenID Provider Authentication
* Policy extension.
*/
public String getTypeUri()
{
return OPENID_NS_PAPE;
}
/**
* Gets ParameterList containing the OpenID Provider Authentication
* Policy extension-specific parameters.
*
* The openid. prefix is not part of the parameter names,
* as it is handled internally by the Message class.
*
* The openid.ns. parameter is also handled by
* the Message class.
*
* @see Message
*/
public ParameterList getParameters()
{
return _parameters;
}
/**
* Sets the extension's parameters to the supplied list.
*
* The parameter names in the list should not contain the
* openid. prefix.
*/
public void setParameters(ParameterList params)
{
_parameters = params;
Iterator iter = params.getParameters().iterator();
while(iter.hasNext())
checkAddAuthLevelExtension((Parameter) iter.next());
}
/**
* Checks if the extension contains a parameter.
*
* @param name The name of the parameter,
* without the openid. prefix.
* @return True if a parameter with the specified name exists,
* false otherwise.
*/
public boolean hasParameter(String name)
{
return _parameters.hasParameter(name);
}
/**
* Sets the value for the parameter with the specified name.
*
* @param name The name of the parameter,
* without the openid. prefix.
*/
protected void set(String name, String value)
{
Parameter param = new Parameter(name, value);
_parameters.set(param);
checkAddAuthLevelExtension(param);
}
private void checkAddAuthLevelExtension(Parameter param) {
String key = param == null ? null : param.getKey();
String value = param == null ? null : param.getValue();
if (key != null && key.startsWith(AUTH_LEVEL_NS_PREFIX))
addAuthLevelExtension(value, key.substring(AUTH_LEVEL_NS_PREFIX.length()));
}
private synchronized String newAuthLevelAlias(String authLevelUri)
{
String newAlias = AUTH_LEVEL_ALIAS_PREFIX + ++authLevelAliasCounter;
_parameters.set(new Parameter(newAlias, authLevelUri));
return newAlias;
}
protected String addAuthLevelExtension(String authLevelTypeUri)
{
return addAuthLevelExtension(authLevelTypeUri, null);
}
private String addAuthLevelExtension(String authLevelTypeUri, String alias)
{
if (!authLevelAliases.containsKey(authLevelTypeUri)) {
String authLevelAlias = alias == null ? newAuthLevelAlias(authLevelTypeUri) : alias;
authLevelAliases.put(authLevelTypeUri, authLevelAlias);
}
return (String) authLevelAliases.get(authLevelTypeUri);
}
public boolean hasCustomAuthLevel(String authLevelTypeUri)
{
return authLevelAliases.containsKey(authLevelTypeUri);
}
protected String getCustomAuthLevelAlias(String authLevelTypeUri)
{
return (String) authLevelAliases.get(authLevelTypeUri);
}
/**
* Gets a the value of the parameter with the specified name.
*
* @param name The name of the parameter,
* without the openid. prefix.
* @return The parameter value, or null if not found.
*/
protected Parameter getParameter(String name)
{
return _parameters.getParameter(name);
}
/**
* Gets a the value of the parameter with the specified name.
*
* @param name The name of the parameter,
* without the openid. prefix.
* @return The parameter value, or null if not found.
*/
public String getParameterValue(String name)
{
return _parameters.getParameterValue(name);
}
/**
* OpenID Provider Authentication Policy extension doesn't implement
* authentication services.
*
* @return false
*/
public boolean providesIdentifier()
{
return false;
}
/**
* PAPE parameters are REQUIRED to be signed.
*
* @return
*/
public boolean signRequired()
{
return true;
}
/**
* Instantiates the apropriate OpenID Provider Authentication Policy
* extension object (request / response) for the supplied parameter
* list.
*
* @param parameterList The OpenID Provider Authentication Policy
* extension specific parameters
* (without the openid. prefix)
* extracted from the openid message.
* @param isRequest Indicates whether the parameters were
* extracted from an OpenID request (true),
* or from an OpenID response.
* @return MessageExtension implementation for
* the supplied extension parameters.
* @throws MessageException If a OpenID Provider Authentication Policy
* extension object could not be
* instantiated from the supplied parameter list.
*/
public MessageExtension getExtension(
ParameterList parameterList, boolean isRequest)
throws MessageException
{
if ( parameterList.hasParameter("preferred_auth_policies") ||
parameterList.hasParameter("max_auth_age"))
return PapeRequest.createPapeRequest(parameterList);
else if ( parameterList.hasParameter("auth_policies") ||
parameterList.hasParameter("auth_time"))
return PapeResponse.createPapeResponse(parameterList);
else
throw new MessageException("Invalid parameters for a PAPE message.");
}
}