com.valhalla.misc
Class GnuPG

java.lang.Object
  com.valhalla.misc.GnuPG

public class GnuPG
extends java.lang.Object

A class that implements PGP interface for Java.

It calls gpg (GnuPG) program to do all the PGP commands. $Id:$

Version:

0.5.1

Author:

Yaniv Yemini, January 2004., Based on a class GnuPG by John Anderson, which can be found, at: http://lists.gnupg.org/pipermail/gnupg-devel/2002-February/018098.html, modified for use in JBother by Andrey Zakirov, February 2005

See Also:

- http://www.gnupg.org/

Constructor Summary

GnuPG()
Default constructor

GnuPG(java.lang.String command)

Method Summary

boolean	clearSign(java.lang.String inStr, java.lang.String secID, java.lang.String passPhrase) ClearSign
boolean	decrypt(java.lang.String inStr, java.lang.String passPhrase) Decrypt
java.lang.String	decryptExtension(java.lang.String xEncryptedData) Description of the Method
boolean	encrypt(java.lang.String inStr, java.lang.String secID, java.lang.String keyID) Encrypt
java.lang.String	encryptExtension(java.lang.String Data, java.lang.String gnupgSecretKey, java.lang.String gnupgPublicKey) Description of the Method
java.lang.String	getErrorString() Get error output from GnuPG process
int	getExitCode() Get GnuPG exit code
java.lang.String	getResult() Get processing result
boolean	listKeys(java.lang.String ID) List public keys in keyring
boolean	listSecretKeys(java.lang.String ID) List secret keys in keyring
boolean	sign(java.lang.String inStr, java.lang.String secID, java.lang.String passPhrase) Sign
boolean	signAndEncrypt(java.lang.String inStr, java.lang.String secID, java.lang.String keyID, java.lang.String passPhrase) Signs and encrypts a string
java.lang.String	signExtension(java.lang.String Data, java.lang.String gnupgSecretKey) Description of the Method
boolean	verify(java.lang.String signedString, java.lang.String dataString) Verify a signature
java.lang.String	verifyExtension(java.lang.String xSignedData, java.lang.String messageBody)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GnuPG

public GnuPG()

Default constructor

GnuPG

public GnuPG(java.lang.String command)

Method Detail

sign

public boolean sign(java.lang.String inStr,
                    java.lang.String secID,
                    java.lang.String passPhrase)

Sign

Parameters:

inStr - input string to sign

secID - ID of secret key to sign with

passPhrase - passphrase for the secret key to sign with

Returns:

true upon success

clearSign

public boolean clearSign(java.lang.String inStr,
                         java.lang.String secID,
                         java.lang.String passPhrase)

ClearSign

Parameters:

inStr - input string to sign

secID - ID of secret key to sign with

passPhrase - passphrase for the secret key to sign with

Returns:

true upon success

signAndEncrypt

public boolean signAndEncrypt(java.lang.String inStr,
                              java.lang.String secID,
                              java.lang.String keyID,
                              java.lang.String passPhrase)

Signs and encrypts a string

Parameters:

inStr - input string to encrypt

secID - ID of secret key to sign with

keyID - ID of public key to encrypt with

passPhrase - passphrase for the secret key to sign with

Returns:

true upon success

encrypt

public boolean encrypt(java.lang.String inStr,
                       java.lang.String secID,
                       java.lang.String keyID)

Encrypt

Parameters:

inStr - input string to encrypt

secID - ID of secret key to use

keyID - ID of public key to encrypt with

Returns:

true upon success

decrypt

public boolean decrypt(java.lang.String inStr,
                       java.lang.String passPhrase)

Decrypt

Parameters:

inStr - input string to decrypt

passPhrase - passphrase for the secret key to decrypt with

Returns:

true upon success

listKeys

public boolean listKeys(java.lang.String ID)

List public keys in keyring

Parameters:

ID - ID of public key to list, blank for all

Returns:

true upon success

listSecretKeys

public boolean listSecretKeys(java.lang.String ID)

List secret keys in keyring

Parameters:

ID - ID of secret key to list, blank for all

Returns:

true upon success

verify

public boolean verify(java.lang.String signedString,
                      java.lang.String dataString)

Verify a signature

Parameters:

inStr - signature to verify

Returns:

true if verified.

getResult

public java.lang.String getResult()

Get processing result

Returns:

result string.

getErrorString

public java.lang.String getErrorString()

Get error output from GnuPG process

Returns:

error string.

getExitCode

public int getExitCode()

Get GnuPG exit code

Returns:

exit code.

decryptExtension

public java.lang.String decryptExtension(java.lang.String xEncryptedData)

Description of the Method

Parameters:

xEncryptedData - Description of the Parameter

Returns:

Description of the Return Value

encryptExtension

public java.lang.String encryptExtension(java.lang.String Data,
                                         java.lang.String gnupgSecretKey,
                                         java.lang.String gnupgPublicKey)

Description of the Method

Parameters:

Data - Description of the Parameter

gnupgSecretKey - Description of the Parameter

gnupgPublicKey - Description of the Parameter

Returns:

Description of the Return Value

signExtension

public java.lang.String signExtension(java.lang.String Data,
                                      java.lang.String gnupgSecretKey)

Description of the Method

Parameters:

Data - Description of the Parameter

gnupgSecretKey - Description of the Parameter

gnupgPublicKey - Description of the Parameter

Returns:

Description of the Return Value

verifyExtension

public java.lang.String verifyExtension(java.lang.String xSignedData,
                                        java.lang.String messageBody)