Package org.jivesoftware.smackx.ox.crypto

Interface OpenPgpProvider

All Known Implementing Classes:

PainlessOpenPgpProvider

public interface OpenPgpProvider

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, 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, Collection<OpenPgpContact> recipients)	Sign a SigncryptElement using our signing key and encrypt it for all recipients and ourselves.

Method Detail

getStore

OpenPgpStore getStore()

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

Returns:

store TODO javadoc me please

signAndEncrypt

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

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

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:

IOException - IO is dangerous

org.bouncycastle.openpgp.PGPException - PGP is brittle

sign

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

Sign a SignElement using our signing key.

Parameters:

element - SignElement which contains a payload.

self - our OpenPGP identity.

Returns:

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

Throws:

IOException - IO is dangerous

org.bouncycastle.openpgp.PGPException - PGP is brittle

encrypt

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

Encrypt a CryptElement for all recipients and ourselves.

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:

IOException - IO is dangerous

org.bouncycastle.openpgp.PGPException - PGP is brittle

decryptAndOrVerify

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

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.

Parameters:

element - signed and or encrypted OpenPgpElement.

self - our OpenPGP identity.

sender - OpenPGP identity of the sender.

connection - XMPP connection used to fetch any missing keys.

Returns:

decrypted message as OpenPgpMessage.

Throws:

IOException - IO is dangerous

org.bouncycastle.openpgp.PGPException - PGP is brittle