mirror of
https://github.com/pgpainless/pgpainless.git
synced 2024-12-25 04:17:59 +01:00
Add more documentation
This commit is contained in:
parent
f6629e95dc
commit
9b5754879a
1 changed files with 20 additions and 1 deletions
|
@ -34,6 +34,19 @@ import org.pgpainless.signature.builder.SubkeyBindingSignatureBuilder
|
||||||
import org.pgpainless.signature.subpackets.SelfSignatureSubpackets
|
import org.pgpainless.signature.subpackets.SelfSignatureSubpackets
|
||||||
import org.pgpainless.util.Passphrase
|
import org.pgpainless.util.Passphrase
|
||||||
|
|
||||||
|
/**
|
||||||
|
* API for generating OpenPGP keys. The API allows to generate keys of different OpenPGP protocol
|
||||||
|
* versions (currently only v4). The API is divided into an opinionated and unopinionated
|
||||||
|
* implementation.
|
||||||
|
*
|
||||||
|
* The opinionated implementation will sanitize algorithms and key sizes and will furthermore make
|
||||||
|
* sure that required signatures (e.g. direct-key or binding signatures) are placed on the key,
|
||||||
|
* while the unopinionated API allows for the use of weak algorithms and does not add any signatures
|
||||||
|
* by itself.
|
||||||
|
*
|
||||||
|
* You can switch from the opinionated API to the unopinionated API by calling `unopinionated()` on
|
||||||
|
* the builder.
|
||||||
|
*/
|
||||||
class OpenPgpKeyGenerator internal constructor() {
|
class OpenPgpKeyGenerator internal constructor() {
|
||||||
|
|
||||||
companion object {
|
companion object {
|
||||||
|
@ -125,7 +138,13 @@ internal constructor(val policy: Policy, val creationTime: Date, val preferences
|
||||||
): PGPKeyPair
|
): PGPKeyPair
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Define the primary key for the OpenPGP key.
|
* Define the primary key for the OpenPGP key. Example:
|
||||||
|
* ```
|
||||||
|
* setPrimaryKey(KeyType.EDDSA(EdDSACurve._Ed25519)) {
|
||||||
|
* addUserId("Alice <alice@example.com>")
|
||||||
|
* addUserId("Bob <bob@example.com>")
|
||||||
|
* }
|
||||||
|
* ```
|
||||||
*
|
*
|
||||||
* @param type primary key type
|
* @param type primary key type
|
||||||
* @param keyFlags list of key flags that denote the primary keys capabilities
|
* @param keyFlags list of key flags that denote the primary keys capabilities
|
||||||
|
|
Loading…
Reference in a new issue