Document that 1.1 uses AES-256 in GCM mode.
[tinc] / src / sptps.h
1 /*
2     sptps.h -- Simple Peer-to-Peer Security
3     Copyright (C) 2011-2013 Guus Sliepen <guus@tinc-vpn.org>,
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 #ifndef __SPTPS_H__
21 #define __SPTPS_H__
22
23 #include "system.h"
24
25 #include "cipher.h"
26 #include "digest.h"
27 #include "ecdh.h"
28 #include "ecdsa.h"
29
30 #define SPTPS_VERSION 0
31
32 // Record types
33 #define SPTPS_HANDSHAKE 128   // Key exchange and authentication
34 #define SPTPS_ALERT 129       // Warning or error messages
35 #define SPTPS_CLOSE 130       // Application closed the connection
36
37 // Key exchange states
38 #define SPTPS_KEX 1           // Waiting for the first Key EXchange record
39 #define SPTPS_SECONDARY_KEX 2 // Ready to receive a secondary Key EXchange record
40 #define SPTPS_SIG 3           // Waiting for a SIGnature record
41 #define SPTPS_ACK 4           // Waiting for an ACKnowledgement record
42
43 typedef bool (*send_data_t)(void *handle, uint8_t type, const char *data, size_t len);
44 typedef bool (*receive_record_t)(void *handle, uint8_t type, const char *data, uint16_t len);
45
46 typedef struct sptps {
47         bool initiator;
48         bool datagram;
49         int state;
50
51         char *inbuf;
52         size_t buflen;
53         uint16_t reclen;
54
55         bool instate;
56         cipher_t *incipher;
57         digest_t *indigest;
58         uint32_t inseqno;
59         uint32_t received;
60         unsigned int replaywin;
61         unsigned int farfuture;
62         char *late;
63
64         bool outstate;
65         cipher_t *outcipher;
66         digest_t *outdigest;
67         uint32_t outseqno;
68
69         ecdsa_t *mykey;
70         ecdsa_t *hiskey;
71         ecdh_t *ecdh;
72
73         char *mykex;
74         char *hiskex;
75         char *key;
76         char *label;
77         size_t labellen;
78
79         void *handle;
80         send_data_t send_data;
81         receive_record_t receive_record;
82 } sptps_t;
83
84 extern unsigned int sptps_replaywin;
85 extern void sptps_log_quiet(sptps_t *s, int s_errno, const char *format, va_list ap);
86 extern void sptps_log_stderr(sptps_t *s, int s_errno, const char *format, va_list ap);
87 extern void (*sptps_log)(sptps_t *s, int s_errno, const char *format, va_list ap);
88 extern 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);
89 extern bool sptps_stop(sptps_t *s);
90 extern bool sptps_send_record(sptps_t *s, uint8_t type, const char *data, uint16_t len);
91 extern bool sptps_receive_data(sptps_t *s, const char *data, size_t len);
92 extern bool sptps_force_kex(sptps_t *s);
93 extern bool sptps_verify_datagram(sptps_t *s, const char *data, size_t len);
94
95 #endif