Skip to content

Commit

Permalink
Add documentation to openssl::sign::Verifier
Browse files Browse the repository at this point in the history
  • Loading branch information
wiktor-k committed Dec 1, 2022
1 parent 91dfef5 commit b42a2b7
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions openssl/src/sign.rs
Original file line number Diff line number Diff line change
Expand Up @@ -403,6 +403,8 @@ impl<'a> Write for Signer<'a> {
}
}

/// A type which can be used to verify the integrity and authenticity
/// of data given the signature.
pub struct Verifier<'a> {
md_ctx: *mut ffi::EVP_MD_CTX,
pctx: *mut ffi::EVP_PKEY_CTX,
Expand All @@ -426,7 +428,7 @@ impl<'a> Verifier<'a> {
/// Creates a new `Verifier`.
///
/// This cannot be used with Ed25519 or Ed448 keys. Please refer to
/// `new_without_digest`.
/// [`Verifier::new_without_digest`].
///
/// OpenSSL documentation at [`EVP_DigestVerifyInit`].
///
Expand Down Expand Up @@ -553,7 +555,7 @@ impl<'a> Verifier<'a> {
/// Feeds more data into the `Verifier`.
///
/// Please note that PureEdDSA (Ed25519 and Ed448 keys) do not support streaming.
/// Use `verify_oneshot` instead.
/// Use [`Verifier::verify_oneshot`] instead.
///
/// OpenSSL documentation at [`EVP_DigestUpdate`].
///
Expand Down

0 comments on commit b42a2b7

Please sign in to comment.