Class WSConstants

java.lang.Object

org.apache.ws.security.WSConstants

public class WSConstants
extends Object

Constants in WS-Security spec.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AES_128	Sets the encryption method to use AES with 128 bit key as the symmetric algorithm to encrypt data.
static final String	AES_192	Sets the encryption method to use AES with 192 bit key as the symmetric algorithm to encrypt data.
static final String	AES_256	Sets the encryption method to use AES with 256 bit key as the symmetric algorithm to encrypt data.
static final String	ASSERTION_LN
static final String	ATTR_ACTOR
static final String	ATTR_MUST_UNDERSTAND
static final String	ATTR_ROLE
static final String	BINARY_TOKEN_LN
static final int	BST_DIRECT_REFERENCE	Sets the signing method to send the signing certificate as a BinarySecurityToken.
static final String	C14N_EXCL_OMIT_COMMENTS
static final String	C14N_EXCL_WITH_COMMENTS
static final String	C14N_OMIT_COMMENTS
static final String	C14N_WITH_COMMENTS
static final String	CREATED_LN
static final String	DSA	Sets the signature method to use DSA with SHA1 (DSS) to sign data.
static final String	ELEM_BODY
static final String	ELEM_ENVELOPE
static final String	ELEM_HEADER
static final int	EMBED_SECURITY_TOKEN_REF	Embeds a keyinfo/wsse:SecurityTokenReference into EncryptedData element.
static final int	EMBEDDED_KEYNAME	Embeds a keyinfo/key name into the EncryptedData element.
static final String	ENC_KEY_LN
static final String	ENC_NS
static final String	ENC_PREFIX
static final int	ENCR
static final String	EXPIRES_LN
static final int	ISSUER_SERIAL	Sets the signing or the encryption method to send the issuer name and the serial number of a certificate to the receiver.
static final String	ITERATION_LN
static final String	KEYTRANSPORT_RSA15	Sets the encryption method to encrypt the symmetric data encryption key with the RSA algoritm.
static final String	KEYTRANSPORT_RSAOEP	Sets the encryption method to encrypt the symmetric data encryption key with the RSA algoritm.
static final String	LABEL_FOR_DERIVED_KEY
static final int	NO_SECURITY
static final int	NO_SERIALIZE
static final String	NONCE_LN
static final String	NULL_NS
static final String	PASSWORD_DIGEST
static final String	PASSWORD_LN
static final String	PASSWORD_TEXT
static final String	PASSWORD_TYPE_ATTR
static final String	PW_DIGEST	Sets the UserNameToken method to use a password digest to send the password information
static final String	PW_TEXT	Sets the UserNameToken method to send the password in clear
static final String	REF_LIST_LN
static final String	RSA	Sets the signature method to use RSA with SHA to sign data.
static final String	SALT_LN
static final String	SAML_ASSERTION_ID
static final String	SAML_NS
static final String	SAMLP_NS
static final String	SAMLTOKEN_NS
static final int	SC
static final int	SCT
static final int	SERIALIZE
static final String	SIG_LN
static final String	SIG_NS
static final String	SIG_PREFIX
static final int	SIGN
static final String	SIGNATURE_CONFIRMATION_LN
static final int	SKI_KEY_IDENTIFIER	Sets the signing method to send a SubjectKeyIdentifier to identify the signing certificate.
static final String	SOAPMESSAGE_NS
static final String	SOAPMESSAGE_NS11
static final int	ST_SIGNED
static final int	ST_UNSIGNED
static final String	THUMBPRINT
static final int	THUMBPRINT_IDENTIFIER	THUMPRINT_IDENTIFIER is used to set the specific key identifier ThumbprintSHA1.
static final String	TIMESTAMP_TOKEN_LN
static final String	TRIPLE_DES	Sets the encryption method to use triple DES as the symmetric algorithm to encrypt data.
static final int	TS
static final String	URI_SOAP11_ENV
static final String	URI_SOAP11_NEXT_ACTOR
static final String	URI_SOAP12_ENV
static final String	URI_SOAP12_NEXT_ROLE
static final String	URI_SOAP12_NONE_ROLE
static final String	URI_SOAP12_ULTIMATE_ROLE
static final String[]	URIS_SOAP_ENV
static final String	USERNAME_LN
static final String	USERNAME_TOKEN_LN
static final String	USERNAMETOKEN_NS
static final int	UT
static final int	UT_SIGN
static final int	UT_SIGNING	UT_SIGNING is used interally only to set a specific Signature behaviour.
static final int	WSE_DERIVED_KEY_LEN	Length of UsernameToken derived key used by .NET WSE to sign a message.
static final String	WSS_SAML_ASSERTION
static final String	WSS_SAML_NS
static final String	WSSE_LN
static final String	WSSE_NS
static final String	WSSE_PREFIX
static final String	WSSE11_NS
static final String	WSSE11_PREFIX
static final String	WSU_NS
static final String	WSU_PREFIX
static final int	X509_KEY_IDENTIFIER	Sets the encryption method to send the certificate used to encrypt the symmetric key.
static final String	X509TOKEN_NS
static final String	XML_NS
static final String	XMLNS_NS

