Package sop.operation
Interface Encrypt
public interface Encrypt
-
Method Summary
Modifier and TypeMethodDescriptionSets encryption mode.noArmor()Disable ASCII armor encoding.default Readyplaintext(byte[] plaintext) Encrypt the given data yielding the ciphertext.plaintext(InputStream plaintext) Encrypt the given data yielding the ciphertext.default EncryptsignWith(byte[] key) Adds the signer key.signWith(InputStream key) Adds the signer key.default EncryptwithCert(byte[] cert) Encrypt with the given cert.withCert(InputStream cert) Encrypt with the given cert.withKeyPassword(byte[] password) Provide the password for the secret key used for signing.default EncryptwithKeyPassword(String password) Provide the password for the secret key used for signing.withPassword(String password) Encrypt with the given password.
-
Method Details
-
noArmor
Encrypt noArmor()Disable ASCII armor encoding.- Returns:
- builder instance
-
mode
Sets encryption mode.- Parameters:
mode- mode- Returns:
- builder instance
- Throws:
SOPGPException.UnsupportedOption- if this option is not supported
-
signWith
Encrypt signWith(InputStream key) throws SOPGPException.KeyCannotSign, SOPGPException.UnsupportedAsymmetricAlgo, SOPGPException.BadData, IOException Adds the signer key.- Parameters:
key- input stream containing the encoded signer key- Returns:
- builder instance
- Throws:
SOPGPException.KeyCannotSign- if the key cannot be used for signingSOPGPException.UnsupportedAsymmetricAlgo- if the key uses an unsupported asymmetric algorithmSOPGPException.BadData- if theInputStreamdoes not contain an OpenPGP keyIOException- in case of an IO error
-
signWith
default Encrypt signWith(byte[] key) throws SOPGPException.KeyCannotSign, SOPGPException.UnsupportedAsymmetricAlgo, SOPGPException.BadData, IOException Adds the signer key.- Parameters:
key- byte array containing the encoded signer key- Returns:
- builder instance
- Throws:
SOPGPException.KeyCannotSign- if the key cannot be used for signingSOPGPException.UnsupportedAsymmetricAlgo- if the key uses an unsupported asymmetric algorithmSOPGPException.BadData- if the byte array does not contain an OpenPGP keyIOException- in case of an IO error
-
withKeyPassword
default Encrypt withKeyPassword(String password) throws SOPGPException.PasswordNotHumanReadable, SOPGPException.UnsupportedOption Provide the password for the secret key used for signing.- Parameters:
password- password- Returns:
- builder instance
- Throws:
SOPGPException.PasswordNotHumanReadable- if the password is not human-readableSOPGPException.UnsupportedOption- if key password are not supported
-
withKeyPassword
Encrypt withKeyPassword(byte[] password) throws SOPGPException.PasswordNotHumanReadable, SOPGPException.UnsupportedOption Provide the password for the secret key used for signing.- Parameters:
password- password- Returns:
- builder instance
- Throws:
SOPGPException.PasswordNotHumanReadable- if the password is not human-readableSOPGPException.UnsupportedOption- if key password are not supported
-
withPassword
Encrypt withPassword(String password) throws SOPGPException.PasswordNotHumanReadable, SOPGPException.UnsupportedOption Encrypt with the given password.- Parameters:
password- password- Returns:
- builder instance
- Throws:
SOPGPException.PasswordNotHumanReadable- if the password is not human-readableSOPGPException.UnsupportedOption- if this option is not supported
-
withCert
Encrypt withCert(InputStream cert) throws SOPGPException.CertCannotEncrypt, SOPGPException.UnsupportedAsymmetricAlgo, SOPGPException.BadData, IOException Encrypt with the given cert.- Parameters:
cert- input stream containing the encoded cert.- Returns:
- builder instance
- Throws:
SOPGPException.CertCannotEncrypt- if the certificate is not encryption capableSOPGPException.UnsupportedAsymmetricAlgo- if the certificate uses an unsupported asymmetric algorithmSOPGPException.BadData- if theInputStreamdoes not contain an OpenPGP certificateIOException- in case of an IO error
-
withCert
default Encrypt withCert(byte[] cert) throws SOPGPException.CertCannotEncrypt, SOPGPException.UnsupportedAsymmetricAlgo, SOPGPException.BadData, IOException Encrypt with the given cert.- Parameters:
cert- byte array containing the encoded cert.- Returns:
- builder instance
- Throws:
SOPGPException.CertCannotEncrypt- if the certificate is not encryption capableSOPGPException.UnsupportedAsymmetricAlgo- if the certificate uses an unsupported asymmetric algorithmSOPGPException.BadData- if the byte array does not contain an OpenPGP certificateIOException- in case of an IO error
-
plaintext
Encrypt the given data yielding the ciphertext.- Parameters:
plaintext- plaintext- Returns:
- input stream containing the ciphertext
- Throws:
IOException- in case of an IO errorSOPGPException.KeyIsProtected- if at least one signing key cannot be unlocked
-
plaintext
Encrypt the given data yielding the ciphertext.- Parameters:
plaintext- plaintext- Returns:
- input stream containing the ciphertext
- Throws:
IOException- in case of an IO errorSOPGPException.KeyIsProtected- if at least one signing key cannot be unlocked
-