memcmp: Introduce and use consttime_memeq
[secnet] / NOTES
CommitLineData
974d0468 1* Design of new, multi-subnet secnet protocol
2fe58dfd 2
974d0468
SE
3Like the first (1995/6) version, we're tunnelling IP packets inside
4UDP packets. To defeat various restrictions which may be imposed on us
5by network providers (like the prohibition of incoming TCP
6connections) we're sticking with UDP for everything this time,
3454dce4 7including key setup. This means we have to handle retries, etc.
2fe58dfd
SE
8
9Other new features include being able to deal with subnets hidden
10behind changing 'real' IP addresses, and the ability to choose
11algorithms and keys per pair of communicating sites.
12
13** Configuration and structure
14
3454dce4
SE
15[The original plan]
16
2fe58dfd
SE
17The network is made up from a number of 'sites'. These are collections
18of machines with private IP addresses. The new secnet code runs on
19machines which have interfaces on the private site network and some
20way of accessing the 'real' internet.
21
22Each end of a tunnel is identified by a name. Often it will be
23convenient for every gateway machine to use the same name for each
24tunnel endpoint, but this is not vital. Individual tunnels are
25identified by their two endpoint names.
26
3454dce4
SE
27[The new plan]
28
29It appears that people want to be able to use secnet on mobile
30machines like laptops as well as to interconnect sites. In particular,
31they want to be able to use their laptop in three situations:
32
331) connected to their internal LAN by a cable; no tunnel involved
342) connected via wireless, using a tunnel to protect traffic
353) connected to some other network, using a tunnel to access the
36internal LAN.
37
38They want the laptop to keep the same IP address all the time.
39
40Case (1) is simple.
41
42Case (2) requires that the laptop run a copy of secnet, and have a
43tunnel configured between it and the main internal LAN default
44gateway. secnet must support the concept of a 'soft' tunnel where it
45adds a route and causes the gateway to do proxy-ARP when the tunnel is
46up, and removes the route again when the tunnel is down.
47
48The usual prohibition of packets coming in from one tunnel and going
49out another must be relaxed in this case (in particular, the
50destination address of packets from these 'mobile station' tunnels may
51be another tunnel as well as the host).
52
53(Quick sanity check: if chiark's secnet address was in
54192.168.73.0/24, would this work properly? Yes, because there will be
55an explicit route to it, and proxy ARP will be done for it. Do we want
56packets from the chiark tunnel to be able to go out along other
57routes? No. So, spotting a 'local' address in a remote site's list of
58networks isn't sufficient to switch on routing for a site. We need an
59explicit option. NB packets may be routed if the source OR the
60destination is marked as allowing routing [otherwise packets couldn't
61get back from eg. chiark to a laptop at greenend]).
62
4f5e39ec
SE
63[the even newer plan]
64
65secnet sites are configured to grant access to particular IP address
66ranges to the holder of a particular public key. The key can certify
67other keys, which will then be permitted to use a subrange of the IP
68address range of the certifying key.
69
70This means that secnet won't know in advance (i.e. at configuration
71time) how many tunnels it might be required to support, so we have to
72be able to create them (and routes, and so on) on the fly.
73
3454dce4
SE
74** VPN-level configuration
75
76At a high level we just want to be able to indicate which groups of
77users can claim ownership of which ranges of IP addresses. Assuming
78these users (or their representatives) all have accounts on a single
79machine, we can automate the submission of keys and other information
80to make up a 'sites' file for the entire VPN.
81
82The distributed 'sites' file should be in a more restricted format
83than the secnet configuration file, to prevent attackers who manage to
84distribute bogus sites files from taking over their victim's machines.
85
86The distributed 'sites' file is read one line at a time. Each line
87consists of a keyword followed by other information. It defines a
88number of VPNs; within each VPN it defines a number of locations;
89within each location it defines a number of sites. These VPNs,
90locations and sites are turned into a secnet.conf file fragment using
91a script.
92
93Some keywords are valid at any 'level' of the distributed 'sites'
94file, indicating defaults.
95
96The keywords are:
97
98vpn n: we are now declaring information to do with VPN 'n'. Must come first.
99
100location n: we are now declaring information for location 'n'.
101
102site n: we are now declaring information for site 'n'.
103endsite: we're finished declaring information for the current site
104
105restrict-nets a b c ...: restrict the allowable 'networks' for the current
106 level to those in this list.
107end-definitions: prevent definition of further vpns and locations, and
108 modification of defaults at VPN level
109
110dh x y: the current VPN uses the specified group; x=modulus, y=generator
111
112hash x: which hash function to use. Valid options are 'md5' and 'sha1'.
113
114admin n: administrator email address for current level
115
116key-lifetime n
117setup-retries n
118setup-timeout n
119wait-time n
120renegotiate-time n
121
122address a b: a=dnsname, b=port
123networks a b c ...
124pubkey x y z: x=keylen, y=encryption key, z=modulus
125mobile: declare this to be a 'mobile' site
126
b2a56f7c
SE
127** Logging etc.
128
129There are several possible ways of running secnet:
130
131'reporting' only: --version, --help, etc. command line options and the
132--just-check-config mode.
133
134'normal' run: perform setup in the foreground, and then background.
135
136'failed' run: setup in the foreground, and terminate with an error
137before going to background.
138
139'reporting' modes should never output anything except to stdout/stderr.
140'normal' and 'failed' runs output to stdout/stderr before
141backgrounding, then thereafter output only to log destinations.
142
2fe58dfd
SE
143** Protocols
144
145*** Protocol environment:
146
147Each gateway machine serves a particular, well-known set of private IP
148addresses (i.e. the agreement over which addresses it serves is
149outside the scope of this discussion). Each gateway machine has an IP
150address on the interconnecting network (usually the Internet), which
151may be dynamically allocated and may change at any point.
152
153Each gateway knows the RSA public keys of the other gateways with
154which it wishes to communicate. The mechanism by which this happens is
155outside the scope of this discussion. There exists a means by which
156each gateway can look up the probable IP address of any other.
157
158*** Protocol goals:
159
160The ultimate goal of the protocol is for the originating gateway
161machine to be able to forward packets from its section of the private
162network to the appropriate gateway machine for the destination
163machine, in such a way that it can be sure that the packets are being
164sent to the correct destination machine, the destination machine can
165be sure that the source of the packets is the originating gateway
166machine, and the contents of the packets cannot be understood other
167than by the two communicating gateways.
168
169XXX not sure about the address-change stuff; leave it out of the first
170version of the protocol. From experience, IP addresses seem to be
171quite stable so the feature doesn't gain us much.
172
173**** Protocol sub-goal 1: establish a shared key
174
175Definitions:
176
177A is the originating gateway machine
178B is the destination gateway machine
179PK_A is the public RSA key of A
180PK_B is the public RSA key of B
181PK_A^-1 is the private RSA key of A
182PK_B^-1 is the private RSA key of B
183x is the fresh private DH key of A
184y is the fresh private DH key of B
185k is g^xy mod m
186g and m are generator and modulus for Diffie-Hellman
187nA is a nonce generated by A
188nB is a nonce generated by B
189iA is an index generated by A, to be used in packets sent from B to A
190iB is an index generated by B, to be used in packets sent from A to B
191i? is appropriate index for receiver
192
193Note that 'i' may be re-used from one session to the next, whereas 'n'
194is always fresh.
195
ff05a229
SE
196The protocol version selection stuff is not yet implemented: I'm not
197yet convinced it's a good idea. Instead, the initiator could try
198using its preferred protocol (which starts with a different magic
199number) and fall back if there's no reply.
200
2fe58dfd
SE
201Messages:
202
baa06aeb 2031) A->B: *,iA,msg1,A,B,protorange-A,nA
2fe58dfd 204
baa06aeb 2052) B->A: iA,iB,msg2,B,A,chosen-protocol,nB,nA
2fe58dfd
SE
206
207(The order of B and A reverses in alternate messages so that the same
208code can be used to construct them...)
209
baa06aeb 2103) A->B: {iB,iA,msg3,A,B,protorange-A,chosen-protocol,nA,nB,g^x mod m}_PK_A^-1
2fe58dfd
SE
211
212If message 1 was a replay then A will not generate message 3, because
213it doesn't recognise nA.
214
215If message 2 was from an attacker then B will not generate message 4,
216because it doesn't recognise nB.
217
baa06aeb
SE
218If an attacker is trying to manipulate the chosen protocol, B can spot
219this when it sees A's message 3.
220
2214) B->A: {iA,iB,msg4,B,A,protorange-B,chosen-protocol,nB,nA,g^y mod m}_PK_B^-1
2fe58dfd
SE
222
223At this point, A and B share a key, k. B must keep retransmitting
224message 4 until it receives a packet encrypted using key k.
225
baa06aeb
SE
226A can abandon the exchange if the chosen protocol is not the one that
227it would have chosen knowing the acceptable protocol ranges of A and
228B.
229
2fe58dfd
SE
2305) A: iB,iA,msg5,(ping/msg5)_k
231
2326) B: iA,iB,msg6,(pong/msg6)_k
233
234(Note that these are encrypted using the same transform that's used
235for normal traffic, so they include sequence number, MAC, etc.)
236
237The ping and pong messages can be used by either end of the tunnel at
238any time, but using msg0 as the unencrypted message type indicator.
239
240**** Protocol sub-goal 2: end the use of a shared key
241
2427) i?,i?,msg0,(end-session/msg7,A,B)_k
243
244This message can be sent by either party. Once sent, k can be
245forgotten. Once received and checked, k can be forgotten. No need to
246retransmit or confirm reception. It is suggested that this message be
247sent when a key times out, or the tunnel is forcibly terminated for
248some reason.
249
794f2398 2508) i?,i?,NAK (encoded as zero)
2fe58dfd
SE
251
252If the link-layer can't work out what to do with a packet (session has
253gone away, etc.) it can transmit a NAK back to the sender. The sender
254can then try to verify whether the session is alive by sending ping
255packets, and forget the key if it isn't. Potential denial-of-service
256if the attacker can stop the ping/pong packets getting through (the
257key will be forgotten and another key setup must take place), but if
258they can delete packets then we've lost anyway...
259
260The attacker can of course forge NAKs since they aren't protected. But
261if they can only forge packets then they won't be able to stop the
262ping/pong working. Trust in NAKs can be rate-limited...
263
974d0468
SE
264Alternative idea (which is actually implemented): if you receive a
265packet you can't decode, because there's no key established, then
266initiate key setup...
267
268Keepalives are probably a good idea.
2fe58dfd
SE
269
270**** Protocol sub-goal 3: send a packet
271
2729) i?,i?,msg0,(send-packet/msg9,packet)_k
4f5e39ec
SE
273
274Some messages may take a long time to prepare (software modexp on slow
275machines); this is a "please wait" message to indicate that a message
276is in preparation.
277
27810) i?,i?,msg8,A,B,nA,nB,msg?