org.apache.rahas.impl

Class SAMLTokenIssuerConfig

java.lang.Object

org.apache.rahas.impl.AbstractIssuerConfig

org.apache.rahas.impl.SAMLTokenIssuerConfig

public class SAMLTokenIssuerConfig
extends AbstractIssuerConfig

Configuration manager for the SAMLTokenIssuer

See Also:

SAMLTokenIssuer

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.rahas.impl.AbstractIssuerConfig

AbstractIssuerConfig.KeyComputation

Field Summary

Fields

Modifier and Type	Field and Description
protected SAMLCallbackHandler	callbackHandler
protected String	callbackHandlerName
static QName	DIGEST_ALGORITHM
protected String	digestAlgorithm
static QName	ISSUER_NAME
protected String	issuerKeyAlias
protected String	issuerKeyPassword
protected String	issuerName
protected String	persisterClassName
protected org.apache.axiom.om.OMElement	persisterElement
protected Map<String,String>	persisterPropertyMap
static QName	SAML_CALLBACK_CLASS
static QName	SAML_ISSUER_CONFIG The QName of the configuration element of the SAMLTokenIssuer
static QName	SIGNATURE_ALGORITHM
protected String	signatureAlgorithm
protected boolean	tokenStoreDisabled
protected Map	trustedServices
protected String	trustStorePropFile
static QName	USE_SAML_ATTRIBUTE_STATEMENT

Fields inherited from class org.apache.rahas.impl.AbstractIssuerConfig

ADD_REQUESTED_ATTACHED_REF, ADD_REQUESTED_UNATTACHED_REF, addRequestedAttachedRef, addRequestedUnattachedRef, ATTR_CLASS_QN, ATTR_PROP_NAME, ATTR_PROP_NAME_QN, CRYPTO, CRYPTO_PROPERTIES, cryptoElement, cryptoPropertiesElement, cryptoPropertiesFile, keyComputation, keySize, LOCAL_PROPERTY_CLASS, LOCAL_PROPERTY_QN, LOCAL_PROPERTY_STORAGE_PATH, LOCAL_PROPERTY_THRESHOLD, PROOF_KEY_TYPE, proofKeyType, PROPERTY, PROVIDER, TOKEN_PERSISTER_QN, TOKEN_STORE_DISABLED_QN, ttl

Constructor Summary

Constructors

Constructor and Description
SAMLTokenIssuerConfig(org.apache.axiom.om.OMElement elem) Create a SAMLTokenIssuer configuration using the give config element
SAMLTokenIssuerConfig(String configFilePath) Create a SAMLTokenIssuer configuration with a config file picked from the given location.
SAMLTokenIssuerConfig(String issuerName, String cryptoProviderClassName, Properties cryptoProps) Create a new configuration with issuer name and crypto information

Method Summary

Modifier and Type	Method and Description
void	addTrustedServiceEndpointAddress(String address, String alias) Add a new trusted service endpoint address with its certificate
SAMLCallbackHandler	getCallbackHander() Deprecated.
SAMLCallbackHandler	getCallbackHandler()
String	getCallbackHandlerName()
String	getDigestAlgorithm()
String	getIssuerKeyAlias()
String	getIssuerKeyPassword()
org.apache.axis2.description.Parameter	getParameter() Generate an Axis2 parameter for this configuration
String	getPersisterClassName()
org.apache.axiom.om.OMElement	getPersisterElement()
Map	getPersisterPropertyMap()
X509Certificate	getServiceCert(org.apache.ws.security.components.crypto.Crypto crypto, String serviceAddress) Uses the wst:AppliesTo to figure out the certificate to encrypt the secret in the SAML token
String	getSignatureAlgorithm()
Map	getTrustedServices() Return the list of trusted services as a java.util.Map.
boolean	isTokenStoreDisabled()
void	setCallbackHander(SAMLCallbackHandler callbackHandler) Deprecated.
void	setCallbackHandler(SAMLCallbackHandler callbackHandler)
void	setCallbackHandlerName(String callbackHandlerName)
void	setCryptoProperties(String providerClassName, Properties props) Set crypto information using WSS4J mechanisms
void	setDigestAlgorithm(String digestAlgorithm)
void	setIssuerKeyAlias(String issuerKeyAlias)
void	setIssuerKeyPassword(String issuerKeyPassword)
void	setIssuerName(String issuerName)
void	setPersisterClassName(String persisterClassName)
void	setPersisterPropertyMap(Map persisterPropertyMap)
void	setSignatureAlgorithm(String signatureAlgorithm)
void	setTokenStoreDisabled(boolean tokenStoreDisabled)
void	setTrustedServices(Map trustedServices)
void	setTrustStorePropFile(String trustStorePropFile)

Methods inherited from class org.apache.rahas.impl.AbstractIssuerConfig

getKeyComputation, getKeySize, getProofKeyType, setAddRequestedAttachedRef, setAddRequestedUnattachedRef, setKeyComputation, setKeySize, setProofKeyType, setTtl

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

SAML_ISSUER_CONFIG

public static final QName SAML_ISSUER_CONFIG

The QName of the configuration element of the SAMLTokenIssuer

USE_SAML_ATTRIBUTE_STATEMENT

public static final QName USE_SAML_ATTRIBUTE_STATEMENT

