Class ProducerOptions
java.lang.Object
org.pgpainless.encryption_signing.ProducerOptions
-
Method Summary
Modifier and TypeMethodDescriptionApply special encoding of line endings to the input data.static ProducerOptions
encrypt
(EncryptionOptions encryptionOptions) Encrypt some data without signing.Return comment set for header in ascii armored output.Return the encrypted files name.Return the modification date of the encrypted file.Return the version info header in ascii armored output.boolean
Return whether a comment was set (!= null).boolean
Return whether a version header was set (!= null).boolean
Return the input encoding that will be applied before signing / encryption.boolean
Return true if the output of the encryption/signing operation shall be ascii armored.boolean
boolean
static ProducerOptions
Only wrap the data in an OpenPGP packet.overrideCompressionAlgorithm
(CompressionAlgorithm compressionAlgorithm) Override which compression algorithm shall be used.setAsciiArmor
(boolean asciiArmor) Specify, whether the result of the encryption/signing operation shall be ascii armored.setComment
(String comment) Set the comment header in ASCII armored output.setEncoding
(StreamEncoding encoding) Deprecated.setFileName
(String fileName) Set the name of the encrypted file.Deprecated.deprecated since at least crypto-refresh-05.setHideArmorHeaders
(boolean hideArmorHeaders) If set tosetModificationDate
(Date modificationDate) Set the modification date of the encrypted file.setVersion
(String version) Set the version header in ASCII armored output.static ProducerOptions
sign
(SigningOptions signingOptions) Sign some data without encryption.static ProducerOptions
signAndEncrypt
(EncryptionOptions encryptionOptions, SigningOptions signingOptions) Sign and encrypt some data.
-
Method Details
-
signAndEncrypt
public static ProducerOptions signAndEncrypt(EncryptionOptions encryptionOptions, SigningOptions signingOptions) Sign and encrypt some data.- Parameters:
encryptionOptions
- encryption optionssigningOptions
- signing options- Returns:
- builder
-
sign
Sign some data without encryption.- Parameters:
signingOptions
- signing options- Returns:
- builder
-
encrypt
Encrypt some data without signing.- Parameters:
encryptionOptions
- encryption options- Returns:
- builder
-
noEncryptionNoSigning
Only wrap the data in an OpenPGP packet. No encryption or signing will be applied.- Returns:
- builder
-
setAsciiArmor
Specify, whether the result of the encryption/signing operation shall be ascii armored. The default value is true.- Parameters:
asciiArmor
- ascii armor- Returns:
- builder
-
isAsciiArmor
public boolean isAsciiArmor()Return true if the output of the encryption/signing operation shall be ascii armored.- Returns:
- ascii armored
-
setComment
Set the comment header in ASCII armored output. The default value is null, which means no comment header is added. Multiline comments are possible using '\\n'.
Note: If a default header comment is set usingArmoredOutputStreamFactory.setComment(String)
, then both comments will be written to the produced ASCII armor.- Parameters:
comment
- comment header text- Returns:
- builder
-
setVersion
Set the version header in ASCII armored output. The default value is null, which means no version header is added.
Note: If the value is non-null, then this method overrides the default version header set usingArmoredOutputStreamFactory.setVersionInfo(String)
.- Parameters:
version
- version header, or null for no version info.- Returns:
- builder
-
getComment
Return comment set for header in ascii armored output.- Returns:
- comment
-
getVersion
Return the version info header in ascii armored output.- Returns:
- version info
-
hasComment
public boolean hasComment()Return whether a comment was set (!= null).- Returns:
- true if commend is set
-
hasVersion
public boolean hasVersion()Return whether a version header was set (!= null).- Returns:
- true if version header is set
-
setCleartextSigned
-
isCleartextSigned
public boolean isCleartextSigned() -
setFileName
Set the name of the encrypted file. Note: This option cannot be used simultaneously withsetForYourEyesOnly()
.- Parameters:
fileName
- name of the encrypted file- Returns:
- this
-
getFileName
Return the encrypted files name.- Returns:
- file name
-
setForYourEyesOnly
Deprecated.deprecated since at least crypto-refresh-05. It is not recommended using this special filename in newly generated literal data packetsMark the encrypted message as for-your-eyes-only by setting a special file name. Note: Therefore this method cannot be used simultaneously withsetFileName(String)
.- Returns:
- this
-
setModificationDate
Set the modification date of the encrypted file.- Parameters:
modificationDate
- Modification date of the encrypted file.- Returns:
- this
-
getModificationDate
Return the modification date of the encrypted file.- Returns:
- modification date
-
setEncoding
Deprecated.options other than the default value ofStreamEncoding.BINARY
are discouraged.Set format metadata field of the literal data packet. Defaults toStreamEncoding.BINARY
.
This does not change the encoding of the wrapped data itself. To apply CR/LF encoding to your input data before processing, useapplyCRLFEncoding()
instead.- Parameters:
encoding
- encoding- Returns:
- this
- See Also:
-
getEncoding
-
applyCRLFEncoding
Apply special encoding of line endings to the input data. By default, this is disabled, which means that the data is not altered.
Enabling it will change the line endings to CR/LF. Note: The encoding will not be reversed when decrypting, so applying CR/LF encoding will result in the identity "decrypt(encrypt(data)) == data == verify(sign(data))".- Returns:
- this
-
isApplyCRLFEncoding
public boolean isApplyCRLFEncoding()Return the input encoding that will be applied before signing / encryption.- Returns:
- input encoding
-
overrideCompressionAlgorithm
Override which compression algorithm shall be used.- Parameters:
compressionAlgorithm
- compression algorithm override- Returns:
- builder
-
getCompressionAlgorithmOverride
-
getEncryptionOptions
-
getSigningOptions
-
isHideArmorHeaders
public boolean isHideArmorHeaders() -
setHideArmorHeaders
If set totrue
, armor headers like version or comments will be omitted from armored output. By default, armor headers are not hidden. Note: If comments are added viasetComment(String)
, those are not omitted, even ifhideArmorHeaders
is set totrue
.- Parameters:
hideArmorHeaders
- true or false- Returns:
- this
-
StreamEncoding.BINARY
are discouraged.