Docs: expand TFO information
[exim.git] / src / src / pdkim / pdkim.h
CommitLineData
80a47a2c
TK
1/*
2 * PDKIM - a RFC4871 (DKIM) implementation
3 *
c4ceed07 4 * Copyright (C) 2009 - 2012 Tom Kistner <tom@duncanthrax.net>
d4e5e70b 5 * Copyright (c) 2016 - 2017 Jeremy Harris
80a47a2c
TK
6 *
7 * http://duncanthrax.net/pdkim/
8 *
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22 */
2592e6c0
JH
23#ifndef PDKIM_H
24#define PDKIM_H
25
63af6f3a
JH
26#include "../blob.h"
27#include "../hash.h"
80a47a2c 28
80a47a2c 29/* -------------------------------------------------------------------------- */
80a47a2c 30/* Length of the preallocated buffer for the "answer" from the dns/txt
4263f395
PP
31 callback function. This should match the maximum RDLENGTH from DNS. */
32#define PDKIM_DNS_TXT_MAX_RECLEN (1 << 16)
80a47a2c
TK
33
34/* -------------------------------------------------------------------------- */
35/* Function success / error codes */
36#define PDKIM_OK 0
37#define PDKIM_FAIL -1
80a47a2c
TK
38#define PDKIM_ERR_RSA_PRIVKEY -101
39#define PDKIM_ERR_RSA_SIGNING -102
40#define PDKIM_ERR_LONG_LINE -103
41#define PDKIM_ERR_BUFFER_TOO_SMALL -104
df3def24
JH
42#define PDKIM_SIGN_PRIVKEY_WRAP -105
43#define PDKIM_SIGN_PRIVKEY_B64D -106
80a47a2c
TK
44
45/* -------------------------------------------------------------------------- */
46/* Main/Extended verification status */
47#define PDKIM_VERIFY_NONE 0
48#define PDKIM_VERIFY_INVALID 1
49#define PDKIM_VERIFY_FAIL 2
50#define PDKIM_VERIFY_PASS 3
51
07eeb4df 52#define PDKIM_VERIFY_FAIL_BODY 1
53#define PDKIM_VERIFY_FAIL_MESSAGE 2
135e9496
JH
54#define PDKIM_VERIFY_FAIL_SIG_ALGO_MISMATCH 3
55#define PDKIM_VERIFY_INVALID_PUBKEY_UNAVAILABLE 4
56#define PDKIM_VERIFY_INVALID_BUFFER_SIZE 5
57#define PDKIM_VERIFY_INVALID_PUBKEY_DNSRECORD 6
58#define PDKIM_VERIFY_INVALID_PUBKEY_IMPORT 7
59#define PDKIM_VERIFY_INVALID_SIGNATURE_ERROR 8
60#define PDKIM_VERIFY_INVALID_DKIM_VERSION 9
80a47a2c
TK
61
62/* -------------------------------------------------------------------------- */
63/* Some parameter values */
64#define PDKIM_QUERYMETHOD_DNS_TXT 0
65
80a47a2c
TK
66#define PDKIM_CANON_SIMPLE 0
67#define PDKIM_CANON_RELAXED 1
68
d73e45df
JH
69/*XXX change to enums */
70#define PDKIM_HASH_SHA256 1
80a47a2c
TK
71
72#define PDKIM_KEYTYPE_RSA 0
73
74/* -------------------------------------------------------------------------- */
75/* Some required forward declarations, please ignore */
76typedef struct pdkim_stringlist pdkim_stringlist;
77typedef struct pdkim_str pdkim_str;
cb224393
JH
78typedef struct sha1_context sha1_context;
79typedef struct sha2_context sha2_context;
80#define HAVE_SHA1_CONTEXT
81#define HAVE_SHA2_CONTEXT
80a47a2c
TK
82
83/* -------------------------------------------------------------------------- */
84/* Some concessions towards Redmond */
85#ifdef WINDOWS
86#define snprintf _snprintf
87#define strcasecmp _stricmp
88#define strncasecmp _strnicmp
89#define DLLEXPORT __declspec(dllexport)
90#else
91#define DLLEXPORT
92#endif
93
94
95/* -------------------------------------------------------------------------- */
96/* Public key as (usually) fetched from DNS */
97typedef struct pdkim_pubkey {
35cf75e9
JH
98 const uschar * version; /* v= */
99 const uschar *granularity; /* g= */
80a47a2c 100
35cf75e9 101 const uschar * hashes; /* h= */
135e9496 102#ifdef notdef
e2e3255a 103 uschar *keytype; /* k= */
e21a4d00 104#endif
35cf75e9 105 const uschar *srvtype; /* s= */
e2e3255a 106 uschar *notes; /* n= */
80a47a2c 107
2592e6c0 108 blob key; /* p= */
80a47a2c
TK
109 int testing; /* t=y */
110 int no_subdomaining; /* t=s */
111} pdkim_pubkey;
112
113/* -------------------------------------------------------------------------- */
114/* Signature as it appears in a DKIM-Signature header */
115typedef struct pdkim_signature {
9e70917d 116 struct pdkim_signature * next;
80a47a2c
TK
117
118 /* Bits stored in a DKIM signature header --------------------------- */
119
120 /* (v=) The version, as an integer. Currently, always "1" */
121 int version;
122
d73e45df
JH
123 int keytype; /* PDKIM_KEYTYPE_RSA */
124 int hashtype; /* pdkim_hashes index */
80a47a2c
TK
125
126 /* (c=x/) Header canonicalization method. Either PDKIM_CANON_SIMPLE
127 or PDKIM_CANON_RELAXED */
128 int canon_headers;
129
130 /* (c=/x) Body canonicalization method. Either PDKIM_CANON_SIMPLE
131 or PDKIM_CANON_RELAXED */
132 int canon_body;
133
134 /* (q=) Query Method. Currently, only PDKIM_QUERYMETHOD_DNS_TXT
135 is specified */
136 int querymethod;
137
138 /* (s=) The selector string as given in the signature */
e2e3255a 139 uschar *selector;
80a47a2c
TK
140
141 /* (d=) The domain as given in the signature */
e2e3255a 142 uschar *domain;
80a47a2c
TK
143
144 /* (i=) The identity as given in the signature */
e2e3255a 145 uschar *identity;
80a47a2c
TK
146
147 /* (t=) Timestamp of signature creation */
148 unsigned long created;
149
150 /* (x=) Timestamp of expiry of signature */
151 unsigned long expires;
152
153 /* (l=) Amount of hashed body bytes (after canonicalization). Default
154 is -1. Note: a value of 0 means that the body is unsigned! */
155 long bodylength;
156
157 /* (h=) Colon-separated list of header names that are included in the
158 signature */
2592e6c0 159 uschar *headernames;
80a47a2c
TK
160
161 /* (z=) */
e2e3255a 162 uschar *copiedheaders;
80a47a2c
TK
163
164 /* (b=) Raw signature data, along with its length in bytes */
dcd03763 165 blob sighash;
80a47a2c
TK
166
167 /* (bh=) Raw body hash data, along with its length in bytes */
2592e6c0 168 blob bodyhash;
80a47a2c 169
9e70917d 170 /* Folded DKIM-Signature: header. Signing only, NULL for verifying.
80a47a2c
TK
171 Ready for insertion into the message. Note: Folded using CRLFTB,
172 but final line terminator is NOT included. Note2: This buffer is
173 free()d when you call pdkim_free_ctx(). */
e2e3255a 174 uschar *signature_header;
80a47a2c
TK
175
176 /* The main verification status. Verification only. One of:
177
178 PDKIM_VERIFY_NONE Verification was not attempted. This status
179 should not appear.
180
181 PDKIM_VERIFY_INVALID There was an error while trying to verify
182 the signature. A more precise description
183 is available in verify_ext_status.
184
185 PDKIM_VERIFY_FAIL Verification failed because either the body
186 hash did not match, or the signature verification
187 failed. This means the message was modified.
188 Check verify_ext_status for the exact reason.
189
190 PDKIM_VERIFY_PASS Verification succeeded.
191 */
192 int verify_status;
193
194 /* Extended verification status. Verification only. Depending on the value
195 of verify_status, it can contain:
196
197 For verify_status == PDKIM_VERIFY_INVALID:
198
199 PDKIM_VERIFY_INVALID_PUBKEY_UNAVAILABLE
200 Unable to retrieve a public key container.
201
202 PDKIM_VERIFY_INVALID_BUFFER_SIZE
203 Either the DNS name constructed to retrieve the public key record
204 does not fit into PDKIM_DNS_TXT_MAX_NAMELEN bytes, or the retrieved
205 record is longer than PDKIM_DNS_TXT_MAX_RECLEN bytes.
206
207 PDKIM_VERIFY_INVALID_PUBKEY_PARSING
208 (Syntax) error while parsing the retrieved public key record.
209
210
211 For verify_status == PDKIM_VERIFY_FAIL:
212
213 PDKIM_VERIFY_FAIL_BODY
214 The calculated body hash does not match the advertised body hash
215 from the bh= tag of the signature.
216
217 PDKIM_VERIFY_FAIL_MESSAGE
218 RSA verification of the signature (b= tag) failed.
219 */
220 int verify_ext_status;
221
222 /* Pointer to a public key record that was used to verify the signature.
223 See pdkim_pubkey declaration above for more information.
224 Caution: is NULL if signing or if no record was retrieved. */
225 pdkim_pubkey *pubkey;
226
80a47a2c
TK
227 /* Properties below this point are used internally only ------------- */
228
229 /* Per-signature helper variables ----------------------------------- */
dcd03763 230 hctx body_hash_ctx;
2592e6c0 231
80a47a2c 232 unsigned long signed_body_bytes; /* How many body bytes we hashed */
9e70917d 233 int num_buffered_blanklines;
cb224393 234 pdkim_stringlist *headers; /* Raw headers included in the sig */
9e70917d 235
80a47a2c 236 /* Signing specific ------------------------------------------------- */
d73e45df 237 uschar * privkey; /* Private key */
ca9cb170
JH
238 uschar * sign_headers; /* To-be-signed header names */
239 uschar * rawsig_no_b_val; /* Original signature header w/o b= tag value. */
80a47a2c
TK
240} pdkim_signature;
241
242
243/* -------------------------------------------------------------------------- */
244/* Context to keep state between all operations. */
80a47a2c
TK
245typedef struct pdkim_ctx {
246
e983e85a
JH
247#define PDKIM_MODE_SIGN BIT(0) /* if unset, mode==verify */
248#define PDKIM_DOT_TERM BIT(1) /* dot termination and unstuffing */
b895f4b2
JH
249#define PDKIM_SEEN_CR BIT(2)
250#define PDKIM_SEEN_LF BIT(3)
e983e85a 251#define PDKIM_PAST_HDRS BIT(4)
b895f4b2 252#define PDKIM_SEEN_EOD BIT(5)
e983e85a 253 unsigned flags;
80a47a2c 254
80a47a2c
TK
255 /* One (signing) or several chained (verification) signatures */
256 pdkim_signature *sig;
257
258 /* Callback for dns/txt query method (verification only) */
259 int(*dns_txt_callback)(char *, char *);
260
261 /* Coder's little helpers */
acec9514 262 gstring *cur_header;
7845dbb3 263 uschar *linebuf;
80a47a2c 264 int linebuf_offset;
80a47a2c 265 int num_headers;
37f8b554 266 pdkim_stringlist *headers; /* Raw headers for verification */
80a47a2c
TK
267} pdkim_ctx;
268
269
270/* -------------------------------------------------------------------------- */
271/* API functions. Please see the sample code in sample/test_sign.c and
272 sample/test_verify.c for documentation.
273*/
274
275#ifdef __cplusplus
276extern "C" {
277#endif
278
2592e6c0
JH
279void pdkim_init (void);
280
9e70917d
JH
281void pdkim_init_context (pdkim_ctx *, BOOL, int(*)(char *, char *));
282
80a47a2c 283DLLEXPORT
9e70917d
JH
284pdkim_signature *pdkim_init_sign (pdkim_ctx *,
285 uschar *, uschar *, uschar *, uschar *,
286 const uschar **);
80a47a2c
TK
287
288DLLEXPORT
e983e85a 289pdkim_ctx *pdkim_init_verify (int(*)(char *, char *), BOOL);
80a47a2c
TK
290
291DLLEXPORT
9e70917d 292void pdkim_set_optional (pdkim_signature *, char *, char *,int, int,
f444c2c7 293 long,
80a47a2c
TK
294 unsigned long,
295 unsigned long);
296
297DLLEXPORT
ef698bf6 298int pdkim_feed (pdkim_ctx *, uschar *, int);
80a47a2c 299DLLEXPORT
b9df1829 300int pdkim_feed_finish (pdkim_ctx *, pdkim_signature **, const uschar **);
80a47a2c
TK
301
302DLLEXPORT
303void pdkim_free_ctx (pdkim_ctx *);
304
f7302073 305
b9df1829 306const uschar * pdkim_errstr(int);
f7302073 307
9e70917d 308uschar * dkim_sig_to_a_tag(const pdkim_signature * sig);
d73e45df 309
80a47a2c
TK
310#ifdef __cplusplus
311}
312#endif
2592e6c0
JH
313
314#endif