diff options
| author | Roberto Tyley <roberto.tyley@gmail.com> | 2014-07-15 01:38:01 +0400 |
|---|---|---|
| committer | Roberto Tyley <roberto.tyley@gmail.com> | 2014-07-26 11:23:17 +0400 |
| commit | 7cb752aaf746dc0b473afeb9e892b7fbc12666c5 (patch) | |
| tree | cc4f91ddc18332b5adbe82e3fcb040d976c90105 /pg/src/main/javadoc/org/spongycastle/openpgp/package.html | |
| parent | 551830f8ea5177042af2c7dd1fc90888bc67387d (diff) | |
Execute become-spongy.sh
https://github.com/rtyley/spongycastle/blob/3040af/become-spongy.sh
Diffstat (limited to 'pg/src/main/javadoc/org/spongycastle/openpgp/package.html')
| -rw-r--r-- | pg/src/main/javadoc/org/spongycastle/openpgp/package.html | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/pg/src/main/javadoc/org/spongycastle/openpgp/package.html b/pg/src/main/javadoc/org/spongycastle/openpgp/package.html new file mode 100644 index 00000000..fd09835c --- /dev/null +++ b/pg/src/main/javadoc/org/spongycastle/openpgp/package.html @@ -0,0 +1,16 @@ +<html> +<body bgcolor="#ffffff"> +High level classes for dealing with OpenPGP objects. +<p> +<b>Note</b>: These are based on the org.spongycastle.bcpg classes and use a streaming +model, so for some objects which have an input stream associated it is necessary +to read to the end of the input stream on the object before trying to read +another object from the orginal input stream. +<p> +A word on key ring files. For the purpose of this package a PGP key ring is a master key and +a collection of sub-keys associated with it. These public and secret key rings are handled by +the PGPPublicKey ring class and the PGPSecretKeyRing class respectively. In the case where +you are trying to read an key file which has multiple key rings in it, use PGPSecretKeyRingCollection +for the secret key file and PGPPublicKeyRingCollection for the public key file. +</body> +</html> |