PGPainless/pgpainless
PGPainless/pgpainless
1
0
Fork 0
mirror of https://github.com/pgpainless/pgpainless.git synced 2024-11-30 00:02:06 +01:00
Code Issues Releases Wiki Activity

Add javadoc p-tags

Browse source
This commit is contained in:
Paul Schaub 2023-05-03 16:03:12 +02:00
parent 1d26751b45
commit 3b8a1b47d7
Signed by: vanitasvitae
GPG key ID: 62BEE9264BF17311
4 changed files with 14 additions and 14 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
pgpainless-core/src/main/java/org/pgpainless/PGPainless.java
View file

@ -152,7 +152,7 @@ public final class PGPainless {
/** /**
* Make changes to a secret key. * Make changes to a secret key.
* This method can be used to change key expiration dates and passphrases, or add/revoke subkeys. * This method can be used to change key expiration dates and passphrases, or add/revoke subkeys.
* * <p>
* After making the desired changes in the builder, the modified key ring can be extracted using {@link SecretKeyRingEditorInterface#done()}. * After making the desired changes in the builder, the modified key ring can be extracted using {@link SecretKeyRingEditorInterface#done()}.
* *
* @param secretKeys secret key ring * @param secretKeys secret key ring
@ -165,7 +165,7 @@ public final class PGPainless {
/** /**
* Make changes to a secret key at the given reference time. * Make changes to a secret key at the given reference time.
* This method can be used to change key expiration dates and passphrases, or add/revoke user-ids and subkeys. * This method can be used to change key expiration dates and passphrases, or add/revoke user-ids and subkeys.
* * <p>
* After making the desired changes in the builder, the modified key can be extracted using {@link SecretKeyRingEditorInterface#done()}. * After making the desired changes in the builder, the modified key can be extracted using {@link SecretKeyRingEditorInterface#done()}.
* *
* @param secretKeys secret key ring * @param secretKeys secret key ring
@ -179,7 +179,7 @@ public final class PGPainless {
/** /**
* Quickly access information about a {@link org.bouncycastle.openpgp.PGPPublicKeyRing} / {@link PGPSecretKeyRing}. * Quickly access information about a {@link org.bouncycastle.openpgp.PGPPublicKeyRing} / {@link PGPSecretKeyRing}.
* This method can be used to determine expiration dates, key flags and other information about a key. * This method can be used to determine expiration dates, key flags and other information about a key.
* * <p>
* To evaluate a key at a given date (e.g. to determine if the key was allowed to create a certain signature) * To evaluate a key at a given date (e.g. to determine if the key was allowed to create a certain signature)
* use {@link #inspectKeyRing(PGPKeyRing, Date)} instead. * use {@link #inspectKeyRing(PGPKeyRing, Date)} instead.
* *

12
pgpainless-core/src/main/java/org/pgpainless/encryption_signing/SigningOptions.java
View file

@ -158,7 +158,7 @@ public final class SigningOptions {
* Add an inline-signature. * Add an inline-signature.
* Inline signatures are being embedded into the message itself and can be processed in one pass, thanks to the use * Inline signatures are being embedded into the message itself and can be processed in one pass, thanks to the use
* of one-pass-signature packets. * of one-pass-signature packets.
* * <p>
* This method uses the passed in user-id to select user-specific hash algorithms. * This method uses the passed in user-id to select user-specific hash algorithms.
* *
* @param secretKeyDecryptor decryptor to unlock the signing secret key * @param secretKeyDecryptor decryptor to unlock the signing secret key
@ -182,7 +182,7 @@ public final class SigningOptions {
* Add an inline-signature. * Add an inline-signature.
* Inline signatures are being embedded into the message itself and can be processed in one pass, thanks to the use * Inline signatures are being embedded into the message itself and can be processed in one pass, thanks to the use
* of one-pass-signature packets. * of one-pass-signature packets.
* * <p>
* This method uses the passed in user-id to select user-specific hash algorithms. * This method uses the passed in user-id to select user-specific hash algorithms.
* *
* @param secretKeyDecryptor decryptor to unlock the signing secret key * @param secretKeyDecryptor decryptor to unlock the signing secret key
@ -295,7 +295,7 @@ public final class SigningOptions {
* Detached signatures are not being added into the PGP message itself. * Detached signatures are not being added into the PGP message itself.
* Instead, they can be distributed separately to the message. * Instead, they can be distributed separately to the message.
* Detached signatures are useful if the data that is being signed shall not be modified (e.g. when signing a file). * Detached signatures are useful if the data that is being signed shall not be modified (e.g. when signing a file).
* * <p>
* This method uses the passed in user-id to select user-specific hash algorithms. * This method uses the passed in user-id to select user-specific hash algorithms.
* *
* @param secretKeyDecryptor decryptor to unlock the secret signing key * @param secretKeyDecryptor decryptor to unlock the secret signing key
@ -320,7 +320,7 @@ public final class SigningOptions {
* Detached signatures are not being added into the PGP message itself. * Detached signatures are not being added into the PGP message itself.
* Instead, they can be distributed separately to the message. * Instead, they can be distributed separately to the message.
* Detached signatures are useful if the data that is being signed shall not be modified (e.g. when signing a file). * Detached signatures are useful if the data that is being signed shall not be modified (e.g. when signing a file).
* * <p>
* This method uses the passed in user-id to select user-specific hash algorithms. * This method uses the passed in user-id to select user-specific hash algorithms.
* *
* @param secretKeyDecryptor decryptor to unlock the secret signing key * @param secretKeyDecryptor decryptor to unlock the secret signing key
@ -406,7 +406,7 @@ public final class SigningOptions {
/** /**
* Negotiate, which hash algorithm to use. * Negotiate, which hash algorithm to use.
* * <p>
* This method gives the highest priority to the algorithm override, which can be set via {@link #overrideHashAlgorithm(HashAlgorithm)}. * This method gives the highest priority to the algorithm override, which can be set via {@link #overrideHashAlgorithm(HashAlgorithm)}.
* After that, the signing keys hash algorithm preferences are iterated to find the first acceptable algorithm. * After that, the signing keys hash algorithm preferences are iterated to find the first acceptable algorithm.
* Lastly, should no acceptable algorithm be found, the {@link Policy Policies} default signature hash algorithm is * Lastly, should no acceptable algorithm be found, the {@link Policy Policies} default signature hash algorithm is
@ -451,7 +451,7 @@ public final class SigningOptions {
/** /**
* Override hash algorithm negotiation by dictating which hash algorithm needs to be used. * Override hash algorithm negotiation by dictating which hash algorithm needs to be used.
* If no override has been set, an accetable algorithm will be negotiated instead. * If no override has been set, an accetable algorithm will be negotiated instead.
* * <p>
* Note: To override the hash algorithm for signing, call this method *before* calling * Note: To override the hash algorithm for signing, call this method *before* calling
* {@link #addInlineSignature(SecretKeyRingProtector, PGPSecretKeyRing, DocumentSignatureType)} or * {@link #addInlineSignature(SecretKeyRingProtector, PGPSecretKeyRing, DocumentSignatureType)} or
* {@link #addDetachedSignature(SecretKeyRingProtector, PGPSecretKeyRing, DocumentSignatureType)}. * {@link #addDetachedSignature(SecretKeyRingProtector, PGPSecretKeyRing, DocumentSignatureType)}.

2
pgpainless-core/src/main/java/org/pgpainless/key/info/KeyAccessor.java
View file

@ -28,7 +28,7 @@ public abstract class KeyAccessor {
/** /**
* Depending on the way we address the key (key-id or user-id), return the respective {@link PGPSignature} * Depending on the way we address the key (key-id or user-id), return the respective {@link PGPSignature}
* which contains the algorithm preferences we are going to use. * which contains the algorithm preferences we are going to use.
* * <p>
* If we address a key via its user-id, we want to rely on the algorithm preferences in the user-id certification, * If we address a key via its user-id, we want to rely on the algorithm preferences in the user-id certification,
* while we would instead rely on those in the direct-key signature if we'd address the key by key-id. * while we would instead rely on those in the direct-key signature if we'd address the key by key-id.
* *

8
pgpainless-core/src/main/java/org/pgpainless/key/info/KeyRingInfo.java
View file

@ -292,7 +292,7 @@ public class KeyRingInfo {
/** /**
* Return the current primary user-id of the key ring. * 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, * 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. * this method returns the first user-id on the key, otherwise null.
* *
@ -472,7 +472,7 @@ public class KeyRingInfo {
/** /**
* Return the latest direct-key self signature. * Return the latest direct-key self signature.
* * <p>
* Note: This signature might be expired (check with {@link SignatureUtils#isSignatureExpired(PGPSignature)}). * Note: This signature might be expired (check with {@link SignatureUtils#isSignatureExpired(PGPSignature)}).
* *
* @return latest direct key self-signature or null * @return latest direct key self-signature or null
@ -782,7 +782,7 @@ public class KeyRingInfo {
* Return the latest date on which the key ring is still usable for the given key flag. * Return the latest date on which the key ring is still usable for the given key flag.
* If only a subkey is carrying the required flag and the primary key expires earlier than the subkey, * If only a subkey is carrying the required flag and the primary key expires earlier than the subkey,
* the expiry date of the primary key is returned. * the expiry date of the primary key is returned.
* * <p>
* This method might return null, if the primary key and a subkey with the required flag does not expire. * This method might return null, if the primary key and a subkey with the required flag does not expire.
* @param use key flag representing the use case, e.g. {@link KeyFlag#SIGN_DATA} or * @param use key flag representing the use case, e.g. {@link KeyFlag#SIGN_DATA} or
* {@link KeyFlag#ENCRYPT_COMMS}/{@link KeyFlag#ENCRYPT_STORAGE}. * {@link KeyFlag#ENCRYPT_COMMS}/{@link KeyFlag#ENCRYPT_STORAGE}.
@ -1133,7 +1133,7 @@ public class KeyRingInfo {
/** /**
* Returns true, if this {@link KeyRingInfo} is based on a {@link PGPSecretKeyRing}, which has a valid signing key * Returns true, if this {@link KeyRingInfo} is based on a {@link PGPSecretKeyRing}, which has a valid signing key
* which is ready to be used (i.e. secret key is present and is not on a smart-card). * which is ready to be used (i.e. secret key is present and is not on a smart-card).
* * <p>
* If you just want to check, whether a key / certificate has signing capable subkeys, * If you just want to check, whether a key / certificate has signing capable subkeys,
* use {@link #isSigningCapable()} instead. * use {@link #isSigningCapable()} instead.
* *