inspec 1.51.6 → 1.51.15

Sign up to get free protection for your applications and to get access to all the features.
Files changed (404) hide show
  1. checksums.yaml +4 -4
  2. data/.rubocop.yml +101 -101
  3. data/CHANGELOG.md +2915 -2902
  4. data/Gemfile +53 -53
  5. data/LICENSE +14 -14
  6. data/MAINTAINERS.md +31 -31
  7. data/MAINTAINERS.toml +47 -47
  8. data/README.md +419 -419
  9. data/Rakefile +167 -167
  10. data/bin/inspec +12 -12
  11. data/docs/.gitignore +2 -2
  12. data/docs/README.md +40 -40
  13. data/docs/dsl_inspec.md +258 -258
  14. data/docs/dsl_resource.md +93 -93
  15. data/docs/glossary.md +99 -99
  16. data/docs/habitat.md +191 -191
  17. data/docs/inspec_and_friends.md +107 -107
  18. data/docs/matchers.md +165 -165
  19. data/docs/migration.md +293 -293
  20. data/docs/plugin_kitchen_inspec.md +49 -49
  21. data/docs/profiles.md +370 -370
  22. data/docs/resources/aide_conf.md.erb +78 -78
  23. data/docs/resources/apache.md.erb +66 -66
  24. data/docs/resources/apache_conf.md.erb +67 -67
  25. data/docs/resources/apt.md.erb +70 -70
  26. data/docs/resources/audit_policy.md.erb +46 -46
  27. data/docs/resources/auditd.md.erb +78 -78
  28. data/docs/resources/auditd_conf.md.erb +68 -68
  29. data/docs/resources/auditd_rules.md.erb +116 -116
  30. data/docs/resources/bash.md.erb +74 -74
  31. data/docs/resources/bond.md.erb +89 -89
  32. data/docs/resources/bridge.md.erb +54 -54
  33. data/docs/resources/bsd_service.md.erb +65 -65
  34. data/docs/resources/command.md.erb +137 -137
  35. data/docs/resources/cpan.md.erb +77 -77
  36. data/docs/resources/cran.md.erb +63 -63
  37. data/docs/resources/crontab.md.erb +87 -87
  38. data/docs/resources/csv.md.erb +53 -53
  39. data/docs/resources/dh_params.md.erb +216 -216
  40. data/docs/resources/directory.md.erb +28 -28
  41. data/docs/resources/docker.md.erb +163 -163
  42. data/docs/resources/docker_container.md.erb +99 -99
  43. data/docs/resources/docker_image.md.erb +93 -93
  44. data/docs/resources/docker_service.md.erb +113 -113
  45. data/docs/resources/elasticsearch.md.erb +230 -230
  46. data/docs/resources/etc_fstab.md.erb +124 -124
  47. data/docs/resources/etc_group.md.erb +74 -74
  48. data/docs/resources/etc_hosts.md.erb +75 -75
  49. data/docs/resources/etc_hosts_allow.md.erb +73 -73
  50. data/docs/resources/etc_hosts_deny.md.erb +73 -73
  51. data/docs/resources/file.md.erb +512 -512
  52. data/docs/resources/filesystem.md.erb +40 -40
  53. data/docs/resources/firewalld.md.erb +105 -105
  54. data/docs/resources/gem.md.erb +78 -78
  55. data/docs/resources/group.md.erb +60 -60
  56. data/docs/resources/grub_conf.md.erb +101 -100
  57. data/docs/resources/host.md.erb +77 -77
  58. data/docs/resources/http.md.erb +104 -98
  59. data/docs/resources/iis_app.md.erb +120 -116
  60. data/docs/resources/iis_site.md.erb +132 -128
  61. data/docs/resources/inetd_conf.md.erb +95 -84
  62. data/docs/resources/ini.md.erb +72 -69
  63. data/docs/resources/interface.md.erb +55 -46
  64. data/docs/resources/iptables.md.erb +63 -63
  65. data/docs/resources/json.md.erb +61 -61
  66. data/docs/resources/kernel_module.md.erb +106 -106
  67. data/docs/resources/kernel_parameter.md.erb +58 -58
  68. data/docs/resources/key_rsa.md.erb +73 -73
  69. data/docs/resources/launchd_service.md.erb +56 -56
  70. data/docs/resources/limits_conf.md.erb +66 -66
  71. data/docs/resources/login_def.md.erb +62 -62
  72. data/docs/resources/mount.md.erb +68 -68
  73. data/docs/resources/mssql_session.md.erb +59 -59
  74. data/docs/resources/mysql_conf.md.erb +98 -98
  75. data/docs/resources/mysql_session.md.erb +73 -73
  76. data/docs/resources/nginx.md.erb +78 -78
  77. data/docs/resources/nginx_conf.md.erb +127 -127
  78. data/docs/resources/npm.md.erb +59 -59
  79. data/docs/resources/ntp_conf.md.erb +59 -59
  80. data/docs/resources/oneget.md.erb +52 -52
  81. data/docs/resources/oracledb_session.md.erb +51 -51
  82. data/docs/resources/os.md.erb +140 -140
  83. data/docs/resources/os_env.md.erb +77 -77
  84. data/docs/resources/package.md.erb +119 -119
  85. data/docs/resources/packages.md.erb +66 -66
  86. data/docs/resources/parse_config.md.erb +102 -102
  87. data/docs/resources/parse_config_file.md.erb +137 -137
  88. data/docs/resources/passwd.md.erb +140 -140
  89. data/docs/resources/pip.md.erb +66 -66
  90. data/docs/resources/port.md.erb +136 -136
  91. data/docs/resources/postgres_conf.md.erb +78 -78
  92. data/docs/resources/postgres_hba_conf.md.erb +92 -92
  93. data/docs/resources/postgres_ident_conf.md.erb +75 -75
  94. data/docs/resources/postgres_session.md.erb +68 -68
  95. data/docs/resources/powershell.md.erb +101 -101
  96. data/docs/resources/processes.md.erb +107 -107
  97. data/docs/resources/rabbitmq_config.md.erb +40 -40
  98. data/docs/resources/registry_key.md.erb +157 -157
  99. data/docs/resources/runit_service.md.erb +56 -56
  100. data/docs/resources/security_policy.md.erb +46 -46
  101. data/docs/resources/service.md.erb +120 -120
  102. data/docs/resources/shadow.md.erb +143 -143
  103. data/docs/resources/ssh_config.md.erb +79 -79
  104. data/docs/resources/sshd_config.md.erb +82 -82
  105. data/docs/resources/ssl.md.erb +118 -118
  106. data/docs/resources/sys_info.md.erb +41 -41
  107. data/docs/resources/systemd_service.md.erb +56 -56
  108. data/docs/resources/sysv_service.md.erb +56 -56
  109. data/docs/resources/upstart_service.md.erb +56 -56
  110. data/docs/resources/user.md.erb +139 -139
  111. data/docs/resources/users.md.erb +126 -126
  112. data/docs/resources/vbscript.md.erb +54 -54
  113. data/docs/resources/virtualization.md.erb +56 -56
  114. data/docs/resources/windows_feature.md.erb +46 -46
  115. data/docs/resources/windows_hotfix.md.erb +52 -52
  116. data/docs/resources/windows_task.md.erb +89 -89
  117. data/docs/resources/wmi.md.erb +80 -80
  118. data/docs/resources/x509_certificate.md.erb +150 -150
  119. data/docs/resources/xinetd_conf.md.erb +155 -155
  120. data/docs/resources/xml.md.erb +84 -84
  121. data/docs/resources/yaml.md.erb +68 -68
  122. data/docs/resources/yum.md.erb +97 -97
  123. data/docs/resources/zfs_dataset.md.erb +52 -52
  124. data/docs/resources/zfs_pool.md.erb +46 -46
  125. data/docs/ruby_usage.md +203 -203
  126. data/docs/shared/matcher_be.md.erb +1 -1
  127. data/docs/shared/matcher_cmp.md.erb +43 -43
  128. data/docs/shared/matcher_eq.md.erb +3 -3
  129. data/docs/shared/matcher_include.md.erb +1 -1
  130. data/docs/shared/matcher_match.md.erb +1 -1
  131. data/docs/shell.md +172 -172
  132. data/examples/README.md +8 -8
  133. data/examples/inheritance/README.md +65 -65
  134. data/examples/inheritance/controls/example.rb +14 -14
  135. data/examples/inheritance/inspec.yml +15 -15
  136. data/examples/kitchen-ansible/.kitchen.yml +25 -25
  137. data/examples/kitchen-ansible/Gemfile +19 -19
  138. data/examples/kitchen-ansible/README.md +53 -53
  139. data/examples/kitchen-ansible/files/nginx.repo +6 -6
  140. data/examples/kitchen-ansible/tasks/main.yml +16 -16
  141. data/examples/kitchen-ansible/test/integration/default/default.yml +5 -5
  142. data/examples/kitchen-ansible/test/integration/default/web_spec.rb +28 -28
  143. data/examples/kitchen-chef/.kitchen.yml +20 -20
  144. data/examples/kitchen-chef/Berksfile +3 -3
  145. data/examples/kitchen-chef/Gemfile +19 -19
  146. data/examples/kitchen-chef/README.md +27 -27
  147. data/examples/kitchen-chef/metadata.rb +7 -7
  148. data/examples/kitchen-chef/recipes/default.rb +6 -6
  149. data/examples/kitchen-chef/recipes/nginx.rb +30 -30
  150. data/examples/kitchen-chef/test/integration/default/web_spec.rb +28 -28
  151. data/examples/kitchen-puppet/.kitchen.yml +22 -22
  152. data/examples/kitchen-puppet/Gemfile +20 -20
  153. data/examples/kitchen-puppet/Puppetfile +25 -25
  154. data/examples/kitchen-puppet/README.md +53 -53
  155. data/examples/kitchen-puppet/manifests/site.pp +33 -33
  156. data/examples/kitchen-puppet/metadata.json +11 -11
  157. data/examples/kitchen-puppet/test/integration/default/web_spec.rb +28 -28
  158. data/examples/meta-profile/README.md +37 -37
  159. data/examples/meta-profile/controls/example.rb +13 -13
  160. data/examples/meta-profile/inspec.yml +13 -13
  161. data/examples/profile-attribute.yml +2 -2
  162. data/examples/profile-attribute/README.md +14 -14
  163. data/examples/profile-attribute/controls/example.rb +11 -11
  164. data/examples/profile-attribute/inspec.yml +8 -8
  165. data/examples/profile-sensitive/README.md +29 -29
  166. data/examples/profile-sensitive/controls/sensitive-failures.rb +9 -9
  167. data/examples/profile-sensitive/controls/sensitive.rb +9 -9
  168. data/examples/profile-sensitive/inspec.yml +8 -8
  169. data/examples/profile/README.md +48 -48
  170. data/examples/profile/controls/example.rb +23 -23
  171. data/examples/profile/controls/gordon.rb +36 -36
  172. data/examples/profile/controls/meta.rb +34 -34
  173. data/examples/profile/inspec.yml +10 -10
  174. data/examples/profile/libraries/gordon_config.rb +53 -53
  175. data/inspec.gemspec +47 -47
  176. data/lib/bundles/README.md +3 -3
  177. data/lib/bundles/inspec-artifact.rb +7 -7
  178. data/lib/bundles/inspec-artifact/README.md +1 -1
  179. data/lib/bundles/inspec-artifact/cli.rb +277 -277
  180. data/lib/bundles/inspec-compliance.rb +16 -16
  181. data/lib/bundles/inspec-compliance/.kitchen.yml +20 -20
  182. data/lib/bundles/inspec-compliance/README.md +185 -185
  183. data/lib/bundles/inspec-compliance/api.rb +316 -316
  184. data/lib/bundles/inspec-compliance/api/login.rb +152 -152
  185. data/lib/bundles/inspec-compliance/bootstrap.sh +41 -41
  186. data/lib/bundles/inspec-compliance/cli.rb +277 -277
  187. data/lib/bundles/inspec-compliance/configuration.rb +103 -103
  188. data/lib/bundles/inspec-compliance/http.rb +86 -86
  189. data/lib/bundles/inspec-compliance/support.rb +36 -36
  190. data/lib/bundles/inspec-compliance/target.rb +98 -98
  191. data/lib/bundles/inspec-compliance/test/integration/default/cli.rb +93 -93
  192. data/lib/bundles/inspec-habitat.rb +12 -12
  193. data/lib/bundles/inspec-habitat/cli.rb +36 -36
  194. data/lib/bundles/inspec-habitat/log.rb +10 -10
  195. data/lib/bundles/inspec-habitat/profile.rb +390 -390
  196. data/lib/bundles/inspec-init.rb +8 -8
  197. data/lib/bundles/inspec-init/README.md +31 -31
  198. data/lib/bundles/inspec-init/cli.rb +97 -97
  199. data/lib/bundles/inspec-init/templates/profile/README.md +3 -3
  200. data/lib/bundles/inspec-init/templates/profile/controls/example.rb +19 -19
  201. data/lib/bundles/inspec-init/templates/profile/inspec.yml +8 -8
  202. data/lib/bundles/inspec-supermarket.rb +13 -13
  203. data/lib/bundles/inspec-supermarket/README.md +45 -45
  204. data/lib/bundles/inspec-supermarket/api.rb +84 -84
  205. data/lib/bundles/inspec-supermarket/cli.rb +65 -65
  206. data/lib/bundles/inspec-supermarket/target.rb +34 -34
  207. data/lib/fetchers/git.rb +163 -163
  208. data/lib/fetchers/local.rb +74 -74
  209. data/lib/fetchers/mock.rb +35 -35
  210. data/lib/fetchers/url.rb +204 -204
  211. data/lib/inspec.rb +24 -24
  212. data/lib/inspec/archive/tar.rb +29 -29
  213. data/lib/inspec/archive/zip.rb +19 -19
  214. data/lib/inspec/backend.rb +92 -92
  215. data/lib/inspec/base_cli.rb +324 -322
  216. data/lib/inspec/cached_fetcher.rb +66 -66
  217. data/lib/inspec/cli.rb +298 -298
  218. data/lib/inspec/completions/bash.sh.erb +45 -45
  219. data/lib/inspec/completions/fish.sh.erb +34 -34
  220. data/lib/inspec/completions/zsh.sh.erb +61 -61
  221. data/lib/inspec/control_eval_context.rb +179 -179
  222. data/lib/inspec/dependencies/cache.rb +72 -72
  223. data/lib/inspec/dependencies/dependency_set.rb +92 -92
  224. data/lib/inspec/dependencies/lockfile.rb +115 -115
  225. data/lib/inspec/dependencies/requirement.rb +123 -123
  226. data/lib/inspec/dependencies/resolver.rb +86 -86
  227. data/lib/inspec/describe.rb +27 -27
  228. data/lib/inspec/dsl.rb +66 -66
  229. data/lib/inspec/dsl_shared.rb +33 -33
  230. data/lib/inspec/env_printer.rb +157 -157
  231. data/lib/inspec/errors.rb +13 -13
  232. data/lib/inspec/exceptions.rb +12 -12
  233. data/lib/inspec/expect.rb +45 -45
  234. data/lib/inspec/fetcher.rb +45 -45
  235. data/lib/inspec/file_provider.rb +275 -275
  236. data/lib/inspec/formatters.rb +3 -3
  237. data/lib/inspec/formatters/base.rb +208 -208
  238. data/lib/inspec/formatters/json_rspec.rb +20 -20
  239. data/lib/inspec/formatters/show_progress.rb +12 -12
  240. data/lib/inspec/library_eval_context.rb +58 -58
  241. data/lib/inspec/log.rb +11 -11
  242. data/lib/inspec/metadata.rb +253 -253
  243. data/lib/inspec/method_source.rb +24 -24
  244. data/lib/inspec/objects.rb +14 -14
  245. data/lib/inspec/objects/attribute.rb +65 -65
  246. data/lib/inspec/objects/control.rb +61 -61
  247. data/lib/inspec/objects/describe.rb +92 -92
  248. data/lib/inspec/objects/each_loop.rb +36 -36
  249. data/lib/inspec/objects/list.rb +15 -15
  250. data/lib/inspec/objects/or_test.rb +40 -40
  251. data/lib/inspec/objects/ruby_helper.rb +15 -15
  252. data/lib/inspec/objects/tag.rb +27 -27
  253. data/lib/inspec/objects/test.rb +87 -87
  254. data/lib/inspec/objects/value.rb +27 -27
  255. data/lib/inspec/plugins.rb +60 -60
  256. data/lib/inspec/plugins/cli.rb +24 -24
  257. data/lib/inspec/plugins/fetcher.rb +86 -86
  258. data/lib/inspec/plugins/resource.rb +132 -132
  259. data/lib/inspec/plugins/secret.rb +15 -15
  260. data/lib/inspec/plugins/source_reader.rb +40 -40
  261. data/lib/inspec/polyfill.rb +12 -12
  262. data/lib/inspec/profile.rb +510 -510
  263. data/lib/inspec/profile_context.rb +207 -207
  264. data/lib/inspec/profile_vendor.rb +66 -66
  265. data/lib/inspec/reporters.rb +50 -33
  266. data/lib/inspec/reporters/base.rb +24 -23
  267. data/lib/inspec/reporters/cli.rb +395 -395
  268. data/lib/inspec/reporters/json.rb +134 -132
  269. data/lib/inspec/reporters/json_min.rb +48 -44
  270. data/lib/inspec/reporters/junit.rb +77 -77
  271. data/lib/inspec/require_loader.rb +33 -33
  272. data/lib/inspec/resource.rb +176 -176
  273. data/lib/inspec/rule.rb +266 -266
  274. data/lib/inspec/runner.rb +340 -337
  275. data/lib/inspec/runner_mock.rb +41 -41
  276. data/lib/inspec/runner_rspec.rb +163 -185
  277. data/lib/inspec/runtime_profile.rb +26 -26
  278. data/lib/inspec/schema.rb +186 -186
  279. data/lib/inspec/secrets.rb +19 -19
  280. data/lib/inspec/secrets/yaml.rb +30 -30
  281. data/lib/inspec/shell.rb +223 -223
  282. data/lib/inspec/shell_detector.rb +90 -90
  283. data/lib/inspec/source_reader.rb +29 -29
  284. data/lib/inspec/version.rb +8 -8
  285. data/lib/matchers/matchers.rb +397 -397
  286. data/lib/resources/aide_conf.rb +160 -160
  287. data/lib/resources/apache.rb +49 -49
  288. data/lib/resources/apache_conf.rb +158 -158
  289. data/lib/resources/apt.rb +150 -150
  290. data/lib/resources/audit_policy.rb +64 -64
  291. data/lib/resources/auditd.rb +233 -233
  292. data/lib/resources/auditd_conf.rb +56 -56
  293. data/lib/resources/auditd_rules.rb +205 -205
  294. data/lib/resources/bash.rb +36 -36
  295. data/lib/resources/bond.rb +69 -69
  296. data/lib/resources/bridge.rb +123 -123
  297. data/lib/resources/command.rb +69 -69
  298. data/lib/resources/cpan.rb +60 -60
  299. data/lib/resources/cran.rb +66 -66
  300. data/lib/resources/crontab.rb +169 -169
  301. data/lib/resources/csv.rb +58 -58
  302. data/lib/resources/dh_params.rb +83 -83
  303. data/lib/resources/directory.rb +25 -25
  304. data/lib/resources/docker.rb +239 -239
  305. data/lib/resources/docker_container.rb +92 -92
  306. data/lib/resources/docker_image.rb +86 -86
  307. data/lib/resources/docker_object.rb +57 -57
  308. data/lib/resources/docker_service.rb +94 -94
  309. data/lib/resources/elasticsearch.rb +168 -168
  310. data/lib/resources/etc_fstab.rb +102 -102
  311. data/lib/resources/etc_group.rb +157 -157
  312. data/lib/resources/etc_hosts.rb +81 -81
  313. data/lib/resources/etc_hosts_allow_deny.rb +122 -122
  314. data/lib/resources/file.rb +298 -298
  315. data/lib/resources/filesystem.rb +31 -31
  316. data/lib/resources/firewalld.rb +144 -144
  317. data/lib/resources/gem.rb +71 -71
  318. data/lib/resources/groups.rb +213 -213
  319. data/lib/resources/grub_conf.rb +237 -237
  320. data/lib/resources/host.rb +300 -300
  321. data/lib/resources/http.rb +252 -252
  322. data/lib/resources/iis_app.rb +103 -103
  323. data/lib/resources/iis_site.rb +147 -147
  324. data/lib/resources/inetd_conf.rb +63 -63
  325. data/lib/resources/ini.rb +29 -29
  326. data/lib/resources/interface.rb +130 -130
  327. data/lib/resources/iptables.rb +70 -70
  328. data/lib/resources/json.rb +115 -115
  329. data/lib/resources/kernel_module.rb +110 -110
  330. data/lib/resources/kernel_parameter.rb +58 -58
  331. data/lib/resources/key_rsa.rb +67 -67
  332. data/lib/resources/limits_conf.rb +56 -56
  333. data/lib/resources/login_def.rb +67 -67
  334. data/lib/resources/mount.rb +90 -90
  335. data/lib/resources/mssql_session.rb +103 -103
  336. data/lib/resources/mysql.rb +82 -82
  337. data/lib/resources/mysql_conf.rb +133 -133
  338. data/lib/resources/mysql_session.rb +72 -72
  339. data/lib/resources/nginx.rb +97 -97
  340. data/lib/resources/nginx_conf.rb +228 -228
  341. data/lib/resources/npm.rb +48 -48
  342. data/lib/resources/ntp_conf.rb +59 -59
  343. data/lib/resources/oneget.rb +72 -72
  344. data/lib/resources/oracledb_session.rb +140 -140
  345. data/lib/resources/os.rb +46 -46
  346. data/lib/resources/os_env.rb +76 -76
  347. data/lib/resources/package.rb +357 -357
  348. data/lib/resources/packages.rb +112 -112
  349. data/lib/resources/parse_config.rb +116 -116
  350. data/lib/resources/passwd.rb +96 -96
  351. data/lib/resources/pip.rb +89 -89
  352. data/lib/resources/platform.rb +112 -112
  353. data/lib/resources/port.rb +771 -771
  354. data/lib/resources/postgres.rb +132 -132
  355. data/lib/resources/postgres_conf.rb +122 -122
  356. data/lib/resources/postgres_hba_conf.rb +101 -101
  357. data/lib/resources/postgres_ident_conf.rb +79 -79
  358. data/lib/resources/postgres_session.rb +72 -72
  359. data/lib/resources/powershell.rb +58 -58
  360. data/lib/resources/processes.rb +204 -204
  361. data/lib/resources/rabbitmq_conf.rb +53 -53
  362. data/lib/resources/registry_key.rb +296 -296
  363. data/lib/resources/security_policy.rb +181 -181
  364. data/lib/resources/service.rb +784 -784
  365. data/lib/resources/shadow.rb +141 -141
  366. data/lib/resources/ssh_conf.rb +102 -102
  367. data/lib/resources/ssl.rb +99 -99
  368. data/lib/resources/sys_info.rb +26 -26
  369. data/lib/resources/toml.rb +32 -32
  370. data/lib/resources/users.rb +652 -652
  371. data/lib/resources/vbscript.rb +70 -70
  372. data/lib/resources/virtualization.rb +251 -251
  373. data/lib/resources/windows_feature.rb +85 -85
  374. data/lib/resources/windows_hotfix.rb +35 -35
  375. data/lib/resources/windows_task.rb +106 -106
  376. data/lib/resources/wmi.rb +114 -114
  377. data/lib/resources/x509_certificate.rb +143 -143
  378. data/lib/resources/xinetd.rb +112 -112
  379. data/lib/resources/xml.rb +45 -45
  380. data/lib/resources/yaml.rb +45 -45
  381. data/lib/resources/yum.rb +181 -181
  382. data/lib/resources/zfs_dataset.rb +60 -60
  383. data/lib/resources/zfs_pool.rb +49 -49
  384. data/lib/source_readers/flat.rb +39 -39
  385. data/lib/source_readers/inspec.rb +75 -75
  386. data/lib/utils/command_wrapper.rb +27 -27
  387. data/lib/utils/convert.rb +12 -12
  388. data/lib/utils/database_helpers.rb +77 -77
  389. data/lib/utils/erlang_parser.rb +192 -192
  390. data/lib/utils/filter.rb +272 -272
  391. data/lib/utils/filter_array.rb +27 -27
  392. data/lib/utils/find_files.rb +44 -44
  393. data/lib/utils/hash.rb +41 -41
  394. data/lib/utils/json_log.rb +18 -18
  395. data/lib/utils/latest_version.rb +22 -22
  396. data/lib/utils/modulator.rb +12 -12
  397. data/lib/utils/nginx_parser.rb +85 -85
  398. data/lib/utils/object_traversal.rb +49 -49
  399. data/lib/utils/parser.rb +274 -274
  400. data/lib/utils/plugin_registry.rb +93 -93
  401. data/lib/utils/simpleconfig.rb +132 -132
  402. data/lib/utils/spdx.rb +13 -13
  403. data/lib/utils/spdx.txt +343 -343
  404. metadata +2 -2
