PGPainless/sop-java
1
0
Fork 0
mirror of https://codeberg.org/PGPainless/sop-java.git synced 2025-09-07 17:29:44 +02:00
Code Issues Projects Releases Packages Wiki Activity

SOPV: Document since when operations are available

Browse source
This commit is contained in:
Paul Schaub 2025-07-25 12:21:06 +02:00
parent d4e8c14b08
commit e680f3450a
Signed by: vanitasvitae
GPG key ID: 62BEE9264BF17311
1 changed files with 16 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

18
sop-java/src/main/kotlin/sop/SOPV.kt
View file

@ -12,27 +12,41 @@ import sop.operation.Version
/** Subset of [SOP] implementing only OpenPGP signature verification. */ /** Subset of [SOP] implementing only OpenPGP signature verification. */
interface SOPV { interface SOPV {
/** Get information about the implementations name and version. */ /**
* Get information about the implementations name and version.
*
* @since sopv 1.0
*/
fun version(): Version? fun version(): Version?
/** /**
* Verify detached signatures. If you need to verify an inline-signed message, use * Verify detached signatures. If you need to verify an inline-signed message, use
* [inlineVerify] instead. * [inlineVerify] instead.
*
* @since sopv 1.0
*/ */
fun verify(): DetachedVerify? = detachedVerify() fun verify(): DetachedVerify? = detachedVerify()
/** /**
* Verify detached signatures. If you need to verify an inline-signed message, use * Verify detached signatures. If you need to verify an inline-signed message, use
* [inlineVerify] instead. * [inlineVerify] instead.
*
* @since sopv 1.0
*/ */
fun detachedVerify(): DetachedVerify? fun detachedVerify(): DetachedVerify?
/** /**
* Verify signatures of an inline-signed message. If you need to verify detached signatures over * Verify signatures of an inline-signed message. If you need to verify detached signatures over
* a message, use [detachedVerify] instead. * a message, use [detachedVerify] instead.
*
* @since sopv 1.0
*/ */
fun inlineVerify(): InlineVerify? fun inlineVerify(): InlineVerify?
/** Validate a UserID in an OpenPGP certificate. */ /**
* Validate a UserID in an OpenPGP certificate.
*
* @since sopv 1.2
*/
fun validateUserId(): ValidateUserId? fun validateUserId(): ValidateUserId?
} }