]> git.meshlink.io Git - meshlink/blob - src/sptps.c
Merge branch 'discovery' into everbase
[meshlink] / src / sptps.c
1 /*
2     sptps.c -- Simple Peer-to-Peer Security
3     Copyright (C) 2014 Guus Sliepen <guus@meshlink.io>
4
5     This program is free software; you can redistribute it and/or modify
6     it under the terms of the GNU General Public License as published by
7     the Free Software Foundation; either version 2 of the License, or
8     (at your option) any later version.
9
10     This program is distributed in the hope that it will be useful,
11     but WITHOUT ANY WARRANTY; without even the implied warranty of
12     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13     GNU General Public License for more details.
14
15     You should have received a copy of the GNU General Public License along
16     with this program; if not, write to the Free Software Foundation, Inc.,
17     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
18 */
19
20 #include "system.h"
21
22 #include "chacha-poly1305/chacha-poly1305.h"
23 #include "crypto.h"
24 #include "ecdh.h"
25 #include "ecdsa.h"
26 #include "logger.h"
27 #include "prf.h"
28 #include "sptps.h"
29
30 unsigned int sptps_replaywin = 16;
31
32 /*
33    Nonce MUST be exchanged first (done)
34    Signatures MUST be done over both nonces, to guarantee the signature is fresh
35    Otherwise: if ECDHE key of one side is compromised, it can be reused!
36
37    Add explicit tag to beginning of structure to distinguish the client and server when signing. (done)
38
39    Sign all handshake messages up to ECDHE kex with long-term public keys. (done)
40
41    HMACed KEX finished message to prevent downgrade attacks and prove you have the right key material (done by virtue of ECDSA over the whole ECDHE exchange?)
42
43    Explicit close message needs to be added.
44
45    Maybe do add some alert messages to give helpful error messages? Not more than TLS sends.
46
47    Use counter mode instead of OFB. (done)
48
49    Make sure ECC operations are fixed time (aka prevent side-channel attacks).
50 */
51
52 void sptps_log_quiet(sptps_t *s, int s_errno, const char *format, va_list ap) {
53 }
54
55 void sptps_log_stderr(sptps_t *s, int s_errno, const char *format, va_list ap) {
56         vfprintf(stderr, format, ap);
57         fputc('\n', stderr);
58 }
59
60 void (*sptps_log)(sptps_t *s, int s_errno, const char *format, va_list ap) = sptps_log_stderr;
61
62 // Log an error message.
63 static bool error(sptps_t *s, int s_errno, const char *format, ...) {
64         if(format) {
65                 va_list ap;
66                 va_start(ap, format);
67                 sptps_log(s, s_errno, format, ap);
68                 va_end(ap);
69         }
70
71         errno = s_errno;
72         return false;
73 }
74
75 static void warning(sptps_t *s, const char *format, ...) {
76         va_list ap;
77         va_start(ap, format);
78         sptps_log(s, 0, format, ap);
79         va_end(ap);
80 }
81
82 // Send a record (datagram version, accepts all record types, handles encryption and authentication).
83 static bool send_record_priv_datagram(sptps_t *s, uint8_t type, const void *data, uint16_t len) {
84         char buffer[len + 21UL];
85
86         // Create header with sequence number, length and record type
87         uint32_t seqno = s->outseqno++;
88         uint32_t netseqno = ntohl(seqno);
89
90         memcpy(buffer, &netseqno, 4);
91         buffer[4] = type;
92         memcpy(buffer + 5, data, len);
93
94         if(s->outstate) {
95                 // If first handshake has finished, encrypt and HMAC
96                 chacha_poly1305_encrypt(s->outcipher, seqno, buffer + 4, len + 1, buffer + 4, NULL);
97                 return s->send_data(s->handle, type, buffer, len + 21UL);
98         } else {
99                 // Otherwise send as plaintext
100                 return s->send_data(s->handle, type, buffer, len + 5UL);
101         }
102 }
103 // Send a record (private version, accepts all record types, handles encryption and authentication).
104 static bool send_record_priv(sptps_t *s, uint8_t type, const void *data, uint16_t len) {
105         if(s->datagram)
106                 return send_record_priv_datagram(s, type, data, len);
107
108         char buffer[len + 19UL];
109
110         // Create header with sequence number, length and record type
111         uint32_t seqno = s->outseqno++;
112         uint16_t netlen = htons(len);
113
114         memcpy(buffer, &netlen, 2);
115         buffer[2] = type;
116         memcpy(buffer + 3, data, len);
117
118         if(s->outstate) {
119                 // If first handshake has finished, encrypt and HMAC
120                 chacha_poly1305_encrypt(s->outcipher, seqno, buffer + 2, len + 1, buffer + 2, NULL);
121                 return s->send_data(s->handle, type, buffer, len + 19UL);
122         } else {
123                 // Otherwise send as plaintext
124                 return s->send_data(s->handle, type, buffer, len + 3UL);
125         }
126 }
127
128 // Send an application record.
129 bool sptps_send_record(sptps_t *s, uint8_t type, const void *data, uint16_t len) {
130         // Sanity checks: application cannot send data before handshake is finished,
131         // and only record types 0..127 are allowed.
132         if(!s->outstate)
133                 return error(s, EINVAL, "Handshake phase not finished yet");
134
135         if(type >= SPTPS_HANDSHAKE)
136                 return error(s, EINVAL, "Invalid application record type");
137
138         return send_record_priv(s, type, data, len);
139 }
140
141 // Send a Key EXchange record, containing a random nonce and an ECDHE public key.
142 static bool send_kex(sptps_t *s) {
143         size_t keylen = ECDH_SIZE;
144
145         // Make room for our KEX message, which we will keep around since send_sig() needs it.
146         if(s->mykex)
147                 return false;
148         s->mykex = realloc(s->mykex, 1 + 32 + keylen);
149         if(!s->mykex)
150                 return error(s, errno, strerror(errno));
151
152         // Set version byte to zero.
153         s->mykex[0] = SPTPS_VERSION;
154
155         // Create a random nonce.
156         randomize(s->mykex + 1, 32);
157
158         // Create a new ECDH public key.
159         if(!(s->ecdh = ecdh_generate_public(s->mykex + 1 + 32)))
160                 return error(s, EINVAL, "Failed to generate ECDH public key");
161
162         return send_record_priv(s, SPTPS_HANDSHAKE, s->mykex, 1 + 32 + keylen);
163 }
164
165 // Send a SIGnature record, containing an ECDSA signature over both KEX records.
166 static bool send_sig(sptps_t *s) {
167         size_t keylen = ECDH_SIZE;
168         size_t siglen = ecdsa_size(s->mykey);
169
170         // Concatenate both KEX messages, plus tag indicating if it is from the connection originator, plus label
171         char msg[(1 + 32 + keylen) * 2 + 1 + s->labellen];
172         char sig[siglen];
173
174         msg[0] = s->initiator;
175         memcpy(msg + 1, s->mykex, 1 + 32 + keylen);
176         memcpy(msg + 1 + 33 + keylen, s->hiskex, 1 + 32 + keylen);
177         memcpy(msg + 1 + 2 * (33 + keylen), s->label, s->labellen);
178
179         // Sign the result.
180         if(!ecdsa_sign(s->mykey, msg, sizeof msg, sig))
181                 return error(s, EINVAL, "Failed to sign SIG record");
182
183         // Send the SIG exchange record.
184         return send_record_priv(s, SPTPS_HANDSHAKE, sig, sizeof sig);
185 }
186
187 // Generate key material from the shared secret created from the ECDHE key exchange.
188 static bool generate_key_material(sptps_t *s, const char *shared, size_t len) {
189         // Initialise cipher and digest structures if necessary
190         if(!s->outstate) {
191                 s->incipher = chacha_poly1305_init();
192                 s->outcipher = chacha_poly1305_init();
193                 if(!s->incipher || !s->outcipher)
194                         return error(s, EINVAL, "Failed to open cipher");
195         }
196
197         // Allocate memory for key material
198         size_t keylen = 2 * CHACHA_POLY1305_KEYLEN;
199
200         s->key = realloc(s->key, keylen);
201         if(!s->key)
202                 return error(s, errno, strerror(errno));
203
204         // Create the HMAC seed, which is "key expansion" + session label + server nonce + client nonce
205         char seed[s->labellen + 64 + 13];
206         strcpy(seed, "key expansion");
207         if(s->initiator) {
208                 memcpy(seed + 13, s->mykex + 1, 32);
209                 memcpy(seed + 45, s->hiskex + 1, 32);
210         } else {
211                 memcpy(seed + 13, s->hiskex + 1, 32);
212                 memcpy(seed + 45, s->mykex + 1, 32);
213         }
214         memcpy(seed + 77, s->label, s->labellen);
215
216         // Use PRF to generate the key material
217         if(!prf(shared, len, seed, s->labellen + 64 + 13, s->key, keylen))
218                 return error(s, EINVAL, "Failed to generate key material");
219
220         return true;
221 }
222
223 // Send an ACKnowledgement record.
224 static bool send_ack(sptps_t *s) {
225         return send_record_priv(s, SPTPS_HANDSHAKE, "", 0);
226 }
227
228 // Receive an ACKnowledgement record.
229 static bool receive_ack(sptps_t *s, const char *data, uint16_t len) {
230         if(len)
231                 return error(s, EIO, "Invalid ACK record length");
232
233         if(s->initiator) {
234                 if(!chacha_poly1305_set_key(s->incipher, s->key))
235                         return error(s, EINVAL, "Failed to set counter");
236         } else {
237                 if(!chacha_poly1305_set_key(s->incipher, s->key + CHACHA_POLY1305_KEYLEN))
238                         return error(s, EINVAL, "Failed to set counter");
239         }
240
241         free(s->key);
242         s->key = NULL;
243         s->instate = true;
244
245         return true;
246 }
247
248 // Receive a Key EXchange record, respond by sending a SIG record.
249 static bool receive_kex(sptps_t *s, const char *data, uint16_t len) {
250         // Verify length of the HELLO record
251         if(len != 1 + 32 + ECDH_SIZE)
252                 return error(s, EIO, "Invalid KEX record length");
253
254         // Ignore version number for now.
255
256         // Make a copy of the KEX message, send_sig() and receive_sig() need it
257         if(s->hiskex)
258                 return error(s, EINVAL, "Received a second KEX message before first has been processed");
259         s->hiskex = realloc(s->hiskex, len);
260         if(!s->hiskex)
261                 return error(s, errno, strerror(errno));
262
263         memcpy(s->hiskex, data, len);
264
265         return send_sig(s);
266 }
267
268 // Receive a SIGnature record, verify it, if it passed, compute the shared secret and calculate the session keys.
269 static bool receive_sig(sptps_t *s, const char *data, uint16_t len) {
270         size_t keylen = ECDH_SIZE;
271         size_t siglen = ecdsa_size(s->hiskey);
272
273         // Verify length of KEX record.
274         if(len != siglen)
275                 return error(s, EIO, "Invalid KEX record length");
276
277         // Concatenate both KEX messages, plus tag indicating if it is from the connection originator
278         char msg[(1 + 32 + keylen) * 2 + 1 + s->labellen];
279
280         msg[0] = !s->initiator;
281         memcpy(msg + 1, s->hiskex, 1 + 32 + keylen);
282         memcpy(msg + 1 + 33 + keylen, s->mykex, 1 + 32 + keylen);
283         memcpy(msg + 1 + 2 * (33 + keylen), s->label, s->labellen);
284
285         // Verify signature.
286         if(!ecdsa_verify(s->hiskey, msg, sizeof msg, data))
287                 return error(s, EIO, "Failed to verify SIG record");
288
289         // Compute shared secret.
290         char shared[ECDH_SHARED_SIZE];
291         if(!ecdh_compute_shared(s->ecdh, s->hiskex + 1 + 32, shared))
292                 return error(s, EINVAL, "Failed to compute ECDH shared secret");
293         s->ecdh = NULL;
294
295         // Generate key material from shared secret.
296         if(!generate_key_material(s, shared, sizeof shared))
297                 return false;
298
299         free(s->mykex);
300         free(s->hiskex);
301
302         s->mykex = NULL;
303         s->hiskex = NULL;
304
305         // Send cipher change record
306         if(s->outstate && !send_ack(s))
307                 return false;
308
309         // TODO: only set new keys after ACK has been set/received
310         if(s->initiator) {
311                 if(!chacha_poly1305_set_key(s->outcipher, s->key + CHACHA_POLY1305_KEYLEN))
312                         return error(s, EINVAL, "Failed to set key");
313         } else {
314                 if(!chacha_poly1305_set_key(s->outcipher, s->key))
315                         return error(s, EINVAL, "Failed to set key");
316         }
317
318         return true;
319 }
320
321 // Force another Key EXchange (for testing purposes).
322 bool sptps_force_kex(sptps_t *s) {
323         if(!s->outstate || s->state != SPTPS_SECONDARY_KEX)
324                 return error(s, EINVAL, "Cannot force KEX in current state");
325
326         s->state = SPTPS_KEX;
327         return send_kex(s);
328 }
329
330 // Receive a handshake record.
331 static bool receive_handshake(sptps_t *s, const char *data, uint16_t len) {
332         // Only a few states to deal with handshaking.
333         switch(s->state) {
334                 case SPTPS_SECONDARY_KEX:
335                         // We receive a secondary KEX request, first respond by sending our own.
336                         if(!send_kex(s))
337                                 return false;
338                 case SPTPS_KEX:
339                         // We have sent our KEX request, we expect our peer to sent one as well.
340                         if(!receive_kex(s, data, len))
341                                 return false;
342                         s->state = SPTPS_SIG;
343                         return true;
344                 case SPTPS_SIG:
345                         // If we already sent our secondary public ECDH key, we expect the peer to send his.
346                         if(!receive_sig(s, data, len))
347                                 return false;
348                         if(s->outstate)
349                                 s->state = SPTPS_ACK;
350                         else {
351                                 s->outstate = true;
352                                 if(!receive_ack(s, NULL, 0))
353                                         return false;
354                                 s->receive_record(s->handle, SPTPS_HANDSHAKE, NULL, 0);
355                                 s->state = SPTPS_SECONDARY_KEX;
356                         }
357
358                         return true;
359                 case SPTPS_ACK:
360                         // We expect a handshake message to indicate transition to the new keys.
361                         if(!receive_ack(s, data, len))
362                                 return false;
363                         s->receive_record(s->handle, SPTPS_HANDSHAKE, NULL, 0);
364                         s->state = SPTPS_SECONDARY_KEX;
365                         return true;
366                 // TODO: split ACK into a VERify and ACK?
367                 default:
368                         return error(s, EIO, "Invalid session state %d", s->state);
369         }
370 }
371
372 // Check datagram for valid HMAC
373 bool sptps_verify_datagram(sptps_t *s, const void *data, size_t len) {
374         if(!s->instate || len < 21)
375                 return error(s, EIO, "Received short packet");
376
377         uint32_t seqno;
378         memcpy(&seqno, data, 4);
379         seqno = ntohl(seqno);
380         // TODO: check whether seqno makes sense, to avoid CPU intensive decrypt
381
382         char buffer[len];
383         size_t outlen;
384         return chacha_poly1305_decrypt(s->incipher, seqno, data + 4, len - 4, buffer, &outlen);
385 }
386
387 // Receive incoming data, datagram version.
388 static bool sptps_receive_data_datagram(sptps_t *s, const void *vdata, size_t len) {
389         const char *data = vdata;
390
391         if(len < (s->instate ? 21 : 5))
392                 return error(s, EIO, "Received short packet");
393
394         uint32_t seqno;
395         memcpy(&seqno, data, 4);
396         seqno = ntohl(seqno);
397
398         if(!s->instate) {
399                 if(seqno != s->inseqno)
400                         return error(s, EIO, "Invalid packet seqno: %d != %d", seqno, s->inseqno);
401
402                 s->inseqno = seqno + 1;
403
404                 uint8_t type = data[4];
405
406                 if(type != SPTPS_HANDSHAKE)
407                         return error(s, EIO, "Application record received before handshake finished");
408
409                 return receive_handshake(s, data + 5, len - 5);
410         }
411
412         // Decrypt
413
414         char buffer[len];
415
416         size_t outlen;
417
418         if(!chacha_poly1305_decrypt(s->incipher, seqno, data + 4, len - 4, buffer, &outlen))
419                 return error(s, EIO, "Failed to decrypt and verify packet");
420
421         // Replay protection using a sliding window of configurable size.
422         // s->inseqno is expected sequence number
423         // seqno is received sequence number
424         // s->late[] is a circular buffer, a 1 bit means a packet has not been received yet
425         // The circular buffer contains bits for sequence numbers from s->inseqno - s->replaywin * 8 to (but excluding) s->inseqno.
426         if(s->replaywin) {
427                 if(seqno != s->inseqno) {
428                         if(seqno >= s->inseqno + s->replaywin * 8) {
429                                 // TODO: Prevent packets that jump far ahead of the queue from causing many others to be dropped.
430                                 warning(s, "Lost %d packets\n", seqno - s->inseqno);
431                                 // Mark all packets in the replay window as being late.
432                                 memset(s->late, 255, s->replaywin);
433                         } else if (seqno < s->inseqno) {
434                                 // If the sequence number is farther in the past than the bitmap goes, or if the packet was already received, drop it.
435                                 if((s->inseqno >= s->replaywin * 8 && seqno < s->inseqno - s->replaywin * 8) || !(s->late[(seqno / 8) % s->replaywin] & (1 << seqno % 8)))
436                                         return error(s, EIO, "Received late or replayed packet, seqno %d, last received %d\n", seqno, s->inseqno);
437                         } else {
438                                 // We missed some packets. Mark them in the bitmap as being late.
439                                 for(int i = s->inseqno; i < seqno; i++)
440                                         s->late[(i / 8) % s->replaywin] |= 1 << i % 8;
441                         }
442                 }
443
444                 // Mark the current packet as not being late.
445                 s->late[(seqno / 8) % s->replaywin] &= ~(1 << seqno % 8);
446         }
447
448         if(seqno >= s->inseqno)
449                 s->inseqno = seqno + 1;
450
451         if(!s->inseqno)
452                 s->received = 0;
453         else
454                 s->received++;
455
456         // Append a NULL byte for safety.
457         buffer[len - 20] = 0;
458
459         uint8_t type = buffer[0];
460
461         if(type < SPTPS_HANDSHAKE) {
462                 if(!s->instate)
463                         return error(s, EIO, "Application record received before handshake finished");
464                 if(!s->receive_record(s->handle, type, buffer + 1, len - 21))
465                         abort();
466         } else if(type == SPTPS_HANDSHAKE) {
467                 if(!receive_handshake(s, buffer + 1, len - 21))
468                         abort();
469         } else {
470                 return error(s, EIO, "Invalid record type %d", type);
471         }
472
473         return true;
474 }
475
476 // Receive incoming data. Check if it contains a complete record, if so, handle it.
477 bool sptps_receive_data(sptps_t *s, const void *data, size_t len) {
478         if(!s->state)
479                 return error(s, EIO, "Invalid session state zero");
480
481         if(s->datagram)
482                 return sptps_receive_data_datagram(s, data, len);
483
484         while(len) {
485                 // First read the 2 length bytes.
486                 if(s->buflen < 2) {
487                         size_t toread = 2 - s->buflen;
488                         if(toread > len)
489                                 toread = len;
490
491                         memcpy(s->inbuf + s->buflen, data, toread);
492
493                         s->buflen += toread;
494                         len -= toread;
495                         data += toread;
496
497                         // Exit early if we don't have the full length.
498                         if(s->buflen < 2)
499                                 return true;
500
501                         // Get the length bytes
502
503                         memcpy(&s->reclen, s->inbuf, 2);
504                         s->reclen = ntohs(s->reclen);
505
506                         // If we have the length bytes, ensure our buffer can hold the whole request.
507                         s->inbuf = realloc(s->inbuf, s->reclen + 19UL);
508                         if(!s->inbuf)
509                                 return error(s, errno, strerror(errno));
510
511                         // Exit early if we have no more data to process.
512                         if(!len)
513                                 return true;
514                 }
515
516                 // Read up to the end of the record.
517                 size_t toread = s->reclen + (s->instate ? 19UL : 3UL) - s->buflen;
518                 if(toread > len)
519                         toread = len;
520
521                 memcpy(s->inbuf + s->buflen, data, toread);
522                 s->buflen += toread;
523                 len -= toread;
524                 data += toread;
525
526                 // If we don't have a whole record, exit.
527                 if(s->buflen < s->reclen + (s->instate ? 19UL : 3UL))
528                         return true;
529
530                 // Update sequence number.
531
532                 uint32_t seqno = s->inseqno++;
533
534                 // Check HMAC and decrypt.
535                 if(s->instate) {
536                         if(!chacha_poly1305_decrypt(s->incipher, seqno, s->inbuf + 2UL, s->reclen + 17UL, s->inbuf + 2UL, NULL))
537                                 return error(s, EINVAL, "Failed to decrypt and verify record");
538                 }
539
540                 // Append a NULL byte for safety.
541                 s->inbuf[s->reclen + 3UL] = 0;
542
543                 uint8_t type = s->inbuf[2];
544
545                 if(type < SPTPS_HANDSHAKE) {
546                         if(!s->instate)
547                                 return error(s, EIO, "Application record received before handshake finished");
548                         if(!s->receive_record(s->handle, type, s->inbuf + 3, s->reclen))
549                                 return false;
550                 } else if(type == SPTPS_HANDSHAKE) {
551                         if(!receive_handshake(s, s->inbuf + 3, s->reclen))
552                                 return false;
553                 } else {
554                         return error(s, EIO, "Invalid record type %d", type);
555                 }
556
557                 s->buflen = 0;
558         }
559
560         return true;
561 }
562
563 // Start a SPTPS session.
564 bool sptps_start(sptps_t *s, void *handle, bool initiator, bool datagram, ecdsa_t *mykey, ecdsa_t *hiskey, const char *label, size_t labellen, send_data_t send_data, receive_record_t receive_record) {
565         // Initialise struct sptps
566         memset(s, 0, sizeof *s);
567
568         s->handle = handle;
569         s->initiator = initiator;
570         s->datagram = datagram;
571         s->mykey = mykey;
572         s->hiskey = hiskey;
573         s->replaywin = sptps_replaywin;
574         if(s->replaywin) {
575                 s->late = malloc(s->replaywin);
576                 if(!s->late)
577                         return error(s, errno, strerror(errno));
578                 memset(s->late, 0, s->replaywin);
579         }
580
581         s->label = malloc(labellen);
582         if(!s->label)
583                 return error(s, errno, strerror(errno));
584
585         if(!datagram) {
586                 s->inbuf = malloc(7);
587                 if(!s->inbuf)
588                         return error(s, errno, strerror(errno));
589                 s->buflen = 0;
590         }
591
592         memcpy(s->label, label, labellen);
593         s->labellen = labellen;
594
595         s->send_data = send_data;
596         s->receive_record = receive_record;
597
598         // Do first KEX immediately
599         s->state = SPTPS_KEX;
600         return send_kex(s);
601 }
602
603 // Stop a SPTPS session.
604 bool sptps_stop(sptps_t *s) {
605         // Clean up any resources.
606         chacha_poly1305_exit(s->incipher);
607         chacha_poly1305_exit(s->outcipher);
608         ecdh_free(s->ecdh);
609         free(s->inbuf);
610         free(s->mykex);
611         free(s->hiskex);
612         free(s->key);
613         free(s->label);
614         free(s->late);
615         memset(s, 0, sizeof *s);
616         return true;
617 }