7.5. ConfigurationΒΆ

Tanium HAT has the option of storing configuration items in an INI based file.

Any items that are not provided in the configuration file or are not properly defined in the configuration file will be prompted for at run time.

The default configuration file is tanium_hat.ini. A new configuration file can be generated at any time using the generate_config script. Multiple .ini files can exist, and different ones can be used by calling each .ini file on executing Tanium HAT.

Note

When referencing config[entry] in this documentation, this refers to whatever value the user provided for [entry] in the configuration file

Note

Username/Password can be saved in the ini file. By default this will be in clear text. Consider using crypt_value to obfuscate the strings before saving the file to disk. For more information on crypt_value see 7.8.1. - crypt_value.

Note

When setting a configuration entry in the ini file, do NOT use QUOTES.

ie. customer_name = Contoso

Default tanium_hat.ini configuration file contents (created using generate_config):

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
; # ===========================================================================
; # Generated on 2017-12-28 at 21:19:45 UTC using tanium_hat v1.0.1 '/github/tanium_hat/scripts/generate_config.py'

; # Any values not provided by this configuration file will be prompted by the tool.
; # See end of file for appendices.

; # ===========================================================================
; # Section: 'tanium_hat'
; # Description: Options for how Tanium Hygiene Assessment Tool runs
; # ===========================================================================
[tanium_hat]

; # ---------------------------------------------------------------------------
; # Section: 'tanium_hat' configuration entry 'customer_name'
; # Value type: string template, Default value: ''
; # Prompt used to ask for value if not defined in configuration file:
; # 	Customer name
customer_name =

; # ---------------------------------------------------------------------------
; # Section: 'tanium_hat' configuration entry 'contact_name'
; # Value type: string template, Default value: ''
; # Prompt used to ask for value if not defined in configuration file:
; # 	Contact name
contact_name =

; # ---------------------------------------------------------------------------
; # Section: 'tanium_hat' configuration entry 'data_path'
; # Value type: string template, Default value: 'data'
; # Force absolute path: {TOOL_PATH}
; # Prompt used to ask for value if not defined in configuration file:
; # 	Path to directory to store output files in
data_path = data

; # ---------------------------------------------------------------------------
; # Section: 'tanium_hat' configuration entry 'http_proxy'
; # Value type: string, Default value: ''
; # Empty value allowed: True
; # Prompt used to ask for value if not defined in configuration file:
; # 	HTTP Proxy for internet requests
http_proxy =

; # ---------------------------------------------------------------------------
; # Section: 'tanium_hat' configuration entry 'https_proxy'
; # Value type: string, Default value: ''
; # Empty value allowed: True
; # Prompt used to ask for value if not defined in configuration file:
; # 	HTTPS Proxy for internet requests
https_proxy =

; # ---------------------------------------------------------------------------
; # Section: 'tanium_hat' configuration entry 'get_tanium_data'
; # Value type: boolean, Default value: 'yes'
; # Prompt used to ask for value if not defined in configuration file:
; # 	Get Data From Tanium Server (Build new CSV's in data directory)
get_tanium_data = yes

; # ---------------------------------------------------------------------------
; # Section: 'tanium_hat' configuration entry 'get_internet_data'
; # Value type: boolean, Default value: 'yes'
; # Prompt used to ask for value if not defined in configuration file:
; # 	Get Data From Internet (Build new internet_data.csv in data directory)
get_internet_data = yes

; # ---------------------------------------------------------------------------
; # Section: 'tanium_hat' configuration entry 'analyze_data'
; # Value type: boolean, Default value: 'yes'
; # Prompt used to ask for value if not defined in configuration file:
; # 	Analyze CSV files in data directory (Generate's PPTX file)
analyze_data = yes

; # ---------------------------------------------------------------------------
; # Section: 'tanium_hat' configuration entry 'layouts_path'
; # Value type: string template, Default value: 'layouts'
; # Force absolute path: {TOOL_PATH}
; # Prompt used to ask for value if not defined in configuration file:
; # 	Path to directory containing layout and pptx files
layouts_path = layouts

; # ---------------------------------------------------------------------------
; # Section: 'tanium_hat' configuration entry 'layout_file'
; # Value type: string template, Default value: 'layout_tanium.py'
; # Force absolute path: {layouts_path}
; # Prompt used to ask for value if not defined in configuration file:
; # 	Filename to use as the python layout definitions file
layout_file = layout_tanium.py

; # ---------------------------------------------------------------------------
; # Section: 'tanium_hat' configuration entry 'pptx_output_file'
; # Value type: string template, Default value: '{now}-{customer_name} Hygiene Assessment.pptx'
; # Force absolute path: {data_path}
; # Prompt used to ask for value if not defined in configuration file:
; # 	Filename to use when saving the PPTX file
pptx_output_file = {now}-{customer_name} Hygiene Assessment.pptx

; # ===========================================================================
; # Section: 'plugins'
; # Description: Options for enabling/disabling plugins
; # ===========================================================================
[plugins]

