From a608ee750dd83bf77a5fb4f0ab5bcf812436ba4d Mon Sep 17 00:00:00 2001 From: "Neal H. Walfield" Date: Mon, 19 Oct 2015 11:15:00 +0200 Subject: gpg: Improve function documentation and some comments. * g10/main.h: Improve function documentation. * g10/packet.h.h: Improve function documentation. * g10/sig-check.c: Improve function documentation and some comments. -- Signed-off-by: Neal H. Walfield --- g10/packet.h | 15 ++++++++++++--- 1 file changed, 12 insertions(+), 3 deletions(-) (limited to 'g10/packet.h') diff --git a/g10/packet.h b/g10/packet.h index 87671a6ce..2bc911d29 100644 --- a/g10/packet.h +++ b/g10/packet.h @@ -638,9 +638,18 @@ int cmp_user_ids( PKT_user_id *a, PKT_user_id *b ); /*-- sig-check.c --*/ -int check_signature( PKT_signature *sig, gcry_md_hd_t digest ); -int check_signature2( PKT_signature *sig, gcry_md_hd_t digest, u32 *r_expiredate, - int *r_expired, int *r_revoked, PKT_public_key *ret_pk ); +/* Check a signature. This is shorthand for check_signature2 with + the unnamed arguments passed as NULL. */ +int check_signature (PKT_signature *sig, gcry_md_hd_t digest); + +/* Check a signature. Looks up the public key from the key db. (If + RET_PK is not NULL, it is returned in *RET_PK.) DIGEST contains a + valid hash context that already includes the signed data. This + function adds the relevant meta-data to the hash before finalizing + it and verifying the signature. */ +int check_signature2 (PKT_signature *sig, gcry_md_hd_t digest, + u32 *r_expiredate, int *r_expired, int *r_revoked, + PKT_public_key *ret_pk); /*-- pubkey-enc.c --*/ -- cgit v1.2.3