Constructor Summary

Constructors

Constructor	Description
WSConstants()

Method Summary

Methods inherited from class Object

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

Field Details

WSSE_NS

public static final String WSSE_NS

See Also:

• Constant Field Values

WSSE11_NS

public static final String WSSE11_NS

See Also:

• Constant Field Values

WSU_NS

public static final String WSU_NS

See Also:

• Constant Field Values

SOAPMESSAGE_NS

public static final String SOAPMESSAGE_NS

See Also:

• Constant Field Values

SOAPMESSAGE_NS11

public static final String SOAPMESSAGE_NS11

See Also:

• Constant Field Values

USERNAMETOKEN_NS

public static final String USERNAMETOKEN_NS

See Also:

• Constant Field Values

X509TOKEN_NS

public static final String X509TOKEN_NS

See Also:

• Constant Field Values

SAMLTOKEN_NS

public static final String SAMLTOKEN_NS

See Also:

• Constant Field Values

WSSE_LN

public static final String WSSE_LN

See Also:

• Constant Field Values

THUMBPRINT

public static final String THUMBPRINT

See Also:

• Constant Field Values

SAML_ASSERTION_ID

public static final String SAML_ASSERTION_ID

See Also:

• Constant Field Values

WSSE_PREFIX

public static final String WSSE_PREFIX

See Also:

• Constant Field Values

WSSE11_PREFIX

public static final String WSSE11_PREFIX

See Also:

• Constant Field Values

WSU_PREFIX

public static final String WSU_PREFIX

See Also:

• Constant Field Values

SIG_NS

public static final String SIG_NS

See Also:

• Constant Field Values

SIG_PREFIX

public static final String SIG_PREFIX

See Also:

• Constant Field Values

SIG_LN

public static final String SIG_LN

See Also:

• Constant Field Values

ENC_NS

public static final String ENC_NS

See Also:

• Constant Field Values

ENC_PREFIX

public static final String ENC_PREFIX

See Also:

• Constant Field Values

ENC_KEY_LN

public static final String ENC_KEY_LN

See Also:

• Constant Field Values

REF_LIST_LN

public static final String REF_LIST_LN

See Also:

• Constant Field Values

XMLNS_NS

public static final String XMLNS_NS

See Also:

• Constant Field Values

XML_NS

public static final String XML_NS

See Also:

• Constant Field Values

USERNAME_TOKEN_LN

public static final String USERNAME_TOKEN_LN

See Also:

• Constant Field Values

BINARY_TOKEN_LN

public static final String BINARY_TOKEN_LN

See Also:

• Constant Field Values

TIMESTAMP_TOKEN_LN

public static final String TIMESTAMP_TOKEN_LN

See Also:

• Constant Field Values

USERNAME_LN

public static final String USERNAME_LN

See Also:

• Constant Field Values

PASSWORD_LN

public static final String PASSWORD_LN

See Also:

• Constant Field Values

PASSWORD_TYPE_ATTR

public static final String PASSWORD_TYPE_ATTR

See Also:

• Constant Field Values

NONCE_LN

public static final String NONCE_LN

See Also:

• Constant Field Values

CREATED_LN

public static final String CREATED_LN

See Also:

• Constant Field Values

EXPIRES_LN

public static final String EXPIRES_LN

See Also:

• Constant Field Values

SIGNATURE_CONFIRMATION_LN

public static final String SIGNATURE_CONFIRMATION_LN

See Also:

• Constant Field Values

SALT_LN

public static final String SALT_LN

See Also:

• Constant Field Values

ITERATION_LN

public static final String ITERATION_LN

See Also:

• Constant Field Values

SAML_NS

public static final String SAML_NS

See Also:

• Constant Field Values

SAMLP_NS

public static final String SAMLP_NS

See Also:

• Constant Field Values

ASSERTION_LN

public static final String ASSERTION_LN

See Also:

• Constant Field Values

WSS_SAML_NS

public static final String WSS_SAML_NS

See Also:

• Constant Field Values

WSS_SAML_ASSERTION

public static final String WSS_SAML_ASSERTION

See Also:

• Constant Field Values

URI_SOAP11_ENV

public static final String URI_SOAP11_ENV

See Also:

• Constant Field Values

URI_SOAP12_ENV

