Configuring the extra properties
There are several extra properties that may need to be set to provide the additional bits of information to the runtime.
|
ws-security.username |
The user's name. It is used differently by each of the WS-Security functions, see the JavaDoc for more information. |
|
ws-security.password |
The user's password when ws-security.callback-handler is not defined. It is currently only used for the case of adding a password to a UsernameToken. See the JavaDoc for more information. |
|
ws-security.signature.username |
The user's name for signature. It is used as the alias name in the keystore to get the user's cert and private key for signature. See the JavaDoc for more information. |
|
ws-security.encryption.username |
The user's name for encryption. It is used as the alias name in the keystore to get the user's public key for encryption. See the JavaDoc for more information. |
|
ws-security.callback-handler |
The WSS4J security CallbackHandler class used for passwords. |
|
ws-security.saml-callback-handler |
The SAML CallbackHandler class used to construct SAML Assertions. |
|
ws-security.signature.properties |
The Crypto property configuration to use for signature, if "ws-security.signature.crypto" is not set instead. |
|
ws-security.encryption.properties |
The Crypto property configuration to use for encryption, if "ws-security.encryption.crypto" is not set instead. |
|
ws-security.signature.crypto |
A Crypto object to be used for signature. If this is not defined then "ws-security.signature.properties" is used instead. |
|
ws-security.encryption.crypto |
A Crypto object to be used for encryption. If this is not defined then "ws-security.encryption.properties" is used instead. |
|
Constant |
Default |
Description |
|---|---|---|
|
ws-security.validate.token |
true |
Whether to validate the password of a received UsernameToken or not. |
|
ws-security.enableRevocation |
false |
Whether to enable Certificate Revocation List (CRL) checking or not when verifying trust in a certificate. |
|
ws-security.username-token.always.encrypted |
true |
Whether to always encrypt UsernameTokens that are defined as a SupportingToken. This should not be set to false in a production environment, as it exposes the password (or the digest of the password) on the wire. |
|
ws-security.is-bsp-compliant |
true |
Whether to enforce compliance with the Basic Security Profile (BSP) 1.1 or not. |
|
ws-security.self-sign-saml-assertion |
false |
Whether to self-sign a SAML Assertion or not. If this is set to true, then an enveloped signature will be generated when the SAML Assertion is constructed. |
|
ws-security.enable.nonce.cache |
(varies) |
Whether to cache UsernameToken nonces. See See the JavaDoc for more information. |
|
ws-security.enable.timestamp.cache |
(varies) |
Whether to cache Timestamp Created Strings. See the JavaDoc for more information. |
|
ws-security.timestamp. timeToLive |
The time in seconds to append to the Creation value of an incoming Timestamp to determine whether to accept the Timestamp as valid or not. The default value is 300 seconds (5 minutes). |
|
ws-security.timestamp. futureTimeToLive |
This configuration tag specifies the time in seconds in the future within which the Created time of an incoming Timestamp is valid. The default value is 60 seconds. See the JavaDoc for more information. |
|
ws-security. saml-role-attributename |
The attribute URI of the SAML AttributeStatement where the role information is stored. The default is "http://schemas.xmlsoap.org/ws/2005/05/identity/claims/role". |
|
ws-security.kerberos.client |
A reference to the Kerberos client object class used to obtain a service ticket. |
|
ws-security.spnego.client.action |
The SpnegoClientAction implementation to use for SPNEGO. This allows the user to plug in a different implementation to obtain a service ticket. |
|
ws-security.kerberos.jaas.context |
The JAAS Context name to use for Kerberos. This is currently only supported for SPNEGO. |
|
ws-security.kerberos.spn |
The Kerberos Service Provider Name (spn) to use. This is currently only supported for SPNEGO. |
|
ws-security.nonce.cache.instance |
This holds a reference to a ReplayCache instance used to cache UsernameToken nonces. The default instance that is used is the EHCacheReplayCache. |
|
ws-security.timestamp.cache.instance |
This holds a reference to a ReplayCache instance used to cache Timestamp Created Strings. The default instance that is used is the EHCacheReplayCache. |
|
ws-security.cache.config.file |
Set this property to point to a configuration file for the underlying caching implementation. The default configuration file that is used is cxf-ehcache.xml in the cxf-rt-ws-security module. |
|
org.apache.cxf.ws.security. tokenstore.TokenStore |
The TokenStore instance to use to cache security tokens. By default this uses the EHCacheTokenStore if EhCache is available. Otherwise it uses the MemoryTokenStore |
|
ws-security.subject.cert.constraints |
A comma separated String of regular expressions which will be applied to the subject DN of the certificate used for signature validation, after trust verification of the certificate chain associated with the certificate. These constraints are not used when the certificate is contained in the keystore (direct trust). |
|
ws-security.ut.validator |
The WSS4J Validator instance to use to validate UsernameTokens. The default value is the UsernameTokenValidator. |
|
ws-security.saml1.validator |
The WSS4J Validator instance to use to validate SAML 1.1 Tokens. The default value is the SamlAssertionValidator. |
|
ws-security.saml2.validator |
The WSS4J Validator instance to use to validate SAML 2.0 Tokens. The default value is the SamlAssertionValidator. |
|
ws-security.timestamp.validator |
The WSS4J Validator instance to use to validate Timestamps. The default value is the TimestampValidator. |
|
ws-security.signature.validator |
The WSS4J Validator instance to use to validate trust in credentials used in Signature verification. The default value is the SignatureTrustValidator. |
|
ws-security.bst.validator |
The WSS4J Validator instance to use to validate BinarySecurityTokens. The default value is the NoOpValidator. |
|
ws-security.sct.validator |
The WSS4J Validator instance to use to validate SecurityContextTokens. The default value is the NoOpValidator. |
|
ws-security.sts.client |
A reference to the STSClient class used to communicate with the STS. |
|
ws-security.sts.applies-to |
The "AppliesTo" address to send to the STS. The default is the endpoint address of the service provider. |
|
ws-security.sts.token.usecert |
If true, writes out an X509Certificate structure in UseKey/KeyInfo. If false (the default), writes out a KeyValue structure instead. |
|
ws-security.sts.token.do.cancel |
Whether to cancel a token when using SecureConversation after successful invocation. The default is "false". |
|
ws-security.cache.issued. token.in.endpoint |
Set this to "false" to not cache a SecurityToken per proxy object in the IssuedTokenInterceptorProvider. This should be done if a token is being retrieved from an STS in an intermediary. The default value is "true". |
|
ws-security.sts.disable-wsmex-call-using-epr-address |
Whether to avoid STS client trying send WS-MetadataExchange call using STS EPR WSA address when the endpoint contract contains no WS-MetadataExchange info. The default value is "false". |
|
ws-security.sts.token.crypto |
A Crypto object to be used for the STS. See the JavaDoc for more information. |
|
ws-security.sts.token.properties |
The Crypto property configuration to use for the STS. See the JavaDoc for more information. |
|
ws-security.sts.token.username |
The alias name in the keystore to get the user's public key to send to the STS for the PublicKey KeyType case. |
|
ws-security.sts.token.act-as |
The token to be sent to the STS in an "ActAs" field. See the JavaDoc for more information. |
|
ws-security.sts.token.on-behalf-of |
The token to be sent to the STS in an "OnBehalfOf" field. See the JavaDoc for more information. |
Note: for Symmetric bindings that specify a protection token, the ws-security-encryption properties are used.