ISSUER_NAME

public static final QName ISSUER_NAME

SAML_CALLBACK_CLASS

public static final QName SAML_CALLBACK_CLASS

SIGNATURE_ALGORITHM

public static final QName SIGNATURE_ALGORITHM

DIGEST_ALGORITHM

public static final QName DIGEST_ALGORITHM

issuerKeyAlias

protected String issuerKeyAlias

issuerKeyPassword

protected String issuerKeyPassword

issuerName

protected String issuerName

trustedServices

protected Map trustedServices

trustStorePropFile

protected String trustStorePropFile

callbackHandler

protected SAMLCallbackHandler callbackHandler

callbackHandlerName

protected String callbackHandlerName

persisterElement

protected org.apache.axiom.om.OMElement persisterElement

persisterClassName

protected String persisterClassName

persisterPropertyMap

protected Map<String,String> persisterPropertyMap

tokenStoreDisabled

protected boolean tokenStoreDisabled

signatureAlgorithm

protected String signatureAlgorithm

digestAlgorithm

protected String digestAlgorithm

Constructor Detail

SAMLTokenIssuerConfig

public SAMLTokenIssuerConfig(String issuerName,
                             String cryptoProviderClassName,
                             Properties cryptoProps)

Create a new configuration with issuer name and crypto information

Parameters:

issuerName - Name of the issuer

cryptoProviderClassName - WSS4J Crypto impl class name

cryptoProps - Configuration properties of crypto impl

SAMLTokenIssuerConfig

public SAMLTokenIssuerConfig(String configFilePath)
                      throws TrustException

Create a SAMLTokenIssuer configuration with a config file picked from the given location.

Parameters:

configFilePath - Path to the config file

Throws:

TrustException

SAMLTokenIssuerConfig

public SAMLTokenIssuerConfig(org.apache.axiom.om.OMElement elem)
                      throws TrustException

Create a SAMLTokenIssuer configuration using the give config element

Parameters:

elem - Configuration element as an OMElement

Throws:

TrustException

Method Detail

getParameter

public org.apache.axis2.description.Parameter getParameter()

Generate an Axis2 parameter for this configuration

Returns:

An Axis2 Parameter instance with configuration information

setIssuerKeyAlias

public void setIssuerKeyAlias(String issuerKeyAlias)

getIssuerKeyAlias

public String getIssuerKeyAlias()

setIssuerKeyPassword

public void setIssuerKeyPassword(String issuerKeyPassword)

getIssuerKeyPassword

public String getIssuerKeyPassword()

setIssuerName

public void setIssuerName(String issuerName)

setTrustedServices

public void setTrustedServices(Map trustedServices)

setTrustStorePropFile

public void setTrustStorePropFile(String trustStorePropFile)

addTrustedServiceEndpointAddress

public void addTrustedServiceEndpointAddress(String address,
                                             String alias)

Add a new trusted service endpoint address with its certificate

Parameters:

address - Service endpoint address

alias - certificate alias

setCryptoProperties

public void setCryptoProperties(String providerClassName,
                                Properties props)

Set crypto information using WSS4J mechanisms

Parameters:

providerClassName - Provider class - an implementation of org.apache.ws.security.components.crypto.Crypto

props - Configuration properties

getTrustedServices

public Map getTrustedServices()

Return the list of trusted services as a java.util.Map. The services addresses are the keys and cert aliases available under those keys.

Returns:

getCallbackHander

@Deprecated
public SAMLCallbackHandler getCallbackHander()

Deprecated.

setCallbackHander

@Deprecated
public void setCallbackHander(SAMLCallbackHandler callbackHandler)

Deprecated.

getCallbackHandler

public SAMLCallbackHandler getCallbackHandler()

setCallbackHandler

public void setCallbackHandler(SAMLCallbackHandler callbackHandler)

getCallbackHandlerName

public String getCallbackHandlerName()

setCallbackHandlerName

public void setCallbackHandlerName(String callbackHandlerName)

getServiceCert

public X509Certificate getServiceCert(org.apache.ws.security.components.crypto.Crypto crypto,
                                      String serviceAddress)
                               throws org.apache.ws.security.WSSecurityException

Uses the wst:AppliesTo to figure out the certificate to encrypt the secret in the SAML token

Parameters:

crypto -

serviceAddress - The address of the service

Returns:

Throws:

org.apache.ws.security.WSSecurityException

getPersisterClassName

public String getPersisterClassName()

setPersisterClassName

public void setPersisterClassName(String persisterClassName)

getPersisterPropertyMap

public Map getPersisterPropertyMap()

setPersisterPropertyMap

public void setPersisterPropertyMap(Map persisterPropertyMap)

getPersisterElement

public org.apache.axiom.om.OMElement getPersisterElement()

isTokenStoreDisabled

public boolean isTokenStoreDisabled()

setTokenStoreDisabled

public void setTokenStoreDisabled(boolean tokenStoreDisabled)

getSignatureAlgorithm

public String getSignatureAlgorithm()

setSignatureAlgorithm

public void setSignatureAlgorithm(String signatureAlgorithm)

getDigestAlgorithm

public String getDigestAlgorithm()

setDigestAlgorithm

public void setDigestAlgorithm(String digestAlgorithm)