org.apache.wss4j.dom.handler

Class WSHandlerConstants

java.lang.Object

org.apache.wss4j.common.ConfigurationConstants

org.apache.wss4j.dom.handler.WSHandlerConstants

public final class WSHandlerConstants
extends ConfigurationConstants

This class defines the names, actions, and other string for the deployment data of the WS handler.

Field Summary

Fields

Modifier and Type	Field and Description
static String	HANDLER_ACTIONS This is an alternative to specifying an "action" String.
static String	NO_SECURITY Perform no action.
static String	RECV_RESULTS The WSHandler stores a result List in this property.
static String	SEND_SIGV internally used property names to store values inside the message context that must have the same lifetime as a message (request/response model).
static String	SIG_CONF_DONE
static String	USE_ENCODED_PASSWORDS Set the value of this parameter to true to treat passwords as binary values for Username Tokens.

Fields inherited from class org.apache.wss4j.common.ConfigurationConstants

ACTION, ACTOR, ADD_INCLUSIVE_PREFIXES, ADD_USERNAMETOKEN_CREATED, ADD_USERNAMETOKEN_NONCE, ALLOW_NAMESPACE_QUALIFIED_PASSWORD_TYPES, ALLOW_RSA15_KEY_TRANSPORT_ALGORITHM, ALLOW_USERNAMETOKEN_NOPASSWORD, CUSTOM_TOKEN, DEC_PROP_FILE, DEC_PROP_REF_ID, DERIVED_ENCRYPTION_KEY_LENGTH, DERIVED_KEY_ITERATIONS, DERIVED_SIGNATURE_KEY_LENGTH, DERIVED_TOKEN_KEY_ID, DERIVED_TOKEN_REFERENCE, ENABLE_NONCE_CACHE, ENABLE_REVOCATION, ENABLE_SAML_ONE_TIME_USE_CACHE, ENABLE_SIGNATURE_CONFIRMATION, ENABLE_TIMESTAMP_CACHE, ENC_DIGEST_ALGO, ENC_KEY_ID, ENC_KEY_TRANSPORT, ENC_MGF_ALGO, ENC_PROP_FILE, ENC_PROP_REF_ID, ENC_SYM_ALGO, ENC_SYM_ENC_KEY, ENCRYPT, ENCRYPT_DERIVED, ENCRYPT_WITH_KERBEROS_TOKEN, ENCRYPTION_PARTS, ENCRYPTION_USER, EXPAND_XOP_INCLUDE_FOR_SIGNATURE, GET_SECRET_KEY_FROM_CALLBACK_HANDLER, HANDLE_CUSTOM_PASSWORD_TYPES, INCLUDE_ENCRYPTION_TOKEN, INCLUDE_SIGNATURE_TOKEN, IS_BSP_COMPLIANT, KERBEROS_TOKEN, MUST_UNDERSTAND, NONCE_CACHE_INSTANCE, OPTIONAL_ENCRYPTION_PARTS, OPTIONAL_SIGNATURE_PARTS, PASSWORD_ENCRYPTOR_INSTANCE, PASSWORD_TYPE, PW_CALLBACK_CLASS, PW_CALLBACK_REF, REQUIRE_SIGNED_ENCRYPTED_DATA_ELEMENTS, REQUIRE_TIMESTAMP_EXPIRES, SAML_CALLBACK_CLASS, SAML_CALLBACK_REF, SAML_ONE_TIME_USE_CACHE_INSTANCE, SAML_TOKEN_SIGNED, SAML_TOKEN_UNSIGNED, SIG_ALGO, SIG_C14N_ALGO, SIG_DIGEST_ALGO, SIG_KEY_ID, SIG_PROP_FILE, SIG_PROP_REF_ID, SIG_SUBJECT_CERT_CONSTRAINTS, SIG_VER_PROP_FILE, SIG_VER_PROP_REF_ID, SIGNATURE, SIGNATURE_DERIVED, SIGNATURE_PARTS, SIGNATURE_USER, SIGNATURE_WITH_KERBEROS_TOKEN, STORE_BYTES_IN_ATTACHMENT, TIMESTAMP, TIMESTAMP_CACHE_INSTANCE, TIMESTAMP_PRECISION, TIMESTAMP_STRICT, TTL_FUTURE_TIMESTAMP, TTL_FUTURE_USERNAMETOKEN, TTL_TIMESTAMP, TTL_USERNAMETOKEN, USE_2005_12_NAMESPACE, USE_DERIVED_KEY_FOR_MAC, USE_REQ_SIG_CERT, USE_SINGLE_CERTIFICATE, USER, USERNAME_TOKEN, USERNAME_TOKEN_NO_PASSWORD, USERNAME_TOKEN_SIGNATURE, VALIDATE_SAML_SUBJECT_CONFIRMATION, VALIDATOR_MAP

Method Summary

Modifier and Type	Method and Description
static Integer	getKeyIdentifier(String parameter) Get the key identifier type corresponding to the parameter.

Methods inherited from class java.lang.Object

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

Field Detail

NO_SECURITY

public static final String NO_SECURITY

Perform no action.

See Also:

Constant Field Values

HANDLER_ACTIONS

public static final String HANDLER_ACTIONS

This is an alternative to specifying an "action" String. This Object should be a list of HandlerAction objects, which associate an "action" Integer with a corresponding SecurityActionToken object. This allows for more control over keys etc. used for different actions.

See Also:

Constant Field Values

USE_ENCODED_PASSWORDS

public static final String USE_ENCODED_PASSWORDS

Set the value of this parameter to true to treat passwords as binary values for Username Tokens. The default value is "false". This is needed to properly handle password equivalence for UsernameToken passwords. Binary passwords are Base64 encoded so they can be treated as strings in most places, but when the password digest is calculated or a key is derived from the password, the password will be Base64 decoded before being used. This is most useful for hashed passwords as password equivalents.

See Also:

Constant Field Values

RECV_RESULTS

public static final String RECV_RESULTS

The WSHandler stores a result List in this property.

See Also:

Constant Field Values

SEND_SIGV

public static final String SEND_SIGV

internally used property names to store values inside the message context that must have the same lifetime as a message (request/response model).

See Also:

Constant Field Values

SIG_CONF_DONE

public static final String SIG_CONF_DONE

See Also:

Constant Field Values

Method Detail

getKeyIdentifier

public static Integer getKeyIdentifier(String parameter)

Get the key identifier type corresponding to the parameter. This is intended for internal use only. Valid values for "parameter" are: - "IssuerSerial" - "DirectReference" - "X509KeyIdentifier" - "Thumbprint" - "SKIKeyIdentifier" - "KeyValue" - "EmbeddedKeyName" - "EncryptedKeySHA1"

Parameters:

parameter -

Returns:

the key identifier type corresponding to the parameter