Apache CXF · Schema

WsSecurityConfig

WS-Security configuration properties for Apache CXF WSS4J interceptors.

ApacheJAX-RSJAX-WSJavaOpen SourceRESTSOAPWS-SecurityWeb Services

Properties

Name	Type	Description
action	string	Space-separated list of WS-Security actions to apply.
passwordType	string	Password encoding type for UsernameToken.
user	string	Username for UsernameToken or keystore alias.
passwordCallbackClass	string	Fully qualified class name of the javax.security.auth.callback.CallbackHandler for password retrieval.
signatureKeyIdentifier	string	Key identifier type for XML Signature.
signaturePropFile	string	Path to the signature keystore properties file.
encryptionPropFile	string	Path to the encryption keystore properties file.
encryptionUser	string	Alias of the recipient public key for encryption.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/apache-cxf/refs/heads/main/json-schema/apache-cxf-ws-security-config-schema.json",
  "title": "WsSecurityConfig",
  "description": "WS-Security configuration properties for Apache CXF WSS4J interceptors.",
  "type": "object",
  "properties": {
    "action": {
      "type": "string",
      "description": "Space-separated list of WS-Security actions to apply.",
      "example": "UsernameToken Timestamp"
    },
    "passwordType": {
      "type": "string",
      "description": "Password encoding type for UsernameToken.",
      "enum": [
        "PasswordDigest",
        "PasswordText"
      ],
      "example": "PasswordDigest"
    },
    "user": {
      "type": "string",
      "description": "Username for UsernameToken or keystore alias.",
      "example": "serviceUser"
    },
    "passwordCallbackClass": {
      "type": "string",
      "description": "Fully qualified class name of the javax.security.auth.callback.CallbackHandler for password retrieval.",
      "example": "com.example.PasswordCallbackHandler"
    },
    "signatureKeyIdentifier": {
      "type": "string",
      "description": "Key identifier type for XML Signature.",
      "enum": [
        "IssuerSerial",
        "DirectReference",
        "X509KeyIdentifier",
        "SKIKeyIdentifier",
        "Thumbprint"
      ],
      "example": "IssuerSerial"
    },
    "signaturePropFile": {
      "type": "string",
      "description": "Path to the signature keystore properties file.",
      "example": "keystore.properties"
    },
    "encryptionPropFile": {
      "type": "string",
      "description": "Path to the encryption keystore properties file.",
      "example": "keystore.properties"
    },
    "encryptionUser": {
      "type": "string",
      "description": "Alias of the recipient public key for encryption.",
      "example": "serverPublicKey"
    }
  }
}