public static final String URI_SOAP12_ENV

See Also:

• Constant Field Values

URIS_SOAP_ENV

public static final String[] URIS_SOAP_ENV

URI_SOAP11_NEXT_ACTOR

public static final String URI_SOAP11_NEXT_ACTOR

See Also:

• Constant Field Values

URI_SOAP12_NEXT_ROLE

public static final String URI_SOAP12_NEXT_ROLE

See Also:

• Constant Field Values

URI_SOAP12_NONE_ROLE

public static final String URI_SOAP12_NONE_ROLE

See Also:

• Constant Field Values

URI_SOAP12_ULTIMATE_ROLE

public static final String URI_SOAP12_ULTIMATE_ROLE

See Also:

• Constant Field Values

ELEM_ENVELOPE

public static final String ELEM_ENVELOPE

See Also:

• Constant Field Values

ELEM_HEADER

public static final String ELEM_HEADER

See Also:

• Constant Field Values

ELEM_BODY

public static final String ELEM_BODY

See Also:

• Constant Field Values

ATTR_MUST_UNDERSTAND

public static final String ATTR_MUST_UNDERSTAND

See Also:

• Constant Field Values

ATTR_ACTOR

public static final String ATTR_ACTOR

See Also:

• Constant Field Values

ATTR_ROLE

public static final String ATTR_ROLE

See Also:

• Constant Field Values

NULL_NS

public static final String NULL_NS

See Also:

• Constant Field Values

PW_DIGEST

public static final String PW_DIGEST

Sets the UserNameToken method to use a password digest to send the password information

This is a required method as defined by WS Specification, Username token profile.

See Also:

• Constant Field Values

PASSWORD_DIGEST

public static final String PASSWORD_DIGEST

See Also:

• Constant Field Values

PW_TEXT

public static final String PW_TEXT

Sets the UserNameToken method to send the password in clear

This is a required method as defined by WS Specification, Username token profile.

See Also:

• Constant Field Values

PASSWORD_TEXT

public static final String PASSWORD_TEXT

See Also:

• Constant Field Values

KEYTRANSPORT_RSA15

public static final String KEYTRANSPORT_RSA15

Sets the encryption method to encrypt the symmetric data encryption key with the RSA algoritm.

This is a required method as defined by XML encryption.

See Also:

• Constant Field Values

KEYTRANSPORT_RSAOEP

public static final String KEYTRANSPORT_RSAOEP

Sets the encryption method to encrypt the symmetric data encryption key with the RSA algoritm.

This is a required method as defined by XML encryption.

NOTE: This algorithm is not yet supported by WSS4J

See Also:

• Constant Field Values

TRIPLE_DES

public static final String TRIPLE_DES

Sets the encryption method to use triple DES as the symmetric algorithm to encrypt data.

