(no commit message)
[ikiwiki.git] / docs / handbook / Security / index.mdwn
1 # Security 
2
3 This chapter will provide a basic introduction to system security concepts, some general good rules of thumb, and some advanced topics under DragonFly. A lot of the topics covered here can be applied to system and Internet security in general as well. The Internet is no longer a ***friendly*** place in which everyone wants to be your kind neighbor. Securing your system is imperative to protect your data, intellectual property, time, and much more from the hands of hackers and the like.
4
5 DragonFly provides an array of utilities and mechanisms to ensure the integrity and security of your system and network.
6
7 Before reading this chapter, you should:
8
9 * Understand basic DragonFly and Internet concepts.
10 * Read security(7).
11 * Read [LibreSSL](https://www.libressl.org/).
12
13 **Command vs. Protocol:**  Throughout this document, we will use  **bold**  text to refer to a command or application. This is used for instances such as ssh, since it is a protocol as well as command.
14
15 [[!toc levels=3]]
16
17 ## DES, MD5, and Crypt 
18
19 Every user on a UNIX® system has a password associated with their account. It seems obvious that these passwords need to be known only to the user. In order to keep these passwords secret, they are encrypted with what is known as a ***one-way hash***, that is, they can only be easily encrypted but not decrypted. In other words, the operating system itself does not ***really*** know the password. It only knows the ***encrypted*** form of the password. The only way to get the ***plain-text*** password is by a brute force search of the space of possible passwords.
20
21 Unfortunately the only secure way to encrypt passwords when UNIX came into being was based on DES, the Data Encryption Standard. This was not such a problem for users resident in the US, but since the source code for DES could not be exported outside the US, DragonFly had to find a way to both comply with US law and retain compatibility with all the other UNIX variants that still used DES.
22
23 The solution was to divide up the encryption libraries so that US users could install the DES libraries and use DES but international users still had an encryption method that could be exported abroad. This is how DragonFly came to use MD5 as its default encryption method. MD5 is believed to be more secure than DES, so installing DES is offered primarily for compatibility reasons.
24
25 ### Recognizing Your Crypt Mechanism 
26
27 `libcrypt.a` provides a configurable password authentication hash library. Currently the library supports DES, MD5, Blowfish, SHA256, and SHA512 hash functions. By default DragonFly uses SHA256 to encrypt passwords.
28
29 It is pretty easy to identify which encryption method DragonFly is set up to use. Examining the encrypted passwords in the `/etc/master.passwd` file is one way. Passwords encrypted with the MD5 hash are longer than those encrypted with the DES hash and also begin with the characters `$1$`. Passwords starting with `$2a$` are encrypted with the Blowfish hash function. DES password strings do not have any particular identifying characteristics, but they are shorter than MD5 passwords, and are coded in a 64-character alphabet which does not include the `$` character, so a relatively short string which does not begin with a dollar sign is very likely a DES password.
30
31 The password format used for new passwords is controlled by the `passwd_format` login capability in `/etc/login.conf`, which takes values of `des`, `md5` or `blf`. See the [login.conf(5)](http://leaf.dragonflybsd.org/cgi/web-man?command#login.conf&section5) manual page for more information about login capabilities.
32
33 ## One-time Passwords 
34
35 S/Key is a one-time password scheme based on a one-way hash function. DragonFly uses the MD4 hash for compatibility but other systems have used MD5 and DES-MAC. S/Key ia part of the FreeBSD base system, and is also used on a growing number of other operating systems. S/Key is a registered trademark of Bell Communications Research, Inc.
36
37 There are three different sorts of passwords which we will discuss below. The first is your usual UNIX® style password; we will call this a ***UNIX password***. The second sort is the one-time password which is generated by the S/Key `key` program or the OPIE [opiekey(1)](http://leaf.dragonflybsd.org/cgi/web-man?command#opiekey&section1) program and accepted by the `keyinit` or [opiepasswd(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=opiepasswd&section=1) programs and the login prompt; we will call this a ***one-time password***. The final sort of password is the secret password which you give to the `key`/`opiekey` programs (and sometimes the `keyinit`/`opiepasswd` programs) which it uses to generate one-time passwords; we will call it a ***secret password*** or just unqualified ***password***.
38
39 The secret password does not have anything to do with your UNIX password; they can be the same but this is not recommended. S/Key and OPIE secret passwords are not limited to eight characters like old UNIX passwords[(1)](#FTN.AEN8429), they can be as long as you like. Passwords of six or seven word long phrases are fairly common. For the most part, the S/Key or OPIE system operates completely independently of the UNIX password system.
40
41 Besides the password, there are two other pieces of data that are important to S/Key and OPIE. One is what is known as the ***seed*** or ***key***, consisting of two letters and five digits. The other is what is called the ***iteration count***, a number between 1 and 100. S/Key creates the one-time password by concatenating the seed and the secret password, then applying the MD4/MD5 hash as many times as specified by the iteration count and turning the result into six short English words. These six English words are your one-time password. The authentication system (primarily PAM) keeps track of the last one-time password used, and the user is authenticated if the hash of the user-provided password is equal to the previous password. Because a one-way hash is used it is impossible to generate future one-time passwords if a successfully used password is captured; the iteration count is decremented after each successful login to keep the user and the login program in sync. When the iteration count gets down to 1, S/Key and OPIE must be reinitialized.
42
43 There are three programs involved in each system which we will discuss below. The `key` and `opiekey` programs accept an iteration count, a seed, and a secret password, and generate a one-time password or a consecutive list of one-time passwords. The `keyinit` and `opiepasswd` programs are used to initialize S/Key and OPIE respectively, and to change passwords, iteration counts, or seeds; they take either a secret passphrase, or an iteration count, seed, and one-time password. The `keyinfo` and `opieinfo` programs examine the relevant credentials files (`/etc/skeykeys` or `/etc/opiekeys`) and print out the invoking user's current iteration count and seed.
44
45 There are four different sorts of operations we will cover. The first is using `keyinit` or `opiepasswd` over a secure connection to set up one-time-passwords for the first time, or to change your password or seed. The second operation is using `keyinit` or `opiepasswd` over an insecure connection, in conjunction with `key` or `opiekey` over a secure connection, to do the same. The third is using `key`/`opiekey` to log in over an insecure connection. The fourth is using `key` or `opiekey` to generate a number of keys which can be written down or printed out to carry with you when going to some location without secure connections to anywhere.
46
47 ### Secure Connection Initialization 
48
49 To initialize S/Key for the first time, change your password, or change your seed while logged in over a secure connection (e.g., on the console of a machine or via  **ssh** ), use the `keyinit` command without any parameters while logged in as yourself:
50
51     
52
53     % keyinit
54
55     Adding unfurl:
56
57     Reminder - Only use this method if you are directly connected.
58
59     If you are using telnet or rlogin exit with no password and use keyinit -s.
60
61     Enter secret password:
62
63     Again secret password:
64
65     
66
67     ID unfurl s/key is 99 to17757
68
69     DEFY CLUB PRO NASH LACE SOFT
70
71 For OPIE, `opiepasswd` is used instead:
72
73     
74
75     % opiepasswd -c
76
77     [grimreaper] ~ $ opiepasswd -f -c
78
79     Adding unfurl:
80
81     Only use this method from the console; NEVER from remote. If you are using
82
83     telnet, xterm, or a dial-in, type ^C now or exit with no password.
84
85     Then run opiepasswd without the -c parameter.
86
87     Using MD5 to compute responses.
88
89     Enter new secret pass phrase:
90
91     Again new secret pass phrase:
92
93     ID unfurl OTP key is 499 to4268
94
95     MOS MALL GOAT ARM AVID COED
96
97 At the Enter new secret pass phrase: or Enter secret password: prompts, you should enter a password or phrase. Remember, this is not the password that you will use to login with, this is used to generate your one-time login keys. The ***ID*** line gives the parameters of your particular instance: your login name, the iteration count, and seed. When logging in the system will remember these parameters and present them back to you so you do not have to remember them. The last line gives the particular one-time password which corresponds to those parameters and your secret password; if you were to re-login immediately, this one-time password is the one you would use.
98
99 ### Insecure Connection Initialization 
100
101 To initialize or change your secret password over an insecure connection, you will need to already have a secure connection to some place where you can run `key` or `opiekey`; this might be in the form of a desk accessory on a Macintosh®, or a shell prompt on a machine you trust. You will also need to make up an iteration count (100 is probably a good value), and you may make up your own seed or use a randomly-generated one. Over on the insecure connection (to the machine you are initializing), use the `keyinit -s` command:
102
103     
104
105     % keyinit -s
106
107     Updating unfurl:
108
109     Old key: to17758
110
111     Reminder you need the 6 English words from the key command.
112
113     Enter sequence count from 1 to 9999: 100
114
115     Enter new key [default to17759]:
116
117     s/key 100 to 17759
118
119     s/key access password:
120
121     s/key access password:CURE MIKE BANE HIM RACY GORE
122
123 For OPIE, you need to use `opiepasswd`:
124
125     
126
127     % opiepasswd
128
129     
130
131     Updating unfurl:
132
133     You need the response from an OTP generator.
134
135     Old secret pass phrase:
136
137             otp-md5 498 to4268 ext
138
139             Response: GAME GAG WELT OUT DOWN CHAT
140
141     New secret pass phrase:
142
143             otp-md5 499 to4269
144
145             Response: LINE PAP MILK NELL BUOY TROY
146
147     
148
149     ID mark OTP key is 499 gr4269
150
151     LINE PAP MILK NELL BUOY TROY
152
153 To accept the default seed (which the `keyinit` program confusingly calls a `key`), press  **Return** . Then before entering an access password, move over to your secure connection or S/Key desk accessory, and give it the same parameters:
154
155     % key 100 to17759
156
157     Reminder - Do not use this program while logged in via telnet or rlogin.
158
159     Enter secret password: <secret password>
160
161     CURE MIKE BANE HIM RACY GORE
162
163 Or for OPIE:
164
165     % opiekey 498 to4268
166
167     Using the MD5 algorithm to compute response.
168
169     Reminder: Don't use opiekey from telnet or dial-in sessions.
170
171     Enter secret pass phrase:
172
173     GAME GAG WELT OUT DOWN CHAT
174
175 Now switch back over to the insecure connection, and copy the one-time password generated over to the relevant program.
176
177 ### Generating a Single One-time Password 
178
179 Once you have initialized S/Key, when you login you will be presented with a prompt like this:
180
181     
182
183     % telnet example.com
184
185     Trying 10.0.0.1...
186
187     Connected to example.com
188
189     Escape character is '^]'.
190
191     
192
193     DragonFly/i386 (example.com) (ttypa)
194
195     
196
197     login: <username>
198
199     s/key 97 fw13894
200
201     Password:
202
203 Or for OPIE:
204
205     % telnet example.com
206
207     Trying 10.0.0.1...
208
209     Connected to example.com
210
211     Escape character is '^]'.
212
213     
214
215     DragonFly/i386 (example.com) (ttypa)
216
217     
218
219     login: <username>
220
221     otp-md5 498 gr4269 ext
222
223     Password:
224
225 As a side note, the S/Key and OPIE prompts have a useful feature (not shown here): if you press  **Return**  at the password prompt, the prompter will turn echo on, so you can see what you are typing. This can be extremely useful if you are attempting to type in a password by hand, such as from a printout.
226
227 At this point you need to generate your one-time password to answer this login prompt. This must be done on a trusted system that you can run `key` or `opiekey` on. (There are versions of these for DOS, Windows® and Mac OS® as well.) They need both the iteration count and the seed as command line options. You can cut-and-paste these right from the login prompt on the machine that you are logging in to.
228
229 On the trusted system:
230
231     % key 97 fw13894
232
233     Reminder - Do not use this program while logged in via telnet or rlogin.
234
235     Enter secret password:
236
237     WELD LIP ACTS ENDS ME HAAG
238
239 For OPIE:
240
241     % opiekey 498 to4268
242
243     Using the MD5 algorithm to compute response.
244
245     Reminder: Don't use opiekey from telnet or dial-in sessions.
246
247     Enter secret pass phrase:
248
249     GAME GAG WELT OUT DOWN CHAT
250
251 Now that you have your one-time password you can continue logging in:
252
253     login: <username>
254
255     s/key 97 fw13894
256
257     Password: <return to enable echo>
258
259     s/key 97 fw13894
260
261     Password [echo on]: WELD LIP ACTS ENDS ME HAAG
262
263     Last login: Tue Mar 21 11:56:41 from 10.0.0.2 ...
264
265 ### Generating Multiple One-time Passwords 
266
267 Sometimes you have to go places where you do not have access to a trusted machine or secure connection. In this case, it is possible to use the `key` and `opiekey` commands to generate a number of one-time passwords beforehand to be printed out and taken with you. For example:
268
269     % key -n 5 30 zz99999
270
271     Reminder - Do not use this program while logged in via telnet or rlogin.
272
273     Enter secret password: <secret password>
274
275     26: SODA RUDE LEA LIND BUDD SILT
276
277     27: JILT SPY DUTY GLOW COWL ROT
278
279     28: THEM OW COLA RUNT BONG SCOT
280
281     29: COT MASH BARR BRIM NAN FLAG
282
283     30: CAN KNEE CAST NAME FOLK BILK
284
285 Or for OPIE:
286
287     % opiekey -n 5 30 zz99999
288
289     Using the MD5 algorithm to compute response.
290
291     Reminder: Don't use opiekey from telnet or dial-in sessions.
292
293     Enter secret pass phrase: <secret password>
294
295     26: JOAN BORE FOSS DES NAY QUIT
296
297     27: LATE BIAS SLAY FOLK MUCH TRIG
298
299     28: SALT TIN ANTI LOON NEAL USE
300
301     29: RIO ODIN GO BYE FURY TIC
302
303     30: GREW JIVE SAN GIRD BOIL PHI
304
305 The `-n 5` requests five keys in sequence, the `30` specifies what the last iteration number should be. Note that these are printed out in ***reverse*** order of eventual use. If you are really paranoid, you might want to write the results down by hand; otherwise you can cut-and-paste into `lpr`. Note that each line shows both the iteration count and the one-time password; you may still find it handy to scratch off passwords as you use them.
306
307 ### Restricting Use of UNIX® Passwords 
308
309 S/Key can place restrictions on the use of UNIX passwords based on the host name, user name, terminal port, or IP address of a login session. These restrictions can be found in the configuration file `/etc/skey.access`. The [skey.access(5)](http://leaf.dragonflybsd.org/cgi/web-man?command#skey.access&section5) manual page has more information on the complete format of the file and also details some security cautions to be aware of before depending on this file for security.
310
311 If there is no `/etc/skey.access` file (this is the default), then all users will be allowed to use UNIX passwords. If the file exists, however, then all users will be required to use S/Key unless explicitly permitted to do otherwise by configuration statements in the `skey.access` file. In all cases, UNIX passwords are permitted on the console.
312
313 Here is a sample `skey.access` configuration file which illustrates the three most common sorts of configuration statements:
314
315     
316
317     permit internet 192.168.0.0 255.255.0.0
318
319     permit user fnord
320
321     permit port ttyd0
322
323 The first line (`permit internet`) allows users whose IP source address (which is vulnerable to spoofing) matches the specified value and mask, to use UNIX passwords. This should not be considered a security mechanism, but rather, a means to remind authorized users that they are using an insecure network and need to use S/Key for authentication.
324
325 The second line (`permit user`) allows the specified username, in this case `fnord`, to use UNIX passwords at any time. Generally speaking, this should only be used for people who are either unable to use the `key` program, like those with dumb terminals, or those who are uneducable.
326
327 The third line (`permit port`) allows all users logging in on the specified terminal line to use UNIX passwords; this would be used for dial-ups.
328
329 Here is a sample `opieaccess` file:
330
331     
332
333     permit 192.168.0.0 255.255.0.0
334
335 This line allows users whose IP source address (which is vulnerable to spoofing) matches the specified value and mask, to use UNIX passwords at any time.
336
337 If no rules in `opieaccess` are matched, the default is to deny non-OPIE logins.
338
339 **Note:** under DragonFly the standard login password may be up to 128 characters in length.
340
341 ## Firewalls 
342
343 Firewalls are an area of increasing interest for people who are connected to the Internet, and are even finding applications on private networks to provide enhanced security. This section will hopefully explain what firewalls are, how to use them, and how to use the facilities provided in the DragonFly kernel to implement them.
344
345  **Note:** People often think that having a firewall between your internal network and the ***Big Bad Internet*** will solve all your security problems. It may help, but a poorly set up firewall system is more of a security risk than not having one at all. A firewall can add another layer of security to your systems, but it cannot stop a really determined cracker from penetrating your internal network. If you let internal security lapse because you believe your firewall to be impenetrable, you have just made the crackers job that much easier.
346
347 ### What Is a Firewall? 
348
349 There are currently two distinct types of firewalls in common use on the Internet today. The first type is more properly called a ***packet filtering router***. This type of firewall utilizes a multi-homed machine and a set of rules to determine whether to forward or block individual packets. A multi-homed machine is simply a device with multiple network interfaces. The second type, known as a ***proxy server***, relies on daemons to provide authentication and to forward packets, possibly on a multi-homed machine which has kernel packet forwarding disabled.
350
351 Sometimes sites combine the two types of firewalls, so that only a certain machine (known as a ***bastion host***) is allowed to send packets through a packet filtering router onto an internal network. Proxy services are run on the bastion host, which are generally more secure than normal authentication mechanisms.
352
353 DragonFly comes with a kernel packet filter (known as IPFW), which is what the rest of this section will concentrate on. Proxy servers can be built on DragonFly from third party software, but there is such a variety of proxy servers available that it would be impossible to cover them in this section.
354
355 #### Packet Filtering Routers 
356
357 A router is a machine which forwards packets between two or more networks. A packet filtering router is programmed to compare each packet to a list of rules before deciding if it should be forwarded or not. Most modern IP routing software includes packet filtering functionality that defaults to forwarding all packets. To enable the filters, you need to define a set of rules.
358
359 To decide whether a packet should be passed on, the firewall looks through its set of rules for a rule which matches the contents of the packet's headers. Once a match is found, the rule action is obeyed. The rule action could be to drop the packet, to forward the packet, or even to send an ICMP message back to the originator. Only the first match counts, as the rules are searched in order. Hence, the list of rules can be referred to as a ***rule chain***.
360
361 The packet-matching criteria varies depending on the software used, but typically you can specify rules which depend on the source IP address of the packet, the destination IP address, the source port number, the destination port number (for protocols which support ports), or even the packet type (UDP, TCP, ICMP, etc).
362
363 #### Proxy Servers 
364
365 Proxy servers are machines which have had the normal system daemons ( **telnetd** ,  **ftpd** , etc) replaced with special servers. These servers are called ***proxy servers***, as they normally only allow onward connections to be made. This enables you to run (for example) a proxy  **telnet**  server on your firewall host, and people can  **telnet**  in to your firewall from the outside, go through some authentication mechanism, and then gain access to the internal network (alternatively, proxy servers can be used for signals coming from the internal network and heading out).
366
367 Proxy servers are normally more secure than normal servers, and often have a wider variety of authentication mechanisms available, including ***one-shot*** password systems so that even if someone manages to discover what password you used, they will not be able to use it to gain access to your systems as the password expires immediately after the first use. As they do not actually give users access to the host machine, it becomes a lot more difficult for someone to install backdoors around your security system.
368
369 Proxy servers often have ways of restricting access further, so that only certain hosts can gain access to the servers. Most will also allow the administrator to specify which users can talk to which destination machines. Again, what facilities are available depends largely on what proxy software you choose.
370
371 ### Firewall options in DragonFlyBSD
372
373 DragonFlyBSD inherited the IPFW firewall (versions 1 and 2) when it forked from FreeBSD. Pretty soon after though, we imported the new pf packet filter that the OpenBSD developers created from scratch. It is a cleaner code base and is now the recommended solution for firewalling DragonFly. Keep in mind that the PF version in DragonFly is not in sync with OpenBSD's PF code. We have not yet incorporated the improvements made in PF over the last few years, but we have some improvements of our own. IPFW is still and will remain supported for the foreseeable future; it has some features not yet available in PF.
374
375 A copy of the OpenBSD PF user's guide corresponding to the version of PF in DragonFly can be downloaded as [TXT](https://ftp.openbsd.org/pub/OpenBSD/doc/history/pf-faq45.txt) or [PDF](https://ftp.openbsd.org/pub/OpenBSD/doc/history/pf-faq45.pdf).
376
377 If you're interested in IPFW, read ipfw(4) and ipfw(8).
378
379 #### What Does IPFW Allow Me to Do? 
380
381 IPFW, the software supplied with DragonFly, is a packet filtering and accounting system which resides in the kernel, and has a user-land control utility, [ipfw(8)](http://leaf.dragonflybsd.org/cgi/web-man?command#ipfw&section8). Together, they allow you to define and query the rules used by the kernel in its routing decisions.
382
383 There are two related parts to IPFW. The firewall section performs packet filtering. There is also an IP accounting section which tracks usage of the router, based on rules similar to those used in the firewall section. This allows the administrator to monitor how much traffic the router is getting from a certain machine, or how much WWW traffic it is forwarding, for example.
384
385 As a result of the way that IPFW is designed, you can use IPFW on non-router machines to perform packet filtering on incoming and outgoing connections. This is a special case of the more general use of IPFW, and the same commands and techniques should be used in this situation.
386
387 #### Enabling IPFW on DragonFly 
388
389 As the main part of the IPFW system lives in the kernel, you will need to add one or more options to your kernel configuration file, depending on what facilities you want, and recompile your kernel. See "Reconfiguring your Kernel" ([kernelconfig.html Chapter 9]) for more details on how to recompile your kernel.
390
391  **Warning:** IPFW defaults to a policy of `deny ip from any to any`. If you do not add other rules during startup to allow access, ***you will lock yourself out*** of the server upon rebooting into a firewall-enabled kernel. We suggest that you set `firewall_type=open` in your `/etc/rc.conf` file when first enabling this feature, then refining the firewall rules in `/etc/rc.firewall` after you have tested that the new kernel feature works properly. To be on the safe side, you may wish to consider performing the initial firewall configuration from the local console rather than via  **ssh** . Another option is to build a kernel using both the `IPFIREWALL` and `IPFIREWALL_DEFAULT_TO_ACCEPT` options. This will change the default rule of IPFW to `allow ip from any to any` and avoid the possibility of a lockout.
392
393 There are currently four kernel configuration options relevant to IPFW:
394
395 `options IPFIREWALL`:: Compiles into the kernel the code for packet filtering.`options IPFIREWALL_VERBOSE`:: Enables code to allow logging of packets through [syslogd(8)](http://leaf.dragonflybsd.org/cgi/web-man?command#syslogd&section8). Without this option, even if you specify that packets should be logged in the filter rules, nothing will happen.`options IPFIREWALL_VERBOSE_LIMIT=10`:: Limits the number of packets logged through [syslogd(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=syslogd&section=8) on a per entry basis. You may wish to use this option in hostile environments in which you want to log firewall activity, but do not want to be open to a denial of service attack via syslog flooding.
396
397 When a chain entry reaches the packet limit specified, logging is turned off for that particular entry. To resume logging, you will need to reset the associated counter using the [ipfw(8)](http://leaf.dragonflybsd.org/cgi/web-man?command#ipfw&section8) utility:
398
399     
400
401     # ipfw zero 4500
402
403 Where 4500 is the chain entry you wish to continue logging.`options IPFIREWALL_DEFAULT_TO_ACCEPT`:: This changes the default rule action from ***deny*** to ***allow***. This avoids the possibility of locking yourself out if you happen to boot a kernel with `IPFIREWALL` support but have not configured your firewall yet. It is also very useful if you often use [ipfw(8)](http://leaf.dragonflybsd.org/cgi/web-man?command#ipfw&section8) as a filter for specific problems as they arise. Use with care though, as this opens up the firewall and changes the way it works.
404
405 #### Configuring IPFW 
406
407 The configuration of the IPFW software is done through the [ipfw(8)](http://leaf.dragonflybsd.org/cgi/web-man?command#ipfw&section8) utility. The syntax for this command looks quite complicated, but it is relatively simple once you understand its structure.
408
409 There are currently four different command categories used by the utility: addition/deletion, listing, flushing, and clearing. Addition/deletion is used to build the rules that control how packets are accepted, rejected, and logged. Listing is used to examine the contents of your rule set (otherwise known as the chain) and packet counters (accounting). Flushing is used to remove all entries from the chain. Clearing is used to zero out one or more accounting entries.
410
411 ##### Altering the IPFW Rules 
412
413 The syntax for this form of the command is:
414
415 `ipfw` [-N] command [index] action [log] protocol addresses [options]
416
417 There is one valid flag when using this form of the command:
418
419 -N:: Resolve addresses and service names in output.
420
421 The ***command*** given can be shortened to the shortest unique form. The valid ***commands*** are:
422
423 add:: Add an entry to the firewall/accounting rule listdelete:: Delete an entry from the firewall/accounting rule list
424
425 Previous versions of IPFW used separate firewall and accounting entries. The present version provides packet accounting with each firewall entry.
426
427 If an ***index*** value is supplied, it is used to place the entry at a specific point in the chain. Otherwise, the entry is placed at the end of the chain at an index 100 greater than the last chain entry (this does not include the default policy, rule 65535, deny).
428
429 The `log` option causes matching rules to be output to the system console if the kernel was compiled with `IPFIREWALL_VERBOSE`.
430
431 Valid ***actions*** are:
432
433 reject:: Drop the packet, and send an ICMP host or port unreachable (as appropriate) packet to the source.allow:: Pass the packet on as normal. (aliases: `pass`, `permit`, and `accept`)deny:: Drop the packet. The source is not notified via an ICMP message (thus it appears that the packet never arrived at the destination).count:: Update packet counters but do not allow/deny the packet based on this rule. The search continues with the next chain entry.
434
435 Each ***action*** will be recognized by the shortest unambiguous prefix.
436
437 The ***protocols*** which can be specified are:
438
439 all:: Matches any IP packeticmp:: Matches ICMP packetstcp:: Matches TCP packetsudp:: Matches UDP packets
440
441 The ***address*** specification is:
442
443 from `***address/mask***` [`***port***`] to `***address/mask***` [`***port***`] [via `***interface***`]
444
445 You can only specify `***port***` in conjunction with ***protocols*** which support ports (UDP and TCP).
446
447 The `via` is optional and may specify the IP address or domain name of a local IP interface, or an interface name (e.g. `ed0`) to match only packets coming through this interface. Interface unit numbers can be specified with an optional wildcard. For example, `ppp*` would match all kernel PPP interfaces.
448
449 The syntax used to specify an `***address/mask***` is:
450
451     
452
453     `***address***`
454
455  or
456
457     
458
459     `***address***`/`***mask-bits***`
460
461  or
462
463     
464
465     `***address***`:`***mask-pattern***`
466
467 A valid hostname may be specified in place of the IP address. ' **mask-bits** ' is a decimal number representing how many bits in the address mask should be set. e.g. specifying `192.216.222.1/24` will create a mask which will allow any address in a class C subnet (in this case, `192.216.222`) to be matched. ' **mask-pattern** ' is an IP address which will be logically AND'ed with the address given. The keyword `any` may be used to specify ***any IP address***.
468
469 The port numbers to be blocked are specified as:
470
471 `***port***` [,`***port***` [,`***port***` [...]]]
472
473  to specify either a single port or a list of ports, or
474
475 `***port***`-`***port***`
476
477  to specify a range of ports. You may also combine a single range with a list, but the range must always be specified first.
478
479 The ***options*** available are:
480
481 frag:: Matches if the packet is not the first fragment of the datagram.in:: Matches if the packet is on the way in.out:: Matches if the packet is on the way out.ipoptions `***spec***`:: Matches if the IP header contains the comma separated list of options specified in `***spec***`. The supported IP options are: `ssrr` (strict source route), `lsrr` (loose source route), `rr` (record packet route), and `ts` (time stamp). The absence of a particular option may be specified with a leading `!`.established:: Matches if the packet is part of an already established TCP connection (i.e. it has the RST or ACK bits set). You can optimize the performance of the firewall by placing ***established*** rules early in the chain.setup:: Matches if the packet is an attempt to establish a TCP connection (the SYN bit is set but the ACK bit is not).tcpflags `***flags***`:: Matches if the TCP header contains the comma separated list of `***flags***`. The supported flags are `fin`, `syn`, `rst`, `psh`, `ack`, and `urg`. The absence of a particular flag may be indicated by a leading `!`.icmptypes `***types***`:: Matches if the ICMP type is present in the list `***types***`. The list may be specified as any combination of ranges and/or individual types separated by commas. Commonly used ICMP types are: `0` echo reply (ping reply), `3` destination unreachable, `5` redirect, `8` echo request (ping request), and `11` time exceeded (used to indicate TTL expiration as with [traceroute(8)](http://leaf.dragonflybsd.org/cgi/web-man?command#traceroute&section8)).
482
483 ##### Listing the IPFW Rules 
484
485 The syntax for this form of the command is:
486
487 `ipfw` [-a] [-c] [-d] [-e] [-t] [-N] [-S] list
488
489 There are seven valid flags when using this form of the command:
490
491 -a:: While listing, show counter values. This option is the only way to see accounting counters.-c:: List rules in compact form.-d:: Show dynamic rules in addition to static rules.-e:: If `-d` was specified, also show expired dynamic rules.-t:: Display the last match times for each chain entry. The time listing is incompatible with the input syntax used by the [ipfw(8)](http://leaf.dragonflybsd.org/cgi/web-man?command#ipfw&section8) utility.-N:: Attempt to resolve given addresses and service names.-S:: Show the set each rule belongs to. If this flag is not specified, disabled rules will not be listed.
492
493 ##### Flushing the IPFW Rules 
494
495 The syntax for flushing the chain is:
496
497 `ipfw` flush
498
499 This causes all entries in the firewall chain to be removed except the fixed default policy enforced by the kernel (index 65535). Use caution when flushing rules; the default deny policy will leave your system cut off from the network until allow entries are added to the chain.
500
501 ##### Clearing the IPFW Packet Counters 
502
503 The syntax for clearing one or more packet counters is:
504
505 `ipfw` zero [`***index***`]
506
507 When used without an `***index***` argument, all packet counters are cleared. If an `***index***` is supplied, the clearing operation only affects a specific chain entry.
508
509 #### Example Commands for  **ipfw**  
510
511 This command will deny all packets from the host `evil.crackers.org` to the telnet port of the host `nice.people.org`:
512
513     
514
515     # ipfw add deny tcp from evil.crackers.org to nice.people.org 23
516
517 The next example denies and logs any TCP traffic from the entire `crackers.org` network (a class C) to the `nice.people.org` machine (any port).
518
519     
520
521     # ipfw add deny log tcp from evil.crackers.org/24 to nice.people.org
522
523 If you do not want people sending X sessions to your internal network (a subnet of a class C), the following command will do the necessary filtering:
524
525     
526
527     # ipfw add deny tcp from any to my.org/28 6000 setup
528
529 To see the accounting records:
530
531     
532
533     # ipfw -a list
534
535  or in the short form
536
537     
538
539     # ipfw -a l
540
541 You can also see the last time a chain entry was matched with:
542
543     
544
545     # ipfw -at l
546
547 #### Building a Packet Filtering Firewall 
548
549  **Note:** The following suggestions are just that: suggestions. The requirements of each firewall are different and we cannot tell you how to build a firewall to meet your particular requirements.
550
551 When initially setting up your firewall, unless you have a test bench setup where you can configure your firewall host in a controlled environment, it is strongly recommend you use the logging version of the commands and enable logging in the kernel. This will allow you to quickly identify problem areas and cure them without too much disruption. Even after the initial setup phase is complete, I recommend using the logging for `deny' as it allows tracing of possible attacks and also modification of the firewall rules if your requirements alter.
552
553  **Note:** If you use the logging versions of the `accept` command, be aware that it can generate ***large*** amounts of log data. One log entry will be generated for every packet that passes through the firewall, so large FTP/http transfers, etc, will really slow the system down. It also increases the latencies on those packets as it requires more work to be done by the kernel before the packet can be passed on.  **syslogd**  will also start using up a lot more processor time as it logs all the extra data to disk, and it could quite easily fill the partition `/var/log` is located on.
554
555 You should enable your firewall from `/etc/rc.conf.local` or `/etc/rc.conf`. The associated manual page explains which knobs to fiddle and lists some preset firewall configurations. If you do not use a preset configuration, `ipfw list` will output the current ruleset into a file that you can pass to `rc.conf`. If you do not use `/etc/rc.conf.local` or `/etc/rc.conf` to enable your firewall, it is important to make sure your firewall is enabled before any IP interfaces are configured.
556
557 The next problem is what your firewall should actually ***do***! This is largely dependent on what access to your network you want to allow from the outside, and how much access to the outside world you want to allow from the inside. Some general rules are:
558
559 * Block all incoming access to ports below 1024 for TCP. This is where most of the security sensitive services are, like finger, SMTP (mail) and telnet.
560
561 * Block ***all*** incoming UDP traffic. There are very few useful services that travel over UDP, and what useful traffic there is, is normally a security threat (e.g. Suns RPC and NFS protocols). This has its disadvantages also, since UDP is a connectionless protocol, denying incoming UDP traffic also blocks the replies to outgoing UDP traffic. This can cause a problem for people (on the inside) using external archie (prospero) servers. If you want to allow access to archie, you will have to allow packets coming from ports 191 and 1525 to any internal UDP port through the firewall.  **ntp**  is another service you may consider allowing through, which comes from port 123.
562
563 * Block traffic to port 6000 from the outside. Port 6000 is the port used for access to X11 servers, and can be a security threat (especially if people are in the habit of doing `xhost +` on their workstations). X11 can actually use a range of ports starting at 6000, the upper limit being how many X displays you can run on the machine. The upper limit as defined by RFC 1700 (Assigned Numbers) is 6063.
564
565 * Check what ports any internal servers use (e.g. SQL servers, etc). It is probably a good idea to block those as well, as they normally fall outside the 1-1024 range specified above.
566
567 Another checklist for firewall configuration is available from CERT at http://www.cert.org/tech_tips/packet_filtering.html
568
569 As stated above, these are only ***guidelines***. You will have to decide what filter rules you want to use on your firewall yourself. We cannot accept ANY responsibility if someone breaks into your network, even if you follow the advice given above.
570
571 #### IPFW Overhead and Optimization 
572
573 Many people want to know how much overhead IPFW adds to a system. The answer to this depends mostly on your rule set and processor speed. For most applications dealing with Ethernet and small rule sets, the answer is ***negligible***. For those of you that need actual measurements to satisfy your curiosity, read on.
574
575 The following measurements were made using FreeBSD 2.2.5-STABLE on a 486-66. (While IPFW has changed slightly in later releases of DragonFly, it still performs with similar speed.) IPFW was modified to measure the time spent within the `ip_fw_chk` routine, displaying the results to the console every 1000 packets.
576
577 Two rule sets, each with 1000 rules, were tested. The first set was designed to demonstrate a worst case scenario by repeating the rule:
578
579     
580
581     # ipfw add deny tcp from any to any 55555
582
583 This demonstrates a worst case scenario by causing most of IPFW's packet check routine to be executed before finally deciding that the packet does not match the rule (by virtue of the port number). Following the 999th iteration of this rule was an `allow ip from any to any`.
584
585 The second set of rules were designed to abort the rule check quickly:
586
587     
588
589     # ipfw add deny ip from 1.2.3.4 to 1.2.3.4
590
591 The non-matching source IP address for the above rule causes these rules to be skipped very quickly. As before, the 1000th rule was an `allow ip from any to any`.
592
593 The per-packet processing overhead in the former case was approximately 2.703 ms/packet, or roughly 2.7 microseconds per rule. Thus the theoretical packet processing limit with these rules is around 370 packets per second. Assuming 10 Mbps Ethernet and a ~1500 byte packet size, we would only be able to achieve 55.5% bandwidth utilization.
594
595 For the latter case each packet was processed in approximately 1.172 ms, or roughly 1.2 microseconds per rule. The theoretical packet processing limit here would be about 853 packets per second, which could consume 10 Mbps Ethernet bandwidth.
596
597 The excessive number of rules tested and the nature of those rules do not provide a real-world scenario -- they were used only to generate the timing information presented here. Here are a few things to keep in mind when building an efficient rule set:
598
599 * Place an `established` rule early on to handle the majority of TCP traffic. Do not put any `allow tcp` statements before this rule.
600
601 * Place heavily triggered rules earlier in the rule set than those rarely used (***without changing the permissiveness of the firewall***, of course). You can see which rules are used most often by examining the packet counting statistics with `ipfw -a l`.
602
603 ## VPN over IPsec 
604
605 Creating a VPN between two networks, separated by the Internet, using DragonFly gateways.
606
607 ### Understanding IPsec 
608
609 This section will guide you through the process of setting up IPsec, and to use it in an environment which consists of DragonFly and  **Microsoft® Windows® 2000/XP**  machines, to make them communicate securely. In order to set up IPsec, it is necessary that you are familiar with the concepts of building a custom kernel (see [kernelconfig.html Chapter 9]).
610
611 ***IPsec*** is a protocol which sits on top of the Internet Protocol (IP) layer. It allows two or more hosts to communicate in a secure manner (hence the name). The DragonFly IPsec ***network stack*** is based on the [KAME](http://www.kame.net/) implementation, which has support for both protocol families, IPv4 and IPv6.
612
613 IPsec consists of two sub-protocols:
614
615 * ***Encapsulated Security Payload (ESP)***, protects the IP packet data from third party interference, by encrypting the contents using symmetric cryptography algorithms (like Blowfish, 3DES).
616
617 * ***Authentication Header (AH)***, protects the IP packet header from third party interference and spoofing, by computing a cryptographic checksum and hashing the IP packet header fields with a secure hashing function. This is then followed by an additional header that contains the hash, to allow the information in the packet to be authenticated.
618
619 ESP and AH can either be used together or separately, depending on the environment.
620
621 IPsec can either be used to directly encrypt the traffic between two hosts (known as ***Transport Mode***); or to build ***virtual tunnels*** between two subnets, which could be used for secure communication between two corporate networks (known as ***Tunnel Mode***). The latter is more commonly known as a ***Virtual Private Network (VPN)***. The [ipsec(4)](http://leaf.dragonflybsd.org/cgi/web-man?command#ipsec&section4) manual page should be consulted for detailed information on the IPsec subsystem in DragonFly.
622
623 To add IPsec support to your kernel, add the following options to your kernel configuration file:
624
625     
626
627     options   IPSEC        #IP security
628
629     options   IPSEC_ESP    #IP security (crypto; define w/ IPSEC)
630
631     
632
633 If IPsec debugging support is desired, the following kernel option should also be added:
634
635     
636
637     options   IPSEC_DEBUG  #debug for IP security
638
639     
640
641 ### The Problem 
642
643 There's no standard for what constitutes a VPN. VPNs can be implemented using a number of different technologies, each of which have their own strengths and weaknesses. This article presents a number of scenarios, and strategies for implementing a VPN for each scenario.
644
645 ### Scenario #1: Two networks, connected to the Internet, to behave as one 
646
647 This is the scenario that caused me to first investigating VPNs. The premise is as follows:
648
649 * You have at least two sites
650
651 * Both sites are using IP internally
652
653 * Both sites are connected to the Internet, through a gateway that is running DragonFly.
654
655 * The gateway on each network has at least one public IP address.
656
657 * The internal addresses of the two networks can be public or private IP addresses, it doesn't matter. You can be running NAT on the gateway machine if necessary.
658
659 * The internal IP addresses of the two networks ***do not collide***. While I expect it is theoretically possible to use a combination of VPN technology and NAT to get this to work, I expect it to be a configuration nightmare.
660
661 If you find that you are trying to connect two networks, both of which, internally, use the same private IP address range (e.g., both of them use `192.168.1.x`), then one of the networks will have to be renumbered.
662
663 The network topology might look something like this:
664
665 security/ipsec-network.png
666
667 Notice the two public IP addresses. I'll use the letters to refer to them in the rest of this article. Anywhere you see those letters in this article, replace them with your own public IP addresses. Note also that internally, the two gateway machines have .1 IP addresses, and that the two networks have different private IP addresses (`192.168.1.x` and `192.168.2.x` respectively). All the machines on the private networks have been configured to use the `.1` machine as their default gateway.
668
669 The intention is that, from a network point of view, each network should view the machines on the other network as though they were directly attached the same router -- albeit a slightly slow router with an occasional tendency to drop packets.
670
671 This means that (for example), machine `192.168.1.20` should be able to run
672
673     
674
675     ping 192.168.2.34
676
677 and have it work, transparently. Windows machines should be able to see the machines on the other network, browse file shares, and so on, in exactly the same way that they can browse machines on the local network.
678
679 And the whole thing has to be secure. This means that traffic between the two networks has to be encrypted.
680
681 Creating a VPN between these two networks is a multi-step process. The stages are as follows:
682
683   1. Create a ***virtual*** network link between the two networks, across the Internet. Test it, using tools like [ping(8)](http://leaf.dragonflybsd.org/cgi/web-man?command#ping&section8), to make sure it works.
684
685   1. Apply security policies to ensure that traffic between the two networks is transparently encrypted and decrypted as necessary. Test this, using tools like [tcpdump(1)](http://leaf.dragonflybsd.org/cgi/web-man?command#tcpdump&section1), to ensure that traffic is encrypted.
686
687   1. Configure additional software on the DragonFly gateways, to allow Windows machines to see one another across the VPN.
688
689 #### Step 1: Creating and testing a ***virtual*** network link 
690
691 Suppose that you were logged in to the gateway machine on network #1 (with public IP address `A.B.C.D`, private IP address `192.168.1.1`), and you ran `ping 192.168.2.1`, which is the private address of the machine with IP address `W.X.Y.Z`. What needs to happen in order for this to work?
692
693   1. The gateway machine needs to know how to reach `192.168.2.1`. In other words, it needs to have a route to `192.168.2.1`.
694
695   1. Private IP addresses, such as those in the `192.168.x` range are not supposed to appear on the Internet at large. Instead, each packet you send to `192.168.2.1` will need to be wrapped up inside another packet. This packet will need to appear to be from `A.B.C.D`, and it will have to be sent to `W.X.Y.Z`. This process is called ***encapsulation***.
696
697   1. Once this packet arrives at `W.X.Y.Z` it will need to ***unencapsulated***, and delivered to `192.168.2.1`.
698
699 You can think of this as requiring a ***tunnel*** between the two networks. The two ***tunnel mouths*** are the IP addresses `A.B.C.D` and `W.X.Y.Z`, and the tunnel must be told the addresses of the private IP addresses that will be allowed to pass through it. The tunnel is used to transfer traffic with private IP addresses across the public Internet.
700
701 This tunnel is created by using the generic interface, or `gif` devices on DragonFly. As you can imagine, the `gif` interface on each gateway host must be configured with four IP addresses; two for the public IP addresses, and two for the private IP addresses.
702
703 Support for the gif device must be compiled in to the DragonFly kernel on both machines. You can do this by adding the line:
704
705     
706
707     pseudo-device gif
708
709 to the kernel configuration files on both machines, and then compile, install, and reboot as normal.
710
711 Configuring the tunnel is a two step process. First the tunnel must be told what the outside (or public) IP addresses are, using [gifconfig(8)](http://leaf.dragonflybsd.org/cgi/web-man?command#gifconfig&section8). Then the private IP addresses must be configured using [ifconfig(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=ifconfig&section=8).
712
713 On the gateway machine on network #1 you would run the following two commands to configure the tunnel.
714
715     
716
717     gifconfig gif0 A.B.C.D W.X.Y.Z
718
719     ifconfig gif0 inet 192.168.1.1 192.168.2.1 netmask 0xffffffff
720
721     
722
723 On the other gateway machine you run the same commands, but with the order of the IP addresses reversed.
724
725     
726
727     gifconfig gif0 W.X.Y.Z A.B.C.D
728
729     ifconfig gif0 inet 192.168.2.1 192.168.1.1 netmask 0xffffffff
730
731     
732
733 You can then run:
734
735     
736
737     gifconfig gif0
738
739 to see the configuration. For example, on the network #1 gateway, you would see this:
740
741     
742
743     # gifconfig gif0
744
745     gif0: flags=8011<UP,POINTTOPOINT,MULTICAST> mtu 1280
746
747     inet 192.168.1.1 --> 192.168.2.1 netmask 0xffffffff
748
749     physical address inet A.B.C.D --> W.X.Y.Z
750
751     
752
753 As you can see, a tunnel has been created between the physical addresses `A.B.C.D` and `W.X.Y.Z`, and the traffic allowed through the tunnel is that between `192.168.1.1` and `192.168.2.1`.
754
755 This will also have added an entry to the routing table on both machines, which you can examine with the command `netstat -rn`. This output is from the gateway host on network #1.
756
757     
758
759     # netstat -rn
760
761     Routing tables
762
763     
764
765     Internet:
766
767     Destination      Gateway       Flags    Refs    Use    Netif  Expire
768
769     ...
770
771     192.168.2.1      192.168.1.1   UH        0        0    gif0
772
773     ...
774
775     
776
777 As the ***Flags*** value indicates, this is a host route, which means that each gateway knows how to reach the other gateway, but they do not know how to reach the rest of their respective networks. That problem will be fixed shortly.
778
779 It is likely that you are running a firewall on both machines. This will need to be circumvented for your VPN traffic. You might want to allow all traffic between both networks, or you might want to include firewall rules that protect both ends of the VPN from one another.
780
781 It greatly simplifies testing if you configure the firewall to allow all traffic through the VPN. You can always tighten things up later. If you are using [ipfw(8)](http://leaf.dragonflybsd.org/cgi/web-man?command#ipfw&section8) on the gateway machines then a command like
782
783     
784
785     ipfw add 1 allow ip from any to any via gif0
786
787 will allow all traffic between the two end points of the VPN, without affecting your other firewall rules. Obviously you will need to run this command on both gateway hosts.
788
789 This is sufficient to allow each gateway machine to ping the other. On `192.168.1.1`, you should be able to run
790
791     
792
793     ping 192.168.2.1
794
795 and get a response, and you should be able to do the same thing on the other gateway machine.
796
797 However, you will not be able to reach internal machines on either network yet. This is because of the routing -- although the gateway machines know how to reach one another, they do not know how to reach the network behind each one.
798
799 To solve this problem you must add a static route on each gateway machine. The command to do this on the first gateway would be:
800
801     
802
803     route add 192.168.2.0 192.168.2.1 netmask 0xffffff00
804
805     
806
807 This says ***In order to reach the hosts on the network `192.168.2.0`, send the packets to the host `192.168.2.1`***. You will need to run a similar command on the other gateway, but with the `192.168.1.x` addresses instead.
808
809 IP traffic from hosts on one network will now be able to reach hosts on the other network.
810
811 That has now created two thirds of a VPN between the two networks, in as much as it is ***virtual*** and it is a ***network***. It is not private yet. You can test this using [ping(8)](http://leaf.dragonflybsd.org/cgi/web-man?command#ping&section8) and [tcpdump(1)](http://leaf.dragonflybsd.org/cgi/web-man?command=tcpdump&section=1). Log in to the gateway host and run
812
813     
814
815     tcpdump dst host 192.168.2.1
816
817 In another log in session on the same host run
818
819     
820
821     ping 192.168.2.1
822
823 You will see output that looks something like this:
824
825     
826
827     16:10:24.018080 192.168.1.1 > 192.168.2.1: icmp: echo request
828
829     16:10:24.018109 192.168.1.1 > 192.168.2.1: icmp: echo reply
830
831     16:10:25.018814 192.168.1.1 > 192.168.2.1: icmp: echo request
832
833     16:10:25.018847 192.168.1.1 > 192.168.2.1: icmp: echo reply
834
835     16:10:26.028896 192.168.1.1 > 192.168.2.1: icmp: echo request
836
837     16:10:26.029112 192.168.1.1 > 192.168.2.1: icmp: echo reply
838
839     
840
841 As you can see, the ICMP messages are going back and forth unencrypted. If you had used the `-s` parameter to [tcpdump(1)](http://leaf.dragonflybsd.org/cgi/web-man?command#tcpdump&section1) to grab more bytes of data from the packets you would see more information.
842
843 Obviously this is unacceptable. The next section will discuss securing the link between the two networks so that it all traffic is automatically encrypted.
844
845  **Summary:** 
846
847 * Configure both kernels with ***pseudo-device gif***.
848
849 * Edit `/etc/rc.conf` on gateway host #1 and add the following lines (replacing IP addresses as necessary).
850
851       
852
853       gifconfig_gif0="A.B.C.D W.X.Y.Z"
854
855       ifconfig_gif0="inet 192.168.1.1 192.168.2.1 netmask 0xffffffff"
856
857       static_routes="vpn"
858
859       route_vpn="192.168.2.0 192.168.2.1 netmask 0xffffff00"
860
861   
862
863 * Edit your firewall script (`/etc/rc.firewall`, or similar) on both hosts, and add
864
865       
866
867       ipfw add 1 allow ip from any to any via gif0
868
869   
870
871 * Make similar changes to `/etc/rc.conf` on gateway host #2, reversing the order of IP addresses.
872
873 #### Step 2: Securing the link 
874
875 To secure the link we will be using IPsec. IPsec provides a mechanism for two hosts to agree on an encryption key, and to then use this key in order to encrypt data between the two hosts.
876
877 The are two areas of configuration to be considered here.
878
879   1. There must be a mechanism for two hosts to agree on the encryption mechanism to use. Once two hosts have agreed on this mechanism there is said to be a ***security association*** between them.
880
881   1. There must be a mechanism for specifying which traffic should be encrypted. Obviously, you don't want to encrypt all your outgoing traffic -- you only want to encrypt the traffic that is part of the VPN. The rules that you put in place to determine what traffic will be encrypted are called ***security policies***.
882
883 Security associations and security policies are both maintained by the kernel, and can be modified by userland programs. However, before you can do this you must configure the kernel to support IPsec and the Encapsulated Security Payload (ESP) protocol. This is done by configuring a kernel with:
884
885     options IPSEC
886     options IPSEC_ESP
887
888 and recompiling, reinstalling, and rebooting. As before you will need to do this to the kernels on both of the gateway hosts.
889
890 You have two choices when it comes to setting up security associations. You can configure them by hand between two hosts, which entails choosing the encryption algorithm, encryption keys, and so forth, or you can use daemons that implement the Internet Key Exchange protocol (IKE) to do this for you.
891
892 I recommend the latter. Apart from anything else, it is easier to set up.
893
894 Editing and displaying security policies is carried out using [setkey(8)](http://leaf.dragonflybsd.org/cgi/web-man?command#setkey&section8). By analogy, `setkey` is to the kernel's security policy tables as [route(8)](http://leaf.dragonflybsd.org/cgi/web-man?command=route&section=8) is to the kernel's routing tables. `setkey` can also display the current security associations, and to continue the analogy further, is akin to `netstat -r` in that respect.
895
896 There are a number of choices for daemons to manage security associations with DragonFly. This article will describe how to use one of these, racoon. racoon is in the FreeBSD ports collection, in the security/ category, and is installed in the usual way.
897
898 racoon must be run on both gateway hosts. On each host it is configured with the IP address of the other end of the VPN, and a secret key (which you choose, and must be the same on both gateways).
899
900 The two daemons then contact one another, confirm that they are who they say they are (by using the secret key that you configured). The daemons then generate a new secret key, and use this to encrypt the traffic over the VPN. They periodically change this secret, so that even if an attacker were to crack one of the keys (which is as theoretically close to unfeasible as it gets) it won't do them much good -- by the time they've cracked the key the two daemons have chosen another one.
901
902 racoon's configuration is stored in `${PREFIX}/etc/racoon`. You should find a configuration file there, which should not need to be changed too much. The other component of racoon's configuration, which you will need to change, is the ***pre-shared key***.
903
904 The default racoon configuration expects to find this in the file `${PREFIX}/etc/racoon/psk.txt`. It is important to note that the pre-shared key is ***not*** the key that will be used to encrypt your traffic across the VPN link, it is simply a token that allows the key management daemons to trust one another.
905
906 `psk.txt` contains a line for each remote site you are dealing with. In this example, where there are two sites, each `psk.txt` file will contain one line (because each end of the VPN is only dealing with one other end).
907
908 On gateway host #1 this line should look like this:
909
910     W.X.Y.Z            secret
911
912 That is, the ***public*** IP address of the remote end, whitespace, and a text string that provides the secret. Obviously, you shouldn't use ***secret*** as your key -- the normal rules for choosing a password apply.
913
914 On gateway host #2 the line would look like this:
915
916     A.B.C.D            secret
917
918 That is, the public IP address of the remote end, and the same secret key. `psk.txt` must be mode `0600` (i.e., only read/write to `root`) before racoon will run.
919
920 You must run racoon on both gateway machines. You will also need to add some firewall rules to allow the IKE traffic, which is carried over UDP to the ISAKMP (Internet Security Association Key Management Protocol) port. Again, this should be fairly early in your firewall ruleset.
921
922     ipfw add 1 allow udp from A.B.C.D to W.X.Y.Z isakmp
923
924     ipfw add 1 allow udp from W.X.Y.Z to A.B.C.D isakmp
925
926 Once racoon is running you can try pinging one gateway host from the other. The connection is still not encrypted, but racoon will then set up the security associations between the two hosts -- this might take a moment, and you may see this as a short delay before the ping commands start responding.
927
928 Once the security association has been set up you can view it using [setkey(8)](http://leaf.dragonflybsd.org/cgi/web-man?command#setkey&section8). Run:
929
930     setkey -D
931
932 on either host to view the security association information.
933
934 That's one half of the problem. They other half is setting your security policies.
935
936 To create a sensible security policy, let's review what's been set up so far. This discussions hold for both ends of the link.
937
938 Each IP packet that you send out has a header that contains data about the packet. The header includes the IP addresses of both the source and destination. As we already know, private IP addresses, such as the `192.168.x.y` range are not supposed to appear on the public Internet. Instead, they must first be encapsulated inside another packet. This packet must have the public source and destination IP addresses substituted for the private addresses.
939
940 So if your outgoing packet started looking like this:
941
942 security/ipsec-out-pkt.png
943
944 Then it will be encapsulated inside another packet, looking something like this:
945
946 security/ipsec-encap-pkt.png
947
948 This encapsulation is carried out by the `gif` device. As you can see, the packet now has real IP addresses on the outside, and our original packet has been wrapped up as data inside the packet that will be put out on the Internet.
949
950 Obviously, we want all traffic between the VPNs to be encrypted. You might try putting this in to words, as:
951
952 ***If a packet leaves from `A.B.C.D`, and it is destined for `W.X.Y.Z`, then encrypt it, using the necessary security associations.***
953
954 ***If a packet arrives from `W.X.Y.Z`, and it is destined for `A.B.C.D`, then decrypt it, using the necessary security associations.***
955
956 That's close, but not quite right. If you did this, all traffic to and from `W.X.Y.Z`, even traffic that was not part of the VPN, would be encrypted. That's not quite what you want. The correct policy is as follows
957
958 ***If a packet leaves from `A.B.C.D`, and that packet is encapsulating another packet, and it is destined for `W.X.Y.Z`, then encrypt it, using the necessary security associations.***
959
960 ***If a packet arrives from `W.X.Y.Z`, and that packet is encapsulating another packet, and it is destined for `A.B.C.D`, then encrypt it, using the necessary security associations.***
961
962 A subtle change, but a necessary one.
963
964 Security policies are also set using setkey(8). setkey(8) features a configuration language for defining the policy. You can either enter configuration instructions via stdin, or you can use the `-f` option to specify a filename that contains configuration instructions.
965
966 The configuration on gateway host #1 (which has the public IP address `A.B.C.D`) to force all outbound traffic to `W.X.Y.Z` to be encrypted is:
967
968     spdadd A.B.C.D/32 W.X.Y.Z/32 ipencap -P out ipsec esp/tunnel/A.B.C.D-W.X.Y.Z/require;
969
970 Put these commands in a file (e.g., `/etc/ipsec.conf`) and then run:
971
972     # setkey -f /etc/ipsec.conf
973
974 `spdadd` tells [setkey(8)](http://leaf.dragonflybsd.org/cgi/web-man?command#setkey&section8) that we want to add a rule to the secure policy database. The rest of this line specifies which packets will match this policy. `A.B.C.D/32` and `W.X.Y.Z/32` are the IP addresses and netmasks that identify the network or hosts that this policy will apply to. In this case, we want it to apply to traffic between these two hosts. `ipencap` tells the kernel that this policy should only apply to packets that encapsulate other packets. `-P out` says that this policy applies to outgoing packets, and `ipsec` says that the packet will be secured.
975
976 The second line specifies how this packet will be encrypted. `esp` is the protocol that will be used, while `tunnel` indicates that the packet will be further encapsulated in an IPsec packet. The repeated use of `A.B.C.D` and `W.X.Y.Z` is used to select the security association to use, and the final `require` mandates that packets must be encrypted if they match this rule.
977
978 This rule only matches outgoing packets. You will need a similar rule to match incoming packets.
979
980     spdadd W.X.Y.Z/32 A.B.C.D/32 ipencap -P in ipsec esp/tunnel/W.X.Y.Z-A.B.C.D/require;
981
982 Note the `in` instead of `out` in this case, and the necessary reversal of the IP addresses.
983
984 The other gateway host (which has the public IP address `W.X.Y.Z`) will need similar rules.
985
986     spdadd W.X.Y.Z/32 A.B.C.D/32 ipencap -P out ipsec esp/tunnel/W.X.Y.Z-A.B.C.D/require;
987     spdadd A.B.C.D/32 W.X.Y.Z/32 ipencap -P in ipsec esp/tunnel/A.B.C.D-W.X.Y.Z/require;
988
989 Finally, you need to add firewall rules to allow ESP and IPENCAP packets back and forth. These rules will need to be added to both hosts.
990
991     ipfw add 1 allow esp from A.B.C.D to W.X.Y.Z
992
993     ipfw add 1 allow esp from W.X.Y.Z to A.B.C.D
994
995     ipfw add 1 allow ipencap from A.B.C.D to W.X.Y.Z
996
997     ipfw add 1 allow ipencap from W.X.Y.Z to A.B.C.D
998
999 Because the rules are symmetric you can use the same rules on each gateway host.
1000
1001 Outgoing packets will now look something like this:
1002
1003 security/ipsec-crypt-pkt.png
1004
1005 When they are received by the far end of the VPN they will first be decrypted (using the security associations that have been negotiated by racoon). Then they will enter the `gif` interface, which will unwrap the second layer, until you are left with the innermost packet, which can then travel in to the inner network.
1006
1007 You can check the security using the same [ping(8)](http://leaf.dragonflybsd.org/cgi/web-man?command#ping&section8) test from earlier. First, log in to the `A.B.C.D` gateway machine, and run:
1008
1009     tcpdump dst host 192.168.2.1
1010
1011 In another log in session on the same host run
1012
1013     ping 192.168.2.1
1014
1015 This time you should see output like the following:
1016
1017     XXX tcpdump output
1018
1019 Now, as you can see, [tcpdump(1)](http://leaf.dragonflybsd.org/cgi/web-man?command#tcpdump&section1) shows the ESP packets. If you try to examine them with the `-s` option you will see (apparently) gibberish, because of the encryption.
1020
1021 Congratulations. You have just set up a VPN between two remote sites.
1022
1023  **Summary** 
1024
1025 * Configure both kernels with:
1026
1027       options IPSEC
1028       options IPSEC_ESP
1029
1030 * Install [`security/racoon`](http://pkgsrc.se/security/racoon). Edit `${PREFIX}/etc/racoon/psk.txt` on both gateway hosts, adding an entry for the remote host's IP address and a secret key that they both know. Make sure this file is mode 0600.
1031
1032 * Add the following lines to `/etc/rc.conf` on each host:
1033
1034       ipsec_enable="YES"
1035       ipsec_file="/etc/ipsec.conf"
1036
1037 * Create an `/etc/ipsec.conf` on each host that contains the necessary spdadd lines. On gateway host #1 this would be:
1038
1039       spdadd A.B.C.D/32 W.X.Y.Z/32 ipencap -P out ipsec
1040
1041         esp/tunnel/A.B.C.D-W.X.Y.Z/require;
1042
1043       spdadd W.X.Y.Z/32 A.B.C.D/32 ipencap -P in ipsec
1044
1045         esp/tunnel/W.X.Y.Z-A.B.C.D/require;
1046
1047   On gateway host #2 this would be:
1048
1049       spdadd W.X.Y.Z/32 A.B.C.D/32 ipencap -P out ipsec
1050
1051         esp/tunnel/W.X.Y.Z-A.B.C.D/require;
1052
1053       spdadd A.B.C.D/32 W.X.Y.Z/32 ipencap -P in ipsec
1054
1055         esp/tunnel/A.B.C.D-W.X.Y.Z/require;
1056
1057 * Add firewall rules to allow IKE, ESP, and IPENCAP traffic to both hosts:
1058
1059       ipfw add 1 allow udp from A.B.C.D to W.X.Y.Z isakmp
1060
1061       ipfw add 1 allow udp from W.X.Y.Z to A.B.C.D isakmp
1062
1063       ipfw add 1 allow esp from A.B.C.D to W.X.Y.Z
1064
1065       ipfw add 1 allow esp from W.X.Y.Z to A.B.C.D
1066
1067       ipfw add 1 allow ipencap from A.B.C.D to W.X.Y.Z
1068
1069       ipfw add 1 allow ipencap from W.X.Y.Z to A.B.C.D
1070
1071
1072 The previous two steps should suffice to get the VPN up and running. Machines on each network will be able to refer to one another using IP addresses, and all traffic across the link will be automatically and securely encrypted.