org.apache.camel.model.dataformat.XMLSecurityDataFormat Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of camel-core Show documentation
Show all versions of camel-core Show documentation
The Core Camel Java DSL based router
/**
* Licensed to the Apache Software Foundation (ASF) under one or more
* contributor license agreements. See the NOTICE file distributed with
* this work for additional information regarding copyright ownership.
* The ASF licenses this file to You under the Apache License, Version 2.0
* (the "License"); you may not use this file except in compliance with
* the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.apache.camel.model.dataformat;
import java.util.HashMap;
import java.util.Map;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlAttribute;
import javax.xml.bind.annotation.XmlRootElement;
import javax.xml.bind.annotation.XmlTransient;
import org.apache.camel.CamelContext;
import org.apache.camel.model.DataFormatDefinition;
import org.apache.camel.spi.DataFormat;
import org.apache.camel.spi.Metadata;
import org.apache.camel.spi.NamespaceAware;
import org.apache.camel.util.jsse.KeyStoreParameters;
/**
* XML-Security data format
*/
@Metadata(firstVersion = "2.0.0", label = "dataformat,transformation,xml,security", title = "XML Security")
@XmlRootElement(name = "secureXML")
@XmlAccessorType(XmlAccessType.FIELD)
public class XMLSecurityDataFormat extends DataFormatDefinition implements NamespaceAware {
private static final String TRIPLEDES = "http://www.w3.org/2001/04/xmlenc#tripledes-cbc";
@XmlAttribute @Metadata(defaultValue = "TRIPLEDES")
private String xmlCipherAlgorithm;
@XmlAttribute
private String passPhrase;
@XmlAttribute
private String secureTag;
@XmlAttribute
private Boolean secureTagContents;
@XmlAttribute @Metadata(defaultValue = "RSA_OAEP")
private String keyCipherAlgorithm;
@XmlAttribute
private String recipientKeyAlias;
@XmlAttribute
// TODO: rename to keyOrTrustStoreParametersRef
private String keyOrTrustStoreParametersId;
@XmlAttribute
private String keyPassword;
@XmlAttribute @Metadata(defaultValue = "SHA1")
private String digestAlgorithm;
@XmlAttribute @Metadata(defaultValue = "MGF1_SHA1")
private String mgfAlgorithm;
@XmlAttribute @Metadata(defaultValue = "true")
private Boolean addKeyValueForEncryptedKey;
@XmlTransient
private KeyStoreParameters keyOrTrustStoreParameters;
@XmlTransient
private Map namespaces;
public XMLSecurityDataFormat() {
super("secureXML");
}
// all the parameter constructors is deprecated as people should use getter/setter to configure
@Deprecated
public XMLSecurityDataFormat(String secureTag, boolean secureTagContents) {
this();
this.setSecureTag(secureTag);
this.setSecureTagContents(secureTagContents);
}
@Deprecated
public XMLSecurityDataFormat(String secureTag, Map namespaces, boolean secureTagContents) {
this();
this.setSecureTag(secureTag);
this.setSecureTagContents(secureTagContents);
this.setNamespaces(namespaces);
}
@Deprecated
public XMLSecurityDataFormat(String secureTag, boolean secureTagContents, String passPhrase) {
this(secureTag, secureTagContents);
this.setPassPhrase(passPhrase);
}
@Deprecated
public XMLSecurityDataFormat(String secureTag, Map namespaces, boolean secureTagContents,
String passPhrase) {
this(secureTag, secureTagContents);
this.setPassPhrase(passPhrase);
this.setNamespaces(namespaces);
}
@Deprecated
public XMLSecurityDataFormat(String secureTag, boolean secureTagContents, String passPhrase,
String xmlCipherAlgorithm) {
this(secureTag, secureTagContents, passPhrase);
this.setXmlCipherAlgorithm(xmlCipherAlgorithm);
}
@Deprecated
public XMLSecurityDataFormat(String secureTag, Map namespaces, boolean secureTagContents, String passPhrase,
String xmlCipherAlgorithm) {
this(secureTag, secureTagContents, passPhrase);
this.setXmlCipherAlgorithm(xmlCipherAlgorithm);
this.setNamespaces(namespaces);
}
/**
* @deprecated use {{@link #XMLSecurityDataFormat(String, boolean, String, String, String, String)} or
* {{@link #XMLSecurityDataFormat(String, boolean, String, String, String, KeyStoreParameters)} instead
*/
@Deprecated
public XMLSecurityDataFormat(String secureTag, boolean secureTagContents, String recipientKeyAlias,
String xmlCipherAlgorithm, String keyCipherAlgorithm) {
this(secureTag, secureTagContents);
this.setRecipientKeyAlias(recipientKeyAlias);
this.setXmlCipherAlgorithm(xmlCipherAlgorithm);
this.setKeyCipherAlgorithm(keyCipherAlgorithm);
}
@Deprecated
public XMLSecurityDataFormat(String secureTag, boolean secureTagContents, String recipientKeyAlias,
String xmlCipherAlgorithm, String keyCipherAlgorithm, String keyOrTrustStoreParametersId) {
this(secureTag, secureTagContents);
this.setRecipientKeyAlias(recipientKeyAlias);
this.setXmlCipherAlgorithm(xmlCipherAlgorithm);
this.setKeyCipherAlgorithm(keyCipherAlgorithm);
this.setKeyOrTrustStoreParametersId(keyOrTrustStoreParametersId);
}
@Deprecated
public XMLSecurityDataFormat(String secureTag, boolean secureTagContents, String recipientKeyAlias,
String xmlCipherAlgorithm, String keyCipherAlgorithm, KeyStoreParameters keyOrTrustStoreParameters) {
this(secureTag, secureTagContents);
this.setRecipientKeyAlias(recipientKeyAlias);
this.setXmlCipherAlgorithm(xmlCipherAlgorithm);
this.setKeyCipherAlgorithm(keyCipherAlgorithm);
this.setKeyOrTrustStoreParameters(keyOrTrustStoreParameters);
}
@Deprecated
public XMLSecurityDataFormat(String secureTag, boolean secureTagContents, String recipientKeyAlias,
String xmlCipherAlgorithm, String keyCipherAlgorithm, String keyOrTrustStoreParametersId, String keyPassword) {
this(secureTag, secureTagContents);
this.setRecipientKeyAlias(recipientKeyAlias);
this.setXmlCipherAlgorithm(xmlCipherAlgorithm);
this.setKeyCipherAlgorithm(keyCipherAlgorithm);
this.setKeyOrTrustStoreParametersId(keyOrTrustStoreParametersId);
this.setKeyPassword(keyPassword);
}
@Deprecated
public XMLSecurityDataFormat(String secureTag, boolean secureTagContents, String recipientKeyAlias,
String xmlCipherAlgorithm, String keyCipherAlgorithm, KeyStoreParameters keyOrTrustStoreParameters, String keyPassword) {
this(secureTag, secureTagContents);
this.setRecipientKeyAlias(recipientKeyAlias);
this.setXmlCipherAlgorithm(xmlCipherAlgorithm);
this.setKeyCipherAlgorithm(keyCipherAlgorithm);
this.setKeyOrTrustStoreParameters(keyOrTrustStoreParameters);
this.setKeyPassword(keyPassword);
}
/**
* @deprecated use {{@link #XMLSecurityDataFormat(String, Map, boolean, String, String, String, String)} or
* {{@link #XMLSecurityDataFormat(String, Map, boolean, String, String, String, KeyStoreParameters)} instead
*/
@Deprecated
public XMLSecurityDataFormat(String secureTag, Map namespaces, boolean secureTagContents, String recipientKeyAlias,
String xmlCipherAlgorithm, String keyCipherAlgorithm) {
this(secureTag, secureTagContents);
this.setRecipientKeyAlias(recipientKeyAlias);
this.setXmlCipherAlgorithm(xmlCipherAlgorithm);
this.setKeyCipherAlgorithm(keyCipherAlgorithm);
this.setNamespaces(namespaces);
}
@Deprecated
public XMLSecurityDataFormat(String secureTag, Map namespaces, boolean secureTagContents, String recipientKeyAlias,
String xmlCipherAlgorithm, String keyCipherAlgorithm, String keyOrTrustStoreParametersId) {
this(secureTag, secureTagContents);
this.setRecipientKeyAlias(recipientKeyAlias);
this.setXmlCipherAlgorithm(xmlCipherAlgorithm);
this.setKeyCipherAlgorithm(keyCipherAlgorithm);
this.setNamespaces(namespaces);
this.setKeyOrTrustStoreParametersId(keyOrTrustStoreParametersId);
}
@Deprecated
public XMLSecurityDataFormat(String secureTag, Map namespaces, boolean secureTagContents, String recipientKeyAlias,
String xmlCipherAlgorithm, String keyCipherAlgorithm, KeyStoreParameters keyOrTrustStoreParameters) {
this(secureTag, secureTagContents);
this.setRecipientKeyAlias(recipientKeyAlias);
this.setXmlCipherAlgorithm(xmlCipherAlgorithm);
this.setKeyCipherAlgorithm(keyCipherAlgorithm);
this.setNamespaces(namespaces);
this.setKeyOrTrustStoreParameters(keyOrTrustStoreParameters);
}
@Deprecated
public XMLSecurityDataFormat(String secureTag, Map namespaces, boolean secureTagContents, String recipientKeyAlias,
String xmlCipherAlgorithm, String keyCipherAlgorithm, String keyOrTrustStoreParametersId, String keyPassword) {
this(secureTag, secureTagContents);
this.setRecipientKeyAlias(recipientKeyAlias);
this.setXmlCipherAlgorithm(xmlCipherAlgorithm);
this.setKeyCipherAlgorithm(keyCipherAlgorithm);
this.setNamespaces(namespaces);
this.setKeyOrTrustStoreParametersId(keyOrTrustStoreParametersId);
this.setKeyPassword(keyPassword);
}
@Deprecated
public XMLSecurityDataFormat(String secureTag, Map namespaces, boolean secureTagContents, String recipientKeyAlias,
String xmlCipherAlgorithm, String keyCipherAlgorithm, KeyStoreParameters keyOrTrustStoreParameters, String keyPassword) {
this(secureTag, secureTagContents);
this.setRecipientKeyAlias(recipientKeyAlias);
this.setXmlCipherAlgorithm(xmlCipherAlgorithm);
this.setKeyCipherAlgorithm(keyCipherAlgorithm);
this.setNamespaces(namespaces);
this.setKeyOrTrustStoreParameters(keyOrTrustStoreParameters);
this.setKeyPassword(keyPassword);
}
@Deprecated
public XMLSecurityDataFormat(String secureTag, Map namespaces, boolean secureTagContents, String recipientKeyAlias,
String xmlCipherAlgorithm, String keyCipherAlgorithm, KeyStoreParameters keyOrTrustStoreParameters, String keyPassword,
String digestAlgorithm) {
this(secureTag, secureTagContents);
this.setRecipientKeyAlias(recipientKeyAlias);
this.setXmlCipherAlgorithm(xmlCipherAlgorithm);
this.setKeyCipherAlgorithm(keyCipherAlgorithm);
this.setNamespaces(namespaces);
this.setKeyOrTrustStoreParameters(keyOrTrustStoreParameters);
this.setKeyPassword(keyPassword);
this.setDigestAlgorithm(digestAlgorithm);
}
@Override
protected void configureDataFormat(DataFormat dataFormat, CamelContext camelContext) {
if (getSecureTag() != null) {
setProperty(camelContext, dataFormat, "secureTag", getSecureTag());
} else {
setProperty(camelContext, dataFormat, "secureTag", "");
}
boolean isSecureTagContents = getSecureTagContents() != null && getSecureTagContents();
setProperty(camelContext, dataFormat, "secureTagContents", isSecureTagContents);
if (passPhrase != null) {
setProperty(camelContext, dataFormat, "passPhrase", getPassPhrase().getBytes());
} else {
setProperty(camelContext, dataFormat, "passPhrase", "Just another 24 Byte key".getBytes());
}
if (getXmlCipherAlgorithm() != null) {
setProperty(camelContext, dataFormat, "xmlCipherAlgorithm", getXmlCipherAlgorithm());
} else {
setProperty(camelContext, dataFormat, "xmlCipherAlgorithm", TRIPLEDES);
}
if (getKeyCipherAlgorithm() != null) {
setProperty(camelContext, dataFormat, "keyCipherAlgorithm", getKeyCipherAlgorithm());
}
if (getRecipientKeyAlias() != null) {
setProperty(camelContext, dataFormat, "recipientKeyAlias", getRecipientKeyAlias());
}
if (getKeyOrTrustStoreParametersId() != null) {
setProperty(camelContext, dataFormat, "keyOrTrustStoreParametersId", getKeyOrTrustStoreParametersId());
}
if (keyOrTrustStoreParameters != null) {
setProperty(camelContext, dataFormat, "keyOrTrustStoreParameters", this.keyOrTrustStoreParameters);
}
if (namespaces != null) {
setProperty(camelContext, dataFormat, "namespaces", this.namespaces);
}
if (keyPassword != null) {
setProperty(camelContext, dataFormat, "keyPassword", this.getKeyPassword());
}
if (digestAlgorithm != null) {
setProperty(camelContext, dataFormat, "digestAlgorithm", this.getDigestAlgorithm());
}
if (mgfAlgorithm != null) {
setProperty(camelContext, dataFormat, "mgfAlgorithm", this.getMgfAlgorithm());
}
// should be true by default
boolean isAddKeyValueForEncryptedKey = getAddKeyValueForEncryptedKey() == null || getAddKeyValueForEncryptedKey();
setProperty(camelContext, dataFormat, "addKeyValueForEncryptedKey", isAddKeyValueForEncryptedKey);
}
public String getXmlCipherAlgorithm() {
return xmlCipherAlgorithm;
}
/**
* The cipher algorithm to be used for encryption/decryption of the XML message content. The available choices are:
*
* - XMLCipher.TRIPLEDES
* - XMLCipher.AES_128
* - XMLCipher.AES_128_GCM
* - XMLCipher.AES_192
* - XMLCipher.AES_192_GCM
* - XMLCipher.AES_256
* - XMLCipher.AES_256_GCM
* - XMLCipher.SEED_128
* - XMLCipher.CAMELLIA_128
* - XMLCipher.CAMELLIA_192
* - XMLCipher.CAMELLIA_256
*
* The default value is MLCipher.TRIPLEDES
*/
public void setXmlCipherAlgorithm(String xmlCipherAlgorithm) {
this.xmlCipherAlgorithm = xmlCipherAlgorithm;
}
public String getPassPhrase() {
return passPhrase;
}
/**
* A String used as passPhrase to encrypt/decrypt content. The passPhrase has to be provided.
* If no passPhrase is specified, a default passPhrase is used.
* The passPhrase needs to be put together in conjunction with the appropriate encryption algorithm.
* For example using TRIPLEDES the passPhase can be a "Only another 24 Byte key"
*/
public void setPassPhrase(String passPhrase) {
this.passPhrase = passPhrase;
}
public String getSecureTag() {
return secureTag;
}
/**
* The XPath reference to the XML Element selected for encryption/decryption. If no tag is specified, the entire payload is encrypted/decrypted.
*/
public void setSecureTag(String secureTag) {
this.secureTag = secureTag;
}
public Boolean getSecureTagContents() {
return secureTagContents;
}
/**
* A boolean value to specify whether the XML Element is to be encrypted or the contents of the XML Element
* false = Element Level
* true = Element Content Level
*/
public void setSecureTagContents(Boolean secureTagContents) {
this.secureTagContents = secureTagContents;
}
/**
* The cipher algorithm to be used for encryption/decryption of the asymmetric key. The available choices are:
*
* - XMLCipher.RSA_v1dot5
* - XMLCipher.RSA_OAEP
* - XMLCipher.RSA_OAEP_11
*
* The default value is XMLCipher.RSA_OAEP
*/
public void setKeyCipherAlgorithm(String keyCipherAlgorithm) {
this.keyCipherAlgorithm = keyCipherAlgorithm;
}
public String getKeyCipherAlgorithm() {
return keyCipherAlgorithm;
}
/**
* The key alias to be used when retrieving the recipient's public or private key from a KeyStore when performing asymmetric key encryption or decryption.
*/
public void setRecipientKeyAlias(String recipientKeyAlias) {
this.recipientKeyAlias = recipientKeyAlias;
}
public String getRecipientKeyAlias() {
return recipientKeyAlias;
}
/**
* Refers to a KeyStore instance to lookup in the registry, which is used for
* configuration options for creating and loading a KeyStore instance that represents the sender's trustStore or recipient's keyStore.
*/
public void setKeyOrTrustStoreParametersId(String id) {
this.keyOrTrustStoreParametersId = id;
}
public String getKeyOrTrustStoreParametersId() {
return this.keyOrTrustStoreParametersId;
}
public KeyStoreParameters getKeyOrTrustStoreParameters() {
return keyOrTrustStoreParameters;
}
/**
* Configuration options for creating and loading a KeyStore instance that represents the sender's trustStore or recipient's keyStore.
*/
private void setKeyOrTrustStoreParameters(KeyStoreParameters keyOrTrustStoreParameters) {
this.keyOrTrustStoreParameters = keyOrTrustStoreParameters;
}
public String getKeyPassword() {
return this.keyPassword;
}
/**
* The password to be used for retrieving the private key from the KeyStore. This key is used for asymmetric decryption.
*/
public void setKeyPassword(String keyPassword) {
this.keyPassword = keyPassword;
}
public String getDigestAlgorithm() {
return digestAlgorithm;
}
/**
* The digest algorithm to use with the RSA OAEP algorithm. The available choices are:
*
* - XMLCipher.SHA1
* - XMLCipher.SHA256
* - XMLCipher.SHA512
*
* The default value is XMLCipher.SHA1
*/
public void setDigestAlgorithm(String digestAlgorithm) {
this.digestAlgorithm = digestAlgorithm;
}
public String getMgfAlgorithm() {
return mgfAlgorithm;
}
/**
* The MGF Algorithm to use with the RSA OAEP algorithm. The available choices are:
*
* - EncryptionConstants.MGF1_SHA1
* - EncryptionConstants.MGF1_SHA256
* - EncryptionConstants.MGF1_SHA512
*
* The default value is EncryptionConstants.MGF1_SHA1
*/
public void setMgfAlgorithm(String mgfAlgorithm) {
this.mgfAlgorithm = mgfAlgorithm;
}
public Boolean getAddKeyValueForEncryptedKey() {
return addKeyValueForEncryptedKey;
}
/**
* Whether to add the public key used to encrypt the session key as a KeyValue in the EncryptedKey structure or not.
*/
public void setAddKeyValueForEncryptedKey(Boolean addKeyValueForEncryptedKey) {
this.addKeyValueForEncryptedKey = addKeyValueForEncryptedKey;
}
@Override
public void setNamespaces(Map nspaces) {
if (this.namespaces == null) {
this.namespaces = new HashMap();
}
this.namespaces.putAll(nspaces);
}
@Override
public Map getNamespaces() {
return namespaces;
}
}