dkim_getcanonlen()

SYNOPSIS
#include <dkim.h>
DKIM_STAT dkim_getcanonlen(
	DKIM *dkim,
        off_t *msglen,
        off_t *canonlen
);
Retrieve the number of bytes of message body presented for signing or verifying, and/or the number of bytes actually signed or verified.
DESCRIPTION
Called When dkim_getcanonlen() is called after dkim_eom() to get the number of bytes of message body presented for signing or verifying, and/or the number of bytes actually signed or verified. This is used to allow a verified to insist on minimum signing volumes or percentages (e.g., a verifier may decide not to trust a message which was only partially signed).
ARGUMENTS
ArgumentDescription
dkim Message-specific handle, returned by dkim_sign() or dkim_verify.
msglen A pointer to an off_t which will receive a count of the number of bytes in the canonicalized form of the message. This should always be the number of bytes in the message body plus or minus whatever was required to canonicalize it (so for "simple" canonicalization it should be roughly the exact byte count, while for "nowsp" canonicalization it should be somewhat less). Can be NULL if this information is not needed by the caller.
canonlen A pointer to an off_t which will receive a count of the number of bytes in the canonicalized form of the message that were included in the signed data. If msglen and canonlen are the same, then the entire message was signed. If it is less, then the signer didn't sign the entire message. A verifier can compare this value with that of msglen to see what portion of the total message was signed by the signer. Can be NULL if this information is not needed by the caller.
NOTES
  • This function is a local addition to the formal API specification and is experimental only. It may not appear in other implementations.

Copyright (c) 2005, 2006 Sendmail, Inc. and its suppliers. All rights reserved.
By using this file, you agree to the terms and conditions set forth in the LICENSE.