; # ---------------------------------------------------------------------------
; # Section: 'plugins' configuration entry 'enable_all_plugins'
; # Value type: boolean, Default value: 'no'
; # Prompt used to ask for value if not defined in configuration file:
; #     Enable all plugins (do not prompt for each one)
enable_all_plugins = no

; # ---------------------------------------------------------------------------
; # Section: 'plugins' configuration entry 'enable_adobe'
; # Value type: boolean, Default value: 'yes'
; # Prompt used to ask for value if not defined in configuration file:
; #     Enable plugin 'adobe'
enable_adobe = yes

; # ---------------------------------------------------------------------------
; # Section: 'plugins' configuration entry 'enable_java'
; # Value type: boolean, Default value: 'yes'
; # Prompt used to ask for value if not defined in configuration file:
; #     Enable plugin 'java'
enable_java = yes

; # ---------------------------------------------------------------------------
; # Section: 'plugins' configuration entry 'enable_mcafee'
; # Value type: boolean, Default value: 'yes'
; # Prompt used to ask for value if not defined in configuration file:
; #     Enable plugin 'mcafee'
enable_mcafee = yes

; # ---------------------------------------------------------------------------
; # Section: 'plugins' configuration entry 'enable_patch'
; # Value type: boolean, Default value: 'yes'
; # Prompt used to ask for value if not defined in configuration file:
; #     Enable plugin 'patch'
enable_patch = no

; # ---------------------------------------------------------------------------
; # Section: 'plugins' configuration entry 'enable_patch2'
; # Value type: boolean, Default value: 'yes'
; # Prompt used to ask for value if not defined in configuration file:
; #     Enable plugin 'patch2'
enable_patch2 = yes

; # ---------------------------------------------------------------------------
; # Section: 'plugins' configuration entry 'enable_sccm'
; # Value type: boolean, Default value: 'yes'
; # Prompt used to ask for value if not defined in configuration file:
; #     Enable plugin 'sccm'
enable_sccm = yes

; # ---------------------------------------------------------------------------
; # Section: 'plugins' configuration entry 'enable_security'
; # Value type: boolean, Default value: 'yes'
; # Prompt used to ask for value if not defined in configuration file:
; #     Enable plugin 'security'
enable_security = yes

; # ---------------------------------------------------------------------------
; # Section: 'plugins' configuration entry 'enable_symantec'
; # Value type: boolean, Default value: 'yes'
; # Prompt used to ask for value if not defined in configuration file:
; #     Enable plugin 'symantec'
enable_symantec = yes

; # ---------------------------------------------------------------------------
; # Section: 'plugins' configuration entry 'enable_taniumstats'
; # Value type: boolean, Default value: 'yes'
; # Prompt used to ask for value if not defined in configuration file:
; #     Enable plugin 'taniumstats'
enable_taniumstats = yes

; # ---------------------------------------------------------------------------
; # Section: 'plugins' configuration entry 'enable_trendmicro'
; # Value type: boolean, Default value: 'yes'
; # Prompt used to ask for value if not defined in configuration file:
; #     Enable plugin 'trendmicro'
enable_trendmicro = yes

; # ===========================================================================
; # Section: 'tanium_console'
; # Description: Options for connecting to/controlling the Tanium Platform console
; # ===========================================================================
[tanium_console]

; # ---------------------------------------------------------------------------
; # Section: 'tanium_console' configuration entry 'question_percent'
; # Value type: number, Default value: '90'
; # Prompt used to ask for value if not defined in configuration file:
; # 	Consider questions asked by this tool to be complete at this percent of answers returned
question_percent = 90

; # ---------------------------------------------------------------------------
; # Section: 'tanium_console' configuration entry 'host'
; # Value type: string, Default value: ''
; # Prompt used to ask for value if not defined in configuration file:
; # 	Tanium Server Address/IP
host =

; # ---------------------------------------------------------------------------
; # Section: 'tanium_console' configuration entry 'port'
; # Value type: number, Default value: '443'
; # Prompt used to ask for value if not defined in configuration file:
; # 	Tanium Console Port Number
port = 443

; # ---------------------------------------------------------------------------
; # Section: 'tanium_console' configuration entry 'username'
; # Value type: string, Default value: ''
; # Is crypt value: True
; # Prompt used to ask for value if not defined in configuration file:
; # 	Tanium Console Username
username =

; # ---------------------------------------------------------------------------
; # Section: 'tanium_console' configuration entry 'password'
; # Value type: string, Default value: ''
; # Is crypt value: True
; # Prompt used to ask for value if not defined in configuration file:
; # 	Tanium Console Password
password =

; # ===========================================================================
; # APPENDIX OF ENTRY OPTIONS
; # ===========================================================================

; # ---------------------------------------------------------------------------
; # Force absolute path:
; #    If true and the value provided is not an absolute path
; #    the value will be prepended with the path set for force absolute path

; # ---------------------------------------------------------------------------
; # Empty value allowed:
; #    Entries that show this as True are allowed to be empty
; #    All others entries require a non-empty value by default

