diff options
Diffstat (limited to 'pg/src/main/javadoc/org/spongycastle')
11 files changed, 85 insertions, 0 deletions
diff --git a/pg/src/main/javadoc/org/spongycastle/bcpg/attr/package.html b/pg/src/main/javadoc/org/spongycastle/bcpg/attr/package.html new file mode 100644 index 00000000..251824f6 --- /dev/null +++ b/pg/src/main/javadoc/org/spongycastle/bcpg/attr/package.html @@ -0,0 +1,5 @@ +<html> +<body bgcolor="#ffffff"> +Low level classes for dealing with OpenPGP user attributes. +</body> +</html> diff --git a/pg/src/main/javadoc/org/spongycastle/bcpg/package.html b/pg/src/main/javadoc/org/spongycastle/bcpg/package.html new file mode 100644 index 00000000..8bf922eb --- /dev/null +++ b/pg/src/main/javadoc/org/spongycastle/bcpg/package.html @@ -0,0 +1,9 @@ +<html> +<body bgcolor="#ffffff"> +Low level classes for dealing with OpenPGP objects. +<p> +These classes deal with things at a raw OpenPGP packet level. For the most part +you are probably better off looking at the org.spongycastle.openpgp package +for what you want. +</body> +</html> diff --git a/pg/src/main/javadoc/org/spongycastle/bcpg/sig/package.html b/pg/src/main/javadoc/org/spongycastle/bcpg/sig/package.html new file mode 100644 index 00000000..474a1a8e --- /dev/null +++ b/pg/src/main/javadoc/org/spongycastle/bcpg/sig/package.html @@ -0,0 +1,5 @@ +<html> +<body bgcolor="#ffffff"> +Low level classes for dealing with OpenPGP signature attributes. +</body> +</html> diff --git a/pg/src/main/javadoc/org/spongycastle/openpgp/bc/package.html b/pg/src/main/javadoc/org/spongycastle/openpgp/bc/package.html new file mode 100644 index 00000000..3e1a4075 --- /dev/null +++ b/pg/src/main/javadoc/org/spongycastle/openpgp/bc/package.html @@ -0,0 +1,8 @@ +<html> +<body bgcolor="#ffffff"> +BC light weight based OpenPGP objects. +<p> +Some high-level OpenPGP classes require access to cryptographic algorithms. The classes in this package provide extensions using the BC light weight API. +</p> +</body> +</html> diff --git a/pg/src/main/javadoc/org/spongycastle/openpgp/examples/package.html b/pg/src/main/javadoc/org/spongycastle/openpgp/examples/package.html new file mode 100644 index 00000000..47b2cf24 --- /dev/null +++ b/pg/src/main/javadoc/org/spongycastle/openpgp/examples/package.html @@ -0,0 +1,5 @@ +<html> +<body bgcolor="#ffffff"> +Examples of use of the org.spongycastle.openpgp package. +</body> +</html> diff --git a/pg/src/main/javadoc/org/spongycastle/openpgp/examples/test/package.html b/pg/src/main/javadoc/org/spongycastle/openpgp/examples/test/package.html new file mode 100644 index 00000000..dc4161c2 --- /dev/null +++ b/pg/src/main/javadoc/org/spongycastle/openpgp/examples/test/package.html @@ -0,0 +1,5 @@ +<html> +<body bgcolor="#ffffff"> +Test code for the examples of use of the org.spongycastle.openpgp package. +</body> +</html> diff --git a/pg/src/main/javadoc/org/spongycastle/openpgp/jcajce/package.html b/pg/src/main/javadoc/org/spongycastle/openpgp/jcajce/package.html new file mode 100644 index 00000000..8e3f89b0 --- /dev/null +++ b/pg/src/main/javadoc/org/spongycastle/openpgp/jcajce/package.html @@ -0,0 +1,8 @@ +<html> +<body bgcolor="#ffffff"> +JCA/JCE provider based OpenPGP objects. +<p> +Some high-level OpenPGP classes require access to cryptographic algorithms. The classes in this package provide extensions using the JCA/JCE. +</p> +</body> +</html> diff --git a/pg/src/main/javadoc/org/spongycastle/openpgp/operator/bc/package.html b/pg/src/main/javadoc/org/spongycastle/openpgp/operator/bc/package.html new file mode 100644 index 00000000..d1642127 --- /dev/null +++ b/pg/src/main/javadoc/org/spongycastle/openpgp/operator/bc/package.html @@ -0,0 +1,8 @@ +<html> +<body bgcolor="#ffffff"> +BC lightweight operators for dealing with OpenPGP objects. +<p> +These provide the actual support for encryption and decryption required for the high level OpenPGP classes. +</p> +</body> +</html> diff --git a/pg/src/main/javadoc/org/spongycastle/openpgp/operator/jcajce/package.html b/pg/src/main/javadoc/org/spongycastle/openpgp/operator/jcajce/package.html new file mode 100644 index 00000000..928425dc --- /dev/null +++ b/pg/src/main/javadoc/org/spongycastle/openpgp/operator/jcajce/package.html @@ -0,0 +1,8 @@ +<html> +<body bgcolor="#ffffff"> +JCA/JCE based operators for dealing with OpenPGP objects. +<p> +These provide the actual support for encryption and decryption required for the high level OpenPGP classes. +</p> +</body> +</html> diff --git a/pg/src/main/javadoc/org/spongycastle/openpgp/operator/package.html b/pg/src/main/javadoc/org/spongycastle/openpgp/operator/package.html new file mode 100644 index 00000000..16e61e10 --- /dev/null +++ b/pg/src/main/javadoc/org/spongycastle/openpgp/operator/package.html @@ -0,0 +1,8 @@ +<html> +<body bgcolor="#ffffff"> +Interfaces and abstract classes to provide the framework to support operations on the OpenPGP high level classes. +<p> +For examples of actual implementations see the org.spongycastle.openpgp.operator.bc and org.spongycastle.openpgp.operator.jcajce packages. +</p> +</body> +</html> 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> |