inspec 2.1.80 → 2.1.81

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (510) hide show
  1. checksums.yaml +4 -4
  2. data/.rubocop.yml +101 -101
  3. data/CHANGELOG.md +3177 -3172
  4. data/Gemfile +56 -56
  5. data/LICENSE +14 -14
  6. data/MAINTAINERS.md +33 -33
  7. data/MAINTAINERS.toml +52 -52
  8. data/README.md +453 -453
  9. data/Rakefile +349 -349
  10. data/bin/inspec +12 -12
  11. data/docs/.gitignore +2 -2
  12. data/docs/README.md +40 -40
  13. data/docs/dev/control-eval.md +61 -61
  14. data/docs/dsl_inspec.md +258 -258
  15. data/docs/dsl_resource.md +100 -100
  16. data/docs/glossary.md +99 -99
  17. data/docs/habitat.md +191 -191
  18. data/docs/inspec_and_friends.md +114 -114
  19. data/docs/matchers.md +169 -169
  20. data/docs/migration.md +293 -293
  21. data/docs/platforms.md +118 -118
  22. data/docs/plugin_kitchen_inspec.md +50 -50
  23. data/docs/profiles.md +378 -378
  24. data/docs/reporters.md +105 -105
  25. data/docs/resources/aide_conf.md.erb +75 -75
  26. data/docs/resources/apache.md.erb +67 -67
  27. data/docs/resources/apache_conf.md.erb +68 -68
  28. data/docs/resources/apt.md.erb +71 -71
  29. data/docs/resources/audit_policy.md.erb +47 -47
  30. data/docs/resources/auditd.md.erb +79 -79
  31. data/docs/resources/auditd_conf.md.erb +68 -68
  32. data/docs/resources/aws_cloudtrail_trail.md.erb +155 -155
  33. data/docs/resources/aws_cloudtrail_trails.md.erb +86 -86
  34. data/docs/resources/aws_cloudwatch_alarm.md.erb +91 -91
  35. data/docs/resources/aws_cloudwatch_log_metric_filter.md.erb +154 -154
  36. data/docs/resources/aws_config_delivery_channel.md.erb +101 -101
  37. data/docs/resources/aws_config_recorder.md.erb +86 -86
  38. data/docs/resources/aws_ec2_instance.md.erb +112 -112
  39. data/docs/resources/aws_ec2_instances.md.erb +79 -79
  40. data/docs/resources/aws_iam_access_key.md.erb +129 -129
  41. data/docs/resources/aws_iam_access_keys.md.erb +204 -204
  42. data/docs/resources/aws_iam_group.md.erb +64 -64
  43. data/docs/resources/aws_iam_groups.md.erb +49 -49
  44. data/docs/resources/aws_iam_password_policy.md.erb +82 -82
  45. data/docs/resources/aws_iam_policies.md.erb +87 -87
  46. data/docs/resources/aws_iam_policy.md.erb +245 -245
  47. data/docs/resources/aws_iam_role.md.erb +69 -69
  48. data/docs/resources/aws_iam_root_user.md.erb +76 -76
  49. data/docs/resources/aws_iam_user.md.erb +120 -120
  50. data/docs/resources/aws_iam_users.md.erb +279 -279
  51. data/docs/resources/aws_kms_key.md.erb +177 -177
  52. data/docs/resources/aws_kms_keys.md.erb +89 -89
  53. data/docs/resources/aws_rds_instance.md.erb +66 -66
  54. data/docs/resources/aws_route_table.md.erb +53 -53
  55. data/docs/resources/aws_route_tables.md.erb +55 -55
  56. data/docs/resources/aws_s3_bucket.md.erb +146 -146
  57. data/docs/resources/aws_s3_bucket_object.md.erb +89 -89
  58. data/docs/resources/aws_s3_buckets.md.erb +59 -59
  59. data/docs/resources/aws_security_group.md.erb +296 -296
  60. data/docs/resources/aws_security_groups.md.erb +97 -97
  61. data/docs/resources/aws_sns_subscription.md.erb +130 -130
  62. data/docs/resources/aws_sns_topic.md.erb +69 -69
  63. data/docs/resources/aws_sns_topics.md.erb +58 -58
  64. data/docs/resources/aws_subnet.md.erb +140 -140
  65. data/docs/resources/aws_subnets.md.erb +132 -132
  66. data/docs/resources/aws_vpc.md.erb +125 -125
  67. data/docs/resources/aws_vpcs.md.erb +125 -125
  68. data/docs/resources/azure_generic_resource.md.erb +171 -171
  69. data/docs/resources/azure_resource_group.md.erb +284 -284
  70. data/docs/resources/azure_virtual_machine.md.erb +347 -347
  71. data/docs/resources/azure_virtual_machine_data_disk.md.erb +224 -224
  72. data/docs/resources/bash.md.erb +75 -75
  73. data/docs/resources/bond.md.erb +90 -90
  74. data/docs/resources/bridge.md.erb +57 -57
  75. data/docs/resources/bsd_service.md.erb +67 -67
  76. data/docs/resources/chocolatey_package.md.erb +58 -58
  77. data/docs/resources/command.md.erb +138 -138
  78. data/docs/resources/cpan.md.erb +79 -79
  79. data/docs/resources/cran.md.erb +64 -64
  80. data/docs/resources/crontab.md.erb +89 -89
  81. data/docs/resources/csv.md.erb +54 -54
  82. data/docs/resources/dh_params.md.erb +205 -205
  83. data/docs/resources/directory.md.erb +30 -30
  84. data/docs/resources/docker.md.erb +219 -219
  85. data/docs/resources/docker_container.md.erb +103 -103
  86. data/docs/resources/docker_image.md.erb +94 -94
  87. data/docs/resources/docker_service.md.erb +114 -114
  88. data/docs/resources/elasticsearch.md.erb +242 -242
  89. data/docs/resources/etc_fstab.md.erb +125 -125
  90. data/docs/resources/etc_group.md.erb +75 -75
  91. data/docs/resources/etc_hosts.md.erb +78 -78
  92. data/docs/resources/etc_hosts_allow.md.erb +74 -74
  93. data/docs/resources/etc_hosts_deny.md.erb +74 -74
  94. data/docs/resources/file.md.erb +526 -526
  95. data/docs/resources/filesystem.md.erb +41 -41
  96. data/docs/resources/firewalld.md.erb +107 -107
  97. data/docs/resources/gem.md.erb +79 -79
  98. data/docs/resources/group.md.erb +61 -61
  99. data/docs/resources/grub_conf.md.erb +101 -101
  100. data/docs/resources/host.md.erb +86 -86
  101. data/docs/resources/http.md.erb +197 -197
  102. data/docs/resources/iis_app.md.erb +122 -122
  103. data/docs/resources/iis_site.md.erb +135 -135
  104. data/docs/resources/inetd_conf.md.erb +94 -94
  105. data/docs/resources/ini.md.erb +76 -76
  106. data/docs/resources/interface.md.erb +58 -58
  107. data/docs/resources/iptables.md.erb +64 -64
  108. data/docs/resources/json.md.erb +63 -63
  109. data/docs/resources/kernel_module.md.erb +120 -120
  110. data/docs/resources/kernel_parameter.md.erb +53 -53
  111. data/docs/resources/key_rsa.md.erb +85 -85
  112. data/docs/resources/launchd_service.md.erb +57 -57
  113. data/docs/resources/limits_conf.md.erb +75 -75
  114. data/docs/resources/login_defs.md.erb +71 -71
  115. data/docs/resources/mount.md.erb +69 -69
  116. data/docs/resources/mssql_session.md.erb +60 -60
  117. data/docs/resources/mysql_conf.md.erb +99 -99
  118. data/docs/resources/mysql_session.md.erb +74 -74
  119. data/docs/resources/nginx.md.erb +79 -79
  120. data/docs/resources/nginx_conf.md.erb +138 -138
  121. data/docs/resources/npm.md.erb +60 -60
  122. data/docs/resources/ntp_conf.md.erb +60 -60
  123. data/docs/resources/oneget.md.erb +53 -53
  124. data/docs/resources/oracledb_session.md.erb +52 -52
  125. data/docs/resources/os.md.erb +141 -141
  126. data/docs/resources/os_env.md.erb +91 -91
  127. data/docs/resources/package.md.erb +120 -120
  128. data/docs/resources/packages.md.erb +67 -67
  129. data/docs/resources/parse_config.md.erb +103 -103
  130. data/docs/resources/parse_config_file.md.erb +138 -138
  131. data/docs/resources/passwd.md.erb +141 -141
  132. data/docs/resources/pip.md.erb +67 -67
  133. data/docs/resources/port.md.erb +137 -137
  134. data/docs/resources/postgres_conf.md.erb +79 -79
  135. data/docs/resources/postgres_hba_conf.md.erb +93 -93
  136. data/docs/resources/postgres_ident_conf.md.erb +76 -76
  137. data/docs/resources/postgres_session.md.erb +69 -69
  138. data/docs/resources/powershell.md.erb +102 -102
  139. data/docs/resources/processes.md.erb +109 -109
  140. data/docs/resources/rabbitmq_config.md.erb +41 -41
  141. data/docs/resources/registry_key.md.erb +158 -158
  142. data/docs/resources/runit_service.md.erb +57 -57
  143. data/docs/resources/security_policy.md.erb +47 -47
  144. data/docs/resources/service.md.erb +121 -121
  145. data/docs/resources/shadow.md.erb +146 -146
  146. data/docs/resources/ssh_config.md.erb +73 -73
  147. data/docs/resources/sshd_config.md.erb +83 -83
  148. data/docs/resources/ssl.md.erb +119 -119
  149. data/docs/resources/sys_info.md.erb +42 -42
  150. data/docs/resources/systemd_service.md.erb +57 -57
  151. data/docs/resources/sysv_service.md.erb +57 -57
  152. data/docs/resources/upstart_service.md.erb +57 -57
  153. data/docs/resources/user.md.erb +140 -140
  154. data/docs/resources/users.md.erb +127 -127
  155. data/docs/resources/vbscript.md.erb +55 -55
  156. data/docs/resources/virtualization.md.erb +57 -57
  157. data/docs/resources/windows_feature.md.erb +47 -47
  158. data/docs/resources/windows_hotfix.md.erb +53 -53
  159. data/docs/resources/windows_task.md.erb +95 -95
  160. data/docs/resources/wmi.md.erb +81 -81
  161. data/docs/resources/x509_certificate.md.erb +151 -151
  162. data/docs/resources/xinetd_conf.md.erb +156 -156
  163. data/docs/resources/xml.md.erb +85 -85
  164. data/docs/resources/yaml.md.erb +69 -69
  165. data/docs/resources/yum.md.erb +98 -98
  166. data/docs/resources/zfs_dataset.md.erb +53 -53
  167. data/docs/resources/zfs_pool.md.erb +47 -47
  168. data/docs/ruby_usage.md +203 -203
  169. data/docs/shared/matcher_be.md.erb +1 -1
  170. data/docs/shared/matcher_cmp.md.erb +43 -43
  171. data/docs/shared/matcher_eq.md.erb +3 -3
  172. data/docs/shared/matcher_include.md.erb +1 -1
  173. data/docs/shared/matcher_match.md.erb +1 -1
  174. data/docs/shell.md +217 -217
  175. data/examples/README.md +8 -8
  176. data/examples/inheritance/README.md +65 -65
  177. data/examples/inheritance/controls/example.rb +14 -14
  178. data/examples/inheritance/inspec.yml +15 -15
  179. data/examples/kitchen-ansible/.kitchen.yml +25 -25
  180. data/examples/kitchen-ansible/Gemfile +19 -19
  181. data/examples/kitchen-ansible/README.md +53 -53
  182. data/examples/kitchen-ansible/files/nginx.repo +6 -6
  183. data/examples/kitchen-ansible/tasks/main.yml +16 -16
  184. data/examples/kitchen-ansible/test/integration/default/default.yml +5 -5
  185. data/examples/kitchen-ansible/test/integration/default/web_spec.rb +28 -28
  186. data/examples/kitchen-chef/.kitchen.yml +20 -20
  187. data/examples/kitchen-chef/Berksfile +3 -3
  188. data/examples/kitchen-chef/Gemfile +19 -19
  189. data/examples/kitchen-chef/README.md +27 -27
  190. data/examples/kitchen-chef/metadata.rb +7 -7
  191. data/examples/kitchen-chef/recipes/default.rb +6 -6
  192. data/examples/kitchen-chef/recipes/nginx.rb +30 -30
  193. data/examples/kitchen-chef/test/integration/default/web_spec.rb +28 -28
  194. data/examples/kitchen-puppet/.kitchen.yml +23 -23
  195. data/examples/kitchen-puppet/Gemfile +20 -20
  196. data/examples/kitchen-puppet/Puppetfile +25 -25
  197. data/examples/kitchen-puppet/README.md +53 -53
  198. data/examples/kitchen-puppet/manifests/site.pp +33 -33
  199. data/examples/kitchen-puppet/metadata.json +11 -11
  200. data/examples/kitchen-puppet/modules/.gitkeep +0 -0
  201. data/examples/kitchen-puppet/test/integration/default/web_spec.rb +28 -28
  202. data/examples/meta-profile/README.md +37 -37
  203. data/examples/meta-profile/controls/example.rb +13 -13
  204. data/examples/meta-profile/inspec.yml +13 -13
  205. data/examples/profile-attribute.yml +2 -2
  206. data/examples/profile-attribute/README.md +14 -14
  207. data/examples/profile-attribute/controls/example.rb +11 -11
  208. data/examples/profile-attribute/inspec.yml +8 -8
  209. data/examples/profile-aws/controls/iam_password_policy_expiration.rb +8 -8
  210. data/examples/profile-aws/controls/iam_password_policy_max_age.rb +8 -8
  211. data/examples/profile-aws/controls/iam_root_user_mfa.rb +8 -8
  212. data/examples/profile-aws/controls/iam_users_access_key_age.rb +8 -8
  213. data/examples/profile-aws/controls/iam_users_console_users_mfa.rb +8 -8
  214. data/examples/profile-aws/inspec.yml +11 -11
  215. data/examples/profile-azure/controls/azure_resource_group_example.rb +24 -24
  216. data/examples/profile-azure/controls/azure_vm_example.rb +29 -29
  217. data/examples/profile-azure/inspec.yml +11 -11
  218. data/examples/profile-sensitive/README.md +29 -29
  219. data/examples/profile-sensitive/controls/sensitive-failures.rb +9 -9
  220. data/examples/profile-sensitive/controls/sensitive.rb +9 -9
  221. data/examples/profile-sensitive/inspec.yml +8 -8
  222. data/examples/profile/README.md +48 -48
  223. data/examples/profile/controls/example.rb +23 -23
  224. data/examples/profile/controls/gordon.rb +36 -36
  225. data/examples/profile/controls/meta.rb +34 -34
  226. data/examples/profile/inspec.yml +10 -10
  227. data/examples/profile/libraries/gordon_config.rb +59 -59
  228. data/inspec.gemspec +49 -49
  229. data/lib/bundles/README.md +3 -3
  230. data/lib/bundles/inspec-artifact.rb +7 -7
  231. data/lib/bundles/inspec-artifact/README.md +1 -1
  232. data/lib/bundles/inspec-artifact/cli.rb +277 -277
  233. data/lib/bundles/inspec-compliance.rb +16 -16
  234. data/lib/bundles/inspec-compliance/.kitchen.yml +20 -20
  235. data/lib/bundles/inspec-compliance/README.md +193 -193
  236. data/lib/bundles/inspec-compliance/api.rb +360 -360
  237. data/lib/bundles/inspec-compliance/api/login.rb +193 -193
  238. data/lib/bundles/inspec-compliance/bootstrap.sh +41 -41
  239. data/lib/bundles/inspec-compliance/cli.rb +260 -260
  240. data/lib/bundles/inspec-compliance/configuration.rb +103 -103
  241. data/lib/bundles/inspec-compliance/http.rb +125 -125
  242. data/lib/bundles/inspec-compliance/images/cc-token.png +0 -0
  243. data/lib/bundles/inspec-compliance/support.rb +36 -36
  244. data/lib/bundles/inspec-compliance/target.rb +112 -112
  245. data/lib/bundles/inspec-compliance/test/integration/default/cli.rb +93 -93
  246. data/lib/bundles/inspec-habitat.rb +12 -12
  247. data/lib/bundles/inspec-habitat/cli.rb +36 -36
  248. data/lib/bundles/inspec-habitat/log.rb +10 -10
  249. data/lib/bundles/inspec-habitat/profile.rb +391 -391
  250. data/lib/bundles/inspec-init.rb +8 -8
  251. data/lib/bundles/inspec-init/README.md +31 -31
  252. data/lib/bundles/inspec-init/cli.rb +97 -97
  253. data/lib/bundles/inspec-init/templates/profile/README.md +3 -3
  254. data/lib/bundles/inspec-init/templates/profile/controls/example.rb +19 -19
  255. data/lib/bundles/inspec-init/templates/profile/inspec.yml +8 -8
  256. data/lib/bundles/inspec-init/templates/profile/libraries/.gitkeep +0 -0
  257. data/lib/bundles/inspec-supermarket.rb +13 -13
  258. data/lib/bundles/inspec-supermarket/README.md +45 -45
  259. data/lib/bundles/inspec-supermarket/api.rb +84 -84
  260. data/lib/bundles/inspec-supermarket/cli.rb +73 -73
  261. data/lib/bundles/inspec-supermarket/target.rb +34 -34
  262. data/lib/fetchers/git.rb +163 -163
  263. data/lib/fetchers/local.rb +74 -74
  264. data/lib/fetchers/mock.rb +35 -35
  265. data/lib/fetchers/url.rb +247 -247
  266. data/lib/inspec.rb +24 -24
  267. data/lib/inspec/archive/tar.rb +29 -29
  268. data/lib/inspec/archive/zip.rb +19 -19
  269. data/lib/inspec/backend.rb +93 -93
  270. data/lib/inspec/base_cli.rb +368 -368
  271. data/lib/inspec/cached_fetcher.rb +66 -66
  272. data/lib/inspec/cli.rb +292 -292
  273. data/lib/inspec/completions/bash.sh.erb +45 -45
  274. data/lib/inspec/completions/fish.sh.erb +34 -34
  275. data/lib/inspec/completions/zsh.sh.erb +61 -61
  276. data/lib/inspec/control_eval_context.rb +179 -179
  277. data/lib/inspec/dependencies/cache.rb +72 -72
  278. data/lib/inspec/dependencies/dependency_set.rb +92 -92
  279. data/lib/inspec/dependencies/lockfile.rb +115 -115
  280. data/lib/inspec/dependencies/requirement.rb +123 -123
  281. data/lib/inspec/dependencies/resolver.rb +86 -86
  282. data/lib/inspec/describe.rb +27 -27
  283. data/lib/inspec/dsl.rb +66 -66
  284. data/lib/inspec/dsl_shared.rb +33 -33
  285. data/lib/inspec/env_printer.rb +157 -157
  286. data/lib/inspec/errors.rb +14 -14
  287. data/lib/inspec/exceptions.rb +12 -12
  288. data/lib/inspec/expect.rb +45 -45
  289. data/lib/inspec/fetcher.rb +45 -45
  290. data/lib/inspec/file_provider.rb +275 -275
  291. data/lib/inspec/formatters.rb +3 -3
  292. data/lib/inspec/formatters/base.rb +259 -259
  293. data/lib/inspec/formatters/json_rspec.rb +20 -20
  294. data/lib/inspec/formatters/show_progress.rb +12 -12
  295. data/lib/inspec/library_eval_context.rb +58 -58
  296. data/lib/inspec/log.rb +11 -11
  297. data/lib/inspec/metadata.rb +247 -247
  298. data/lib/inspec/method_source.rb +24 -24
  299. data/lib/inspec/objects.rb +14 -14
  300. data/lib/inspec/objects/attribute.rb +75 -75
  301. data/lib/inspec/objects/control.rb +61 -61
  302. data/lib/inspec/objects/describe.rb +92 -92
  303. data/lib/inspec/objects/each_loop.rb +36 -36
  304. data/lib/inspec/objects/list.rb +15 -15
  305. data/lib/inspec/objects/or_test.rb +40 -40
  306. data/lib/inspec/objects/ruby_helper.rb +15 -15
  307. data/lib/inspec/objects/tag.rb +27 -27
  308. data/lib/inspec/objects/test.rb +87 -87
  309. data/lib/inspec/objects/value.rb +27 -27
  310. data/lib/inspec/plugins.rb +60 -60
  311. data/lib/inspec/plugins/cli.rb +24 -24
  312. data/lib/inspec/plugins/fetcher.rb +86 -86
  313. data/lib/inspec/plugins/resource.rb +135 -135
  314. data/lib/inspec/plugins/secret.rb +15 -15
  315. data/lib/inspec/plugins/source_reader.rb +40 -40
  316. data/lib/inspec/polyfill.rb +12 -12
  317. data/lib/inspec/profile.rb +513 -513
  318. data/lib/inspec/profile_context.rb +208 -208
  319. data/lib/inspec/profile_vendor.rb +66 -66
  320. data/lib/inspec/reporters.rb +60 -60
  321. data/lib/inspec/reporters/automate.rb +76 -76
  322. data/lib/inspec/reporters/base.rb +25 -25
  323. data/lib/inspec/reporters/cli.rb +356 -356
  324. data/lib/inspec/reporters/json.rb +117 -117
  325. data/lib/inspec/reporters/json_min.rb +48 -48
  326. data/lib/inspec/reporters/junit.rb +78 -78
  327. data/lib/inspec/require_loader.rb +33 -33
  328. data/lib/inspec/resource.rb +190 -190
  329. data/lib/inspec/rule.rb +280 -280
  330. data/lib/inspec/runner.rb +345 -345
  331. data/lib/inspec/runner_mock.rb +41 -41
  332. data/lib/inspec/runner_rspec.rb +175 -175
  333. data/lib/inspec/runtime_profile.rb +26 -26
  334. data/lib/inspec/schema.rb +213 -213
  335. data/lib/inspec/secrets.rb +19 -19
  336. data/lib/inspec/secrets/yaml.rb +30 -30
  337. data/lib/inspec/shell.rb +220 -220
  338. data/lib/inspec/shell_detector.rb +90 -90
  339. data/lib/inspec/source_reader.rb +29 -29
  340. data/lib/inspec/version.rb +8 -8
  341. data/lib/matchers/matchers.rb +339 -339
  342. data/lib/resource_support/aws.rb +50 -50
  343. data/lib/resource_support/aws/aws_backend_base.rb +12 -12
  344. data/lib/resource_support/aws/aws_backend_factory_mixin.rb +12 -12
  345. data/lib/resource_support/aws/aws_plural_resource_mixin.rb +21 -21
  346. data/lib/resource_support/aws/aws_resource_mixin.rb +66 -66
  347. data/lib/resource_support/aws/aws_singular_resource_mixin.rb +24 -24
  348. data/lib/resources/aide_conf.rb +151 -151
  349. data/lib/resources/apache.rb +48 -48
  350. data/lib/resources/apache_conf.rb +149 -149
  351. data/lib/resources/apt.rb +149 -149
  352. data/lib/resources/audit_policy.rb +63 -63
  353. data/lib/resources/auditd.rb +231 -231
  354. data/lib/resources/auditd_conf.rb +46 -46
  355. data/lib/resources/aws/aws_cloudtrail_trail.rb +93 -93
  356. data/lib/resources/aws/aws_cloudtrail_trails.rb +47 -47
  357. data/lib/resources/aws/aws_cloudwatch_alarm.rb +62 -62
  358. data/lib/resources/aws/aws_cloudwatch_log_metric_filter.rb +100 -100
  359. data/lib/resources/aws/aws_config_delivery_channel.rb +70 -70
  360. data/lib/resources/aws/aws_config_recorder.rb +93 -93
  361. data/lib/resources/aws/aws_ec2_instance.rb +157 -157
  362. data/lib/resources/aws/aws_ec2_instances.rb +64 -64
  363. data/lib/resources/aws/aws_iam_access_key.rb +106 -106
  364. data/lib/resources/aws/aws_iam_access_keys.rb +149 -149
  365. data/lib/resources/aws/aws_iam_group.rb +58 -58
  366. data/lib/resources/aws/aws_iam_groups.rb +52 -52
  367. data/lib/resources/aws/aws_iam_password_policy.rb +116 -116
  368. data/lib/resources/aws/aws_iam_policies.rb +53 -53
  369. data/lib/resources/aws/aws_iam_policy.rb +291 -291
  370. data/lib/resources/aws/aws_iam_role.rb +55 -55
  371. data/lib/resources/aws/aws_iam_root_user.rb +78 -78
  372. data/lib/resources/aws/aws_iam_user.rb +142 -142
  373. data/lib/resources/aws/aws_iam_users.rb +146 -146
  374. data/lib/resources/aws/aws_kms_key.rb +96 -96
  375. data/lib/resources/aws/aws_kms_keys.rb +53 -53
  376. data/lib/resources/aws/aws_rds_instance.rb +71 -71
  377. data/lib/resources/aws/aws_route_table.rb +63 -63
  378. data/lib/resources/aws/aws_route_tables.rb +60 -60
  379. data/lib/resources/aws/aws_s3_bucket.rb +137 -137
  380. data/lib/resources/aws/aws_s3_bucket_object.rb +82 -82
  381. data/lib/resources/aws/aws_s3_buckets.rb +51 -51
  382. data/lib/resources/aws/aws_security_group.rb +249 -249
  383. data/lib/resources/aws/aws_security_groups.rb +68 -68
  384. data/lib/resources/aws/aws_sns_subscription.rb +78 -78
  385. data/lib/resources/aws/aws_sns_topic.rb +53 -53
  386. data/lib/resources/aws/aws_sns_topics.rb +56 -56
  387. data/lib/resources/aws/aws_subnet.rb +88 -88
  388. data/lib/resources/aws/aws_subnets.rb +53 -53
  389. data/lib/resources/aws/aws_vpc.rb +73 -73
  390. data/lib/resources/aws/aws_vpcs.rb +52 -52
  391. data/lib/resources/azure/azure_backend.rb +377 -377
  392. data/lib/resources/azure/azure_generic_resource.rb +59 -59
  393. data/lib/resources/azure/azure_resource_group.rb +152 -152
  394. data/lib/resources/azure/azure_virtual_machine.rb +264 -264
  395. data/lib/resources/azure/azure_virtual_machine_data_disk.rb +134 -134
  396. data/lib/resources/bash.rb +35 -35
  397. data/lib/resources/bond.rb +69 -69
  398. data/lib/resources/bridge.rb +122 -122
  399. data/lib/resources/chocolatey_package.rb +78 -78
  400. data/lib/resources/command.rb +73 -73
  401. data/lib/resources/cpan.rb +58 -58
  402. data/lib/resources/cran.rb +64 -64
  403. data/lib/resources/crontab.rb +169 -169
  404. data/lib/resources/csv.rb +56 -56
  405. data/lib/resources/dh_params.rb +77 -77
  406. data/lib/resources/directory.rb +25 -25
  407. data/lib/resources/docker.rb +236 -236
  408. data/lib/resources/docker_container.rb +89 -89
  409. data/lib/resources/docker_image.rb +83 -83
  410. data/lib/resources/docker_object.rb +57 -57
  411. data/lib/resources/docker_service.rb +90 -90
  412. data/lib/resources/elasticsearch.rb +169 -169
  413. data/lib/resources/etc_fstab.rb +94 -94
  414. data/lib/resources/etc_group.rb +154 -154
  415. data/lib/resources/etc_hosts.rb +66 -66
  416. data/lib/resources/etc_hosts_allow_deny.rb +112 -112
  417. data/lib/resources/file.rb +298 -298
  418. data/lib/resources/filesystem.rb +31 -31
  419. data/lib/resources/firewalld.rb +143 -143
  420. data/lib/resources/gem.rb +70 -70
  421. data/lib/resources/groups.rb +215 -215
  422. data/lib/resources/grub_conf.rb +227 -227
  423. data/lib/resources/host.rb +306 -306
  424. data/lib/resources/http.rb +253 -253
  425. data/lib/resources/iis_app.rb +101 -101
  426. data/lib/resources/iis_site.rb +148 -148
  427. data/lib/resources/inetd_conf.rb +54 -54
  428. data/lib/resources/ini.rb +29 -29
  429. data/lib/resources/interface.rb +129 -129
  430. data/lib/resources/iptables.rb +80 -80
  431. data/lib/resources/json.rb +111 -111
  432. data/lib/resources/kernel_module.rb +107 -107
  433. data/lib/resources/kernel_parameter.rb +58 -58
  434. data/lib/resources/key_rsa.rb +63 -63
  435. data/lib/resources/limits_conf.rb +46 -46
  436. data/lib/resources/login_def.rb +57 -57
  437. data/lib/resources/mount.rb +88 -88
  438. data/lib/resources/mssql_session.rb +101 -101
  439. data/lib/resources/mysql.rb +82 -82
  440. data/lib/resources/mysql_conf.rb +127 -127
  441. data/lib/resources/mysql_session.rb +85 -85
  442. data/lib/resources/nginx.rb +96 -96
  443. data/lib/resources/nginx_conf.rb +226 -226
  444. data/lib/resources/npm.rb +48 -48
  445. data/lib/resources/ntp_conf.rb +51 -51
  446. data/lib/resources/oneget.rb +71 -71
  447. data/lib/resources/oracledb_session.rb +139 -139
  448. data/lib/resources/os.rb +36 -36
  449. data/lib/resources/os_env.rb +86 -86
  450. data/lib/resources/package.rb +370 -370
  451. data/lib/resources/packages.rb +111 -111
  452. data/lib/resources/parse_config.rb +112 -112
  453. data/lib/resources/passwd.rb +76 -76
  454. data/lib/resources/pip.rb +130 -130
  455. data/lib/resources/platform.rb +109 -109
  456. data/lib/resources/port.rb +771 -771
  457. data/lib/resources/postgres.rb +131 -131
  458. data/lib/resources/postgres_conf.rb +114 -114
  459. data/lib/resources/postgres_hba_conf.rb +90 -90
  460. data/lib/resources/postgres_ident_conf.rb +79 -79
  461. data/lib/resources/postgres_session.rb +71 -71
  462. data/lib/resources/powershell.rb +67 -67
  463. data/lib/resources/processes.rb +204 -204
  464. data/lib/resources/rabbitmq_conf.rb +51 -51
  465. data/lib/resources/registry_key.rb +297 -297
  466. data/lib/resources/security_policy.rb +180 -180
  467. data/lib/resources/service.rb +794 -794
  468. data/lib/resources/shadow.rb +159 -159
  469. data/lib/resources/ssh_conf.rb +97 -97
  470. data/lib/resources/ssl.rb +99 -99
  471. data/lib/resources/sys_info.rb +28 -28
  472. data/lib/resources/toml.rb +32 -32
  473. data/lib/resources/users.rb +654 -654
  474. data/lib/resources/vbscript.rb +68 -68
  475. data/lib/resources/virtualization.rb +247 -247
  476. data/lib/resources/windows_feature.rb +84 -84
  477. data/lib/resources/windows_hotfix.rb +35 -35
  478. data/lib/resources/windows_task.rb +102 -102
  479. data/lib/resources/wmi.rb +110 -110
  480. data/lib/resources/x509_certificate.rb +137 -137
  481. data/lib/resources/xinetd.rb +106 -106
  482. data/lib/resources/xml.rb +46 -46
  483. data/lib/resources/yaml.rb +43 -43
  484. data/lib/resources/yum.rb +180 -180
  485. data/lib/resources/zfs_dataset.rb +60 -60
  486. data/lib/resources/zfs_pool.rb +49 -49
  487. data/lib/source_readers/flat.rb +39 -39
  488. data/lib/source_readers/inspec.rb +75 -75
  489. data/lib/utils/command_wrapper.rb +27 -27
  490. data/lib/utils/convert.rb +12 -12
  491. data/lib/utils/database_helpers.rb +77 -77
  492. data/lib/utils/enumerable_delegation.rb +9 -9
  493. data/lib/utils/erlang_parser.rb +192 -192
  494. data/lib/utils/file_reader.rb +25 -25
  495. data/lib/utils/filter.rb +273 -273
  496. data/lib/utils/filter_array.rb +27 -27
  497. data/lib/utils/find_files.rb +47 -47
  498. data/lib/utils/hash.rb +41 -41
  499. data/lib/utils/json_log.rb +18 -18
  500. data/lib/utils/latest_version.rb +22 -22
  501. data/lib/utils/modulator.rb +12 -12
  502. data/lib/utils/nginx_parser.rb +105 -105
  503. data/lib/utils/object_traversal.rb +49 -49
  504. data/lib/utils/parser.rb +274 -274
  505. data/lib/utils/pkey_reader.rb +15 -15
  506. data/lib/utils/plugin_registry.rb +93 -93
  507. data/lib/utils/simpleconfig.rb +120 -120
  508. data/lib/utils/spdx.rb +13 -13
  509. data/lib/utils/spdx.txt +343 -343
  510. metadata +3 -3