; # ---------------------------------------------------------------------------
; # Is crypt value:
; #    Entries that show this as True are checked to see if they are a crypted value
; #    Use the 'crypt_value.[sh|bat]' tool to generate a crypted value
; #    Then copy and paste that crypted value into this configuration file

; # ===========================================================================
; # APPENDIX OF VALID VALUES
; # ===========================================================================

; # Valid values for value type: boolean
; #     Yes: 1, true, y, ye, yes
; #      No: 0, false, n, no

; # Valid template keys for value type: string template

; #     N.B. Values shown are dynamically generated!

; #     {any_configuration_entry} = will be replaced with value defined in this file
; #     {BACKUP_ON_FORMAT}        = will be replaced with 'D%Y-%m-%dT%H-%M-%S-%f'
; #     {BACKUP_PATH}             = will be replaced with '/github/tanium_hat/backups'
; #     {CONFIG_FILE}             = will be replaced with 'tanium_hat.ini'
; #     {CONFIG_FILE_PATH}        = will be replaced with '/github/tanium_hat/tanium_hat.ini'
; #     {CONSTANTS_FILE}          = will be replaced with '/github/tanium_hat/tanium_hat/constants.py'
; #     {DEBUG}                   = will be replaced with 'False'
; #     {DEBUG_PPTX}              = will be replaced with 'False'
; #     {INTERNET_FILE_NAME}      = will be replaced with 'internet_data.csv'
; #     {INTERNET_TEST_URL}       = will be replaced with 'https://www.google.com'
; #     {LOG_CON_FORMAT}          = will be replaced with '[%(name)-22s] %(levelname)-8s %(message)s'
; #     {LOG_FILE}                = will be replaced with 'tanium_hat.log'
; #     {LOG_FILE_COUNT}          = will be replaced with '10'
; #     {LOG_FILE_FORMAT}         = will be replaced with '%(asctime)s [%(name)s] [%(funcName)s] %(levelname)-8s %(message)s'
; #     {LOG_FILE_MB}             = will be replaced with '10'
; #     {LOG_GMTIME}              = will be replaced with 'True'
; #     {NOW_FORMAT}              = will be replaced with '%H%M%S-%m%d%Y'
; #     {PKG_PATH}                = will be replaced with '/github/tanium_hat/tanium_hat'
; #     {PLUGINS_MATCH}           = will be replaced with '/github/tanium_hat/plugins/plugin_*.py'
; #     {PLUGINS_PATH}            = will be replaced with '/github/tanium_hat/plugins'
; #     {PLUGIN_WILD}             = will be replaced with 'plugin_*.py'
; #     {PREPARED_ON_FORMAT}      = will be replaced with '%m/%d/%Y'
; #     {PYTAN_EXPORT_FORMAT}     = will be replaced with 'csv'
; #     {PYTAN_SSE}               = will be replaced with 'False'
; #     {TOOL_PATH}               = will be replaced with '/github/tanium_hat'
; #     {ZIP_DEST}                = will be replaced with 'data_D%Y-%m-%dT%H-%M-%S-%f'
; #     {ZIP_FILE}                = will be replaced with 'tanium_hat_{customer_name}_data.zip'
; #     {ZIP_REMOVE_OLD}          = will be replaced with 'True'
; #     {now}                     = will be replaced with '161945-12282017'
; #     {pathsep}                 = will be replaced with '/'
; #     {platform}                = will be replaced with 'Darwin-16.7.0-x86_64-i386-64bit'
; #     {prepared_on}             = will be replaced with '12/28/2017'
; #     {python_version}          = will be replaced with '2.7.14 (v2.7.14:84471935ed, Sep 16 2017, 12:01:12)  [GCC 4.2.1 (Apple Inc. build 5666) (dot 3)]'
; #     {that_version}            = will be replaced with '1.1.0'
; #     {tool_author}             = will be replaced with 'Jim Olsen'
; #     {tool_codename}           = will be replaced with 'broccoli'
; #     {tool_copyright}          = will be replaced with 'Copyright Tanium Inc. 2017'
; #     {tool_description}        = will be replaced with 'Modular framework for extracting and analyzing data from Tanium and the internet into a PowerPoint file.'
; #     {tool_email}              = will be replaced with 'jim.olsen@tanium.com'
; #     {tool_fullname}           = will be replaced with 'Tanium Hygiene Assessment Tool'
; #     {tool_license}            = will be replaced with 'MIT'
; #     {tool_prodstr}            = will be replaced with 'tanium_hat v1.1.0-broccoli'
; #     {tool_propername}         = will be replaced with 'Tanium HAT'
; #     {tool_shortname}          = will be replaced with 'THAT'
; #     {tool_status}             = will be replaced with 'production'
; #     {tool_title}              = will be replaced with 'tanium_hat'
; #     {tool_url}                = will be replaced with 'https://github.com/tanium/tanium_hat'
; #     {tool_version}            = will be replaced with '1.1.0'