7b2b9921bca3c030b233834146beeeb0b2d60c87
[xonotic/darkplaces.git] / crypto.h
1 #ifndef CRYPTO_H
2 #define CRYPTO_H
3
4 extern cvar_t crypto_developer;
5 extern cvar_t crypto_aeslevel;
6 #define ENCRYPTION_REQUIRED (crypto_aeslevel.integer >= 3)
7
8 extern int crypto_keyfp_recommended_length; // applies to LOCAL IDs, and to ALL keys
9
10 #define CRYPTO_HEADERSIZE 31
11 // AES case causes 16 to 31 bytes overhead
12 // SHA256 case causes 16 bytes overhead as we truncate to 128bit
13
14 #include "lhnet.h"
15
16 #define FP64_SIZE 44
17 #define DHKEY_SIZE 16
18
19 typedef struct
20 {
21         unsigned char dhkey[DHKEY_SIZE]; // shared key, not NUL terminated
22         char client_idfp[FP64_SIZE+1];
23         char client_keyfp[FP64_SIZE+1]; // NULL if signature fail
24         char server_idfp[FP64_SIZE+1];
25         char server_keyfp[FP64_SIZE+1]; // NULL if signature fail
26         qboolean authenticated;
27         qboolean use_aes;
28         void *data;
29 }
30 crypto_t;
31
32 void Crypto_Init(void);
33 void Crypto_Init_Commands(void);
34 void Crypto_LoadKeys(void);
35 void Crypto_Shutdown(void);
36 qboolean Crypto_Available(void);
37 void sha256(unsigned char *out, const unsigned char *in, int n); // may ONLY be called if Crypto_Available()
38 const void *Crypto_EncryptPacket(crypto_t *crypto, const void *data_src, size_t len_src, void *data_dst, size_t *len_dst, size_t len);
39 const void *Crypto_DecryptPacket(crypto_t *crypto, const void *data_src, size_t len_src, void *data_dst, size_t *len_dst, size_t len);
40 #define CRYPTO_NOMATCH 0        // process as usual (packet was not used)
41 #define CRYPTO_MATCH 1          // process as usual (packet was used)
42 #define CRYPTO_DISCARD 2        // discard this packet
43 #define CRYPTO_REPLACE 3        // make the buffer the current packet
44 int Crypto_ClientParsePacket(const char *data_in, size_t len_in, char *data_out, size_t *len_out, lhnetaddress_t *peeraddress);
45 int Crypto_ServerParsePacket(const char *data_in, size_t len_in, char *data_out, size_t *len_out, lhnetaddress_t *peeraddress);
46
47 // if len_out is nonzero, the packet is to be sent to the client
48
49 qboolean Crypto_ServerAppendToChallenge(const char *data_in, size_t len_in, char *data_out, size_t *len_out, size_t maxlen);
50 crypto_t *Crypto_ServerGetInstance(lhnetaddress_t *peeraddress);
51 qboolean Crypto_ServerFinishInstance(crypto_t *out, crypto_t *in); // also clears allocated memory
52 const char *Crypto_GetInfoResponseDataString(void);
53
54 // retrieves a host key for an address (can be exposed to menuqc, or used by the engine to look up stored keys e.g. for server bookmarking)
55 // pointers may be NULL
56 qboolean Crypto_RetrieveHostKey(lhnetaddress_t *peeraddress, int *keyid, char *keyfp, size_t keyfplen, char *idfp, size_t idfplen, int *aeslevel);
57 int Crypto_RetrieveLocalKey(int keyid, char *keyfp, size_t keyfplen, char *idfp, size_t idfplen); // return value: -1 if more to come, +1 if valid, 0 if end of list
58
59 size_t Crypto_SignData(const void *data, size_t datasize, int keyid, void *signed_data, size_t signed_size);
60 size_t Crypto_SignDataDetached(const void *data, size_t datasize, int keyid, void *signed_data, size_t signed_size);
61
62 // netconn protocol:
63 //   non-crypto:
64 //     getchallenge                                            >
65 //                                                             < challenge
66 //     connect                                                 >
67 //                                                             < accept (or: reject)
68 //   crypto:
69 //     getchallenge                                            >
70 //                                                             < challenge SP <challenge> NUL vlen <size> d0pk <fingerprints I can auth to> NUL NUL <other fingerprints I accept>
71 //
72 //     IF serverfp:
73 //     d0pk\cnt\0\challenge\<challenge>\aeslevel\<level> NUL <serverfp> NUL <clientfp>
74 //                                                             >
75 //                                                               check if client would get accepted; if not, do "reject" now
76 //     require non-control packets to be encrypted               require non-control packets to be encrypted
77 //     do not send anything yet                                  do not send anything yet
78 //     RESET to serverfp                                         RESET to serverfp
79 //                                                               d0_blind_id_authenticate_with_private_id_start() = 1
80 //                                                             < d0pk\cnt\1\aes\<aesenabled> NUL *startdata*
81 //     d0_blind_id_authenticate_with_private_id_challenge() = 1
82 //     d0pk\cnt\2 NUL *challengedata*                          >
83 //                                                               d0_blind_id_authenticate_with_private_id_response() = 0
84 //                                                             < d0pk\cnt\3 NUL *responsedata*
85 //     d0_blind_id_authenticate_with_private_id_verify() = 1
86 //     store server's fingerprint NOW
87 //     d0_blind_id_sessionkey_public_id() = 1                    d0_blind_id_sessionkey_public_id() = 1
88 //
89 //     IF clientfp AND NOT serverfp:
90 //     RESET to clientfp                                         RESET to clientfp
91 //     d0_blind_id_authenticate_with_private_id_start() = 1
92 //     d0pk\cnt\0\challenge\<challenge>\aeslevel\<level> NUL NUL <clientfp> NUL *startdata*
93 //                                                             >
94 //                                                               check if client would get accepted; if not, do "reject" now
95 //     require non-control packets to be encrypted               require non-control packets to be encrypted
96 //                                                               d0_blind_id_authenticate_with_private_id_challenge() = 1
97 //                                                             < d0pk\cnt\5\aes\<aesenabled> NUL *challengedata*
98 //
99 //     IF clientfp AND serverfp:
100 //     RESET to clientfp                                         RESET to clientfp
101 //     d0_blind_id_authenticate_with_private_id_start() = 1
102 //     d0pk\cnt\4 NUL *startdata*                              >
103 //                                                               d0_blind_id_authenticate_with_private_id_challenge() = 1
104 //                                                             < d0pk\cnt\5 NUL *challengedata*
105 //
106 //     IF clientfp:
107 //     d0_blind_id_authenticate_with_private_id_response() = 0
108 //     d0pk\cnt\6 NUL *responsedata*                           >
109 //                                                               d0_blind_id_authenticate_with_private_id_verify() = 1
110 //                                                               store client's fingerprint NOW
111 //     d0_blind_id_sessionkey_public_id() = 1                    d0_blind_id_sessionkey_public_id() = 1
112 //     note: the ... is the "connect" message, except without the challenge. Reinterpret as regular connect message on server side
113 //
114 //     enforce encrypted transmission (key is XOR of the two DH keys)
115 //
116 //     IF clientfp:
117 //                                                             < challenge (mere sync message)
118 //
119 //     connect\...                                             >
120 //                                                             < accept (ALWAYS accept if connection is encrypted, ignore challenge as it had been checked before)
121 //
122 //     commence with ingame protocol
123
124 // in short:
125 //   server:
126 //     getchallenge NUL d0_blind_id: reply with challenge with added fingerprints
127 //     cnt=0: IF server will auth, cnt=1, ELSE cnt=5
128 //     cnt=2: cnt=3
129 //     cnt=4: cnt=5
130 //     cnt=6: send "challenge"
131 //   client:
132 //     challenge with added fingerprints: cnt=0; if client will auth but not server, append client auth start
133 //     cnt=1: cnt=2
134 //     cnt=3: IF client will auth, cnt=4, ELSE rewrite as "challenge"
135 //     cnt=5: cnt=6, server will continue by sending "challenge" (let's avoid sending two packets as response to one)
136 // other change:
137 //   accept empty "challenge", and challenge-less connect in case crypto protocol has executed and finished
138 //   statusResponse and infoResponse get an added d0_blind_id key that lists
139 //   the keys the server can auth with and to in key@ca SPACE key@ca notation
140 //   any d0pk\ message has an appended "id" parameter; messages with an unexpected "id" are ignored to prevent errors from multiple concurrent auth runs
141
142
143 // comparison to OTR:
144 // - encryption: yes
145 // - authentication: yes
146 // - deniability: no (attacker requires the temporary session key to prove you
147 //   have sent a specific message, the private key itself does not suffice), no
148 //   measures are taken to provide forgeability to even provide deniability
149 //   against an attacker who knows the temporary session key, as using CTR mode
150 //   for the encryption - which, together with deriving the MAC key from the
151 //   encryption key, and MACing the ciphertexts instead of the plaintexts,
152 //   would provide forgeability and thus deniability - requires longer
153 //   encrypted packets and deniability was not a goal of this, as we may e.g.
154 //   reserve the right to capture packet dumps + extra state info to prove a
155 //   client/server has sent specific packets to prove cheating)
156 // - perfect forward secrecy: yes (session key is derived via DH key exchange)
157
158 #endif