org.apache.ws.security
Class WSConstants

java.lang.Object
  extended byorg.apache.ws.security.WSConstants

public class WSConstants
extends java.lang.Object

Constants in WS-Security spec.


Field Summary
static java.lang.String AES_128
          Sets the encryption method to use AES with 128 bit key as the symmetric algorithm to encrypt data.
static java.lang.String AES_192
          Sets the encryption method to use AES with 192 bit key as the symmetric algorithm to encrypt data.
static java.lang.String AES_256
          Sets the encryption method to use AES with 256 bit key as the symmetric algorithm to encrypt data.
static java.lang.String ASSERTION_LN
           
static java.lang.String ATTR_ACTOR
           
static java.lang.String ATTR_MUST_UNDERSTAND
           
static java.lang.String ATTR_ROLE
           
static java.lang.String BINARY_TOKEN_LN
           
static int BST_DIRECT_REFERENCE
          Sets the signing method to send the signing certificate as a BinarySecurityToken.
static java.lang.String C14N_EXCL_OMIT_COMMENTS
           
static java.lang.String C14N_EXCL_WITH_COMMENTS
           
static java.lang.String C14N_OMIT_COMMENTS
           
static java.lang.String C14N_WITH_COMMENTS
           
static int COMPLIANCE_MODE
          Set the specification compliance mode.
static java.lang.String CREATED_LN
           
static java.lang.String DSA
          Sets the signature method to use DSA with SHA1 (DSS) to sign data.
static java.lang.String ELEM_BODY
           
static java.lang.String ELEM_ENVELOPE
           
static java.lang.String ELEM_HEADER
           
static int EMBED_SECURITY_TOKEN_REF
          Embeds a keyinfo/wsse:SecurityTokenReference into EncryptedData element.
static int EMBEDDED_KEYNAME
          Embeds a keyinfo/key name into the EncryptedData element.
static java.lang.String ENC_KEY_LN
           
static java.lang.String ENC_NS
           
static java.lang.String ENC_PREFIX
           
static int ENCR
           
static java.lang.String EXPIRES_LN
           
static 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 java.lang.String KEYTRANSPORT_RSA15
          Sets the encryption method to encrypt the symmetric data encryption key with the RSA algoritm.
static java.lang.String KEYTRANSPORT_RSAOEP
          Sets the encryption method to encrypt the symmetric data encryption key with the RSA algoritm.
static java.lang.String LABEL_FOR_DERIVED_KEY
           
static int NO_SECURITY
           
static int NO_SERIALIZE
           
static java.lang.String NONCE_LN
           
static int OASIS_1_0
           
static int OASIS_2002_07
           
static int OASIS_2002_12
           
static int OASIS_2003_06
           
static java.lang.String PASSWORD_DIGEST
           
static java.lang.String PASSWORD_LN
           
static java.lang.String PASSWORD_TEXT
           
static java.lang.String PASSWORD_TYPE_ATTR
           
static java.lang.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.

static java.lang.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.

static java.lang.String REF_LIST_LN
           
static java.lang.String RSA
          Sets the signature method to use RSA with SHA to sign data.
static java.lang.String SAML_NS
           
static java.lang.String SAMLP_NS
           
static int SERIALIZE
           
static java.lang.String SIG_LN
           
static java.lang.String SIG_NS
           
static java.lang.String SIG_PREFIX
           
static int SIGN
           
static int SKI_KEY_IDENTIFIER
          Sets the signing method to send a SubjectKeyIdentifier to identify the signing certificate.
static java.lang.String SOAPMESSAGE_NS
           
static int ST_SIGNED
           
static int ST_UNSIGNED
           
static java.lang.String TIMESTAMP_TOKEN_LN
           
static java.lang.String TRIPLE_DES
          Sets the encryption method to use triple DES as the symmetric algorithm to encrypt data.
static int TS
           
static java.lang.String URI_SOAP11_ENV
           
static java.lang.String URI_SOAP11_NEXT_ACTOR
           
static java.lang.String URI_SOAP12_ENV
           
static java.lang.String URI_SOAP12_NEXT_ROLE
           
static java.lang.String URI_SOAP12_NONE_ROLE
           
static java.lang.String URI_SOAP12_ULTIMATE_ROLE
           
static java.lang.String[] URIS_SOAP_ENV
           
static java.lang.String USERNAME_LN
           
static java.lang.String USERNAME_TOKEN_LN
           
static java.lang.String USERNAMETOKEN_NS
           
static int UT
           
static int UT_SIGN
           
static int UT_SIGNING
          UT_SIGNING is used interally only to set a specific Signature behaviour.
static int WSE_DERIVED_KEY_LEN
          Length of UsernameToken derived key used by .NET WSE to sign a message.
static java.lang.String WSS_SAML_ASSERTION
           
static java.lang.String WSS_SAML_NS
           
