Refresh Debian packaging
[grml-etc.git] / etc / kismet / kismet.conf
1 # Kismet config file
2 # Most of the "static" configs have been moved to here -- the command line
3 # config was getting way too crowded and cryptic.  We want functionality,
4 # not continually reading --help!
5
6 # Version of Kismet config
7 version=2005.06.R1
8
9 # Name of server (Purely for organizational purposes)
10 servername=Kismet
11
12 # User to setid to (should be your normal user)
13 #suiduser=your_user_here
14
15 # Sources are defined as:
16 # source=sourcetype,interface,name[,initialchannel]
17 # Source types and required drivers are listed in the README under the
18 # CAPTURE SOURCES section.
19 # The initial channel is optional, if hopping is not enabled it can be used
20 # to set the channel the interface listens on.
21 # YOU MUST CHANGE THIS TO BE THE SOURCE YOU WANT TO USE
22 source=none,none,addme
23 # Usage examples:
24 # source=orinoco,eth2,orinocosource
25 # source=cisco,eth0,ciscosource
26 # source=prism2,wlan0,prism2source
27 # source=prism2_avs,wlan0,newprism2source
28 # source=orinoco,eth0,orinocosource
29 # source=madwifi_b,ath0,madwifi
30 # An example source line with an initial channel:
31 # source=orinoco,eth0,silver,11
32
33 # Comma-separated list of sources to enable.  This is only needed if you defined
34 # multiple sources and only want to enable some of them.  By default, all defined
35 # sources are enabled.
36 # For example:
37 # enablesources=prismsource,ciscosource
38
39 # Do we channelhop?
40 channelhop=true
41
42 # How many channels per second do we hop?  (1-10)
43 channelvelocity=5
44
45 # By setting the dwell time for channel hopping we override the channelvelocity
46 # setting above and dwell on each channel for the given number of seconds.
47 #channeldwell=10
48
49 # Do we split channels between cards on the same spectrum?  This means if 
50 # multiple 802.11b capture sources are defined, they will be offset to cover
51 # the most possible spectrum at a given time.  This also controls splitting
52 # fine-tuned sourcechannels lines which cover multiple interfaces (see below)
53 channelsplit=true
54
55 # Basic channel hopping control:
56 # These define the channels the cards hop through for various frequency ranges
57 # supported by Kismet.   More finegrain control is available via the 
58 # "sourcechannels" configuration option.
59
60 # Don't change the IEEE80211<x> identifiers or channel hopping won't work.
61
62 # Users outside the US might want to use this list:
63 # defaultchannels=IEEE80211b:1,7,13,2,8,3,14,9,4,10,5,11,6,12
64 defaultchannels=IEEE80211b:1,6,11,2,7,3,8,4,9,5,10
65
66 # 802.11g uses the same channels as 802.11b...
67 defaultchannels=IEEE80211g:1,6,11,2,7,3,8,4,9,5,10
68
69 # 802.11a channels are non-overlapping so sequential is fine.  You may want to
70 # adjust the list depending on the channels your card actually supports.
71 # defaultchannels=IEEE80211a:36,40,44,48,52,56,60,64,100,104,108,112,116,120,124,128,132,136,140,149,153,157,161,184,188,192,196,200,204,208,212,216 
72 defaultchannels=IEEE80211a:36,40,44,48,52,56,60,64
73
74 # Combo cards like Atheros use both 'a' and 'b/g' channels.  Of course, you
75 # can also explicitly override a given source.  You can use the script 
76 # extras/listchan.pl to extract all the channels your card supports.
77 defaultchannels=IEEE80211ab:1,6,11,2,7,3,8,4,9,5,10,36,40,44,48,52,56,60,64
78
79 # Fine-tuning channel hopping control:
80 # The sourcechannels option can be used to set the channel hopping for 
81 # specific interfaces, and to control what interfaces share a list of 
82 # channels for split hopping.  This can also be used to easily lock
83 # one card on a single channel while hopping with other cards.
84 # Any card without a sourcechannel definition will use the standard hopping
85 # list.
86 # sourcechannels=sourcename[,sourcename]:ch1,ch2,ch3,...chN
87
88 # ie, for us channels on the source 'prism2source' (same as normal channel
89 # hopping behavior):
90 # sourcechannels=prism2source:1,6,11,2,7,3,8,4,9,5,10
91
92 # Given two capture sources, "prism2a" and "prism2b", we want prism2a to stay
93 # on channel 6 and prism2b to hop normally.  By not setting a sourcechannels 
94 # line for prism2b, it will use the standard hopping.
95 # sourcechannels=prism2a:6
96
97 # To assign the same custom hop channel to multiple sources, or to split the 
98 # same custom hop channel over two sources (if splitchannels is true), list
99 # them all on the same sourcechannels line:
100 # sourcechannels=prism2a,prism2b,prism2c:1,6,11
101
102 # Port to serve GUI data
103 tcpport=2501
104 # People allowed to connect, comma seperated IP addresses or network/mask
105 # blocks.  Netmasks can be expressed as dotted quad (/255.255.255.0) or as
106 # numbers (/24)
107 allowedhosts=127.0.0.1
108 # Address to bind to.  Should be an address already configured already on
109 # this host, reverts to INADDR_ANY if specified incorrectly.
110 bindaddress=127.0.0.1
111 # Maximum number of concurrent GUI's
112 maxclients=5
113
114 # Do we have a GPS?
115 gps=true
116 # Host:port that GPSD is running on.  This can be localhost OR remote!
117 gpshost=localhost:2947
118 # Do we lock the mode?  This overrides coordinates of lock "0", which will
119 # generate some bad information until you get a GPS lock, but it will 
120 # fix problems with GPS units with broken NMEA that report lock 0
121 gpsmodelock=false
122
123 # Packet filtering options:
124 # filter_tracker - Packets filtered from the tracker are not processed or
125 #                  recorded in any way.
126 # filter_dump    - Packets filtered at the dump level are tracked, displayed,
127 #                  and written to the csv/xml/network/etc files, but not 
128 #                  recorded in the packet dump
129 # filter_export  - Controls what packets influence the exported CSV, network,
130 #                  xml, gps, etc files.
131 # All filtering options take arguments containing the type of address and
132 # addresses to be filtered.  Valid address types are 'ANY', 'BSSID',
133 # 'SOURCE', and 'DEST'.  Filtering can be inverted by the use of '!' before
134 # the address.  For example,
135 # filter_tracker=ANY(!00:00:DE:AD:BE:EF)
136 # has the same effect as the previous mac_filter config file option.
137 # filter_tracker=...
138 # filter_dump=...
139 # filter_export=...
140
141 # Alerts to be reported and the throttling rates.
142 # alert=name,throttle/unit,burst/unit
143 # The throttle/unit describes the number of alerts of this type that are
144 # sent per time unit.  Valid time units are second, minute, hour, and day.
145 # Burst rates control the number of packets sent at a time
146 # For example:
147 # alert=FOO,10/min,5/sec
148 # Would allow 5 alerts per second, and 10 alerts total per minute.
149 # A throttle rate of 0 disables throttling of the alert.
150 # See the README for a list of alert types.
151 alert=NETSTUMBLER,10/min,1/sec
152 alert=WELLENREITER,10/min,1/sec
153 alert=LUCENTTEST,10/min,1/sec
154 alert=DEAUTHFLOOD,10/min,2/sec
155 alert=BCASTDISCON,10/min,2/sec
156 alert=CHANCHANGE,5/min,1/sec
157 alert=AIRJACKSSID,5/min,1/sec
158 alert=PROBENOJOIN,10/min,1/sec
159 alert=DISASSOCTRAFFIC,10/min,1/sec
160 alert=NULLPROBERESP,10/min,1/sec
161 alert=BSSTIMESTAMP,10/min,1/sec
162
163 # Known WEP keys to decrypt, bssid,hexkey.  This is only for networks where
164 # the keys are already known, and it may impact throughput on slower hardware.
165 # Multiple wepkey lines may be used for multiple BSSIDs.
166 # wepkey=00:DE:AD:C0:DE:00,FEEDFACEDEADBEEF01020304050607080900
167
168 # Is transmission of the keys to the client allowed?  This may be a security
169 # risk for some.  If you disable this, you will not be able to query keys from
170 # a client.
171 allowkeytransmit=true
172
173 # How often (in seconds) do we write all our data files (0 to disable)
174 writeinterval=300
175
176 # Do we use sound?
177 # Not to be confused with GUI sound parameter, this controls wether or not the
178 # server itself will play sound.  Primarily for headless or automated systems.
179 sound=false
180 # Path to sound player
181 soundplay=/usr/bin/play
182 # Optional parameters to pass to the player
183 # soundopts=--volume=.3
184 # New network found
185 sound_new=//usr/share/kismet/wav/new_network.wav
186 # Wepped new network
187 # sound_new_wep=${prefix}/com/kismet/wav/new_wep_network.wav
188 # Network traffic sound
189 sound_traffic=//usr/share/kismet/wav/traffic.wav
190 # Network junk traffic found
191 sound_junktraffic=//usr/share/kismet/wav/junk_traffic.wav
192 # GPS lock aquired sound
193 # sound_gpslock=//usr/share/kismet/wav/foo.wav
194 # GPS lock lost sound
195 # sound_gpslost=//usr/share/kismet/wav/bar.wav
196 # Alert sound
197 sound_alert=//usr/share/kismet/wav/alert.wav
198
199 # Does the server have speech? (Again, not to be confused with the GUI's speech)
200 speech=false
201 # Server's path to Festival
202 festival=/usr/bin/festival
203 # Are we using festival lite?  If so, set the above "festival" path to also
204 # point to the "flite" binary
205 flite=false
206 # How do we speak?  Valid options:
207 # speech    Normal speech
208 # nato      NATO spellings (alpha, bravo, charlie)
209 # spell     Spell the letters out (aye, bee, sea)
210 speech_type=nato
211 # speech_encrypted and speech_unencrypted - Speech templates
212 # Similar to the logtemplate option, this lets you customize the speech output.
213 # speech_encrypted is used for an encrypted network spoken string
214 # speech_unencrypted is used for an unencrypted network spoken string
215 #
216 # %b is replaced by the BSSID (MAC) of the network
217 # %s is replaced by the SSID (name) of the network
218 # %c is replaced by the CHANNEL of the network
219 # %r is replaced by the MAX RATE of the network
220 speech_encrypted=New network detected, s.s.i.d. %s, channel %c, network encrypted.
221 speech_unencrypted=New network detected, s.s.i.d. %s, channel %c, network open.
222
223 # Where do we get our manufacturer fingerprints from?  Assumed to be in the
224 # default config directory if an absolute path is not given.
225 ap_manuf=ap_manuf
226 client_manuf=client_manuf
227
228 # Use metric measurements in the output?
229 metric=false
230
231 # Do we write waypoints for gpsdrive to load?  Note:  This is NOT related to
232 # recent versions of GPSDrive's native support of Kismet.
233 waypoints=false
234 # GPSDrive waypoint file.  This WILL be truncated.
235 waypointdata=%h/.gpsdrive/way_kismet.txt
236 # Do we want ESSID or BSSID as the waypoint name ?
237 waypoint_essid=false
238
239 # How many alerts do we backlog for new clients?  Only change this if you have
240 # a -very- low memory system and need those extra bytes, or if you have a high
241 # memory system and a huge number of alert conditions.
242 alertbacklog=50
243
244 # File types to log, comma seperated
245 # dump    - raw packet dump
246 # network - plaintext detected networks
247 # csv     - plaintext detected networks in CSV format
248 # xml     - XML formatted network and cisco log
249 # weak    - weak packets (in airsnort format)
250 # cisco   - cisco equipment CDP broadcasts
251 # gps     - gps coordinates
252 logtypes=dump,network,csv,xml,weak,cisco,gps
253
254 # Do we track probe responses and merge probe networks into their owners?
255 # This isn't always desireable, depending on the type of monitoring you're
256 # trying to do.
257 trackprobenets=true
258
259 # Do we log "noise" packets that we can't decipher?  I tend to not, since 
260 # they don't have anything interesting at all in them.
261 noiselog=false
262
263 # Do we log corrupt packets?  Corrupt packets have enough header information
264 # to see what they are, but someting is wrong with them that prevents us from
265 # completely dissecting them.  Logging these is usually not a bad idea.
266 corruptlog=true
267
268 # Do we log beacon packets or do we filter them out of the dumpfile
269 beaconlog=true
270
271 # Do we log PHY layer packets or do we filter them out of the dumpfile
272 phylog=true
273
274 # Do we mangle packets if we can decrypt them or if they're fuzzy-detected
275 mangledatalog=true
276
277 # Do we do "fuzzy" crypt detection?  (byte-based detection instead of 802.11
278 # frame headers)
279 # valid option: Comma seperated list of card types to perform fuzzy detection 
280 #  on, or 'all'
281 fuzzycrypt=wtapfile,wlanng,wlanng_legacy,wlanng_avs,hostap,wlanng_wext,ipw2200,ipw2915
282
283 # Do we use network-classifier fuzzy-crypt detection?  This means we expect 
284 # packets that are associated with an encrypted network to be encrypted too, 
285 # and we process them by the same fuzzy compare. 
286 # This essentially replaces the fuzzycrypt per-source option.
287 netfuzzycrypt=true
288
289 # What type of dump do we generate? 
290 # valid option: "wiretap" 
291 dumptype=wiretap
292 # Do we limit the size of dump logs?  Sometimes ethereal can't handle big ones.
293 # 0 = No limit
294 # Anything else = Max number of packets to log to a single file before closing
295 # and opening a new one.
296 dumplimit=0
297
298 # Do we write data packets to a FIFO for an external data-IDS (such as Snort)?
299 # See the docs before enabling this.
300 #fifo=/tmp/kismet_dump
301
302 # Default log title
303 logdefault=Kismet
304
305 # logtemplate - Filename logging template.
306 # This is, at first glance, really nasty and ugly, but you'll hardly ever
307 # have to touch it so don't complain too much.
308 #
309 # %n is replaced by the logging instance name
310 # %d is replaced by the current date as Mon-DD-YYYY
311 # %D is replaced by the current date as YYYYMMDD
312 # %t is replaced by the starting log time
313 # %i is replaced by the increment log in the case of multiple logs
314 # %l is replaced by the log type (dump, status, crypt, etc)
315 # %h is replaced by the home directory
316 # ie, "netlogs/%n-%d-%i.dump" called with a logging name of "Pok" could expand
317 # to something like "netlogs/Pok-Dec-20-01-1.dump" for the first instance and 
318 # "netlogs/Pok-Dec-20-01-2.%l" for the second logfile generated.
319 # %h/netlots/%n-%d-%i.dump could expand to
320 # /home/foo/netlogs/Pok-Dec-20-01-2.dump
321 #
322 # Other possibilities:  Sorting by directory
323 # logtemplate=%l/%n-%d-%i
324 # Would expand to, for example,
325 # dump/Pok-Dec-20-01-1
326 # crypt/Pok-Dec-20-01-1
327 # and so on.  The "dump", "crypt", etc, dirs must exist before kismet is run
328 # in this case.
329 logtemplate=/var/log/kismet/%n-%d-%i.%l
330
331 # Where do we store the pid file of the server?
332 piddir=/var/run/
333
334 # Where state info, etc, is stored.  You shouldnt ever need to change this.
335 # This is a directory.
336 configdir=/var/lib/kismet/
337
338 # cloaked SSID file.  You shouldn't ever need to change this.
339 ssidmap=ssid_map
340
341 # Group map file.  You shouldn't ever need to change this.
342 groupmap=group_map
343
344 # IP range map file.  You shouldn't ever need to change this.
345 ipmap=ip_map
346