Update README.md
[usbkill.git] / install / usbkill.ini
blob8750432fc1accf345e272011fcef002899605d96
1 # _ _ _ _ _
2 # | | | | (_) | |
3 # _ _ ___| |__ | | _ _| | |
4 # | | | |/___) _ \| |_/ ) | | |
5 # | |_| |___ | |_) ) _ (| | | |
6 # |____/(___/|____/|_| \_)_|\_)_)
9 # Hephaestos <hephaestos@riseup.net> - 8764 EF6F D5C1 7838 8D10 E061 CF84 9CE5 42D0 B12B
10 # <https://github.com/hephaest0s/usbkill>
12 # This program is free software: you can redistribute it and/or modify
13 # it under the terms of the GNU General Public License as published by
14 # the Free Software Foundation, either version 3 of the License, or
15 # (at your option) any later version.
17 # This program is distributed in the hope that it will be useful,
18 # but WITHOUT ANY WARRANTY; without even the implied warranty of
19 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 # GNU General Public License for more details.
22 # You should have received a copy of the GNU General Public License
23 # along with this program. If not, see <http://www.gnu.org/licenses/>.
25 [config]
27 ######################## ########################
28 # First are settings about usbkill behavior, then about the kill/destruction commands
29 ######################## ########################
31 ########################
32 # Usbkill behavior commands:
34 # whitelist
35 # sleep
36 # log_file
37 ########################
39 # Whitelist command lists the USB ids that you want whitelisted
40 # How to get the correct usbid for your trusted USB device?
41 # BSD/Linux: run "lsusb", the usbid will looks like this: 0123:9abc
42 # Mac OS X: run "system_profiler SPUSBDataType" in the terminal and find the Vendor/Product ID, it will looks like this:
43 # > Product ID: 0x8403
44 # > Vendor ID: 0x05ac (Apple Inc.)
45 # Take the 4 characters after the 0x and merge them (Vendor ID first), it will look like: 05ac:8403
46 # Be warned! Other parties can copy your trusted usbid to another usb device!
47 # use whitelist command and single space separation as follows:
48 # whitelist = ["4c2a:d2b0", "0b2d:a2c4"]
49 # To allow multiple (2 and 4) USBs with same id: [ {"4c2a:d2b0":2}, {"0b2d:a2c4":4}] or
50 # [ "4c2a:d2b0","4c2a:d2b0", "0b2d:a2c4", ..., "0b2d:a2c4" ] (be consistent)
51 whitelist = []
53 # allow for a certain amount of sleep time between checks, e.g. 0.25 seconds:
54 sleep = 0.25
56 # Log file location:
57 log_file = /var/log/usbkill/usbkill.log
60 ########################
61 # Usbkill destruction commands:
62 # N.B: all these commands are executed in the following order, except that ram and swap-wipe are in parallel.
64 # remove_file_cmd
65 # files_to_remove
66 # folders_to_remove
67 # melt_usbkill
69 # kill_commands
70 # do_sync
72 # wipe_ram
73 # wipe_ram_cmd
74 # wipe_swap
75 # wipe_swap_cmd
76 ########################
78 ##########
79 # Remove commands:
81 # remove_file_cmd
82 # files_to_remove
83 # folders_to_remove
84 # melt_usbkill
85 ##########
87 # use srm to remove files.
88 # Check srm --help for available options
89 remove_file_cmd = srm -l
91 # What files should be removed upon a kill?
92 # Provide absolute paths to the files (paths that start with '/' or '~').
93 # Use " not ' to define the strings, e.g.:
94 # files_to_remove = ["~/Desktop/contacts.txt", "~/Desktop/dpr_journal.txt"]
95 files_to_remove = []
97 # What folders should be removed upon a kill?
98 # Provide absolute paths to the files (paths that start with '/' or '~').
99 # Content in folders will be removed recursively
100 # Use " not ' to define the strings, e.g.:
101 # folders_to_remove = ["~/Desktop/sensitive/", "~/Desktop/dpr_journal_entries/"]
102 folders_to_remove = [ ]
104 # Remove log (folder) and settings (folder) and usbkill program (folder) upon kill?
105 # This might be usefull if you only encrypt portions of your disk (home folder or volumes).
106 # Make sure to sync the system (using do_sync=True) if this is a critical feature for you.
107 # (True/False)
108 melt_usbkill = False
111 ##########
112 # Custom commands:
114 # kill_commands
115 # do_sync
116 ##########
118 # Custom kill commands that can not be specified using above described mechanisms.
119 # This is where you want to release volumes, etc.
120 # These commands will run in order and as root, as the last commands.
121 # Sync should be activated once more if you want to sync
122 # Use " not ' to define the strings, e.g.:
123 # kill_commands = [ "bash ~/scripts/destroy.sh", "sync" ]
124 kill_commands = [ ]
126 # Should usbkill sync the file system for you?
127 # This should not be a problem on most computers.
128 # Sync will save some of your work to disk before killing your computer.
129 do_sync = True
131 ##########
132 # Wipe commands:
133 # Note: if both are set, the commands are excecuted in parallel.
134 # These commands will take a long time to complete and also make the device unresponsive!
135 # These commands will greatly stall the halting of your system!
137 # do_wipe_swap
138 # wipe_swap_cmd
139 # do_wipe_ram
140 # wipe_ram_cmd
141 ##########
144 # Set do_wipe_ram to True in order clean the ram.
145 do_wipe_ram = False
146 # Check sdmem --help for available options
147 wipe_ram_cmd = sdmem -fll
149 # Set do_wipe_swap to True in order clean the swap.
150 do_wipe_swap = False
151 # Check sswap --help for available options
152 wipe_swap_cmd = sswap -l