@@ -1,213 +1,213 @@
1
- # encoding: utf-8
2
- # author: Christoph Hartmann
3
- # author: Dominik Richter
4
-
5
- require 'utils/filter'
6
-
7
- module Inspec::Resources
8
- # This file contains two resources, the `group` and `groups` resource.
9
- # The `group` resource is optimized for requests that verify specific groups
10
- # that you know upfront for testing. If you need to query all groups or search
11
- # specific groups with certain properties, use the `groups` resource.
12
- module GroupManagementSelector
13
- # select group provider based on the operating system
14
- # returns nil, if no group manager was found for the operating system
15
- def select_group_manager(os)
16
- @group_provider = if os.darwin?
17
- DarwinGroup.new(inspec)
18
- elsif os.unix?
19
- UnixGroup.new(inspec)
20
- elsif os.windows?
21
- WindowsGroup.new(inspec)
22
- end
23
- end
24
- end
25
-
26
- class Groups < Inspec.resource(1)
27
- include GroupManagementSelector
28
-
29
- name 'groups'
30
- desc 'Use the group InSpec audit resource to test groups on the system. Groups can be filtered.'
31
- example "
32
- describe groups.where { name == 'root'} do
33
- its('names') { should eq ['root'] }
34
- its('gids') { should eq [0] }
35
- end
36
-
37
- describe groups.where { name == 'Administrators'} do
38
- its('names') { should eq ['Administrators'] }
39
- its('gids') { should eq ['S-1-5-32-544'] }
40
- end
41
- "
42
-
43
- def initialize
44
- # select group manager
45
- @group_provider = select_group_manager(inspec.os)
46
- return skip_resource 'The `groups` resource is not supported on your OS yet.' if @group_provider.nil?
47
- end
48
-
49
- filter = FilterTable.create
50
- filter.add_accessor(:where)
51
- .add_accessor(:entries)
52
- .add(:names, field: 'name')
53
- .add(:gids, field: 'gid')
54
- .add(:domains, field: 'domain')
55
- .add(:exists?) { |x| !x.entries.empty? }
56
- filter.connect(self, :collect_group_details)
57
-
58
- def to_s
59
- 'Groups'
60
- end
61
-
62
- private
63
-
64
- # collects information about every group
65
- def collect_group_details
66
- return @groups_cache ||= @group_provider.groups unless @group_provider.nil?
67
- []
68
- end
69
- end
70
-
71
- # Usage:
72
- # describe group('root') do
73
- # it { should exist }
74
- # its('gid') { should eq 0 }
75
- # end
76
- #
77
- # deprecated has matcher
78
- # describe group('root') do
79
- # it { should have_gid 0 }
80
- # end
81
- class Group < Inspec.resource(1)
82
- include GroupManagementSelector
83
-
84
- name 'group'
85
- desc 'Use the group InSpec audit resource to test groups on the system.'
86
- example "
87
- describe group('root') do
88
- it { should exist }
89
- its('gid') { should eq 0 }
90
- end
91
- "
92
-
93
- def initialize(groupname)
94
- @group = groupname
95
-
96
- # select group manager
97
- @group_provider = select_group_manager(inspec.os)
98
- return skip_resource 'The `group` resource is not supported on your OS yet.' if @group_provider.nil?
99
- end
100
-
101
- # verifies if a group exists
102
- def exists?
103
- !group_info.entries.empty?
104
- end
105
-
106
- def gid
107
- gids = group_info.gids
108
- if gids.empty?
109
- nil
110
- # the default case should be one group
111
- elsif gids.size == 1
112
- gids.entries[0]
113
- else
114
- raise 'found more than one group with the same name, please use `groups` resource'
115
- end
116
- end
117
-
118
- # implements rspec has matcher, to be compatible with serverspec
119
- def has_gid?(compare_gid)
120
- gid == compare_gid
121
- end
122
-
123
- def local
124
- # at this point the implementation only returns local groups
125
- true
126
- end
127
-
128
- def to_s
129
- "Group #{@group}"
130
- end
131
-
132
- private
133
-
134
- def group_info
135
- # we need a local copy for the block
136
- group = @group.dup
137
- @groups_cache ||= inspec.groups.where { name == group }
138
- end
139
- end
140
-
141
- class GroupInfo
142
- attr_reader :inspec
143
- def initialize(inspec)
144
- @inspec = inspec
145
- end
146
-
147
- def groups
148
- raise 'group provider must implement the `groups` method'
149
- end
150
- end
151
-
152
- # implements generic unix groups via /etc/group
153
- class UnixGroup < GroupInfo
154
- def groups
155
- inspec.etc_group.entries
156
- end
157
- end
158
-
159
- # OSX uses opendirectory for groups, so `/etc/group` may not be fully accurate
160
- # This uses `dscacheutil` to get the group info instead of `etc_group`
161
- class DarwinGroup < GroupInfo
162
- def groups
163
- group_info = inspec.command('dscacheutil -q group').stdout.split("\n\n")
164
-
165
- groups = []
166
- regex = /^([^:]*?)\s*:\s(.*?)\s*$/
167
- group_info.each do |data|
168
- groups << inspec.parse_config(data, assignment_regex: regex).params
169
- end
170
-
171
- # Convert the `dscacheutil` groups to match `inspec.etc_group.entries`
172
- groups.each { |g| g['gid'] = g['gid'].to_i }
173
- groups.each do |g|
174
- next if g['users'].nil?
175
- g['members'] = g.delete('users')
176
- g['members'].tr!(' ', ',')
177
- end
178
- end
179
- end
180
-
181
- class WindowsGroup < GroupInfo
182
- # returns all local groups
183
- def groups
184
- script = <<~EOH
185
- Function ConvertTo-SID { Param([byte[]]$BinarySID)
186
- (New-Object System.Security.Principal.SecurityIdentifier($BinarySID,0)).Value
187
- }
188
-
189
- $Computername = $Env:Computername
190
- $adsi = [ADSI]"WinNT://$Computername"
191
- $groups = $adsi.Children | where {$_.SchemaClassName -eq 'group'} | ForEach {
192
- $name = $_.Name[0]
193
- $sid = ConvertTo-SID -BinarySID $_.ObjectSID[0]
194
- $group =[ADSI]$_.Path
195
- new-object psobject -property @{name = $group.Name[0]; gid = $sid; domain=$Computername}
196
- }
197
- $groups | ConvertTo-Json -Depth 3
198
- EOH
199
- cmd = inspec.powershell(script)
200
- # cannot rely on exit code for now, successful command returns exit code 1
201
- # return nil if cmd.exit_status != 0, try to parse json
202
- begin
203
- groups = JSON.parse(cmd.stdout)
204
- rescue JSON::ParserError => _e
205
- return []
206
- end
207
-
208
- # ensure we have an array of groups
209
- groups = [groups] if !groups.is_a?(Array)
210
- groups
211
- end
212
- end
213
- end
1
+ # encoding: utf-8
2
+ # author: Christoph Hartmann
3
+ # author: Dominik Richter
4
+
5
+ require 'utils/filter'
6
+
7
+ module Inspec::Resources
8
+ # This file contains two resources, the `group` and `groups` resource.
9
+ # The `group` resource is optimized for requests that verify specific groups
10
+ # that you know upfront for testing. If you need to query all groups or search
11
+ # specific groups with certain properties, use the `groups` resource.
12
+ module GroupManagementSelector
13
+ # select group provider based on the operating system
14
+ # returns nil, if no group manager was found for the operating system
15
+ def select_group_manager(os)
16
+ @group_provider = if os.darwin?
17
+ DarwinGroup.new(inspec)
18
+ elsif os.unix?
19
+ UnixGroup.new(inspec)
20
+ elsif os.windows?
21
+ WindowsGroup.new(inspec)
22
+ end
23
+ end
24
+ end
25
+
26
+ class Groups < Inspec.resource(1)
27
+ include GroupManagementSelector
28
+
29
+ name 'groups'
30
+ desc 'Use the group InSpec audit resource to test groups on the system. Groups can be filtered.'
31
+ example "
32
+ describe groups.where { name == 'root'} do
33
+ its('names') { should eq ['root'] }
34
+ its('gids') { should eq [0] }
35
+ end
36
+
37
+ describe groups.where { name == 'Administrators'} do
38
+ its('names') { should eq ['Administrators'] }
39
+ its('gids') { should eq ['S-1-5-32-544'] }
40
+ end
41
+ "
42
+
43
+ def initialize
44
+ # select group manager
45
+ @group_provider = select_group_manager(inspec.os)
46
+ return skip_resource 'The `groups` resource is not supported on your OS yet.' if @group_provider.nil?
47
+ end
48
+
49
+ filter = FilterTable.create
50
+ filter.add_accessor(:where)
51
+ .add_accessor(:entries)
52
+ .add(:names, field: 'name')
53
+ .add(:gids, field: 'gid')
54
+ .add(:domains, field: 'domain')
55
+ .add(:exists?) { |x| !x.entries.empty? }
56
+ filter.connect(self, :collect_group_details)
57
+
58
+ def to_s
59
+ 'Groups'
60
+ end
61
+
62
+ private
63
+
64
+ # collects information about every group
65
+ def collect_group_details
66
+ return @groups_cache ||= @group_provider.groups unless @group_provider.nil?
67
+ []
68
+ end
69
+ end
70
+
71
+ # Usage:
72
+ # describe group('root') do
73
+ # it { should exist }
74
+ # its('gid') { should eq 0 }
75
+ # end
76
+ #
77
+ # deprecated has matcher
78
+ # describe group('root') do
79
+ # it { should have_gid 0 }
80
+ # end
81
+ class Group < Inspec.resource(1)
82
+ include GroupManagementSelector
83
+
84
+ name 'group'
85
+ desc 'Use the group InSpec audit resource to test groups on the system.'
86
+ example "
87
+ describe group('root') do
88
+ it { should exist }
89
+ its('gid') { should eq 0 }
90
+ end
91
+ "
92
+
93
+ def initialize(groupname)
94
+ @group = groupname
95
+
96
+ # select group manager
97
+ @group_provider = select_group_manager(inspec.os)
98
+ return skip_resource 'The `group` resource is not supported on your OS yet.' if @group_provider.nil?
99
+ end
100
+
101
+ # verifies if a group exists
102
+ def exists?
103
+ !group_info.entries.empty?
104
+ end
105
+
106
+ def gid
107
+ gids = group_info.gids
108
+ if gids.empty?
109
+ nil
110
+ # the default case should be one group
111
+ elsif gids.size == 1
112
+ gids.entries[0]
113
+ else
114
+ raise 'found more than one group with the same name, please use `groups` resource'
115
+ end
116
+ end
117
+
118
+ # implements rspec has matcher, to be compatible with serverspec
119
+ def has_gid?(compare_gid)
120
+ gid == compare_gid
121
+ end
122
+
123
+ def local
124
+ # at this point the implementation only returns local groups
125
+ true
126
+ end
127
+
128
+ def to_s
129
+ "Group #{@group}"
130
+ end
131
+
132
+ private
133
+
134
+ def group_info
135
+ # we need a local copy for the block
136
+ group = @group.dup
137
+ @groups_cache ||= inspec.groups.where { name == group }
138
+ end
139
+ end
140
+
141
+ class GroupInfo
142
+ attr_reader :inspec
143
+ def initialize(inspec)
144
+ @inspec = inspec
145
+ end
146
+
147
+ def groups
148
+ raise 'group provider must implement the `groups` method'
149
+ end
150
+ end
151
+
152
+ # implements generic unix groups via /etc/group
153
+ class UnixGroup < GroupInfo
154
+ def groups
155
+ inspec.etc_group.entries
156
+ end
157
+ end
158
+
159
+ # OSX uses opendirectory for groups, so `/etc/group` may not be fully accurate
160
+ # This uses `dscacheutil` to get the group info instead of `etc_group`
161
+ class DarwinGroup < GroupInfo
162
+ def groups
163
+ group_info = inspec.command('dscacheutil -q group').stdout.split("\n\n")
164
+
165
+ groups = []
166
+ regex = /^([^:]*?)\s*:\s(.*?)\s*$/
167
+ group_info.each do |data|
168
+ groups << inspec.parse_config(data, assignment_regex: regex).params
169
+ end
170
+
171
+ # Convert the `dscacheutil` groups to match `inspec.etc_group.entries`
172
+ groups.each { |g| g['gid'] = g['gid'].to_i }
173
+ groups.each do |g|
174
+ next if g['users'].nil?
175
+ g['members'] = g.delete('users')
176
+ g['members'].tr!(' ', ',')
177
+ end
178
+ end
179
+ end
180
+
181
+ class WindowsGroup < GroupInfo
182
+ # returns all local groups
183
+ def groups
184
+ script = <<~EOH
185
+ Function ConvertTo-SID { Param([byte[]]$BinarySID)
186
+ (New-Object System.Security.Principal.SecurityIdentifier($BinarySID,0)).Value
187
+ }
188
+
189
+ $Computername = $Env:Computername
190
+ $adsi = [ADSI]"WinNT://$Computername"
191
+ $groups = $adsi.Children | where {$_.SchemaClassName -eq 'group'} | ForEach {
192
+ $name = $_.Name[0]
193
+ $sid = ConvertTo-SID -BinarySID $_.ObjectSID[0]
194
+ $group =[ADSI]$_.Path
195
+ new-object psobject -property @{name = $group.Name[0]; gid = $sid; domain=$Computername}
196
+ }
197
+ $groups | ConvertTo-Json -Depth 3
198
+ EOH
199
+ cmd = inspec.powershell(script)
200
+ # cannot rely on exit code for now, successful command returns exit code 1
201
+ # return nil if cmd.exit_status != 0, try to parse json
202
+ begin
203
+ groups = JSON.parse(cmd.stdout)
204
+ rescue JSON::ParserError => _e
205
+ return []
206
+ end
207
+
208
+ # ensure we have an array of groups
209
+ groups = [groups] if !groups.is_a?(Array)
210
+ groups
211
+ end
212
+ end
213
+ end
@@ -1,237 +1,237 @@
1
- # encoding: utf-8
2
- # author: Thomas Cate
3
-
4
- require 'utils/simpleconfig'
5
-
6
- class GrubConfig < Inspec.resource(1)
7
- name 'grub_conf'
8
- desc 'Use the grub_conf InSpec audit resource to test the boot config of Linux systems that use Grub.'
9
- example "
10
- describe grub_conf('/etc/grub.conf', 'default') do
11
- its('kernel') { should include '/vmlinuz-2.6.32-573.7.1.el6.x86_64' }
12
- its('initrd') { should include '/initramfs-2.6.32-573.el6.x86_64.img=1' }
13
- its('default') { should_not eq '1' }
14
- its('timeout') { should eq '5' }
15
- end
16
-
17
- also check specific kernels
18
- describe grub_conf('/etc/grub.conf', 'CentOS (2.6.32-573.12.1.el6.x86_64)') do
19
- its('kernel') { should include 'audit=1' }
20
- end
21
- "
22
-
23
- class UnknownGrubConfig < StandardError; end
24
-
25
- def initialize(path = nil, kernel = nil)
26
- config_for_platform(path)
27
- @kernel = kernel || 'default'
28
- rescue UnknownGrubConfig
29
- return skip_resource 'The `grub_config` resource is not supported on your OS yet.'
30
- end
31
-
32
- def config_for_platform(path)
33
- os = inspec.os
34
- if os.redhat? || os[:name] == 'fedora'
35
- config_for_redhatish(path)
36
- elsif os.debian?
37
- @conf_path = path || '/boot/grub/grub.cfg'
38
- @defaults_path = '/etc/default/grub'
39
- @grubenv_path = '/boot/grub2/grubenv'
40
- @version = 'grub2'
41
- elsif os[:name] == 'amazon'
42
- @conf_path = path || '/etc/grub.conf'
43
- @version = 'legacy'
44
- else
45
- raise UnknownGrubConfig
46
- end
47
- end
48
-
49
- def config_for_redhatish(path)
50
- if inspec.os[:release].to_f < 7
51
- @conf_path = path || '/etc/grub.conf'
52
- @version = 'legacy'
53
- else
54
- @conf_path = path || '/boot/grub2/grub.cfg'
55
- @defaults_path = '/etc/default/grub'
56
- @grubenv_path = '/boot/grub2/grubenv'
57
- @version = 'grub2'
58
- end
59
- end
60
-
61
- def method_missing(name)
62
- read_params[name.to_s]
63
- end
64
-
65
- def to_s
66
- 'Grub Config'
67
- end
68
-
69
- private
70
-
71
- ######################################################################
72
- # Grub2 This is used by all supported versions of Ubuntu and Rhel 7+ #
73
- ######################################################################
74
-
75
- def grub2_parse_kernel_lines(content, conf)
76
- menu_entries = extract_menu_entries(content)
77
-
78
- if @kernel == 'default'
79
- default_menu_entry(menu_entries, conf['GRUB_DEFAULT'])
80
- else
81
- menu_entries.find { |entry| entry['name'] == @kernel }
82
- end
83
- end
84
-
85
- def extract_menu_entries(content)
86
- menu_entries = []
87
-
88
- lines = content.split("\n")
89
- lines.each_with_index do |line, index|
90
- next unless line =~ /^menuentry\s+.*/
91
- entry = {}
92
- entry['insmod'] = []
93
-
94
- # Extract name from menuentry line
95
- capture_data = line.match(/(?:^|\s+).*menuentry\s*['|"](.*)['|"]\s*--/)
96
- if capture_data.nil? || capture_data.captures[0].nil?
97
- raise Inspec::Exceptions::ResourceFailed "Failed to extract menuentry name from #{line}"
98
- end
99
-
100
- entry['name'] = capture_data.captures[0]
101
-
102
- # Begin processing from index forward until a `}` line is met
103
- lines.drop(index+1).each do |mline|
104
- break if mline =~ /^\s*}\s*$/
105
- case mline
106
- when /(?:^|\s*)initrd.*/
107
- entry['initrd'] = mline.split(' ')[1]
108
- when /(?:^|\s*)linux.*/
109
- entry['kernel'] = mline.split
110
- when /(?:^|\s*)set root=.*/
111
- entry['root'] = mline.split('=')[1].tr('\'', '')
112
- when /(?:^|\s*)insmod.*/
113
- entry['insmod'] << mline.split(' ')[1]
114
- end
115
- end
116
-
117
- menu_entries << entry
118
- end
119
-
120
- menu_entries
121
- end
122
-
123
- def default_menu_entry(menu_entries, default)
124
- # If the default entry isn't `saved` then a number is used as an index.
125
- # By default this is `0`, which would be the first item in the list.
126
- return menu_entries[default.to_i] unless default == 'saved'
127
-
128
- grubenv_contents = inspec.file(@grubenv_path).content
129
-
130
- # The location of the grubenv file is not guaranteed. In the case that
131
- # the file does not exist this will return the 0th entry. This will also
132
- # return the 0th entry if InSpec lacks permission to read the file. Both
133
- # of these reflect the default Grub2 behavior.
134
- return menu_entries[0] if grubenv_contents.nil?
135
-
136
- default_name = SimpleConfig.new(grubenv_contents).params['saved_entry']
137
- default_entry = menu_entries.select { |k| k['name'] == default_name }[0]
138
- return default_entry unless default_entry.nil?
139
-
140
- # It is possible for the saved entry to not be valid . For example, grubenv
141
- # not being up to date. If so, the 0th entry is the default.
142
- menu_entries[0]
143
- end
144
-
145
- ###################################################################
146
- # Grub1 aka legacy-grub config. Primarily used by Centos/Rhel 6.x #
147
- ###################################################################
148
-
149
- def parse_kernel_lines(content, conf)
150
- # Find all "title" lines and then parse them into arrays
151
- menu_entry = 0
152
- lines = content.split("\n")
153
- kernel_opts = {}
154
- lines.each_with_index do |file_line, index|
155
- next unless file_line =~ /^title.*/
156
- current_kernel = file_line.split(' ', 2)[1]
157
- lines.drop(index+1).each do |kernel_line|
158
- if kernel_line =~ /^\s.*/
159
- option_type = kernel_line.split(' ')[0]
160
- line_options = kernel_line.split(' ').drop(1)
161
- if (menu_entry == conf['default'].to_i && @kernel == 'default') || current_kernel == @kernel
162
- if option_type == 'kernel'
163
- kernel_opts['kernel'] = line_options
164
- else
165
- kernel_opts[option_type] = line_options[0]
166
- end
167
- end
168
- else
169
- menu_entry += 1
170
- break
171
- end
172
- end
173
- end
174
- kernel_opts
175
- end
176
-
177
- def read_file(config_file)
178
- file = inspec.file(config_file)
179
-
180
- if !file.file? && !file.symlink?
181
- skip_resource "Can't find file '#{@conf_path}'"
182
- return @params = {}
183
- end
184
-
185
- content = file.content
186
-
187
- if content.empty? && !file.empty?
188
- skip_resource "Can't read file '#{@conf_path}'"
189
- return @params = {}
190
- end
191
-
192
- content
193
- end
194
-
195
- def read_params
196
- return @params if defined?(@params)
197
-
198
- content = read_file(@conf_path)
199
-
200
- if @version == 'legacy'
201
- # parse the file
202
- conf = SimpleConfig.new(
203
- content,
204
- multiple_values: true,
205
- ).params
206
- # convert single entry arrays into strings
207
- conf.each do |key, value|
208
- if value.size == 1
209
- conf[key] = conf[key][0].to_s
210
- end
211
- end
212
- kernel_opts = parse_kernel_lines(content, conf)
213
- @params = conf.merge(kernel_opts)
214
- end
215
-
216
- if @version == 'grub2'
217
- # read defaults
218
- defaults = read_file(@defaults_path)
219
-
220
- conf = SimpleConfig.new(
221
- defaults,
222
- multiple_values: true,
223
- ).params
224
-
225
- # convert single entry arrays into strings
226
- conf.each do |key, value|
227
- if value.size == 1
228
- conf[key] = conf[key][0].to_s
229
- end
230
- end
231
-
232
- kernel_opts = grub2_parse_kernel_lines(content, conf)
233
- @params = conf.merge(kernel_opts)
234
- end
235
- @params
236
- end
237
- end
1
+ # encoding: utf-8
2
+ # author: Thomas Cate
3
+
4
+ require 'utils/simpleconfig'
5
+
6
+ class GrubConfig < Inspec.resource(1)
7
+ name 'grub_conf'
8
+ desc 'Use the grub_conf InSpec audit resource to test the boot config of Linux systems that use Grub.'
9
+ example "
10
+ describe grub_conf('/etc/grub.conf', 'default') do
11
+ its('kernel') { should include '/vmlinuz-2.6.32-573.7.1.el6.x86_64' }
12
+ its('initrd') { should include '/initramfs-2.6.32-573.el6.x86_64.img=1' }
13
+ its('default') { should_not eq '1' }
14
+ its('timeout') { should eq '5' }
15
+ end
16
+
17
+ also check specific kernels
18
+ describe grub_conf('/etc/grub.conf', 'CentOS (2.6.32-573.12.1.el6.x86_64)') do
19
+ its('kernel') { should include 'audit=1' }
20
+ end
21
+ "
22
+
23
+ class UnknownGrubConfig < StandardError; end
24
+
25
+ def initialize(path = nil, kernel = nil)
26
+ config_for_platform(path)
27
+ @kernel = kernel || 'default'
28
+ rescue UnknownGrubConfig
29
+ return skip_resource 'The `grub_config` resource is not supported on your OS yet.'
30
+ end
31
+
32
+ def config_for_platform(path)
33
+ os = inspec.os
34
+ if os.redhat? || os[:name] == 'fedora'
35
+ config_for_redhatish(path)
36
+ elsif os.debian?
37
+ @conf_path = path || '/boot/grub/grub.cfg'
38
+ @defaults_path = '/etc/default/grub'
39
+ @grubenv_path = '/boot/grub2/grubenv'
40
+ @version = 'grub2'
41
+ elsif os[:name] == 'amazon'
42
+ @conf_path = path || '/etc/grub.conf'
43
+ @version = 'legacy'
44
+ else
45
+ raise UnknownGrubConfig
46
+ end
47
+ end
48
+
49
+ def config_for_redhatish(path)
50
+ if inspec.os[:release].to_f < 7
51
+ @conf_path = path || '/etc/grub.conf'
52
+ @version = 'legacy'
53
+ else
54
+ @conf_path = path || '/boot/grub2/grub.cfg'
55
+ @defaults_path = '/etc/default/grub'
56
+ @grubenv_path = '/boot/grub2/grubenv'
57
+ @version = 'grub2'
58
+ end
59
+ end
60
+
61
+ def method_missing(name)
62
+ read_params[name.to_s]
63
+ end
64
+
65
+ def to_s
66
+ 'Grub Config'
67
+ end
68
+
69
+ private
70
+
71
+ ######################################################################
72
+ # Grub2 This is used by all supported versions of Ubuntu and Rhel 7+ #
73
+ ######################################################################
74
+
75
+ def grub2_parse_kernel_lines(content, conf)
76
+ menu_entries = extract_menu_entries(content)
77
+
78
+ if @kernel == 'default'
79
+ default_menu_entry(menu_entries, conf['GRUB_DEFAULT'])
80
+ else
81
+ menu_entries.find { |entry| entry['name'] == @kernel }
82
+ end
83
+ end
84
+
85
+ def extract_menu_entries(content)
86
+ menu_entries = []
87
+
88
+ lines = content.split("\n")
89
+ lines.each_with_index do |line, index|
90
+ next unless line =~ /^menuentry\s+.*/
91
+ entry = {}
92
+ entry['insmod'] = []
93
+
94
+ # Extract name from menuentry line
95
+ capture_data = line.match(/(?:^|\s+).*menuentry\s*['|"](.*)['|"]\s*--/)
96
+ if capture_data.nil? || capture_data.captures[0].nil?
97
+ raise Inspec::Exceptions::ResourceFailed "Failed to extract menuentry name from #{line}"
98
+ end
99
+
100
+ entry['name'] = capture_data.captures[0]
101
+
102
+ # Begin processing from index forward until a `}` line is met
103
+ lines.drop(index+1).each do |mline|
104
+ break if mline =~ /^\s*}\s*$/
105
+ case mline
106
+ when /(?:^|\s*)initrd.*/
107
+ entry['initrd'] = mline.split(' ')[1]
108
+ when /(?:^|\s*)linux.*/
109
+ entry['kernel'] = mline.split
110
+ when /(?:^|\s*)set root=.*/
111
+ entry['root'] = mline.split('=')[1].tr('\'', '')
112
+ when /(?:^|\s*)insmod.*/
113
+ entry['insmod'] << mline.split(' ')[1]
114
+ end
115
+ end
116
+
117
+ menu_entries << entry
118
+ end
119
+
120
+ menu_entries
121
+ end
122
+
123
+ def default_menu_entry(menu_entries, default)
124
+ # If the default entry isn't `saved` then a number is used as an index.
125
+ # By default this is `0`, which would be the first item in the list.
126
+ return menu_entries[default.to_i] unless default == 'saved'
127
+
128
+ grubenv_contents = inspec.file(@grubenv_path).content
129
+
130
+ # The location of the grubenv file is not guaranteed. In the case that
131
+ # the file does not exist this will return the 0th entry. This will also
132
+ # return the 0th entry if InSpec lacks permission to read the file. Both
133
+ # of these reflect the default Grub2 behavior.
134
+ return menu_entries[0] if grubenv_contents.nil?
135
+
136
+ default_name = SimpleConfig.new(grubenv_contents).params['saved_entry']
137
+ default_entry = menu_entries.select { |k| k['name'] == default_name }[0]
138
+ return default_entry unless default_entry.nil?
139
+
140
+ # It is possible for the saved entry to not be valid . For example, grubenv
141
+ # not being up to date. If so, the 0th entry is the default.
142
+ menu_entries[0]
143
+ end
144
+
145
+ ###################################################################
146
+ # Grub1 aka legacy-grub config. Primarily used by Centos/Rhel 6.x #
147
+ ###################################################################
148
+
149
+ def parse_kernel_lines(content, conf)
150
+ # Find all "title" lines and then parse them into arrays
151
+ menu_entry = 0
152
+ lines = content.split("\n")
153
+ kernel_opts = {}
154
+ lines.each_with_index do |file_line, index|
155
+ next unless file_line =~ /^title.*/
156
+ current_kernel = file_line.split(' ', 2)[1]
157
+ lines.drop(index+1).each do |kernel_line|
158
+ if kernel_line =~ /^\s.*/
159
+ option_type = kernel_line.split(' ')[0]
160
+ line_options = kernel_line.split(' ').drop(1)
161
+ if (menu_entry == conf['default'].to_i && @kernel == 'default') || current_kernel == @kernel
162
+ if option_type == 'kernel'
163
+ kernel_opts['kernel'] = line_options
164
+ else
165
+ kernel_opts[option_type] = line_options[0]
166
+ end
167
+ end
168
+ else
169
+ menu_entry += 1
170
+ break
171
+ end
172
+ end
173
+ end
174
+ kernel_opts
175
+ end
176
+
177
+ def read_file(config_file)
178
+ file = inspec.file(config_file)
179
+
180
+ if !file.file? && !file.symlink?
181
+ skip_resource "Can't find file '#{@conf_path}'"
182
+ return @params = {}
183
+ end
184
+
185
+ content = file.content
186
+
187
+ if content.empty? && !file.empty?
188
+ skip_resource "Can't read file '#{@conf_path}'"
189
+ return @params = {}
190
+ end
191
+
192
+ content
193
+ end
194
+
195
+ def read_params
196
+ return @params if defined?(@params)
197
+
198
+ content = read_file(@conf_path)
199
+
200
+ if @version == 'legacy'
201
+ # parse the file
202
+ conf = SimpleConfig.new(
203
+ content,
204
+ multiple_values: true,
205
+ ).params
206
+ # convert single entry arrays into strings
207
+ conf.each do |key, value|
208
+ if value.size == 1
209
+ conf[key] = conf[key][0].to_s
210
+ end
211
+ end
212
+ kernel_opts = parse_kernel_lines(content, conf)
213
+ @params = conf.merge(kernel_opts)
214
+ end
215
+
216
+ if @version == 'grub2'
217
+ # read defaults
218
+ defaults = read_file(@defaults_path)
219
+
220
+ conf = SimpleConfig.new(
221
+ defaults,
222
+ multiple_values: true,
223
+ ).params
224
+
225
+ # convert single entry arrays into strings
226
+ conf.each do |key, value|
227
+ if value.size == 1
228
+ conf[key] = conf[key][0].to_s
229
+ end
230
+ end
231
+
232
+ kernel_opts = grub2_parse_kernel_lines(content, conf)
233
+ @params = conf.merge(kernel_opts)
234
+ end
235
+ @params
236
+ end
237
+ end