blob: cee4a8330baa3c70e9642b70dab486000274bdec [file] [log] [blame]
/*
* 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.converter.crypto.springboot;
import javax.annotation.Generated;
import org.apache.camel.spring.boot.DataFormatConfigurationPropertiesCommon;
import org.springframework.boot.context.properties.ConfigurationProperties;
/**
* Encrypt and decrypt messages using Java Cryptographic Extension (JCE) and
* PGP.
*
* Generated by camel-package-maven-plugin - do not edit this file!
*/
@Generated("org.apache.camel.springboot.maven.SpringBootAutoConfigurationMojo")
@ConfigurationProperties(prefix = "camel.dataformat.pgp")
public class PGPDataFormatConfiguration
extends
DataFormatConfigurationPropertiesCommon {
/**
* Whether to enable auto configuration of the pgp data format. This is
* enabled by default.
*/
private Boolean enabled;
/**
* The user ID of the key in the PGP keyring used during encryption. Can
* also be only a part of a user ID. For example, if the user ID is Test
* User then you can use the part Test User or to address the user ID.
*/
private String keyUserid;
/**
* User ID of the key in the PGP keyring used for signing (during
* encryption) or signature verification (during decryption). During the
* signature verification process the specified User ID restricts the public
* keys from the public keyring which can be used for the verification. If
* no User ID is specified for the signature verficiation then any public
* key in the public keyring can be used for the verification. Can also be
* only a part of a user ID. For example, if the user ID is Test User then
* you can use the part Test User or to address the User ID.
*/
private String signatureKeyUserid;
/**
* Password used when opening the private key (not used for encryption).
*/
private String password;
/**
* Password used when opening the private key used for signing (during
* encryption).
*/
private String signaturePassword;
/**
* Filename of the keyring; must be accessible as a classpath resource (but
* you can specify a location in the file system by using the file: prefix).
*/
private String keyFileName;
/**
* Filename of the keyring to use for signing (during encryption) or for
* signature verification (during decryption); must be accessible as a
* classpath resource (but you can specify a location in the file system by
* using the file: prefix).
*/
private String signatureKeyFileName;
/**
* Keyring used for signing/verifying as byte array. You can not set the
* signatureKeyFileName and signatureKeyRing at the same time.
*/
private String signatureKeyRing;
/**
* This option will cause PGP to base64 encode the encrypted text, making it
* available for copy/paste, etc.
*/
private Boolean armored = false;
/**
* Adds an integrity check/sign into the encryption file. The default value
* is true.
*/
private Boolean integrity = true;
/**
* Java Cryptography Extension (JCE) provider, default is Bouncy Castle
* (BC). Alternatively you can use, for example, the IAIK JCE provider; in
* this case the provider must be registered beforehand and the Bouncy
* Castle provider must not be registered beforehand. The Sun JCE provider
* does not work.
*/
private String provider;
/**
* Symmetric key encryption algorithm; possible values are defined in
* org.bouncycastle.bcpg.SymmetricKeyAlgorithmTags; for example 2 (= TRIPLE
* DES), 3 (= CAST5), 4 (= BLOWFISH), 6 (= DES), 7 (= AES_128). Only
* relevant for encrypting.
*/
private Integer algorithm;
/**
* Compression algorithm; possible values are defined in
* org.bouncycastle.bcpg.CompressionAlgorithmTags; for example 0 (=
* UNCOMPRESSED), 1 (= ZIP), 2 (= ZLIB), 3 (= BZIP2). Only relevant for
* encrypting.
*/
private Integer compressionAlgorithm;
/**
* Signature hash algorithm; possible values are defined in
* org.bouncycastle.bcpg.HashAlgorithmTags; for example 2 (= SHA1), 8 (=
* SHA256), 9 (= SHA384), 10 (= SHA512), 11 (=SHA224). Only relevant for
* signing.
*/
private Integer hashAlgorithm;
/**
* Controls the behavior for verifying the signature during unmarshaling.
* There are 4 values possible: optional: The PGP message may or may not
* contain signatures; if it does contain signatures, then a signature
* verification is executed. required: The PGP message must contain at least
* one signature; if this is not the case an exception (PGPException) is
* thrown. A signature verification is executed. ignore: Contained
* signatures in the PGP message are ignored; no signature verification is
* executed. no_signature_allowed: The PGP message must not contain a
* signature; otherwise an exception (PGPException) is thrown.
*/
private String signatureVerificationOption;
public String getKeyUserid() {
return keyUserid;
}
public void setKeyUserid(String keyUserid) {
this.keyUserid = keyUserid;
}
public String getSignatureKeyUserid() {
return signatureKeyUserid;
}
public void setSignatureKeyUserid(String signatureKeyUserid) {
this.signatureKeyUserid = signatureKeyUserid;
}
public String getPassword() {
return password;
}
public void setPassword(String password) {
this.password = password;
}
public String getSignaturePassword() {
return signaturePassword;
}
public void setSignaturePassword(String signaturePassword) {
this.signaturePassword = signaturePassword;
}
public String getKeyFileName() {
return keyFileName;
}
public void setKeyFileName(String keyFileName) {
this.keyFileName = keyFileName;
}
public String getSignatureKeyFileName() {
return signatureKeyFileName;
}
public void setSignatureKeyFileName(String signatureKeyFileName) {
this.signatureKeyFileName = signatureKeyFileName;
}
public String getSignatureKeyRing() {
return signatureKeyRing;
}
public void setSignatureKeyRing(String signatureKeyRing) {
this.signatureKeyRing = signatureKeyRing;
}
public Boolean getArmored() {
return armored;
}
public void setArmored(Boolean armored) {
this.armored = armored;
}
public Boolean getIntegrity() {
return integrity;
}
public void setIntegrity(Boolean integrity) {
this.integrity = integrity;
}
public String getProvider() {
return provider;
}
public void setProvider(String provider) {
this.provider = provider;
}
public Integer getAlgorithm() {
return algorithm;
}
public void setAlgorithm(Integer algorithm) {
this.algorithm = algorithm;
}
public Integer getCompressionAlgorithm() {
return compressionAlgorithm;
}
public void setCompressionAlgorithm(Integer compressionAlgorithm) {
this.compressionAlgorithm = compressionAlgorithm;
}
public Integer getHashAlgorithm() {
return hashAlgorithm;
}
public void setHashAlgorithm(Integer hashAlgorithm) {
this.hashAlgorithm = hashAlgorithm;
}
public String getSignatureVerificationOption() {
return signatureVerificationOption;
}
public void setSignatureVerificationOption(
String signatureVerificationOption) {
this.signatureVerificationOption = signatureVerificationOption;
}
}