JarCastingPGPlug
A PGP plugin for Java project to make the use of PGP painless and easy.
This package uses Bouncycastel for PGP encryption. Due to the high demands on PGP it is sometimes not possible to realize projects without high expertise.
Swen Kalski designed this package for the BlackChamber server and makes it universally usable for JAVA and Android projects with this repository.
Install
Maven:
<dependency>
<groupId>io.github.no-such-company</groupId>
<artifactId>pgplug</artifactId>
<version>21.5</version>
</dependency>
Gradle:
repositories {
mavenCentral()
}
dependencies {
implementation 'io.github.no-such-company:pgplug:21.5'
}
Basic usage
create keys
Keys can be written directly to a file.
String pass = "something123".toCharArray();
OutputStream privateOut = new FileOutputStream("test.prv");
OutputStream publicOut = new FileOutputStream("test.pub");
generateKeyPair(privateOut, publicOut, pass);
read keys
FileInputStream publicKeyInputStream = new FileInputStream("test.pub");
PGPPublicKey publicKeyRing = readPublicKey(publicKeyInputStream);
FileInputStream privateKeyInputStream = new FileInputStream("test.prv");
PGPSecretKey privateKeyRing = readSecretKey(privateKeyInputStream);
encrytpData
Encrypt a plain Text with a set (or one) public key
The Encrypt method support plaintext with char[] as same as inputStream()
public static byte[] encrypt(byte[] clearData, byte[]... publicKeys)
public static void encrypt(
OutputStream out,
byte[] clearData,
Collection<PGPPublicKey> publicKeys
)
Example:
final byte[] clearData = "1234567890".getBytes();
FileInputStream publicKeyInputStream = new FileInputStream("test.pub");
ByteArrayOutputStream encrypted_output = new ByteArrayOutputStream();
Set<PGPPublicKey> publicKeys = new HashSet<PGPPublicKey>();
publicKeys.add(readPublicKey(publicKeyInputStream));
PGPUtils.encrypt(encrypted_output, clearData, publicKeys);
// now you can save encryted_output
decryptData
Decrypt data with the private key (secret). decrypt_outputstream support OutputStream and char[]
PGPUtils.decrypt(
encryptedByteArray,
readSecretKey(privateKeyInputStream),
decrypt_outputStream,
pass);
signData
A file can be signed with a private key. If you are lazy you can simply overwrite the encrypted file with the signed encrypted file
SignedFileProcessor.signFile(
encryptedFileDest, //a String with the destination of the encryted file wich has to be signed
new FileInputStream(privateKeyDest), //The InputStream of the private (secret) key
new FileOutputStream(encryptedSignedFileDest), //The Outputstream of the signed file
pass, // the char[] of the secret key password
true amor (leave true if you got no idea)
);
verify signed file
The verifyFile() check the signature against a public key. It returns a boolean
SignedFileProcessor.verifyFile(
new FileInputStream(encryptedSignedFileDestination),
new FileInputStream(publicKey_of_the_sign)
);