static java.lang.String WSSE_LN
           
static java.lang.String WSSE_NS
           
static java.lang.String[] WSSE_NS_ARRAY
           
static java.lang.String WSSE_NS_OASIS_1_0
           
static java.lang.String WSSE_NS_OASIS_2002_07
           
static java.lang.String WSSE_NS_OASIS_2002_12
           
static java.lang.String WSSE_NS_OASIS_2003_06
           
static java.lang.String WSSE_PREFIX
           
static java.lang.String WSU_NS
           
static java.lang.String[] WSU_NS_ARRAY
           
static java.lang.String WSU_NS_OASIS_1_0
           
static java.lang.String WSU_NS_OASIS_2002_07
           
static java.lang.String WSU_NS_OASIS_2002_12
           
static java.lang.String WSU_NS_OASIS_2003_06
           
static java.lang.String WSU_PREFIX
           
static int X509_KEY_IDENTIFIER
          Sets the encryption method to send the certificate used to encrypt the symmetric key.
static java.lang.String X509TOKEN_NS
           
static java.lang.String XML_NS
           
static java.lang.String XMLNS_NS
           
 
Constructor Summary
WSConstants()
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

OASIS_2002_07

public static final int OASIS_2002_07
See Also:
Constant Field Values

OASIS_2002_12

public static final int OASIS_2002_12
See Also:
Constant Field Values

OASIS_2003_06

public static final int OASIS_2003_06
See Also:
Constant Field Values

OASIS_1_0

public static final int OASIS_1_0
See Also:
Constant Field Values

COMPLIANCE_MODE

public static final int COMPLIANCE_MODE
Set the specification compliance mode. This affects namespaces as well as how certain items are constructed in security headers.

Currently this can only be set at compile time. The valid values are:

Using #OASIS_2002 enhances chances of interoperability with other WSS implementations that do not fully adhere to the OASIS v1.0 March 2004 specs yet.

See Also:
Constant Field Values

WSSE_NS_OASIS_2002_07

public static final java.lang.String WSSE_NS_OASIS_2002_07
See Also:
Constant Field Values

WSSE_NS_OASIS_2002_12

public static final java.lang.String WSSE_NS_OASIS_2002_12
See Also:
Constant Field Values

WSSE_NS_OASIS_2003_06

public static final java.lang.String WSSE_NS_OASIS_2003_06
See Also:
Constant Field Values

WSSE_NS_OASIS_1_0

public static final java.lang.String WSSE_NS_OASIS_1_0
See Also:
Constant Field Values

WSSE_NS

public static java.lang.String WSSE_NS

WSSE_NS_ARRAY

public static final java.lang.String[] WSSE_NS_ARRAY

USERNAMETOKEN_NS

public static final java.lang.String USERNAMETOKEN_NS
See Also:
Constant Field Values

SOAPMESSAGE_NS

public static final java.lang.String SOAPMESSAGE_NS
See Also:
Constant Field Values

X509TOKEN_NS

public static final java.lang.String X509TOKEN_NS
See Also:
Constant Field Values

WSSE_PREFIX

public static final java.lang.String WSSE_PREFIX
See Also:
Constant Field Values

WSSE_LN

public static final java.lang.String WSSE_LN
See Also:
Constant Field Values

WSU_NS_OASIS_2002_07

public static final java.lang.String WSU_NS_OASIS_2002_07
See Also:
Constant Field Values

WSU_NS_OASIS_2002_12

public static final java.lang.String WSU_NS_OASIS_2002_12
See Also:
Constant Field Values

WSU_NS_OASIS_2003_06

public static final java.lang.String WSU_NS_OASIS_2003_06
See Also:
Constant Field Values

WSU_NS_OASIS_1_0

public static final java.lang.String WSU_NS_OASIS_1_0
See Also:
Constant Field Values

WSU_NS

public static java.lang.String WSU_NS

WSU_NS_ARRAY

public static final java.lang.String[] WSU_NS_ARRAY

WSU_PREFIX

public static final java.lang.String WSU_PREFIX
See Also:
Constant Field Values

SIG_NS

public static final java.lang.String SIG_NS
See Also:
Constant Field Values

SIG_PREFIX

public static final java.lang.String SIG_PREFIX
See Also:
Constant Field Values

SIG_LN

public static final java.lang.String SIG_LN
See Also:
Constant Field Values

ENC_NS

public static final java.lang.String ENC_NS
See Also:
Constant Field Values

ENC_PREFIX

public static final java.lang.String ENC_PREFIX
See Also:
Constant Field Values

ENC_KEY_LN

public static final java.lang.String ENC_KEY_LN
See Also:
Constant Field Values

REF_LIST_LN

public static final java.lang.String REF_LIST_LN
See Also:
Constant Field Values

XMLNS_NS

