mirror of
https://github.com/pgpainless/pgpainless.git
synced 2024-12-22 19:08:00 +01:00
Fix linking in KDoc documentation
This commit is contained in:
parent
67457bbe78
commit
b719810575
GPG key ID:
62BEE9264BF17311
16 changed files with 88 additions and 94 deletions
|
|
@ -129,7 +129,7 @@ class PGPainless private constructor() {
|
|||
*
|
||||
* <p>
|
||||
* After making the desired changes in the builder, the modified key can be extracted using
|
||||
* {@link SecretKeyRingEditorInterface#done()}.
|
||||
* [org.pgpainless.key.modification.secretkeyring.SecretKeyRingEditorInterface.done].
|
||||
*
|
||||
* @param secretKeys secret key ring
|
||||
* @param referenceTime reference time used as signature creation date
|
||||
|
|
|
|||
|
|
@ -42,7 +42,7 @@ enum class KeyFlag(val flag: Int) {
|
|||
}
|
||||
|
||||
/**
|
||||
* Encode a list of {@link KeyFlag KeyFlags} into a bitmask.
|
||||
* Encode a list of [KeyFlags][KeyFlag] into a bitmask.
|
||||
*
|
||||
* @param flags list of flags
|
||||
* @return bitmask
|
||||
|
|
|
|||
|
|
@ -23,7 +23,7 @@ enum class SignatureType(val code: Int) {
|
|||
/**
|
||||
* Signature of a canonical text document. This means the signer owns it, created it, or
|
||||
* certifies that it has not been modified. The signature is calculated over the text data with
|
||||
* its line endings converted to {@code <CR><LF>}.
|
||||
* its line endings converted to `<CR><LF>`.
|
||||
*/
|
||||
CANONICAL_TEXT_DOCUMENT(0x01),
|
||||
|
||||
|
|
|
|||
|
|
@ -50,16 +50,16 @@ class EncryptionOptions(private val purpose: EncryptionPurpose) {
|
|||
constructor() : this(EncryptionPurpose.ANY)
|
||||
|
||||
/**
|
||||
* Factory method to create an {@link EncryptionOptions} object which will encrypt for keys
|
||||
* which carry the flag {@link org.pgpainless.algorithm.KeyFlag#ENCRYPT_COMMS}.
|
||||
* Factory method to create an [EncryptionOptions] object which will encrypt for keys which
|
||||
* carry the flag [org.pgpainless.algorithm.KeyFlag.ENCRYPT_COMMS].
|
||||
*
|
||||
* @return encryption options
|
||||
*/
|
||||
fun setEvaluationDate(evaluationDate: Date) = apply { this.evaluationDate = evaluationDate }
|
||||
|
||||
/**
|
||||
* Identify authenticatable certificates for the given user-ID by querying the {@link
|
||||
* CertificateAuthority} for identifiable bindings. Add all acceptable bindings, whose trust
|
||||
* Identify authenticatable certificates for the given user-ID by querying the
|
||||
* [CertificateAuthority] for identifiable bindings. Add all acceptable bindings, whose trust
|
||||
* amount is larger or equal to the target amount to the list of recipients.
|
||||
*
|
||||
* @param userId userId
|
||||
|
|
@ -88,8 +88,8 @@ class EncryptionOptions(private val purpose: EncryptionPurpose) {
|
|||
}
|
||||
|
||||
/**
|
||||
* Add all key rings in the provided {@link Iterable} (e.g. {@link PGPPublicKeyRingCollection})
|
||||
* as recipients.
|
||||
* Add all key rings in the provided [Iterable] (e.g.
|
||||
* [org.bouncycastle.openpgp.PGPPublicKeyRingCollection]) as recipients.
|
||||
*
|
||||
* @param keys keys
|
||||
* @return this
|
||||
|
|
@ -102,9 +102,9 @@ class EncryptionOptions(private val purpose: EncryptionPurpose) {
|
|||
}
|
||||
|
||||
/**
|
||||
* Add all key rings in the provided {@link Iterable} (e.g. {@link PGPPublicKeyRingCollection})
|
||||
* as recipients. Per key ring, the selector is applied to select one or more encryption
|
||||
* subkeys.
|
||||
* Add all key rings in the provided [Iterable] (e.g.
|
||||
* [org.bouncycastle.openpgp.PGPPublicKeyRingCollection]) as recipients. Per key ring, the
|
||||
* selector is applied to select one or more encryption subkeys.
|
||||
*
|
||||
* @param keys keys
|
||||
* @param selector encryption key selector
|
||||
|
|
@ -245,9 +245,9 @@ class EncryptionOptions(private val purpose: EncryptionPurpose) {
|
|||
}
|
||||
|
||||
/**
|
||||
* Add an {@link PGPKeyEncryptionMethodGenerator} which will be used to encrypt the message.
|
||||
* Method generators are either {@link PBEKeyEncryptionMethodGenerator} (passphrase) or {@link
|
||||
* PGPKeyEncryptionMethodGenerator} (public key).
|
||||
* Add a [PGPKeyEncryptionMethodGenerator] which will be used to encrypt the message. Method
|
||||
* generators are either [org.bouncycastle.openpgp.operator.PBEKeyEncryptionMethodGenerator]
|
||||
* (passphrase) or [PGPKeyEncryptionMethodGenerator] (public key).
|
||||
*
|
||||
* This method is intended for advanced users to allow encryption for specific subkeys. This can
|
||||
* come in handy for example if data needs to be encrypted to a subkey that's ignored by
|
||||
|
|
@ -278,10 +278,10 @@ class EncryptionOptions(private val purpose: EncryptionPurpose) {
|
|||
}
|
||||
|
||||
/**
|
||||
* If this method is called, subsequent calls to {@link #addRecipient(PGPPublicKeyRing)} will
|
||||
* allow encryption for subkeys that do not carry any {@link org.pgpainless.algorithm.KeyFlag}
|
||||
* subpacket. This is a workaround for dealing with legacy keys that have no key flags subpacket
|
||||
* but rely on the key algorithm type to convey the subkeys use.
|
||||
* If this method is called, subsequent calls to [addRecipient] will allow encryption for
|
||||
* subkeys that do not carry any [org.pgpainless.algorithm.KeyFlag] subpacket. This is a
|
||||
* workaround for dealing with legacy keys that have no key flags subpacket but rely on the key
|
||||
* algorithm type to convey the subkeys use.
|
||||
*
|
||||
* @return this
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -176,8 +176,7 @@ private constructor(
|
|||
* @return this
|
||||
* @see <a href="https://datatracker.ietf.org/doc/html/rfc4880#section-5.9">RFC4880 §5.9.
|
||||
* Literal Data Packet</a>
|
||||
* @deprecated options other than the default value of {@link StreamEncoding#BINARY} are
|
||||
* discouraged.
|
||||
* @deprecated options other than the default value of [StreamEncoding.BINARY] are discouraged.
|
||||
*/
|
||||
@Deprecated("Options other than BINARY are discouraged.")
|
||||
fun setEncoding(encoding: StreamEncoding) = apply { encodingField = encoding }
|
||||
|
|
|
|||
|
|
@ -23,8 +23,8 @@ abstract class OpenPgpFingerprint : CharSequence, Comparable<OpenPgpFingerprint>
|
|||
abstract fun getVersion(): Int
|
||||
|
||||
/**
|
||||
* Return the key id of the OpenPGP public key this {@link OpenPgpFingerprint} belongs to. This
|
||||
* method can be implemented for V4 and V5 fingerprints. V3 key-IDs cannot be derived from the
|
||||
* Return the key id of the OpenPGP public key this [OpenPgpFingerprint] belongs to. This method
|
||||
* can be implemented for V4 and V5 fingerprints. V3 key-IDs cannot be derived from the
|
||||
* fingerprint, but we don't care, since V3 is deprecated.
|
||||
*
|
||||
* @return key id
|
||||
|
|
@ -127,10 +127,10 @@ abstract class OpenPgpFingerprint : CharSequence, Comparable<OpenPgpFingerprint>
|
|||
@JvmStatic fun of(keys: PGPKeyRing): OpenPgpFingerprint = of(keys.publicKey)
|
||||
|
||||
/**
|
||||
* Try to parse an {@link OpenPgpFingerprint} from the given fingerprint string. If the
|
||||
* trimmed fingerprint without whitespace is 64 characters long, it is either a v5 or v6
|
||||
* fingerprint. In this case, we return a {@link _64DigitFingerprint}. Since this is
|
||||
* ambiguous, it is generally recommended to know the version of the key beforehand.
|
||||
* Try to parse an [OpenPgpFingerprint] from the given fingerprint string. If the trimmed
|
||||
* fingerprint without whitespace is 64 characters long, it is either a v5 or v6
|
||||
* fingerprint. In this case, we return a [_64DigitFingerprint]. Since this is ambiguous, it
|
||||
* is generally recommended to know the version of the key beforehand.
|
||||
*
|
||||
* @param fingerprint fingerprint
|
||||
* @return parsed fingerprint
|
||||
|
|
@ -152,7 +152,7 @@ abstract class OpenPgpFingerprint : CharSequence, Comparable<OpenPgpFingerprint>
|
|||
}
|
||||
|
||||
/**
|
||||
* Parse a binary OpenPGP fingerprint into an {@link OpenPgpFingerprint} object.
|
||||
* Parse a binary OpenPGP fingerprint into an [OpenPgpFingerprint] object.
|
||||
*
|
||||
* @param binaryFingerprint binary representation of the fingerprint
|
||||
* @return parsed fingerprint
|
||||
|
|
|
|||
|
|
@ -20,7 +20,7 @@ import org.bouncycastle.util.encoders.Hex
|
|||
open class _64DigitFingerprint : OpenPgpFingerprint {
|
||||
|
||||
/**
|
||||
* Create an {@link _64DigitFingerprint}.
|
||||
* Create a [_64DigitFingerprint].
|
||||
*
|
||||
* @param fingerprint uppercase hexadecimal fingerprint of length 64
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -64,14 +64,13 @@ class KeyRingTemplates {
|
|||
}
|
||||
|
||||
/**
|
||||
* Creates a simple RSA KeyPair of length {@code length} with user-id {@code userId}. The
|
||||
* KeyPair consists of a single RSA master key which is used for signing, encryption and
|
||||
* certification.
|
||||
* Creates a simple RSA KeyPair of length `length` with user-id `userId`. The KeyPair consists
|
||||
* of a single RSA master key which is used for signing, encryption and certification.
|
||||
*
|
||||
* @param userId user id.
|
||||
* @param length length in bits.
|
||||
* @param password Password of the key. Can be empty for unencrypted keys.
|
||||
* @return {@link PGPSecretKeyRing} containing the KeyPair.
|
||||
* @return [PGPSecretKeyRing] containing the KeyPair.
|
||||
*/
|
||||
@JvmOverloads
|
||||
fun simpleRsaKeyRing(
|
||||
|
|
@ -95,14 +94,13 @@ class KeyRingTemplates {
|
|||
.build()
|
||||
|
||||
/**
|
||||
* Creates a simple RSA KeyPair of length {@code length} with user-id {@code userId}. The
|
||||
* KeyPair consists of a single RSA master key which is used for signing, encryption and
|
||||
* certification.
|
||||
* Creates a simple RSA KeyPair of length `length` with user-id `userId`. The KeyPair consists
|
||||
* of a single RSA master key which is used for signing, encryption and certification.
|
||||
*
|
||||
* @param userId user id.
|
||||
* @param length length in bits.
|
||||
* @param password Password of the key. Can be null or blank for unencrypted keys.
|
||||
* @return {@link PGPSecretKeyRing} containing the KeyPair.
|
||||
* @return [PGPSecretKeyRing] containing the KeyPair.
|
||||
*/
|
||||
fun simpleRsaKeyRing(userId: CharSequence?, length: RsaLength, password: String?) =
|
||||
password.let {
|
||||
|
|
@ -120,7 +118,7 @@ class KeyRingTemplates {
|
|||
*
|
||||
* @param userId user-id
|
||||
* @param passphrase Password of the private key. Can be empty for an unencrypted key.
|
||||
* @return {@link PGPSecretKeyRing} containing the key pairs.
|
||||
* @return [PGPSecretKeyRing] containing the key pairs.
|
||||
*/
|
||||
@JvmOverloads
|
||||
fun simpleEcKeyRing(
|
||||
|
|
@ -153,7 +151,7 @@ class KeyRingTemplates {
|
|||
*
|
||||
* @param userId user-id
|
||||
* @param passphrase Password of the private key. Can be null or blank for an unencrypted key.
|
||||
* @return {@link PGPSecretKeyRing} containing the key pairs.
|
||||
* @return [PGPSecretKeyRing] containing the key pairs.
|
||||
*/
|
||||
fun simpleEcKeyRing(userId: CharSequence?, password: String?): PGPSecretKeyRing =
|
||||
password.let {
|
||||
|
|
|
|||
|
|
@ -41,8 +41,7 @@ interface KeyType {
|
|||
val bitStrength: Int
|
||||
|
||||
/**
|
||||
* Return an implementation of {@link AlgorithmParameterSpec} that can be used to generate the
|
||||
* key.
|
||||
* Return an implementation of [AlgorithmParameterSpec] that can be used to generate the key.
|
||||
*
|
||||
* @return algorithm parameter spec
|
||||
*/
|
||||
|
|
@ -50,7 +49,7 @@ interface KeyType {
|
|||
|
||||
/**
|
||||
* Return true if the key that is generated from this type is able to carry the SIGN_DATA key
|
||||
* flag. See {@link org.pgpainless.algorithm.KeyFlag#SIGN_DATA}.
|
||||
* flag. See [org.pgpainless.algorithm.KeyFlag.SIGN_DATA].
|
||||
*
|
||||
* @return true if the key can sign.
|
||||
*/
|
||||
|
|
@ -59,7 +58,7 @@ interface KeyType {
|
|||
|
||||
/**
|
||||
* Return true if the key that is generated from this type is able to carry the CERTIFY_OTHER
|
||||
* key flag. See {@link org.pgpainless.algorithm.KeyFlag#CERTIFY_OTHER}.
|
||||
* key flag. See [org.pgpainless.algorithm.KeyFlag.CERTIFY_OTHER].
|
||||
*
|
||||
* @return true if the key is able to certify other keys
|
||||
*/
|
||||
|
|
@ -68,7 +67,7 @@ interface KeyType {
|
|||
|
||||
/**
|
||||
* Return true if the key that is generated from this type is able to carry the AUTHENTICATION
|
||||
* key flag. See {@link org.pgpainless.algorithm.KeyFlag#AUTHENTICATION}.
|
||||
* key flag. See [org.pgpainless.algorithm.KeyFlag.AUTHENTICATION].
|
||||
*
|
||||
* @return true if the key can be used for authentication purposes.
|
||||
*/
|
||||
|
|
@ -77,7 +76,7 @@ interface KeyType {
|
|||
|
||||
/**
|
||||
* Return true if the key that is generated from this type is able to carry the ENCRYPT_COMMS
|
||||
* key flag. See {@link org.pgpainless.algorithm.KeyFlag#ENCRYPT_COMMS}.
|
||||
* key flag. See [org.pgpainless.algorithm.KeyFlag.ENCRYPT_COMMS].
|
||||
*
|
||||
* @return true if the key can encrypt communication
|
||||
*/
|
||||
|
|
@ -86,7 +85,7 @@ interface KeyType {
|
|||
|
||||
/**
|
||||
* Return true if the key that is generated from this type is able to carry the ENCRYPT_STORAGE
|
||||
* key flag. See {@link org.pgpainless.algorithm.KeyFlag#ENCRYPT_STORAGE}.
|
||||
* key flag. See [org.pgpainless.algorithm.KeyFlag.ENCRYPT_STORAGE].
|
||||
*
|
||||
* @return true if the key can encrypt for storage
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@ class KeyRingInfo(
|
|||
|
||||
private val signatures: Signatures = Signatures(keys, referenceDate, policy)
|
||||
|
||||
/** Primary {@link PGPPublicKey}.´ */
|
||||
/** Primary [PGPPublicKey]. */
|
||||
val publicKey: PGPPublicKey = KeyRingUtils.requirePrimaryPublicKeyFrom(keys)
|
||||
|
||||
/** Primary key ID. */
|
||||
|
|
@ -73,8 +73,8 @@ class KeyRingInfo(
|
|||
val version: Int = publicKey.version
|
||||
|
||||
/**
|
||||
* Return all {@link PGPPublicKey PGPPublicKeys} of this key ring. The first key in the list
|
||||
* being the primary key. Note that the list is unmodifiable.
|
||||
* Return all [PGPPublicKeys][PGPPublicKey] of this key ring. The first key in the list being
|
||||
* the primary key. Note that the list is unmodifiable.
|
||||
*
|
||||
* @return list of public keys
|
||||
*/
|
||||
|
|
@ -448,7 +448,7 @@ class KeyRingInfo(
|
|||
signatures.subkeyRevocations[keyId]
|
||||
|
||||
/**
|
||||
* Return a list of {@link KeyFlag KeyFlags} that apply to the subkey with the provided key id.
|
||||
* Return a list of [KeyFlags][KeyFlag] that apply to the subkey with the provided key id.
|
||||
*
|
||||
* @param keyId key-id
|
||||
* @return list of key flags
|
||||
|
|
@ -478,7 +478,7 @@ class KeyRingInfo(
|
|||
}
|
||||
|
||||
/**
|
||||
* Return a list of {@link KeyFlag KeyFlags} that apply to the given user-id.
|
||||
* Return a list of [KeyFlags][KeyFlag] that apply to the given user-id.
|
||||
*
|
||||
* @param userId user-id
|
||||
* @return key flags
|
||||
|
|
@ -622,8 +622,8 @@ class KeyRingInfo(
|
|||
* Return the current primary user-id of the key ring.
|
||||
*
|
||||
* <p>
|
||||
* Note: If no user-id is marked as primary key using a {@link PrimaryUserID} packet, this
|
||||
* method returns the first user-id on the key, otherwise null.
|
||||
* Note: If no user-id is marked as primary key using a [PrimaryUserID] packet, this method
|
||||
* returns the first user-id on the key, otherwise null.
|
||||
*
|
||||
* @return primary user-id or null
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -15,7 +15,7 @@ class KeyIdUtil {
|
|||
* Convert a long key-id into a key-id. A long key-id is a 16 digit hex string.
|
||||
*
|
||||
* @param longKeyId 16-digit hexadecimal string
|
||||
* @return key-id converted to {@link Long}.
|
||||
* @return key-id converted to [Long].
|
||||
*/
|
||||
@JvmStatic
|
||||
@Deprecated(
|
||||
|
|
|
|||
|
|
@ -27,8 +27,8 @@ class KeyRingUtils {
|
|||
@JvmStatic private val LOGGER: Logger = LoggerFactory.getLogger(KeyRingUtils::class.java)
|
||||
|
||||
/**
|
||||
* Return the primary {@link PGPSecretKey} from the provided {@link PGPSecretKeyRing}. If it
|
||||
* has no primary secret key, throw a {@link NoSuchElementException}.
|
||||
* Return the primary [PGPSecretKey] from the provided [PGPSecretKeyRing]. If it has no
|
||||
* primary secret key, throw a [NoSuchElementException].
|
||||
*
|
||||
* @param secretKeys secret keys
|
||||
* @return primary secret key
|
||||
|
|
@ -61,8 +61,8 @@ class KeyRingUtils {
|
|||
}
|
||||
|
||||
/**
|
||||
* Return the primary {@link PGPPublicKey} from the provided key ring. Throws a {@link
|
||||
* NoSuchElementException} if the key ring has no primary public key.
|
||||
* Return the primary [PGPPublicKey] from the provided key ring. Throws a
|
||||
* [NoSuchElementException] if the key ring has no primary public key.
|
||||
*
|
||||
* @param keyRing key ring
|
||||
* @return primary public key
|
||||
|
|
@ -74,8 +74,7 @@ class KeyRingUtils {
|
|||
}
|
||||
|
||||
/**
|
||||
* Return the primary {@link PGPPublicKey} from the provided key ring or null if it has
|
||||
* none.
|
||||
* Return the primary [PGPPublicKey] from the provided key ring or null if it has none.
|
||||
*
|
||||
* @param keyRing key ring
|
||||
* @return primary public key
|
||||
|
|
@ -93,7 +92,7 @@ class KeyRingUtils {
|
|||
|
||||
/**
|
||||
* Require the public key with the given subKeyId from the keyRing. If no such subkey
|
||||
* exists, throw an {@link NoSuchElementException}.
|
||||
* exists, throw an [NoSuchElementException].
|
||||
*
|
||||
* @param keyRing key ring
|
||||
* @param subKeyId subkey id
|
||||
|
|
@ -108,7 +107,7 @@ class KeyRingUtils {
|
|||
|
||||
/**
|
||||
* Require the secret key with the given secret subKeyId from the secret keyRing. If no such
|
||||
* subkey exists, throw an {@link NoSuchElementException}.
|
||||
* subkey exists, throw an [NoSuchElementException].
|
||||
*
|
||||
* @param keyRing secret key ring
|
||||
* @param subKeyId subkey id
|
||||
|
|
@ -131,8 +130,8 @@ class KeyRingUtils {
|
|||
}
|
||||
|
||||
/**
|
||||
* Extract a {@link PGPPublicKeyRing} containing all public keys from the provided {@link
|
||||
* PGPSecretKeyRing}.
|
||||
* Extract a [PGPPublicKeyRing] containing all public keys from the provided
|
||||
* [PGPSecretKeyRing].
|
||||
*
|
||||
* @param secretKeys secret key ring
|
||||
* @return public key ring
|
||||
|
|
@ -146,9 +145,9 @@ class KeyRingUtils {
|
|||
}
|
||||
|
||||
/**
|
||||
* Extract {@link PGPPublicKeyRing PGPPublicKeyRings} from all {@link PGPSecretKeyRing
|
||||
* PGPSecretKeyRings} in the given {@link PGPSecretKeyRingCollection} and return them as a
|
||||
* {@link PGPPublicKeyRingCollection}.
|
||||
* Extract [PGPPublicKeyRings][PGPPublicKeyRing] from all
|
||||
* [PGPSecretKeyRings][PGPSecretKeyRing] in the given [PGPSecretKeyRingCollection] and
|
||||
* return them as a [PGPPublicKeyRingCollection].
|
||||
*
|
||||
* @param secretKeyRings secret key ring collection
|
||||
* @return public key ring collection
|
||||
|
|
@ -162,8 +161,8 @@ class KeyRingUtils {
|
|||
}
|
||||
|
||||
/**
|
||||
* Create a new {@link PGPPublicKeyRingCollection} from an array of {@link PGPPublicKeyRing
|
||||
* PGPPublicKeyRings}.
|
||||
* Create a new [PGPPublicKeyRingCollection] from an array of
|
||||
* [PGPPublicKeyRings][PGPPublicKeyRing].
|
||||
*
|
||||
* @param certificates array of public key rings
|
||||
* @return key ring collection
|
||||
|
|
@ -176,8 +175,8 @@ class KeyRingUtils {
|
|||
}
|
||||
|
||||
/**
|
||||
* Create a new {@link PGPSecretKeyRingCollection} from an array of {@link PGPSecretKeyRing
|
||||
* PGPSecretKeyRings}.
|
||||
* Create a new [PGPSecretKeyRingCollection] from an array of
|
||||
* [PGPSecretKeyRings][PGPSecretKeyRing].
|
||||
*
|
||||
* @param secretKeys array of secret key rings
|
||||
* @return secret key ring collection
|
||||
|
|
@ -190,8 +189,8 @@ class KeyRingUtils {
|
|||
}
|
||||
|
||||
/**
|
||||
* Return true, if the given {@link PGPPublicKeyRing} contains a {@link PGPPublicKey} for
|
||||
* the given key id.
|
||||
* Return true, if the given [PGPPublicKeyRing] contains a [PGPPublicKey] for the given key
|
||||
* id.
|
||||
*
|
||||
* @param certificate public key ring
|
||||
* @param keyId id of the key in question
|
||||
|
|
@ -207,7 +206,7 @@ class KeyRingUtils {
|
|||
*
|
||||
* @param keyRing key ring
|
||||
* @param certification key signature
|
||||
* @param <T> either {@link PGPPublicKeyRing} or {@link PGPSecretKeyRing}
|
||||
* @param <T> either [PGPPublicKeyRing] or [PGPSecretKeyRing]
|
||||
* @return key ring with injected signature
|
||||
*/
|
||||
@JvmStatic
|
||||
|
|
@ -221,7 +220,7 @@ class KeyRingUtils {
|
|||
* @param keyRing key ring
|
||||
* @param certifiedKey signed public key
|
||||
* @param certification key signature
|
||||
* @param <T> either {@link PGPPublicKeyRing} or {@link PGPSecretKeyRing}
|
||||
* @param <T> either [PGPPublicKeyRing] or [PGPSecretKeyRing]
|
||||
* @return key ring with injected signature
|
||||
* @throws NoSuchElementException in case that the signed key is not part of the key ring
|
||||
*/
|
||||
|
|
@ -265,7 +264,7 @@ class KeyRingUtils {
|
|||
* @param keyRing key ring
|
||||
* @param userId signed user-id
|
||||
* @param certification signature
|
||||
* @param <T> either {@link PGPPublicKeyRing} or {@link PGPSecretKeyRing}
|
||||
* @param <T> either [PGPPublicKeyRing] or [PGPSecretKeyRing]
|
||||
* @return key ring with injected certification
|
||||
*/
|
||||
@JvmStatic
|
||||
|
|
@ -300,7 +299,7 @@ class KeyRingUtils {
|
|||
* @param keyRing key ring
|
||||
* @param userAttributes certified user attributes
|
||||
* @param certification certification signature
|
||||
* @param <T> either {@link PGPPublicKeyRing} or {@link PGPSecretKeyRing}
|
||||
* @param <T> either [PGPPublicKeyRing] or [PGPSecretKeyRing]
|
||||
* @return key ring with injected user-attribute certification
|
||||
*/
|
||||
@JvmStatic
|
||||
|
|
@ -330,11 +329,11 @@ class KeyRingUtils {
|
|||
}
|
||||
|
||||
/**
|
||||
* Inject a {@link PGPPublicKey} into the given key ring.
|
||||
* Inject a [PGPPublicKey] into the given key ring.
|
||||
*
|
||||
* @param keyRing key ring
|
||||
* @param publicKey public key
|
||||
* @param <T> either {@link PGPPublicKeyRing} or {@link PGPSecretKeyRing}
|
||||
* @param <T> either [PGPPublicKeyRing] or [PGPSecretKeyRing]
|
||||
* @return key ring with injected public key
|
||||
*/
|
||||
@JvmStatic
|
||||
|
|
@ -372,7 +371,7 @@ class KeyRingUtils {
|
|||
}
|
||||
|
||||
/**
|
||||
* Inject a {@link PGPSecretKey} into a {@link PGPSecretKeyRing}.
|
||||
* Inject a [PGPSecretKey] into a [PGPSecretKeyRing].
|
||||
*
|
||||
* @param secretKeys secret key ring
|
||||
* @param secretKey secret key
|
||||
|
|
|
|||
|
|
@ -284,8 +284,8 @@ class Policy(
|
|||
companion object {
|
||||
|
||||
/**
|
||||
* Default {@link CompressionAlgorithmPolicy} of PGPainless. The default compression
|
||||
* algorithm policy accepts any compression algorithm.
|
||||
* Default [CompressionAlgorithmPolicy] of PGPainless. The default compression algorithm
|
||||
* policy accepts any compression algorithm.
|
||||
*
|
||||
* @return default algorithm policy
|
||||
* @deprecated not expressive - might be removed in a future release
|
||||
|
|
@ -385,17 +385,16 @@ class Policy(
|
|||
|
||||
enum class SignerUserIdValidationLevel {
|
||||
/**
|
||||
* PGPainless will verify {@link org.bouncycastle.bcpg.sig.SignerUserID} subpackets in
|
||||
* signatures strictly. This means, that signatures with Signer's User-ID subpackets
|
||||
* containing a value that does not match the signer key's user-id exactly, will be
|
||||
* rejected. E.g. Signer's user-id "alice@pgpainless.org", User-ID: "Alice
|
||||
* <alice@pgpainless.org>" does not match exactly and is therefore rejected.
|
||||
* PGPainless will verify [org.bouncycastle.bcpg.sig.SignerUserID] subpackets in signatures
|
||||
* strictly. This means, that signatures with Signer's User-ID subpackets containing a value
|
||||
* that does not match the signer key's user-id exactly, will be rejected. E.g. Signer's
|
||||
* user-id "alice@pgpainless.org", User-ID: "Alice <alice@pgpainless.org>" does not
|
||||
* match exactly and is therefore rejected.
|
||||
*/
|
||||
STRICT,
|
||||
|
||||
/**
|
||||
* PGPainless will ignore {@link org.bouncycastle.bcpg.sig.SignerUserID} subpackets on
|
||||
* signature.
|
||||
* PGPainless will ignore [org.bouncycastle.bcpg.sig.SignerUserID] subpackets on signature.
|
||||
*/
|
||||
DISABLED
|
||||
}
|
||||
|
|
|
|||
|
|
@ -64,7 +64,7 @@ class SignatureSubpacketsUtil {
|
|||
* such packet is present, return null.
|
||||
*
|
||||
* @param signature signature
|
||||
* @return issuer key-id as {@link Long}
|
||||
* @return issuer key-id as [Long]
|
||||
*/
|
||||
@JvmStatic
|
||||
fun getIssuerKeyIdAsLong(signature: PGPSignature): Long? = getIssuerKeyId(signature)?.keyID
|
||||
|
|
|
|||
|
|
@ -153,8 +153,8 @@ class ArmorUtils {
|
|||
): String = toAsciiArmoredString(bytes.inputStream(), header)
|
||||
|
||||
/**
|
||||
* Return the ASCII armored encoding of the OpenPGP data from the given {@link InputStream}.
|
||||
* The ASCII armor will include armor headers from the given header map.
|
||||
* Return the ASCII armored encoding of the OpenPGP data from the given [InputStream]. The
|
||||
* ASCII armor will include armor headers from the given header map.
|
||||
*
|
||||
* @param inputStream input stream of OpenPGP data
|
||||
* @param header ASCII armor header map
|
||||
|
|
@ -179,7 +179,7 @@ class ArmorUtils {
|
|||
|
||||
/**
|
||||
* Return an [ArmoredOutputStream] prepared with headers for the given key ring, which wraps
|
||||
* the given {@link OutputStream}.
|
||||
* the given [OutputStream].
|
||||
*
|
||||
* The armored output stream can be used to encode the key ring by calling
|
||||
* [PGPKeyRing.encode] with the armored output stream as an argument.
|
||||
|
|
|
|||
|
|
@ -9,7 +9,7 @@ package org.pgpainless.util
|
|||
* notations that are not known to the application, there must be some way to tell PGPainless which
|
||||
* notations actually are known.
|
||||
*
|
||||
* To add a notation name, call {@link #addKnownNotation(String)}.
|
||||
* To add a notation name, call [addKnownNotation].
|
||||
*/
|
||||
class NotationRegistry constructor(notations: Set<String> = setOf()) {
|
||||
private val knownNotations: MutableSet<String>
|
||||
|
|
|
|||
Loading…
Reference in a new issue