@@ -1,33 +1,33 @@
1
- # encoding: utf-8
2
- # author: Dominik Richter
3
- # author: Christoph Hartmann
4
-
5
- module Inspec
6
- class RequireLoader
7
- Item = Struct.new(:content, :ref, :line, :loaded)
8
-
9
- def initialize
10
- @contents = {}
11
- end
12
-
13
- def add(path, content, ref, line)
14
- @contents[path] = Item.new(content, ref, line, false)
15
- end
16
-
17
- def load(path)
18
- c = @contents[path]
19
- c.loaded = true
20
- res = [c.content, c.ref, c.line || 1]
21
- yield res if block_given?
22
- res
23
- end
24
-
25
- def exists?(path)
26
- @contents.key?(path)
27
- end
28
-
29
- def loaded?(path)
30
- @contents[path].loaded == true
31
- end
32
- end
33
- end
1
+ # encoding: utf-8
2
+ # author: Dominik Richter
3
+ # author: Christoph Hartmann
4
+
5
+ module Inspec
6
+ class RequireLoader
7
+ Item = Struct.new(:content, :ref, :line, :loaded)
8
+
9
+ def initialize
10
+ @contents = {}
11
+ end
12
+
13
+ def add(path, content, ref, line)
14
+ @contents[path] = Item.new(content, ref, line, false)
15
+ end
16
+
17
+ def load(path)
18
+ c = @contents[path]
19
+ c.loaded = true
20
+ res = [c.content, c.ref, c.line || 1]
21
+ yield res if block_given?
22
+ res
23
+ end
24
+
25
+ def exists?(path)
26
+ @contents.key?(path)
27
+ end
28
+
29
+ def loaded?(path)
30
+ @contents[path].loaded == true
31
+ end
32
+ end
33
+ end
@@ -1,190 +1,190 @@
1
- # encoding: utf-8
2
- # copyright: 2015, Vulcano Security GmbH
3
- # author: Dominik Richter
4
- # author: Christoph Hartmann
5
- require 'inspec/plugins'
6
-
7
- module Inspec
8
- class ProfileNotFound < StandardError; end
9
-
10
- class Resource
11
- def self.default_registry
12
- @default_registry ||= {}
13
- end
14
-
15
- def self.registry
16
- @registry ||= default_registry
17
- end
18
-
19
- def self.supports
20
- @supports ||= {}
21
- end
22
-
23
- def self.new_registry
24
- default_registry.dup
25
- end
26
-
27
- # Creates the inner DSL which includes all resources for
28
- # creating tests. It is always connected to one target,
29
- # which is specified via the backend argument.
30
- #
31
- # @param backend [BackendRunner] exposing the target to resources
32
- # @return [ResourcesDSL]
33
- def self.create_dsl(profile_context)
34
- backend = profile_context.backend
35
- my_registry = profile_context.resource_registry
36
-
37
- Module.new do
38
- define_method :resource_class do |profile_name, resource_name|
39
- inner_context = if profile_name == profile_context.profile_id
40
- profile_context
41
- else
42
- profile_context.subcontext_by_name(profile_name)
43
- end
44
-
45
- raise ProfileNotFound, "Cannot find profile named: #{profile_name}" if inner_context.nil?
46
- inner_context.resource_registry[resource_name]
47
- end
48
-
49
- my_registry.each do |id, r|
50
- define_method id.to_sym do |*args|
51
- r.new(backend, id.to_s, *args)
52
- end
53
- end
54
-
55
- define_method :inspec do
56
- backend
57
- end
58
- end
59
- end
60
- end
61
-
62
- # Retrieve the base class for creating a new resource.
63
- # Create classes that inherit from this class.
64
- #
65
- # @param [int] version the resource version to use
66
- # @return [Resource] base class for creating a new resource
67
- def self.resource(version)
68
- validate_resource_dsl_version!(version)
69
- Inspec::Plugins::Resource
70
- end
71
-
72
- def self.validate_resource_dsl_version!(version)
73
- raise 'Only resource version 1 is supported!' if version != 1
74
- end
75
- end
76
-
77
- # Many resources use FilterTable.
78
- require 'utils/filter'
79
-
80
- # AWS resources are included via their own file.
81
- require 'resource_support/aws' if Gem.loaded_specs.key?('aws-sdk')
82
-
83
- if Gem.loaded_specs.key?('azure_mgmt_resources')
84
- require 'resources/azure/azure_backend.rb'
85
- require 'resources/azure/azure_generic_resource.rb'
86
- require 'resources/azure/azure_resource_group.rb'
87
- require 'resources/azure/azure_virtual_machine.rb'
88
- require 'resources/azure/azure_virtual_machine_data_disk.rb'
89
- end
90
-
91
- require 'resources/aide_conf'
92
- require 'resources/apache'
93
- require 'resources/apache_conf'
94
- require 'resources/apt'
95
- require 'resources/audit_policy'
96
- require 'resources/auditd'
97
- require 'resources/auditd_conf'
98
- require 'resources/bash'
99
- require 'resources/bond'
100
- require 'resources/bridge'
101
- require 'resources/chocolatey_package'
102
- require 'resources/command'
103
- require 'resources/cran'
104
- require 'resources/cpan'
105
- require 'resources/crontab'
106
- require 'resources/dh_params'
107
- require 'resources/directory'
108
- require 'resources/docker'
109
- require 'resources/docker_container'
110
- require 'resources/docker_image'
111
- require 'resources/docker_service'
112
- require 'resources/elasticsearch'
113
- require 'resources/etc_fstab'
114
- require 'resources/etc_group'
115
- require 'resources/etc_hosts_allow_deny'
116
- require 'resources/etc_hosts'
117
- require 'resources/file'
118
- require 'resources/filesystem'
119
- require 'resources/firewalld'
120
- require 'resources/gem'
121
- require 'resources/groups'
122
- require 'resources/grub_conf'
123
- require 'resources/host'
124
- require 'resources/http'
125
- require 'resources/iis_app'
126
- require 'resources/iis_site'
127
- require 'resources/inetd_conf'
128
- require 'resources/interface'
129
- require 'resources/iptables'
130
- require 'resources/json'
131
- require 'resources/kernel_module'
132
- require 'resources/kernel_parameter'
133
- require 'resources/key_rsa'
134
- require 'resources/limits_conf'
135
- require 'resources/login_def'
136
- require 'resources/mount'
137
- require 'resources/mssql_session'
138
- require 'resources/mysql'
139
- require 'resources/mysql_conf'
140
- require 'resources/mysql_session'
141
- require 'resources/nginx'
142
- require 'resources/nginx_conf'
143
- require 'resources/npm'
144
- require 'resources/ntp_conf'
145
- require 'resources/oneget'
146
- require 'resources/oracledb_session'
147
- require 'resources/os'
148
- require 'resources/os_env'
149
- require 'resources/package'
150
- require 'resources/packages'
151
- require 'resources/parse_config'
152
- require 'resources/passwd'
153
- require 'resources/pip'
154
- require 'resources/platform'
155
- require 'resources/port'
156
- require 'resources/postgres'
157
- require 'resources/postgres_conf'
158
- require 'resources/postgres_hba_conf'
159
- require 'resources/postgres_ident_conf'
160
- require 'resources/postgres_session'
161
- require 'resources/powershell'
162
- require 'resources/processes'
163
- require 'resources/rabbitmq_conf'
164
- require 'resources/registry_key'
165
- require 'resources/security_policy'
166
- require 'resources/service'
167
- require 'resources/shadow'
168
- require 'resources/ssh_conf'
169
- require 'resources/ssl'
170
- require 'resources/sys_info'
171
- require 'resources/toml'
172
- require 'resources/users'
173
- require 'resources/vbscript'
174
- require 'resources/virtualization'
175
- require 'resources/windows_feature'
176
- require 'resources/windows_hotfix'
177
- require 'resources/windows_task'
178
- require 'resources/wmi'
179
- require 'resources/x509_certificate'
180
- require 'resources/xinetd'
181
- require 'resources/yum'
182
- require 'resources/zfs_dataset'
183
- require 'resources/zfs_pool'
184
-
185
- # file formats, depend on json implementation
186
- require 'resources/json'
187
- require 'resources/yaml'
188
- require 'resources/csv'
189
- require 'resources/ini'
190
- require 'resources/xml'
1
+ # encoding: utf-8
2
+ # copyright: 2015, Vulcano Security GmbH
3
+ # author: Dominik Richter
4
+ # author: Christoph Hartmann
5
+ require 'inspec/plugins'
6
+
7
+ module Inspec
8
+ class ProfileNotFound < StandardError; end
9
+
10
+ class Resource
11
+ def self.default_registry
12
+ @default_registry ||= {}
13
+ end
14
+
15
+ def self.registry
16
+ @registry ||= default_registry
17
+ end
18
+
19
+ def self.supports
20
+ @supports ||= {}
21
+ end
22
+
23
+ def self.new_registry
24
+ default_registry.dup
25
+ end
26
+
27
+ # Creates the inner DSL which includes all resources for
28
+ # creating tests. It is always connected to one target,
29
+ # which is specified via the backend argument.
30
+ #
31
+ # @param backend [BackendRunner] exposing the target to resources
32
+ # @return [ResourcesDSL]
33
+ def self.create_dsl(profile_context)
34
+ backend = profile_context.backend
35
+ my_registry = profile_context.resource_registry
36
+
37
+ Module.new do
38
+ define_method :resource_class do |profile_name, resource_name|
39
+ inner_context = if profile_name == profile_context.profile_id
40
+ profile_context
41
+ else
42
+ profile_context.subcontext_by_name(profile_name)
43
+ end
44
+
45
+ raise ProfileNotFound, "Cannot find profile named: #{profile_name}" if inner_context.nil?
46
+ inner_context.resource_registry[resource_name]
47
+ end
48
+
49
+ my_registry.each do |id, r|
50
+ define_method id.to_sym do |*args|
51
+ r.new(backend, id.to_s, *args)
52
+ end
53
+ end
54
+
55
+ define_method :inspec do
56
+ backend
57
+ end
58
+ end
59
+ end
60
+ end
61
+
62
+ # Retrieve the base class for creating a new resource.
63
+ # Create classes that inherit from this class.
64
+ #
65
+ # @param [int] version the resource version to use
66
+ # @return [Resource] base class for creating a new resource
67
+ def self.resource(version)
68
+ validate_resource_dsl_version!(version)
69
+ Inspec::Plugins::Resource
70
+ end
71
+
72
+ def self.validate_resource_dsl_version!(version)
73
+ raise 'Only resource version 1 is supported!' if version != 1
74
+ end
75
+ end
76
+
77
+ # Many resources use FilterTable.
78
+ require 'utils/filter'
79
+
80
+ # AWS resources are included via their own file.
81
+ require 'resource_support/aws' if Gem.loaded_specs.key?('aws-sdk')
82
+
83
+ if Gem.loaded_specs.key?('azure_mgmt_resources')
84
+ require 'resources/azure/azure_backend.rb'
85
+ require 'resources/azure/azure_generic_resource.rb'
86
+ require 'resources/azure/azure_resource_group.rb'
87
+ require 'resources/azure/azure_virtual_machine.rb'
88
+ require 'resources/azure/azure_virtual_machine_data_disk.rb'
89
+ end
90
+
91
+ require 'resources/aide_conf'
92
+ require 'resources/apache'
93
+ require 'resources/apache_conf'
94
+ require 'resources/apt'
95
+ require 'resources/audit_policy'
96
+ require 'resources/auditd'
97
+ require 'resources/auditd_conf'
98
+ require 'resources/bash'
99
+ require 'resources/bond'
100
+ require 'resources/bridge'
101
+ require 'resources/chocolatey_package'
102
+ require 'resources/command'
103
+ require 'resources/cran'
104
+ require 'resources/cpan'
105
+ require 'resources/crontab'
106
+ require 'resources/dh_params'
107
+ require 'resources/directory'
108
+ require 'resources/docker'
109
+ require 'resources/docker_container'
110
+ require 'resources/docker_image'
111
+ require 'resources/docker_service'
112
+ require 'resources/elasticsearch'
113
+ require 'resources/etc_fstab'
114
+ require 'resources/etc_group'
115
+ require 'resources/etc_hosts_allow_deny'
116
+ require 'resources/etc_hosts'
117
+ require 'resources/file'
118
+ require 'resources/filesystem'
119
+ require 'resources/firewalld'
120
+ require 'resources/gem'
121
+ require 'resources/groups'
122
+ require 'resources/grub_conf'
123
+ require 'resources/host'
124
+ require 'resources/http'
125
+ require 'resources/iis_app'
126
+ require 'resources/iis_site'
127
+ require 'resources/inetd_conf'
128
+ require 'resources/interface'
129
+ require 'resources/iptables'
130
+ require 'resources/json'
131
+ require 'resources/kernel_module'
132
+ require 'resources/kernel_parameter'
133
+ require 'resources/key_rsa'
134
+ require 'resources/limits_conf'
135
+ require 'resources/login_def'
136
+ require 'resources/mount'
137
+ require 'resources/mssql_session'
138
+ require 'resources/mysql'
139
+ require 'resources/mysql_conf'
140
+ require 'resources/mysql_session'
141
+ require 'resources/nginx'
142
+ require 'resources/nginx_conf'
143
+ require 'resources/npm'
144
+ require 'resources/ntp_conf'
145
+ require 'resources/oneget'
146
+ require 'resources/oracledb_session'
147
+ require 'resources/os'
148
+ require 'resources/os_env'
149
+ require 'resources/package'
150
+ require 'resources/packages'
151
+ require 'resources/parse_config'
152
+ require 'resources/passwd'
153
+ require 'resources/pip'
154
+ require 'resources/platform'
155
+ require 'resources/port'
156
+ require 'resources/postgres'
157
+ require 'resources/postgres_conf'
158
+ require 'resources/postgres_hba_conf'
159
+ require 'resources/postgres_ident_conf'
160
+ require 'resources/postgres_session'
161
+ require 'resources/powershell'
162
+ require 'resources/processes'
163
+ require 'resources/rabbitmq_conf'
164
+ require 'resources/registry_key'
165
+ require 'resources/security_policy'
166
+ require 'resources/service'
167
+ require 'resources/shadow'
168
+ require 'resources/ssh_conf'
169
+ require 'resources/ssl'
170
+ require 'resources/sys_info'
171
+ require 'resources/toml'
172
+ require 'resources/users'
173
+ require 'resources/vbscript'
174
+ require 'resources/virtualization'
175
+ require 'resources/windows_feature'
176
+ require 'resources/windows_hotfix'
177
+ require 'resources/windows_task'
178
+ require 'resources/wmi'
179
+ require 'resources/x509_certificate'
180
+ require 'resources/xinetd'
181
+ require 'resources/yum'
182
+ require 'resources/zfs_dataset'
183
+ require 'resources/zfs_pool'
184
+
185
+ # file formats, depend on json implementation
186
+ require 'resources/json'
187
+ require 'resources/yaml'
188
+ require 'resources/csv'
189
+ require 'resources/ini'
190
+ require 'resources/xml'
@@ -1,280 +1,280 @@
1
- # encoding: utf-8
2
- # copyright: 2015, Dominik Richter
3
- # author: Dominik Richter
4
- # author: Christoph Hartmann
5
-
6
- require 'method_source'
7
- require 'inspec/describe'
8
- require 'inspec/expect'
9
-
10
- module Inspec
11
- class Rule
12
- include ::RSpec::Matchers
13
-
14
- #
15
- # Include any resources from the given resource DSL. The passed
16
- # resource_dsl will also be included in any Inspec::Expect objects
17
- # we make.
18
- #
19
- # @params resource_dsl [Module]
20
- # @returns [TrueClass]
21
- #
22
- def self.with_resource_dsl(resource_dsl)
23
- include resource_dsl
24
- @resource_dsl = resource_dsl
25
- true
26
- end
27
-
28
- def self.resource_dsl # rubocop:disable Style/TrivialAccessors
29
- @resource_dsl
30
- end
31
-
32
- def initialize(id, profile_id, opts, &block)
33
- @impact = nil
34
- @title = nil
35
- @desc = nil
36
- @refs = []
37
- @tags = {}
38
-
39
- # not changeable by the user:
40
- @__block = block
41
- @__source_location = __get_block_source_location(&block)
42
- @__rule_id = id
43
- @__profile_id = profile_id
44
- @__checks = []
45
- @__skip_rule = nil
46
- @__merge_count = 0
47
- @__skip_only_if_eval = opts[:skip_only_if_eval]
48
-
49
- # evaluate the given definition
50
- return unless block_given?
51
- begin
52
- instance_eval(&block)
53
- rescue StandardError => e
54
- # We've encountered an exception while trying to eval the code inside the
55
- # control block. We need to prevent the exception from bubbling up, and
56
- # fail the control. Controls are failed by having a failed resource within
57
- # them; but since our control block is unsafe (and opaque) to us, let's
58
- # make a dummy and fail that.
59
- location = block.source_location.compact.join(':')
60
- describe 'Control Source Code Error' do
61
- # Rubocop thinks we are raising an exception - we're actually calling RSpec's fail()
62
- its(location) { fail e.message } # rubocop: disable Style/SignalException
63
- end
64
- end
65
- end
66
-
67
- def to_s
68
- Inspec::Rule.rule_id(self)
69
- end
70
-
71
- def id(*_)
72
- # never overwrite the ID
73
- @id
74
- end
75
-
76
- def impact(v = nil)
77
- @impact = v unless v.nil?
78
- @impact
79
- end
80
-
81
- def title(v = nil)
82
- @title = v unless v.nil?
83
- @title
84
- end
85
-
86
- def desc(v = nil)
87
- @desc = unindent(v) unless v.nil?
88
- @desc
89
- end
90
-
91
- def ref(ref = nil, opts = {})
92
- return @refs if ref.nil? && opts.empty?
93
- if opts.empty? && ref.is_a?(Hash)
94
- opts = ref
95
- else
96
- opts[:ref] = ref
97
- end
98
- @refs.push(opts)
99
- end
100
-
101
- def tag(*args)
102
- args.each do |arg|
103
- if arg.is_a?(Hash)
104
- @tags.merge!(arg)
105
- else
106
- @tags[arg] ||= nil
107
- end
108
- end
109
- @tags
110
- end
111
-
112
- def source_file
113
- @__file
114
- end
115
-
116
- # Skip all checks if only_if is false
117
- #
118
- # @param [Type] &block returns true if tests are added, false otherwise
119
- # @return [nil]
120
- def only_if
121
- return unless block_given?
122
- return if @__skip_only_if_eval == true
123
-
124
- @__skip_rule ||= !yield
125
- end
126
-
127
- # Describe will add one or more tests to this control. There is 2 ways
128
- # of calling it:
129
- #
130
- # describe resource do ... end
131
- #
132
- # or
133
- #
134
- # describe.one do ... end
135
- #
136
- # @param [any] Resource to be describe, string, or nil
137
- # @param [Proc] An optional block containing tests for the described resource
138
- # @return [nil|DescribeBase] if called without arguments, returns DescribeBase
139
- def describe(*values, &block)
140
- if values.empty? && !block_given?
141
- dsl = self.class.ancestors[1]
142
- Class.new(DescribeBase) do
143
- include dsl
144
- end.new(method(:__add_check))
145
- else
146
- __add_check('describe', values, with_dsl(block))
147
- end
148
- end
149
-
150
- def expect(value, &block)
151
- target = Inspec::Expect.new(value, &with_dsl(block))
152
- __add_check('expect', [value], target)
153
- target
154
- end
155
-
156
- def self.rule_id(rule)
157
- rule.instance_variable_get(:@__rule_id)
158
- end
159
-
160
- def self.set_rule_id(rule, value)
161
- rule.instance_variable_set(:@__rule_id, value)
162
- end
163
-
164
- def self.profile_id(rule)
165
- rule.instance_variable_get(:@__profile_id)
166
- end
167
-
168
- def self.checks(rule)
169
- rule.instance_variable_get(:@__checks)
170
- end
171
-
172
- def self.skip_status(rule)
173
- rule.instance_variable_get(:@__skip_rule)
174
- end
175
-
176
- def self.set_skip_rule(rule, value)
177
- rule.instance_variable_set(:@__skip_rule, value)
178
- end
179
-
180
- def self.merge_count(rule)
181
- rule.instance_variable_get(:@__merge_count)
182
- end
183
-
184
- def self.prepare_checks(rule)
185
- msg = skip_status(rule)
186
- return checks(rule) unless msg
187
- msg = 'Skipped control due to only_if condition.' if msg == true
188
-
189
- # TODO: we use os as the carrier here, but should consider
190
- # a separate resource to do skipping
191
- resource = rule.os
192
- resource.skip_resource(msg)
193
- [['describe', [resource], nil]]
194
- end
195
-
196
- def self.merge(dst, src)
197
- if src.id != dst.id
198
- # TODO: register an error, this case should not happen
199
- return
200
- end
201
- sp = rule_id(src)
202
- dp = rule_id(dst)
203
- if sp != dp
204
- # TODO: register an error, this case should not happen
205
- return
206
- end
207
- # merge all fields
208
- dst.impact(src.impact) unless src.impact.nil?
209
- dst.title(src.title) unless src.title.nil?
210
- dst.desc(src.desc) unless src.desc.nil?
211
- # merge indirect fields
212
- # checks defined in the source will completely eliminate
213
- # all checks that were defined in the destination
214
- sc = checks(src)
215
- dst.instance_variable_set(:@__checks, sc) unless sc.empty?
216
- sr = skip_status(src)
217
- set_skip_rule(dst, sr) unless sr.nil?
218
- # increment merge count
219
- dst.instance_variable_set(:@__merge_count, merge_count(dst) + 1)
220
- end
221
-
222
- private
223
-
224
- def __add_check(describe_or_expect, values, block)
225
- @__checks.push([describe_or_expect, values, block])
226
- end
227
-
228
- #
229
- # Takes a block and returns a block that will run the given block
230
- # with access to the resource_dsl of the current class. This is to
231
- # ensure that inside the constructed Rspec::ExampleGroup users
232
- # have access to DSL methods. Previous this was done in
233
- # Inspec::Runner before sending the example groups to rspec. It
234
- # was moved here to ensure that code inside `its` blocks hae the
235
- # same visibility into resources as code outside its blocks.
236
- #
237
- # @param [Proc] block
238
- # @return [Proc]
239
- #
240
- def with_dsl(block)
241
- return nil if block.nil?
242
- if self.class.resource_dsl
243
- dsl = self.class.resource_dsl
244
- proc do |*args|
245
- include dsl
246
- instance_exec(*args, &block)
247
- end
248
- else
249
- block
250
- end
251
- end
252
-
253
- # Idio(ma)tic unindent, behaves similar to Ruby2.3 curly heredocs.
254
- # Find the shortest indentation of non-empty lines and strip that from every line
255
- # See: https://bugs.ruby-lang.org/issues/9098
256
- #
257
- # It is implemented here to support pre-Ruby2.3 with this feature and
258
- # to not force non-programmers to understand heredocs.
259
- #
260
- # Please note: tabs are not supported! (they will be removed but they are not
261
- # treated the same as in Ruby2.3 heredocs)
262
- #
263
- # @param [String] text string which needs to be unindented
264
- # @return [String] input with indentation removed; '' if input is nil
265
- def unindent(text)
266
- return '' if text.nil?
267
- len = text.split("\n").reject { |l| l.strip.empty? }.map { |x| x.index(/[^\s]/) }.compact.min
268
- text.gsub(/^[[:blank:]]{#{len}}/, '').strip
269
- end
270
-
271
- # get the source location of the block
272
- def __get_block_source_location(&block)
273
- return {} unless block_given?
274
- r, l = block.source_location
275
- { ref: r, line: l }
276
- rescue MethodSource::SourceNotFoundError
277
- {}
278
- end
279
- end
280
- end
1
+ # encoding: utf-8
2
+ # copyright: 2015, Dominik Richter
3
+ # author: Dominik Richter
4
+ # author: Christoph Hartmann
5
+
6
+ require 'method_source'
7
+ require 'inspec/describe'
8
+ require 'inspec/expect'
9
+
10
+ module Inspec
11
+ class Rule
12
+ include ::RSpec::Matchers
13
+
14
+ #
15
+ # Include any resources from the given resource DSL. The passed
16
+ # resource_dsl will also be included in any Inspec::Expect objects
17
+ # we make.
18
+ #
19
+ # @params resource_dsl [Module]
20
+ # @returns [TrueClass]
21
+ #
22
+ def self.with_resource_dsl(resource_dsl)
23
+ include resource_dsl
24
+ @resource_dsl = resource_dsl
25
+ true
26
+ end
27
+
28
+ def self.resource_dsl # rubocop:disable Style/TrivialAccessors
29
+ @resource_dsl
30
+ end
31
+
32
+ def initialize(id, profile_id, opts, &block)
33
+ @impact = nil
34
+ @title = nil
35
+ @desc = nil
36
+ @refs = []
37
+ @tags = {}
38
+
39
+ # not changeable by the user:
40
+ @__block = block
41
+ @__source_location = __get_block_source_location(&block)
42
+ @__rule_id = id
43
+ @__profile_id = profile_id
44
+ @__checks = []
45
+ @__skip_rule = nil
46
+ @__merge_count = 0
47
+ @__skip_only_if_eval = opts[:skip_only_if_eval]
48
+
49
+ # evaluate the given definition
50
+ return unless block_given?
51
+ begin
52
+ instance_eval(&block)
53
+ rescue StandardError => e
54
+ # We've encountered an exception while trying to eval the code inside the
55
+ # control block. We need to prevent the exception from bubbling up, and
56
+ # fail the control. Controls are failed by having a failed resource within
57
+ # them; but since our control block is unsafe (and opaque) to us, let's
58
+ # make a dummy and fail that.
59
+ location = block.source_location.compact.join(':')
60
+ describe 'Control Source Code Error' do
61
+ # Rubocop thinks we are raising an exception - we're actually calling RSpec's fail()
62
+ its(location) { fail e.message } # rubocop: disable Style/SignalException
63
+ end
64
+ end
65
+ end
66
+
67
+ def to_s
68
+ Inspec::Rule.rule_id(self)
69
+ end
70
+
71
+ def id(*_)
72
+ # never overwrite the ID
73
+ @id
74
+ end
75
+
76
+ def impact(v = nil)
77
+ @impact = v unless v.nil?
78
+ @impact
79
+ end
80
+
81
+ def title(v = nil)
82
+ @title = v unless v.nil?
83
+ @title
84
+ end
85
+
86
+ def desc(v = nil)
87
+ @desc = unindent(v) unless v.nil?
88
+ @desc
89
+ end
90
+
91
+ def ref(ref = nil, opts = {})
92
+ return @refs if ref.nil? && opts.empty?
93
+ if opts.empty? && ref.is_a?(Hash)
94
+ opts = ref
95
+ else
96
+ opts[:ref] = ref
97
+ end
98
+ @refs.push(opts)
99
+ end
100
+
101
+ def tag(*args)
102
+ args.each do |arg|
103
+ if arg.is_a?(Hash)
104
+ @tags.merge!(arg)
105
+ else
106
+ @tags[arg] ||= nil
107
+ end
108
+ end
109
+ @tags
110
+ end
111
+
112
+ def source_file
113
+ @__file
114
+ end
115
+
116
+ # Skip all checks if only_if is false
117
+ #
118
+ # @param [Type] &block returns true if tests are added, false otherwise
119
+ # @return [nil]
120
+ def only_if
121
+ return unless block_given?
122
+ return if @__skip_only_if_eval == true
123
+
124
+ @__skip_rule ||= !yield
125
+ end
126
+
127
+ # Describe will add one or more tests to this control. There is 2 ways
128
+ # of calling it:
129
+ #
130
+ # describe resource do ... end
131
+ #
132
+ # or
133
+ #
134
+ # describe.one do ... end
135
+ #
136
+ # @param [any] Resource to be describe, string, or nil
137
+ # @param [Proc] An optional block containing tests for the described resource
138
+ # @return [nil|DescribeBase] if called without arguments, returns DescribeBase
139
+ def describe(*values, &block)
140
+ if values.empty? && !block_given?
141
+ dsl = self.class.ancestors[1]
142
+ Class.new(DescribeBase) do
143
+ include dsl
144
+ end.new(method(:__add_check))
145
+ else
146
+ __add_check('describe', values, with_dsl(block))
147
+ end
148
+ end
149
+
150
+ def expect(value, &block)
151
+ target = Inspec::Expect.new(value, &with_dsl(block))
152
+ __add_check('expect', [value], target)
153
+ target
154
+ end
155
+
156
+ def self.rule_id(rule)
157
+ rule.instance_variable_get(:@__rule_id)
158
+ end
159
+
160
+ def self.set_rule_id(rule, value)
161
+ rule.instance_variable_set(:@__rule_id, value)
162
+ end
163
+
164
+ def self.profile_id(rule)
165
+ rule.instance_variable_get(:@__profile_id)
166
+ end
167
+
168
+ def self.checks(rule)
169
+ rule.instance_variable_get(:@__checks)
170
+ end
171
+
172
+ def self.skip_status(rule)
173
+ rule.instance_variable_get(:@__skip_rule)
174
+ end
175
+
176
+ def self.set_skip_rule(rule, value)
177
+ rule.instance_variable_set(:@__skip_rule, value)
178
+ end
179
+
180
+ def self.merge_count(rule)
181
+ rule.instance_variable_get(:@__merge_count)
182
+ end
183
+
184
+ def self.prepare_checks(rule)
185
+ msg = skip_status(rule)
186
+ return checks(rule) unless msg
187
+ msg = 'Skipped control due to only_if condition.' if msg == true
188
+
189
+ # TODO: we use os as the carrier here, but should consider
190
+ # a separate resource to do skipping
191
+ resource = rule.os
192
+ resource.skip_resource(msg)
193
+ [['describe', [resource], nil]]
194
+ end
195
+
196
+ def self.merge(dst, src)
197
+ if src.id != dst.id
198
+ # TODO: register an error, this case should not happen
199
+ return
200
+ end
201
+ sp = rule_id(src)
202
+ dp = rule_id(dst)
203
+ if sp != dp
204
+ # TODO: register an error, this case should not happen
205
+ return
206
+ end
207
+ # merge all fields
208
+ dst.impact(src.impact) unless src.impact.nil?
209
+ dst.title(src.title) unless src.title.nil?
210
+ dst.desc(src.desc) unless src.desc.nil?
211
+ # merge indirect fields
212
+ # checks defined in the source will completely eliminate
213
+ # all checks that were defined in the destination
214
+ sc = checks(src)
215
+ dst.instance_variable_set(:@__checks, sc) unless sc.empty?
216
+ sr = skip_status(src)
217
+ set_skip_rule(dst, sr) unless sr.nil?
218
+ # increment merge count
219
+ dst.instance_variable_set(:@__merge_count, merge_count(dst) + 1)
220
+ end
221
+
222
+ private
223
+
224
+ def __add_check(describe_or_expect, values, block)
225
+ @__checks.push([describe_or_expect, values, block])
226
+ end
227
+
228
+ #
229
+ # Takes a block and returns a block that will run the given block
230
+ # with access to the resource_dsl of the current class. This is to
231
+ # ensure that inside the constructed Rspec::ExampleGroup users
232
+ # have access to DSL methods. Previous this was done in
233
+ # Inspec::Runner before sending the example groups to rspec. It
234
+ # was moved here to ensure that code inside `its` blocks hae the
235
+ # same visibility into resources as code outside its blocks.
236
+ #
237
+ # @param [Proc] block
238
+ # @return [Proc]
239
+ #
240
+ def with_dsl(block)
241
+ return nil if block.nil?
242
+ if self.class.resource_dsl
243
+ dsl = self.class.resource_dsl
244
+ proc do |*args|
245
+ include dsl
246
+ instance_exec(*args, &block)
247
+ end
248
+ else
249
+ block
250
+ end
251
+ end
252
+
253
+ # Idio(ma)tic unindent, behaves similar to Ruby2.3 curly heredocs.
254
+ # Find the shortest indentation of non-empty lines and strip that from every line
255
+ # See: https://bugs.ruby-lang.org/issues/9098
256
+ #
257
+ # It is implemented here to support pre-Ruby2.3 with this feature and
258
+ # to not force non-programmers to understand heredocs.
259
+ #
260
+ # Please note: tabs are not supported! (they will be removed but they are not
261
+ # treated the same as in Ruby2.3 heredocs)
262
+ #
263
+ # @param [String] text string which needs to be unindented
264
+ # @return [String] input with indentation removed; '' if input is nil
265
+ def unindent(text)
266
+ return '' if text.nil?
267
+ len = text.split("\n").reject { |l| l.strip.empty? }.map { |x| x.index(/[^\s]/) }.compact.min
268
+ text.gsub(/^[[:blank:]]{#{len}}/, '').strip
269
+ end
270
+
271
+ # get the source location of the block
272
+ def __get_block_source_location(&block)
273
+ return {} unless block_given?
274
+ r, l = block.source_location
275
+ { ref: r, line: l }
276
+ rescue MethodSource::SourceNotFoundError
277
+ {}
278
+ end
279
+ end
280
+ end