public static final java.lang.String XMLNS_NS
See Also:
Constant Field Values

XML_NS

public static final java.lang.String XML_NS
See Also:
Constant Field Values

USERNAME_TOKEN_LN

public static final java.lang.String USERNAME_TOKEN_LN
See Also:
Constant Field Values

BINARY_TOKEN_LN

public static final java.lang.String BINARY_TOKEN_LN
See Also:
Constant Field Values

TIMESTAMP_TOKEN_LN

public static final java.lang.String TIMESTAMP_TOKEN_LN
See Also:
Constant Field Values

USERNAME_LN

public static final java.lang.String USERNAME_LN
See Also:
Constant Field Values

PASSWORD_LN

public static final java.lang.String PASSWORD_LN
See Also:
Constant Field Values

PASSWORD_TYPE_ATTR

public static final java.lang.String PASSWORD_TYPE_ATTR
See Also:
Constant Field Values

NONCE_LN

public static final java.lang.String NONCE_LN
See Also:
Constant Field Values

CREATED_LN

public static final java.lang.String CREATED_LN
See Also:
Constant Field Values

EXPIRES_LN

public static final java.lang.String EXPIRES_LN
See Also:
Constant Field Values

SAML_NS

public static final java.lang.String SAML_NS
See Also:
Constant Field Values

SAMLP_NS

public static final java.lang.String SAMLP_NS
See Also:
Constant Field Values

ASSERTION_LN

public static final java.lang.String ASSERTION_LN
See Also:
Constant Field Values

WSS_SAML_NS

public static final java.lang.String WSS_SAML_NS
See Also:
Constant Field Values

WSS_SAML_ASSERTION

public static final java.lang.String WSS_SAML_ASSERTION
See Also:
Constant Field Values

URI_SOAP11_ENV

public static final java.lang.String URI_SOAP11_ENV
See Also:
Constant Field Values

URI_SOAP12_ENV

public static final java.lang.String URI_SOAP12_ENV
See Also:
Constant Field Values

URIS_SOAP_ENV

public static final java.lang.String[] URIS_SOAP_ENV

URI_SOAP11_NEXT_ACTOR

public static final java.lang.String URI_SOAP11_NEXT_ACTOR
See Also:
Constant Field Values

URI_SOAP12_NEXT_ROLE

public static final java.lang.String URI_SOAP12_NEXT_ROLE
See Also:
Constant Field Values

URI_SOAP12_NONE_ROLE

public static final java.lang.String URI_SOAP12_NONE_ROLE
See Also:
Constant Field Values

URI_SOAP12_ULTIMATE_ROLE

public static final java.lang.String URI_SOAP12_ULTIMATE_ROLE
See Also:
Constant Field Values

ELEM_ENVELOPE

public static final java.lang.String ELEM_ENVELOPE
See Also:
Constant Field Values

ELEM_HEADER

public static final java.lang.String ELEM_HEADER
See Also:
Constant Field Values

ELEM_BODY

public static final java.lang.String ELEM_BODY
See Also:
Constant Field Values

ATTR_MUST_UNDERSTAND

public static final java.lang.String ATTR_MUST_UNDERSTAND
See Also:
Constant Field Values

ATTR_ACTOR

public static final java.lang.String ATTR_ACTOR
See Also:
Constant Field Values

ATTR_ROLE

public static final java.lang.String ATTR_ROLE
See Also:
Constant Field Values

PW_DIGEST

public static final java.lang.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 java.lang.String PASSWORD_DIGEST
See Also:
Constant Field Values

PW_TEXT

public static final java.lang.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 java.lang.String PASSWORD_TEXT
See Also:
Constant Field Values

KEYTRANSPORT_RSA15

public static final java.lang.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 java.lang.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 java.lang.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.

See Also:
Constant Field Values

AES_128

public static final java.lang.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.

See Also:
Constant Field Values

AES_256

public static final java.lang.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.

See Also:
Constant Field Values

AES_192

public static final java.lang.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.

See Also:
Constant Field Values

DSA

public static final java.lang.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 java.lang.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 java.lang.String C14N_OMIT_COMMENTS
See Also:
Constant Field Values

C14N_WITH_COMMENTS

public static final java.lang.String C14N_WITH_COMMENTS
See Also:
Constant Field Values

C14N_EXCL_OMIT_COMMENTS

public static final java.lang.String C14N_EXCL_OMIT_COMMENTS
See Also:
Constant Field Values

C14N_EXCL_WITH_COMMENTS

public static final java.lang.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 private 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 private 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

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

NO_SERIALIZE

public static final int NO_SERIALIZE
See Also:
Constant Field Values

SERIALIZE

public static final int SERIALIZE
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 java.lang.String LABEL_FOR_DERIVED_KEY
See Also:
Constant Field Values
Constructor Detail

WSConstants

public WSConstants()