This is a required method as defined by XML encryption. The String to use in WSDD file (in accordance to w3c specifications:
http://www.w3.org/2001/04/xmlenc#tripledes-cbc

See Also:

• Constant Field Values

AES_128

public static final String AES_128

Sets the encryption method to use AES with 128 bit key as the symmetric algorithm to encrypt data.

This is a required method as defined by XML encryption. The String to use in WSDD file (in accordance to w3c specifications:
http://www.w3.org/2001/04/xmlenc#aes128-cbc

See Also:

• Constant Field Values

AES_256

public static final String AES_256

Sets the encryption method to use AES with 256 bit key as the symmetric algorithm to encrypt data.

This is a required method as defined by XML encryption. The String to use in WSDD file (in accordance to w3c specifications:
http://www.w3.org/2001/04/xmlenc#aes256-cbc

See Also:

• Constant Field Values

AES_192

public static final String AES_192

Sets the encryption method to use AES with 192 bit key as the symmetric algorithm to encrypt data.

This is a optional method as defined by XML encryption. The String to use in WSDD file (in accordance to w3c specifications:
http://www.w3.org/2001/04/xmlenc#aes192-cbc

See Also:

• Constant Field Values

DSA

public static final String DSA

Sets the signature method to use DSA with SHA1 (DSS) to sign data.

This is a required method as defined by XML signature.

See Also:

• Constant Field Values

RSA

public static final String RSA

Sets the signature method to use RSA with SHA to sign data.

This is a recommended method as defined by XML signature.

See Also:

• Constant Field Values

C14N_OMIT_COMMENTS

public static final String C14N_OMIT_COMMENTS

See Also:

• Constant Field Values

C14N_WITH_COMMENTS

public static final String C14N_WITH_COMMENTS

See Also:

• Constant Field Values

C14N_EXCL_OMIT_COMMENTS

public static final String C14N_EXCL_OMIT_COMMENTS

See Also:

• Constant Field Values

C14N_EXCL_WITH_COMMENTS

public static final String C14N_EXCL_WITH_COMMENTS

See Also:

• Constant Field Values

BST_DIRECT_REFERENCE

public static final int BST_DIRECT_REFERENCE

Sets the signing method to send the signing certificate as a BinarySecurityToken.

The signing method takes the signing certificate, converts it to a BinarySecurityToken, puts it in the security header, and inserts a Reference to the binary security token into the wsse:SecurityReferenceToken. Thus the whole signing certificate is transfered to the receiver. The X509 profile recommends to use ISSUER_SERIAL instead of sending the whole certificate.

Please refer to WS Security specification X509 profile, chapter 3.3.2 and to WS Security specification, chapter 7.2

Note: only local refernces to BinarySecurityToken are supported

See Also:

• Constant Field Values

ISSUER_SERIAL

public static final int ISSUER_SERIAL

Sets the signing or the encryption method to send the issuer name and the serial number of a certificate to the receiver.

In contrast to BST_DIRECT_REFERENCE only the issuer name and the serial number of the signiung certificate are sent to the receiver. This reduces the amount of data being sent. The ecnryption method uses the public key associated with this certificate to encrypt the symmetric key used to encrypt data.

Please refer to WS Security specification X509 profile, chapter 3.3.3

See Also:

• Constant Field Values

X509_KEY_IDENTIFIER

public static final int X509_KEY_IDENTIFIER

Sets the encryption method to send the certificate used to encrypt the symmetric key.

The encryption method uses the public key associated with this certificate to encrypr the symmetric key used to encrypt data. The certificate is converted into a KeyIdentfier token and sent to the receiver. Thus the complete certificate data is transfered to receiver. The X509 profile recommends to use ISSUER_SERIAL instead of sending the whole certificate.

Please refer to WS Security specification X509 profile, chapter 7.3

See Also:

• Constant Field Values

SKI_KEY_IDENTIFIER

public static final int SKI_KEY_IDENTIFIER

Sets the signing method to send a SubjectKeyIdentifier to identify the signing certificate.

Refer to WS Security specification X509 profile, chapter 3.3.1 This identification token is not yet fully tested by WSS4J. The WsDoAllSender does not include the X.509 certificate as BinarySecurityToken in the request message.

See Also:

• Constant Field Values

EMBEDDED_KEYNAME

public static final int EMBEDDED_KEYNAME

Embeds a keyinfo/key name into the EncryptedData element.

Refer to WS Security specification X509 profile

See Also:

• Constant Field Values

EMBED_SECURITY_TOKEN_REF

public static final int EMBED_SECURITY_TOKEN_REF

Embeds a keyinfo/wsse:SecurityTokenReference into EncryptedData element.

See Also:

• Constant Field Values

UT_SIGNING

public static final int UT_SIGNING

UT_SIGNING is used interally only to set a specific Signature behaviour. The signing token is constructed from values in the UsernameToken according to WS-Trust specification.

See Also:

• Constant Field Values

THUMBPRINT_IDENTIFIER

public static final int THUMBPRINT_IDENTIFIER

THUMPRINT_IDENTIFIER is used to set the specific key identifier ThumbprintSHA1. This identifier uses the SHA-1 digest of a security token to identify the security token. Please refer to chapter 7.2 of the OASIS WSS 1.1 specification.

See Also:

• Constant Field Values

NO_SECURITY

public static final int NO_SECURITY

See Also:

• Constant Field Values

UT

public static final int UT

See Also:

• Constant Field Values

SIGN

public static final int SIGN

See Also:

• Constant Field Values

ENCR

public static final int ENCR

See Also:

• Constant Field Values

ST_UNSIGNED

public static final int ST_UNSIGNED

See Also:

• Constant Field Values

ST_SIGNED

public static final int ST_SIGNED

See Also:

• Constant Field Values

TS

public static final int TS

See Also:

• Constant Field Values

UT_SIGN

public static final int UT_SIGN

See Also:

• Constant Field Values

SC

public static final int SC

See Also:

• Constant Field Values

NO_SERIALIZE

public static final int NO_SERIALIZE

See Also:

• Constant Field Values

SERIALIZE

public static final int SERIALIZE

See Also:

• Constant Field Values

SCT

public static final int SCT

See Also:

• Constant Field Values

WSE_DERIVED_KEY_LEN

public static final int WSE_DERIVED_KEY_LEN

Length of UsernameToken derived key used by .NET WSE to sign a message.

See Also:

• Constant Field Values

LABEL_FOR_DERIVED_KEY

public static final String LABEL_FOR_DERIVED_KEY

See Also:

• Constant Field Values

Constructor Details

WSConstants

public WSConstants()