X-Git-Url: https://git.exim.org/exim.git/blobdiff_plain/3ecab1575ef1f45a5e7cd3c48cd937ffa8eb0ad9..cd1a5fe0ed22087c6afbe585ab0206c2a4a267aa:/src/src/pdkim/pdkim.h diff --git a/src/src/pdkim/pdkim.h b/src/src/pdkim/pdkim.h index 764cc83be..c1c8c262e 100644 --- a/src/src/pdkim/pdkim.h +++ b/src/src/pdkim/pdkim.h @@ -2,6 +2,7 @@ * PDKIM - a RFC4871 (DKIM) implementation * * Copyright (C) 2009 - 2012 Tom Kistner + * Copyright (c) Jeremy Harris 2016 * * http://duncanthrax.net/pdkim/ * @@ -19,26 +20,27 @@ * with this program; if not, write to the Free Software Foundation, Inc., * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. */ +#ifndef PDKIM_H +#define PDKIM_H -/* -------------------------------------------------------------------------- */ -/* Debugging. This can also be enabled/disabled at run-time. I recommend to - leave it defined. */ -#define PDKIM_DEBUG +#include "../blob.h" +#include "../hash.h" /* -------------------------------------------------------------------------- */ /* Length of the preallocated buffer for the "answer" from the dns/txt - callback function. */ -#define PDKIM_DNS_TXT_MAX_RECLEN 4096 + callback function. This should match the maximum RDLENGTH from DNS. */ +#define PDKIM_DNS_TXT_MAX_RECLEN (1 << 16) /* -------------------------------------------------------------------------- */ /* Function success / error codes */ #define PDKIM_OK 0 #define PDKIM_FAIL -1 -#define PDKIM_ERR_OOM -100 #define PDKIM_ERR_RSA_PRIVKEY -101 #define PDKIM_ERR_RSA_SIGNING -102 #define PDKIM_ERR_LONG_LINE -103 #define PDKIM_ERR_BUFFER_TOO_SMALL -104 +#define PDKIM_SIGN_PRIVKEY_WRAP -105 +#define PDKIM_SIGN_PRIVKEY_B64D -106 /* -------------------------------------------------------------------------- */ /* Main/Extended verification status */ @@ -47,11 +49,14 @@ #define PDKIM_VERIFY_FAIL 2 #define PDKIM_VERIFY_PASS 3 -#define PDKIM_VERIFY_FAIL_BODY 1 -#define PDKIM_VERIFY_FAIL_MESSAGE 2 -#define PDKIM_VERIFY_INVALID_PUBKEY_UNAVAILABLE 3 -#define PDKIM_VERIFY_INVALID_BUFFER_SIZE 4 -#define PDKIM_VERIFY_INVALID_PUBKEY_PARSING 5 +#define PDKIM_VERIFY_FAIL_BODY 1 +#define PDKIM_VERIFY_FAIL_MESSAGE 2 +#define PDKIM_VERIFY_INVALID_PUBKEY_UNAVAILABLE 3 +#define PDKIM_VERIFY_INVALID_BUFFER_SIZE 4 +#define PDKIM_VERIFY_INVALID_PUBKEY_DNSRECORD 5 +#define PDKIM_VERIFY_INVALID_PUBKEY_IMPORT 6 +#define PDKIM_VERIFY_INVALID_SIGNATURE_ERROR 7 +#define PDKIM_VERIFY_INVALID_DKIM_VERSION 8 /* -------------------------------------------------------------------------- */ /* Some parameter values */ @@ -92,17 +97,17 @@ typedef struct sha2_context sha2_context; /* -------------------------------------------------------------------------- */ /* Public key as (usually) fetched from DNS */ typedef struct pdkim_pubkey { - char *version; /* v= */ - char *granularity; /* g= */ - - char *hashes; /* h= */ - char *keytype; /* k= */ - char *srvtype; /* s= */ - char *notes; /* n= */ + uschar *version; /* v= */ + uschar *granularity; /* g= */ - char *key; /* p= */ - int key_len; +#ifdef notdef + uschar *hashes; /* h= */ + uschar *keytype; /* k= */ +#endif + uschar *srvtype; /* s= */ + uschar *notes; /* n= */ + blob key; /* p= */ int testing; /* t=y */ int no_subdomaining; /* t=s */ } pdkim_pubkey; @@ -133,13 +138,13 @@ typedef struct pdkim_signature { int querymethod; /* (s=) The selector string as given in the signature */ - char *selector; + uschar *selector; /* (d=) The domain as given in the signature */ - char *domain; + uschar *domain; /* (i=) The identity as given in the signature */ - char *identity; + uschar *identity; /* (t=) Timestamp of signature creation */ unsigned long created; @@ -153,24 +158,22 @@ typedef struct pdkim_signature { /* (h=) Colon-separated list of header names that are included in the signature */ - char *headernames; + uschar *headernames; /* (z=) */ - char *copiedheaders; + uschar *copiedheaders; /* (b=) Raw signature data, along with its length in bytes */ - char *sigdata; - int sigdata_len; + blob sigdata; /* (bh=) Raw body hash data, along with its length in bytes */ - char *bodyhash; - int bodyhash_len; + blob bodyhash; /* Folded DKIM-Signature: header. Singing only, NULL for verifying. Ready for insertion into the message. Note: Folded using CRLFTB, but final line terminator is NOT included. Note2: This buffer is free()d when you call pdkim_free_ctx(). */ - char *signature_header; + uschar *signature_header; /* The main verification status. Verification only. One of: @@ -230,30 +233,27 @@ typedef struct pdkim_signature { /* Properties below this point are used internally only ------------- */ /* Per-signature helper variables ----------------------------------- */ - sha1_context *sha1_body; /* SHA1 block */ - sha2_context *sha2_body; /* SHA256 block */ + hctx body_hash; + unsigned long signed_body_bytes; /* How many body bytes we hashed */ pdkim_stringlist *headers; /* Raw headers included in the sig */ /* Signing specific ------------------------------------------------- */ - char *rsa_privkey; /* Private RSA key */ - char *sign_headers; /* To-be-signed header names */ - char *rawsig_no_b_val; /* Original signature header w/o b= tag value. */ + uschar * rsa_privkey; /* Private RSA key */ + uschar * sign_headers; /* To-be-signed header names */ + uschar * rawsig_no_b_val; /* Original signature header w/o b= tag value. */ } pdkim_signature; /* -------------------------------------------------------------------------- */ /* Context to keep state between all operations. */ -#define PDKIM_MODE_SIGN 0 -#define PDKIM_MODE_VERIFY 1 -#define PDKIM_INPUT_NORMAL 0 -#define PDKIM_INPUT_SMTP 1 typedef struct pdkim_ctx { - /* PDKIM_MODE_VERIFY or PDKIM_MODE_SIGN */ - int mode; - - /* PDKIM_INPUT_SMTP or PDKIM_INPUT_NORMAL */ - int input_mode; +#define PDKIM_MODE_SIGN BIT(0) /* if unset, mode==verify */ +#define PDKIM_DOT_TERM BIT(1) /* dot termination and unstuffing */ +#define PDKIM_SEEN_LF BIT(2) +#define PDKIM_SEEN_EOD BIT(3) +#define PDKIM_PAST_HDRS BIT(4) + unsigned flags; /* One (signing) or several chained (verification) signatures */ pdkim_signature *sig; @@ -262,22 +262,14 @@ typedef struct pdkim_ctx { int(*dns_txt_callback)(char *, char *); /* Coder's little helpers */ - pdkim_str *cur_header; + uschar *cur_header; + int cur_header_size; + int cur_header_len; char *linebuf; int linebuf_offset; - int seen_lf; - int seen_eod; - int past_headers; int num_buffered_crlf; int num_headers; pdkim_stringlist *headers; /* Raw headers for verification */ - -#ifdef PDKIM_DEBUG - /* A FILE pointer. When not NULL, debug output will be generated - and sent to this stream */ - FILE *debug_stream; -#endif - } pdkim_ctx; @@ -290,15 +282,18 @@ typedef struct pdkim_ctx { extern "C" { #endif +void pdkim_init (void); + DLLEXPORT -pdkim_ctx *pdkim_init_sign (int, char *, char *, char *); +pdkim_ctx *pdkim_init_sign (char *, char *, char *, int, + BOOL, int(*)(char *, char *)); DLLEXPORT -pdkim_ctx *pdkim_init_verify (int, int(*)(char *, char *)); +pdkim_ctx *pdkim_init_verify (int(*)(char *, char *), BOOL); DLLEXPORT int pdkim_set_optional (pdkim_ctx *, char *, char *,int, int, - long, int, + long, unsigned long, unsigned long); @@ -310,11 +305,11 @@ int pdkim_feed_finish (pdkim_ctx *, pdkim_signature **); DLLEXPORT void pdkim_free_ctx (pdkim_ctx *); -#ifdef PDKIM_DEBUG -DLLEXPORT -void pdkim_set_debug_stream(pdkim_ctx *, FILE *); -#endif + +const char * pdkim_errstr(int); #ifdef __cplusplus } #endif + +#endif