Package org.jivesoftware.smackx.ox.crypto

Class PainlessOpenPgpProvider

java.lang.Object

org.jivesoftware.smackx.ox.crypto.PainlessOpenPgpProvider

All Implemented Interfaces:

OpenPgpProvider

public class PainlessOpenPgpProvider
extends java.lang.Object
implements OpenPgpProvider

Constructor Summary

Constructors

Constructor	Description
PainlessOpenPgpProvider(OpenPgpStore store)

Method Summary

Modifier and Type	Method	Description
OpenPgpMessage	decryptAndOrVerify(XMPPConnection connection, OpenPgpElement element, OpenPgpSelf self, OpenPgpContact sender)	Decrypt and/or verify signatures on an incoming OpenPgpElement.
OpenPgpElementAndMetadata	encrypt(CryptElement element, OpenPgpSelf self, java.util.Collection<OpenPgpContact> recipients)	Encrypt a CryptElement for all recipients and ourselves.
OpenPgpStore	getStore()	Return the OpenPgpStore instance of this provider.
OpenPgpElementAndMetadata	sign(SignElement element, OpenPgpSelf self)	Sign a SignElement using our signing key.
OpenPgpElementAndMetadata	signAndEncrypt(SigncryptElement element, OpenPgpSelf self, java.util.Collection<OpenPgpContact> recipients)	Sign a SigncryptElement using our signing key and encrypt it for all recipients and ourselves.

Methods inherited from class java.lang.Object

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

Constructor Detail

PainlessOpenPgpProvider

public PainlessOpenPgpProvider(OpenPgpStore store)

Method Detail

getStore

public OpenPgpStore getStore()

Description copied from interface: OpenPgpProvider

Return the OpenPgpStore instance of this provider. This MUST NOT return null.

Specified by:

getStore in interface OpenPgpProvider

Returns:

store TODO javadoc me please

signAndEncrypt

public OpenPgpElementAndMetadata signAndEncrypt(SigncryptElement element,
                                                OpenPgpSelf self,
                                                java.util.Collection<OpenPgpContact> recipients)
                                         throws java.io.IOException,
                                                org.bouncycastle.openpgp.PGPException

Description copied from interface: OpenPgpProvider

Sign a SigncryptElement using our signing key and encrypt it for all recipients and ourselves.

Specified by:

signAndEncrypt in interface OpenPgpProvider

Parameters:

element - SigncryptElement which contains a payload which will be transmitted.

self - our own OpenPGP identity.

recipients - recipients identities.

Returns:

signed and encrypted SigncryptElement as a OpenPgpElement, along with OpenPgpMetadata about the encryption/signatures.

Throws:

java.io.IOException - IO is dangerous

org.bouncycastle.openpgp.PGPException - PGP is brittle

sign

public OpenPgpElementAndMetadata sign(SignElement element,
                                      OpenPgpSelf self)
                               throws java.io.IOException,
                                      org.bouncycastle.openpgp.PGPException

Description copied from interface: OpenPgpProvider

Sign a SignElement using our signing key.

Specified by:

sign in interface OpenPgpProvider

Parameters:

element - SignElement which contains a payload.

self - our OpenPGP identity.

Returns:

signed SignElement as OpenPgpElement, along with OpenPgpMetadata about the signatures.

Throws:

java.io.IOException - IO is dangerous

org.bouncycastle.openpgp.PGPException - PGP is brittle

encrypt

public OpenPgpElementAndMetadata encrypt(CryptElement element,
                                         OpenPgpSelf self,
                                         java.util.Collection<OpenPgpContact> recipients)
                                  throws java.io.IOException,
                                         org.bouncycastle.openpgp.PGPException

Description copied from interface: OpenPgpProvider

Encrypt a CryptElement for all recipients and ourselves.

Specified by:

encrypt in interface OpenPgpProvider

Parameters:

element - CryptElement which contains a payload which will be transmitted.

self - our own OpenPGP identity.

recipients - recipient identities.

Returns:

encrypted CryptElement as an OpenPgpElement, along with OpenPgpMetadata about the encryption.

Throws:

java.io.IOException - IO is dangerous

org.bouncycastle.openpgp.PGPException - PGP is brittle

decryptAndOrVerify

public OpenPgpMessage decryptAndOrVerify(XMPPConnection connection,
                                         OpenPgpElement element,
                                         OpenPgpSelf self,
                                         OpenPgpContact sender)
                                  throws java.io.IOException,
                                         org.bouncycastle.openpgp.PGPException

Description copied from interface: OpenPgpProvider

Decrypt and/or verify signatures on an incoming OpenPgpElement. If the message is encrypted, this method decrypts it. If it is (also) signed, the signature will be checked. The resulting OpenPgpMessage contains the original OpenPgpContentElement, as well as information about the encryption/signing.

Specified by:

decryptAndOrVerify in interface OpenPgpProvider

Parameters:

connection - XMPP connection used to fetch any missing keys.

element - signed and or encrypted OpenPgpElement.

self - our OpenPGP identity.

sender - OpenPGP identity of the sender.

Returns:

decrypted message as OpenPgpMessage.

Throws:

java.io.IOException - IO is dangerous

org.bouncycastle.openpgp.PGPException - PGP is brittle