inspec 2.1.81 → 2.1.83

Sign up to get free protection for your applications and to get access to all the features.
Files changed (507) hide show
  1. checksums.yaml +5 -5
  2. data/.rubocop.yml +101 -101
  3. data/CHANGELOG.md +3183 -3177
  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 +41 -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/test/integration/default/web_spec.rb +28 -28
  201. data/examples/meta-profile/README.md +37 -37
  202. data/examples/meta-profile/controls/example.rb +13 -13
  203. data/examples/meta-profile/inspec.yml +13 -13
  204. data/examples/profile-attribute.yml +2 -2
  205. data/examples/profile-attribute/README.md +14 -14
  206. data/examples/profile-attribute/controls/example.rb +11 -11
  207. data/examples/profile-attribute/inspec.yml +8 -8
  208. data/examples/profile-aws/controls/iam_password_policy_expiration.rb +8 -8
  209. data/examples/profile-aws/controls/iam_password_policy_max_age.rb +8 -8
  210. data/examples/profile-aws/controls/iam_root_user_mfa.rb +8 -8
  211. data/examples/profile-aws/controls/iam_users_access_key_age.rb +8 -8
  212. data/examples/profile-aws/controls/iam_users_console_users_mfa.rb +8 -8
  213. data/examples/profile-aws/inspec.yml +11 -11
  214. data/examples/profile-azure/controls/azure_resource_group_example.rb +24 -24
  215. data/examples/profile-azure/controls/azure_vm_example.rb +29 -29
  216. data/examples/profile-azure/inspec.yml +11 -11
  217. data/examples/profile-sensitive/README.md +29 -29
  218. data/examples/profile-sensitive/controls/sensitive-failures.rb +9 -9
  219. data/examples/profile-sensitive/controls/sensitive.rb +9 -9
  220. data/examples/profile-sensitive/inspec.yml +8 -8
  221. data/examples/profile/README.md +48 -48
  222. data/examples/profile/controls/example.rb +23 -23
  223. data/examples/profile/controls/gordon.rb +36 -36
  224. data/examples/profile/controls/meta.rb +34 -34
  225. data/examples/profile/inspec.yml +10 -10
  226. data/examples/profile/libraries/gordon_config.rb +59 -59
  227. data/inspec.gemspec +49 -49
  228. data/lib/bundles/README.md +3 -3
  229. data/lib/bundles/inspec-artifact.rb +7 -7
  230. data/lib/bundles/inspec-artifact/README.md +1 -1
  231. data/lib/bundles/inspec-artifact/cli.rb +277 -277
  232. data/lib/bundles/inspec-compliance.rb +16 -16
  233. data/lib/bundles/inspec-compliance/.kitchen.yml +20 -20
  234. data/lib/bundles/inspec-compliance/README.md +193 -193
  235. data/lib/bundles/inspec-compliance/api.rb +360 -360
  236. data/lib/bundles/inspec-compliance/api/login.rb +193 -193
  237. data/lib/bundles/inspec-compliance/bootstrap.sh +41 -41
  238. data/lib/bundles/inspec-compliance/cli.rb +260 -260
  239. data/lib/bundles/inspec-compliance/configuration.rb +103 -103
  240. data/lib/bundles/inspec-compliance/http.rb +125 -125
  241. data/lib/bundles/inspec-compliance/support.rb +36 -36
  242. data/lib/bundles/inspec-compliance/target.rb +112 -112
  243. data/lib/bundles/inspec-compliance/test/integration/default/cli.rb +93 -93
  244. data/lib/bundles/inspec-habitat.rb +12 -12
  245. data/lib/bundles/inspec-habitat/cli.rb +36 -36
  246. data/lib/bundles/inspec-habitat/log.rb +10 -10
  247. data/lib/bundles/inspec-habitat/profile.rb +391 -391
  248. data/lib/bundles/inspec-init.rb +8 -8
  249. data/lib/bundles/inspec-init/README.md +31 -31
  250. data/lib/bundles/inspec-init/cli.rb +97 -97
  251. data/lib/bundles/inspec-init/templates/profile/README.md +3 -3
  252. data/lib/bundles/inspec-init/templates/profile/controls/example.rb +19 -19
  253. data/lib/bundles/inspec-init/templates/profile/inspec.yml +8 -8
  254. data/lib/bundles/inspec-supermarket.rb +13 -13
  255. data/lib/bundles/inspec-supermarket/README.md +45 -45
  256. data/lib/bundles/inspec-supermarket/api.rb +84 -84
  257. data/lib/bundles/inspec-supermarket/cli.rb +73 -73
  258. data/lib/bundles/inspec-supermarket/target.rb +34 -34
  259. data/lib/fetchers/git.rb +163 -163
  260. data/lib/fetchers/local.rb +74 -74
  261. data/lib/fetchers/mock.rb +35 -35
  262. data/lib/fetchers/url.rb +247 -247
  263. data/lib/inspec.rb +24 -24
  264. data/lib/inspec/archive/tar.rb +29 -29
  265. data/lib/inspec/archive/zip.rb +19 -19
  266. data/lib/inspec/backend.rb +93 -93
  267. data/lib/inspec/base_cli.rb +368 -368
  268. data/lib/inspec/cached_fetcher.rb +66 -66
  269. data/lib/inspec/cli.rb +292 -292
  270. data/lib/inspec/completions/bash.sh.erb +45 -45
  271. data/lib/inspec/completions/fish.sh.erb +34 -34
  272. data/lib/inspec/completions/zsh.sh.erb +61 -61
  273. data/lib/inspec/control_eval_context.rb +179 -179
  274. data/lib/inspec/dependencies/cache.rb +72 -72
  275. data/lib/inspec/dependencies/dependency_set.rb +92 -92
  276. data/lib/inspec/dependencies/lockfile.rb +115 -115
  277. data/lib/inspec/dependencies/requirement.rb +123 -123
  278. data/lib/inspec/dependencies/resolver.rb +86 -86
  279. data/lib/inspec/describe.rb +27 -27
  280. data/lib/inspec/dsl.rb +66 -66
  281. data/lib/inspec/dsl_shared.rb +33 -33
  282. data/lib/inspec/env_printer.rb +157 -157
  283. data/lib/inspec/errors.rb +14 -14
  284. data/lib/inspec/exceptions.rb +12 -12
  285. data/lib/inspec/expect.rb +45 -45
  286. data/lib/inspec/fetcher.rb +45 -45
  287. data/lib/inspec/file_provider.rb +275 -275
  288. data/lib/inspec/formatters.rb +3 -3
  289. data/lib/inspec/formatters/base.rb +259 -259
  290. data/lib/inspec/formatters/json_rspec.rb +20 -20
  291. data/lib/inspec/formatters/show_progress.rb +12 -12
  292. data/lib/inspec/library_eval_context.rb +58 -58
  293. data/lib/inspec/log.rb +11 -11
  294. data/lib/inspec/metadata.rb +247 -247
  295. data/lib/inspec/method_source.rb +24 -24
  296. data/lib/inspec/objects.rb +14 -14
  297. data/lib/inspec/objects/attribute.rb +75 -75
  298. data/lib/inspec/objects/control.rb +61 -61
  299. data/lib/inspec/objects/describe.rb +92 -92
  300. data/lib/inspec/objects/each_loop.rb +36 -36
  301. data/lib/inspec/objects/list.rb +15 -15
  302. data/lib/inspec/objects/or_test.rb +40 -40
  303. data/lib/inspec/objects/ruby_helper.rb +15 -15
  304. data/lib/inspec/objects/tag.rb +27 -27
  305. data/lib/inspec/objects/test.rb +87 -87
  306. data/lib/inspec/objects/value.rb +27 -27
  307. data/lib/inspec/plugins.rb +60 -60
  308. data/lib/inspec/plugins/cli.rb +24 -24
  309. data/lib/inspec/plugins/fetcher.rb +86 -86
  310. data/lib/inspec/plugins/resource.rb +135 -135
  311. data/lib/inspec/plugins/secret.rb +15 -15
  312. data/lib/inspec/plugins/source_reader.rb +40 -40
  313. data/lib/inspec/polyfill.rb +12 -12
  314. data/lib/inspec/profile.rb +513 -513
  315. data/lib/inspec/profile_context.rb +208 -208
  316. data/lib/inspec/profile_vendor.rb +66 -66
  317. data/lib/inspec/reporters.rb +60 -60
  318. data/lib/inspec/reporters/automate.rb +76 -76
  319. data/lib/inspec/reporters/base.rb +25 -25
  320. data/lib/inspec/reporters/cli.rb +356 -356
  321. data/lib/inspec/reporters/json.rb +117 -117
  322. data/lib/inspec/reporters/json_min.rb +48 -48
  323. data/lib/inspec/reporters/junit.rb +78 -78
  324. data/lib/inspec/require_loader.rb +33 -33
  325. data/lib/inspec/resource.rb +190 -190
  326. data/lib/inspec/rule.rb +280 -280
  327. data/lib/inspec/runner.rb +345 -345
  328. data/lib/inspec/runner_mock.rb +41 -41
  329. data/lib/inspec/runner_rspec.rb +175 -175
  330. data/lib/inspec/runtime_profile.rb +26 -26
  331. data/lib/inspec/schema.rb +213 -213
  332. data/lib/inspec/secrets.rb +19 -19
  333. data/lib/inspec/secrets/yaml.rb +30 -30
  334. data/lib/inspec/shell.rb +220 -220
  335. data/lib/inspec/shell_detector.rb +90 -90
  336. data/lib/inspec/source_reader.rb +29 -29
  337. data/lib/inspec/version.rb +8 -8
  338. data/lib/matchers/matchers.rb +339 -339
  339. data/lib/resource_support/aws.rb +50 -50
  340. data/lib/resource_support/aws/aws_backend_base.rb +12 -12
  341. data/lib/resource_support/aws/aws_backend_factory_mixin.rb +12 -12
  342. data/lib/resource_support/aws/aws_plural_resource_mixin.rb +21 -21
  343. data/lib/resource_support/aws/aws_resource_mixin.rb +66 -66
  344. data/lib/resource_support/aws/aws_singular_resource_mixin.rb +24 -24
  345. data/lib/resources/aide_conf.rb +151 -151
  346. data/lib/resources/apache.rb +48 -48
  347. data/lib/resources/apache_conf.rb +149 -149
  348. data/lib/resources/apt.rb +149 -149
  349. data/lib/resources/audit_policy.rb +63 -63
  350. data/lib/resources/auditd.rb +231 -231
  351. data/lib/resources/auditd_conf.rb +46 -46
  352. data/lib/resources/aws/aws_cloudtrail_trail.rb +93 -93
  353. data/lib/resources/aws/aws_cloudtrail_trails.rb +47 -47
  354. data/lib/resources/aws/aws_cloudwatch_alarm.rb +62 -62
  355. data/lib/resources/aws/aws_cloudwatch_log_metric_filter.rb +100 -100
  356. data/lib/resources/aws/aws_config_delivery_channel.rb +70 -70
  357. data/lib/resources/aws/aws_config_recorder.rb +93 -93
  358. data/lib/resources/aws/aws_ec2_instance.rb +157 -157
  359. data/lib/resources/aws/aws_ec2_instances.rb +64 -64
  360. data/lib/resources/aws/aws_iam_access_key.rb +106 -106
  361. data/lib/resources/aws/aws_iam_access_keys.rb +149 -149
  362. data/lib/resources/aws/aws_iam_group.rb +58 -58
  363. data/lib/resources/aws/aws_iam_groups.rb +52 -52
  364. data/lib/resources/aws/aws_iam_password_policy.rb +116 -116
  365. data/lib/resources/aws/aws_iam_policies.rb +53 -53
  366. data/lib/resources/aws/aws_iam_policy.rb +291 -291
  367. data/lib/resources/aws/aws_iam_role.rb +55 -55
  368. data/lib/resources/aws/aws_iam_root_user.rb +78 -78
  369. data/lib/resources/aws/aws_iam_user.rb +142 -142
  370. data/lib/resources/aws/aws_iam_users.rb +146 -146
  371. data/lib/resources/aws/aws_kms_key.rb +96 -96
  372. data/lib/resources/aws/aws_kms_keys.rb +53 -53
  373. data/lib/resources/aws/aws_rds_instance.rb +71 -71
  374. data/lib/resources/aws/aws_route_table.rb +63 -63
  375. data/lib/resources/aws/aws_route_tables.rb +60 -60
  376. data/lib/resources/aws/aws_s3_bucket.rb +137 -137
  377. data/lib/resources/aws/aws_s3_bucket_object.rb +82 -82
  378. data/lib/resources/aws/aws_s3_buckets.rb +51 -51
  379. data/lib/resources/aws/aws_security_group.rb +249 -249
  380. data/lib/resources/aws/aws_security_groups.rb +68 -68
  381. data/lib/resources/aws/aws_sns_subscription.rb +78 -78
  382. data/lib/resources/aws/aws_sns_topic.rb +53 -53
  383. data/lib/resources/aws/aws_sns_topics.rb +56 -56
  384. data/lib/resources/aws/aws_subnet.rb +88 -88
  385. data/lib/resources/aws/aws_subnets.rb +53 -53
  386. data/lib/resources/aws/aws_vpc.rb +73 -73
  387. data/lib/resources/aws/aws_vpcs.rb +52 -52
  388. data/lib/resources/azure/azure_backend.rb +377 -377
  389. data/lib/resources/azure/azure_generic_resource.rb +59 -59
  390. data/lib/resources/azure/azure_resource_group.rb +152 -152
  391. data/lib/resources/azure/azure_virtual_machine.rb +264 -264
  392. data/lib/resources/azure/azure_virtual_machine_data_disk.rb +134 -134
  393. data/lib/resources/bash.rb +35 -35
  394. data/lib/resources/bond.rb +69 -69
  395. data/lib/resources/bridge.rb +122 -122
  396. data/lib/resources/chocolatey_package.rb +78 -78
  397. data/lib/resources/command.rb +73 -73
  398. data/lib/resources/cpan.rb +58 -58
  399. data/lib/resources/cran.rb +64 -64
  400. data/lib/resources/crontab.rb +169 -169
  401. data/lib/resources/csv.rb +56 -56
  402. data/lib/resources/dh_params.rb +77 -77
  403. data/lib/resources/directory.rb +25 -25
  404. data/lib/resources/docker.rb +236 -236
  405. data/lib/resources/docker_container.rb +89 -89
  406. data/lib/resources/docker_image.rb +83 -83
  407. data/lib/resources/docker_object.rb +57 -57
  408. data/lib/resources/docker_service.rb +90 -90
  409. data/lib/resources/elasticsearch.rb +169 -169
  410. data/lib/resources/etc_fstab.rb +94 -94
  411. data/lib/resources/etc_group.rb +154 -154
  412. data/lib/resources/etc_hosts.rb +66 -66
  413. data/lib/resources/etc_hosts_allow_deny.rb +112 -112
  414. data/lib/resources/file.rb +298 -298
  415. data/lib/resources/filesystem.rb +31 -31
  416. data/lib/resources/firewalld.rb +143 -143
  417. data/lib/resources/gem.rb +70 -70
  418. data/lib/resources/groups.rb +215 -215
  419. data/lib/resources/grub_conf.rb +227 -227
  420. data/lib/resources/host.rb +306 -306
  421. data/lib/resources/http.rb +253 -253
  422. data/lib/resources/iis_app.rb +101 -101
  423. data/lib/resources/iis_site.rb +148 -148
  424. data/lib/resources/inetd_conf.rb +54 -54
  425. data/lib/resources/ini.rb +29 -29
  426. data/lib/resources/interface.rb +129 -129
  427. data/lib/resources/iptables.rb +80 -80
  428. data/lib/resources/json.rb +111 -111
  429. data/lib/resources/kernel_module.rb +107 -107
  430. data/lib/resources/kernel_parameter.rb +58 -58
  431. data/lib/resources/key_rsa.rb +63 -63
  432. data/lib/resources/limits_conf.rb +46 -46
  433. data/lib/resources/login_def.rb +57 -57
  434. data/lib/resources/mount.rb +88 -88
  435. data/lib/resources/mssql_session.rb +101 -101
  436. data/lib/resources/mysql.rb +82 -82
  437. data/lib/resources/mysql_conf.rb +127 -127
  438. data/lib/resources/mysql_session.rb +85 -85
  439. data/lib/resources/nginx.rb +96 -96
  440. data/lib/resources/nginx_conf.rb +226 -226
  441. data/lib/resources/npm.rb +48 -48
  442. data/lib/resources/ntp_conf.rb +51 -51
  443. data/lib/resources/oneget.rb +71 -71
  444. data/lib/resources/oracledb_session.rb +139 -139
  445. data/lib/resources/os.rb +36 -36
  446. data/lib/resources/os_env.rb +86 -86
  447. data/lib/resources/package.rb +370 -370
  448. data/lib/resources/packages.rb +111 -111
  449. data/lib/resources/parse_config.rb +112 -112
  450. data/lib/resources/passwd.rb +76 -76
  451. data/lib/resources/pip.rb +130 -130
  452. data/lib/resources/platform.rb +109 -109
  453. data/lib/resources/port.rb +771 -771
  454. data/lib/resources/postgres.rb +131 -131
  455. data/lib/resources/postgres_conf.rb +114 -114
  456. data/lib/resources/postgres_hba_conf.rb +90 -90
  457. data/lib/resources/postgres_ident_conf.rb +79 -79
  458. data/lib/resources/postgres_session.rb +71 -71
  459. data/lib/resources/powershell.rb +67 -67
  460. data/lib/resources/processes.rb +204 -204
  461. data/lib/resources/rabbitmq_conf.rb +51 -51
  462. data/lib/resources/registry_key.rb +297 -297
  463. data/lib/resources/security_policy.rb +180 -180
  464. data/lib/resources/service.rb +794 -794
  465. data/lib/resources/shadow.rb +159 -159
  466. data/lib/resources/ssh_conf.rb +97 -97
  467. data/lib/resources/ssl.rb +99 -99
  468. data/lib/resources/sys_info.rb +28 -28
  469. data/lib/resources/toml.rb +32 -32
  470. data/lib/resources/users.rb +654 -654
  471. data/lib/resources/vbscript.rb +68 -68
  472. data/lib/resources/virtualization.rb +247 -247
  473. data/lib/resources/windows_feature.rb +84 -84
  474. data/lib/resources/windows_hotfix.rb +35 -35
  475. data/lib/resources/windows_task.rb +102 -102
  476. data/lib/resources/wmi.rb +110 -110
  477. data/lib/resources/x509_certificate.rb +137 -137
  478. data/lib/resources/xinetd.rb +106 -106
  479. data/lib/resources/xml.rb +46 -46
  480. data/lib/resources/yaml.rb +43 -43
  481. data/lib/resources/yum.rb +180 -180
  482. data/lib/resources/zfs_dataset.rb +60 -60
  483. data/lib/resources/zfs_pool.rb +49 -49
  484. data/lib/source_readers/flat.rb +39 -39
  485. data/lib/source_readers/inspec.rb +75 -75
  486. data/lib/utils/command_wrapper.rb +27 -27
  487. data/lib/utils/convert.rb +12 -12
  488. data/lib/utils/database_helpers.rb +77 -77
  489. data/lib/utils/enumerable_delegation.rb +9 -9
  490. data/lib/utils/erlang_parser.rb +192 -192
  491. data/lib/utils/file_reader.rb +25 -25
  492. data/lib/utils/filter.rb +273 -273
  493. data/lib/utils/filter_array.rb +27 -27
  494. data/lib/utils/find_files.rb +47 -47
  495. data/lib/utils/hash.rb +41 -41
  496. data/lib/utils/json_log.rb +18 -18
  497. data/lib/utils/latest_version.rb +22 -22
  498. data/lib/utils/modulator.rb +12 -12
  499. data/lib/utils/nginx_parser.rb +105 -105
  500. data/lib/utils/object_traversal.rb +49 -49
  501. data/lib/utils/parser.rb +274 -274
  502. data/lib/utils/pkey_reader.rb +15 -15
  503. data/lib/utils/plugin_registry.rb +93 -93
  504. data/lib/utils/simpleconfig.rb +120 -120
  505. data/lib/utils/spdx.rb +13 -13
  506. data/lib/utils/spdx.txt +343 -343
  507. metadata +3 -3
@@ -1,66 +1,66 @@
1
- # encoding: utf-8
2
-
3
- require 'utils/parser'
4
- require 'utils/file_reader'
5
-
6
- class EtcHosts < Inspec.resource(1)
7
- name 'etc_hosts'
8
- supports platform: 'linux'
9
- supports platform: 'bsd'
10
- supports platform: 'windows'
11
- desc 'Use the etc_hosts InSpec audit resource to find an
12
- ip_address and its associated hosts'
13
- example "
14
- describe etc_hosts.where { ip_address == '127.0.0.1' } do
15
- its('ip_address') { should cmp '127.0.0.1' }
16
- its('primary_name') { should cmp 'localhost' }
17
- its('all_host_names') { should eq [['localhost', 'localhost.localdomain', 'localhost4', 'localhost4.localdomain4']] }
18
- end
19
- "
20
-
21
- attr_reader :params
22
-
23
- include CommentParser
24
- include FileReader
25
-
26
- DEFAULT_UNIX_PATH = '/etc/hosts'.freeze
27
- DEFAULT_WINDOWS_PATH = 'C:\windows\system32\drivers\etc\hosts'.freeze
28
-
29
- def initialize(hosts_path = nil)
30
- content = read_file_content(hosts_path || default_hosts_file_path)
31
-
32
- @params = parse_conf(content.lines)
33
- end
34
-
35
- FilterTable.create
36
- .add_accessor(:where)
37
- .add_accessor(:entries)
38
- .add(:ip_address, field: 'ip_address')
39
- .add(:primary_name, field: 'primary_name')
40
- .add(:all_host_names, field: 'all_host_names')
41
- .connect(self, :params)
42
-
43
- private
44
-
45
- def default_hosts_file_path
46
- inspec.os.windows? ? DEFAULT_WINDOWS_PATH : DEFAULT_UNIX_PATH
47
- end
48
-
49
- def parse_conf(lines)
50
- lines.reject(&:empty?).reject(&comment?).map(&parse_data).map(&format_data)
51
- end
52
-
53
- def comment?
54
- parse_options = { comment_char: '#', standalone_comments: false }
55
-
56
- ->(data) { parse_comment_line(data, parse_options).first.empty? }
57
- end
58
-
59
- def parse_data
60
- ->(data) { [data.split[0], data.split[1], data.split[1..-1]] }
61
- end
62
-
63
- def format_data
64
- ->(data) { %w{ip_address primary_name all_host_names}.zip(data).to_h }
65
- end
66
- end
1
+ # encoding: utf-8
2
+
3
+ require 'utils/parser'
4
+ require 'utils/file_reader'
5
+
6
+ class EtcHosts < Inspec.resource(1)
7
+ name 'etc_hosts'
8
+ supports platform: 'linux'
9
+ supports platform: 'bsd'
10
+ supports platform: 'windows'
11
+ desc 'Use the etc_hosts InSpec audit resource to find an
12
+ ip_address and its associated hosts'
13
+ example "
14
+ describe etc_hosts.where { ip_address == '127.0.0.1' } do
15
+ its('ip_address') { should cmp '127.0.0.1' }
16
+ its('primary_name') { should cmp 'localhost' }
17
+ its('all_host_names') { should eq [['localhost', 'localhost.localdomain', 'localhost4', 'localhost4.localdomain4']] }
18
+ end
19
+ "
20
+
21
+ attr_reader :params
22
+
23
+ include CommentParser
24
+ include FileReader
25
+
26
+ DEFAULT_UNIX_PATH = '/etc/hosts'.freeze
27
+ DEFAULT_WINDOWS_PATH = 'C:\windows\system32\drivers\etc\hosts'.freeze
28
+
29
+ def initialize(hosts_path = nil)
30
+ content = read_file_content(hosts_path || default_hosts_file_path)
31
+
32
+ @params = parse_conf(content.lines)
33
+ end
34
+
35
+ FilterTable.create
36
+ .add_accessor(:where)
37
+ .add_accessor(:entries)
38
+ .add(:ip_address, field: 'ip_address')
39
+ .add(:primary_name, field: 'primary_name')
40
+ .add(:all_host_names, field: 'all_host_names')
41
+ .connect(self, :params)
42
+
43
+ private
44
+
45
+ def default_hosts_file_path
46
+ inspec.os.windows? ? DEFAULT_WINDOWS_PATH : DEFAULT_UNIX_PATH
47
+ end
48
+
49
+ def parse_conf(lines)
50
+ lines.reject(&:empty?).reject(&comment?).map(&parse_data).map(&format_data)
51
+ end
52
+
53
+ def comment?
54
+ parse_options = { comment_char: '#', standalone_comments: false }
55
+
56
+ ->(data) { parse_comment_line(data, parse_options).first.empty? }
57
+ end
58
+
59
+ def parse_data
60
+ ->(data) { [data.split[0], data.split[1], data.split[1..-1]] }
61
+ end
62
+
63
+ def format_data
64
+ ->(data) { %w{ip_address primary_name all_host_names}.zip(data).to_h }
65
+ end
66
+ end
@@ -1,112 +1,112 @@
1
- # encoding: utf-8
2
-
3
- require 'utils/parser'
4
- require 'utils/file_reader'
5
-
6
- module Inspec::Resources
7
- class EtcHostsAllow < Inspec.resource(1)
8
- name 'etc_hosts_allow'
9
- supports platform: 'unix'
10
- desc 'Use the etc_hosts_allow InSpec audit resource to test the connections
11
- the client will allow. Controlled by the /etc/hosts.allow file.'
12
- example "
13
- describe etc_hosts_allow.where { daemon == 'ALL' } do
14
- its('client_list') { should include ['127.0.0.1', '[::1]'] }
15
- its('options') { should eq [[]] }
16
- end
17
- "
18
-
19
- attr_reader :params
20
-
21
- include CommentParser
22
- include FileReader
23
-
24
- def initialize(hosts_allow_path = nil)
25
- @conf_path = hosts_allow_path || '/etc/hosts.allow'
26
- @content = nil
27
- @params = nil
28
- read_content
29
- end
30
-
31
- filter = FilterTable.create
32
- filter.add_accessor(:where)
33
- .add_accessor(:entries)
34
- .add(:daemon, field: 'daemon')
35
- .add(:client_list, field: 'client_list')
36
- .add(:options, field: 'options')
37
-
38
- filter.connect(self, :params)
39
-
40
- private
41
-
42
- def read_content
43
- @content = ''
44
- @params = {}
45
- @content = split_daemons(read_file(@conf_path))
46
- @params = parse_conf(@content)
47
- end
48
-
49
- def split_daemons(content)
50
- split_daemons_list = []
51
- content.each do |line|
52
- data, = parse_comment_line(line, comment_char: '#', standalone_comments: false)
53
- next unless data != ''
54
- data.split(':')[0].split(',').each do |daemon|
55
- split_daemons_list.push("#{daemon} : " + line.split(':', 2)[1])
56
- end
57
- end
58
- split_daemons_list
59
- end
60
-
61
- def parse_conf(content)
62
- content.map do |line|
63
- data, = parse_comment_line(line, comment_char: '#', standalone_comments: false)
64
- parse_line(data) unless data == ''
65
- end.compact
66
- end
67
-
68
- def parse_line(line)
69
- daemon, clients_and_options = line.split(/:\s+/, 2)
70
- daemon = daemon.strip
71
-
72
- clients_and_options ||= ''
73
- clients, options = clients_and_options.split(/\s+:\s+/, 2)
74
- client_list = clients.split(/,/).map(&:strip)
75
-
76
- options ||= ''
77
- options_list = options.split(/:\s+/).map(&:strip)
78
-
79
- {
80
- 'daemon' => daemon,
81
- 'client_list' => client_list,
82
- 'options' => options_list,
83
- }
84
- end
85
-
86
- def read_file(conf_path = @conf_path)
87
- read_file_content(conf_path).lines
88
- end
89
- end
90
-
91
- class EtcHostsDeny < EtcHostsAllow
92
- name 'etc_hosts_deny'
93
- supports platform: 'unix'
94
- desc 'Use the etc_hosts_deny InSpec audit resource to test the connections
95
- the client will deny. Controlled by the /etc/hosts.deny file.'
96
- example "
97
- describe etc_hosts_deny.where { daemon_list == 'ALL' } do
98
- its('client_list') { should eq [['127.0.0.1', '[::1]']] }
99
- its('options') { should eq [] }
100
- end
101
- "
102
-
103
- def initialize(path = nil)
104
- return skip_resource '`etc_hosts_deny` is not supported on your OS' unless inspec.os.linux?
105
- super(path || '/etc/hosts.deny')
106
- end
107
-
108
- def to_s
109
- 'hosts.deny Configuration'
110
- end
111
- end
112
- end
1
+ # encoding: utf-8
2
+
3
+ require 'utils/parser'
4
+ require 'utils/file_reader'
5
+
6
+ module Inspec::Resources
7
+ class EtcHostsAllow < Inspec.resource(1)
8
+ name 'etc_hosts_allow'
9
+ supports platform: 'unix'
10
+ desc 'Use the etc_hosts_allow InSpec audit resource to test the connections
11
+ the client will allow. Controlled by the /etc/hosts.allow file.'
12
+ example "
13
+ describe etc_hosts_allow.where { daemon == 'ALL' } do
14
+ its('client_list') { should include ['127.0.0.1', '[::1]'] }
15
+ its('options') { should eq [[]] }
16
+ end
17
+ "
18
+
19
+ attr_reader :params
20
+
21
+ include CommentParser
22
+ include FileReader
23
+
24
+ def initialize(hosts_allow_path = nil)
25
+ @conf_path = hosts_allow_path || '/etc/hosts.allow'
26
+ @content = nil
27
+ @params = nil
28
+ read_content
29
+ end
30
+
31
+ filter = FilterTable.create
32
+ filter.add_accessor(:where)
33
+ .add_accessor(:entries)
34
+ .add(:daemon, field: 'daemon')
35
+ .add(:client_list, field: 'client_list')
36
+ .add(:options, field: 'options')
37
+
38
+ filter.connect(self, :params)
39
+
40
+ private
41
+
42
+ def read_content
43
+ @content = ''
44
+ @params = {}
45
+ @content = split_daemons(read_file(@conf_path))
46
+ @params = parse_conf(@content)
47
+ end
48
+
49
+ def split_daemons(content)
50
+ split_daemons_list = []
51
+ content.each do |line|
52
+ data, = parse_comment_line(line, comment_char: '#', standalone_comments: false)
53
+ next unless data != ''
54
+ data.split(':')[0].split(',').each do |daemon|
55
+ split_daemons_list.push("#{daemon} : " + line.split(':', 2)[1])
56
+ end
57
+ end
58
+ split_daemons_list
59
+ end
60
+
61
+ def parse_conf(content)
62
+ content.map do |line|
63
+ data, = parse_comment_line(line, comment_char: '#', standalone_comments: false)
64
+ parse_line(data) unless data == ''
65
+ end.compact
66
+ end
67
+
68
+ def parse_line(line)
69
+ daemon, clients_and_options = line.split(/:\s+/, 2)
70
+ daemon = daemon.strip
71
+
72
+ clients_and_options ||= ''
73
+ clients, options = clients_and_options.split(/\s+:\s+/, 2)
74
+ client_list = clients.split(/,/).map(&:strip)
75
+
76
+ options ||= ''
77
+ options_list = options.split(/:\s+/).map(&:strip)
78
+
79
+ {
80
+ 'daemon' => daemon,
81
+ 'client_list' => client_list,
82
+ 'options' => options_list,
83
+ }
84
+ end
85
+
86
+ def read_file(conf_path = @conf_path)
87
+ read_file_content(conf_path).lines
88
+ end
89
+ end
90
+
91
+ class EtcHostsDeny < EtcHostsAllow
92
+ name 'etc_hosts_deny'
93
+ supports platform: 'unix'
94
+ desc 'Use the etc_hosts_deny InSpec audit resource to test the connections
95
+ the client will deny. Controlled by the /etc/hosts.deny file.'
96
+ example "
97
+ describe etc_hosts_deny.where { daemon_list == 'ALL' } do
98
+ its('client_list') { should eq [['127.0.0.1', '[::1]']] }
99
+ its('options') { should eq [] }
100
+ end
101
+ "
102
+
103
+ def initialize(path = nil)
104
+ return skip_resource '`etc_hosts_deny` is not supported on your OS' unless inspec.os.linux?
105
+ super(path || '/etc/hosts.deny')
106
+ end
107
+
108
+ def to_s
109
+ 'hosts.deny Configuration'
110
+ end
111
+ end
112
+ end
@@ -1,298 +1,298 @@
1
- # encoding: utf-8
2
- # copyright: 2015, Vulcano Security GmbH
3
-
4
- require 'shellwords'
5
-
6
- module Inspec::Resources
7
- module FilePermissionsSelector
8
- def select_file_perms_style(os)
9
- if os.unix?
10
- UnixFilePermissions.new(inspec)
11
- elsif os.windows?
12
- WindowsFilePermissions.new(inspec)
13
- end
14
- end
15
- end
16
-
17
- class FileResource < Inspec.resource(1)
18
- include FilePermissionsSelector
19
- include LinuxMountParser
20
-
21
- name 'file'
22
- supports platform: 'unix'
23
- supports platform: 'windows'
24
- desc 'Use the file InSpec audit resource to test all system file types, including files, directories, symbolic links, named pipes, sockets, character devices, block devices, and doors.'
25
- example "
26
- describe file('path') do
27
- it { should exist }
28
- it { should be_file }
29
- it { should be_readable }
30
- it { should be_writable }
31
- it { should be_executable.by_user('root') }
32
- it { should be_owned_by 'root' }
33
- its('mode') { should cmp '0644' }
34
- end
35
- "
36
-
37
- attr_reader :file, :mount_options
38
- def initialize(path)
39
- # select permissions style
40
- @perms_provider = select_file_perms_style(inspec.os)
41
- @file = inspec.backend.file(path)
42
- end
43
-
44
- %w{
45
- type exist? file? block_device? character_device? socket? directory?
46
- symlink? pipe? mode mode? owner owned_by? group grouped_into?
47
- link_path linked_to? mtime size selinux_label immutable?
48
- product_version file_version version? md5sum sha256sum
49
- path basename source source_path uid gid
50
- }.each do |m|
51
- define_method m.to_sym do |*args|
52
- file.method(m.to_sym).call(*args)
53
- end
54
- end
55
-
56
- def content
57
- res = file.content
58
- return nil if res.nil?
59
- res.force_encoding('utf-8')
60
- end
61
-
62
- def contain(*_)
63
- raise 'Contain is not supported. Please use standard RSpec matchers.'
64
- end
65
-
66
- def readable?(by_usergroup, by_specific_user)
67
- return false unless exist?
68
- return skip_resource '`readable?` is not supported on your OS yet.' if @perms_provider.nil?
69
-
70
- file_permission_granted?('read', by_usergroup, by_specific_user)
71
- end
72
-
73
- def writable?(by_usergroup, by_specific_user)
74
- return false unless exist?
75
- return skip_resource '`writable?` is not supported on your OS yet.' if @perms_provider.nil?
76
-
77
- file_permission_granted?('write', by_usergroup, by_specific_user)
78
- end
79
-
80
- def executable?(by_usergroup, by_specific_user)
81
- return false unless exist?
82
- return skip_resource '`executable?` is not supported on your OS yet.' if @perms_provider.nil?
83
-
84
- file_permission_granted?('execute', by_usergroup, by_specific_user)
85
- end
86
-
87
- def allowed?(permission, opts = {})
88
- return false unless exist?
89
- return skip_resource '`allowed?` is not supported on your OS yet.' if @perms_provider.nil?
90
-
91
- file_permission_granted?(permission, opts[:by], opts[:by_user])
92
- end
93
-
94
- def mounted?(expected_options = nil, identical = false)
95
- mounted = file.mounted
96
-
97
- # return if no additional parameters have been provided
98
- return file.mounted? if expected_options.nil?
99
-
100
- # deprecation warning, this functionality will be removed in future version
101
- warn "[DEPRECATION] `be_mounted.with and be_mounted.only_with` are deprecated. Please use `mount('#{source_path}')` instead."
102
-
103
- # we cannot read mount data on non-Linux systems
104
- return nil if !inspec.os.linux?
105
-
106
- # parse content if we are on linux
107
- @mount_options ||= parse_mount_options(mounted.stdout, true)
108
-
109
- if identical
110
- # check if the options should be identical
111
- @mount_options == expected_options
112
- else
113
- # otherwise compare the selected values
114
- @mount_options.contains(expected_options)
115
- end
116
- end
117
-
118
- def suid
119
- (mode & 04000) > 0
120
- end
121
-
122
- alias setuid? suid
123
-
124
- def sgid
125
- (mode & 02000) > 0
126
- end
127
-
128
- alias setgid? sgid
129
-
130
- def sticky
131
- (mode & 01000) > 0
132
- end
133
-
134
- alias sticky? sticky
135
-
136
- def to_s
137
- "File #{source_path}"
138
- end
139
-
140
- private
141
-
142
- def file_permission_granted?(access_type, by_usergroup, by_specific_user)
143
- raise '`file_permission_granted?` is not supported on your OS' if @perms_provider.nil?
144
- if by_specific_user.nil? || by_specific_user.empty?
145
- @perms_provider.check_file_permission_by_mask(file, access_type, by_usergroup, by_specific_user)
146
- else
147
- @perms_provider.check_file_permission_by_user(access_type, by_specific_user, source_path)
148
- end
149
- end
150
- end
151
-
152
- class FilePermissions
153
- attr_reader :inspec
154
- def initialize(inspec)
155
- @inspec = inspec
156
- end
157
- end
158
-
159
- class UnixFilePermissions < FilePermissions
160
- def permission_flag(access_type)
161
- case access_type
162
- when 'read'
163
- 'r'
164
- when 'write'
165
- 'w'
166
- when 'execute'
167
- 'x'
168
- else
169
- raise 'Invalid access_type provided'
170
- end
171
- end
172
-
173
- def usergroup_for(usergroup, specific_user)
174
- if usergroup == 'others'
175
- 'other'
176
- elsif (usergroup.nil? || usergroup.empty?) && specific_user.nil?
177
- 'all'
178
- else
179
- usergroup
180
- end
181
- end
182
-
183
- def check_file_permission_by_mask(file, access_type, usergroup, specific_user)
184
- usergroup = usergroup_for(usergroup, specific_user)
185
- flag = permission_flag(access_type)
186
- mask = file.unix_mode_mask(usergroup, flag)
187
- raise 'Invalid usergroup/owner provided' if mask.nil?
188
- (file.mode & mask) != 0
189
- end
190
-
191
- def check_file_permission_by_user(access_type, user, path)
192
- flag = permission_flag(access_type)
193
- if inspec.os.linux?
194
- perm_cmd = "su -s /bin/sh -c \"test -#{flag} #{path}\" #{user}"
195
- elsif inspec.os.bsd? || inspec.os.solaris?
196
- perm_cmd = "sudo -u #{user} test -#{flag} #{path}"
197
- elsif inspec.os.aix?
198
- perm_cmd = "su #{user} -c test -#{flag} #{path}"
199
- elsif inspec.os.hpux?
200
- perm_cmd = "su #{user} -c \"test -#{flag} #{path}\""
201
- else
202
- return skip_resource 'The `file` resource does not support `by_user` on your OS.'
203
- end
204
-
205
- cmd = inspec.command(perm_cmd)
206
- cmd.exit_status == 0 ? true : false
207
- end
208
- end
209
-
210
- class WindowsFilePermissions < FilePermissions
211
- def check_file_permission_by_mask(_file, _access_type, _usergroup, _specific_user)
212
- raise '`check_file_permission_by_mask` is not supported on Windows'
213
- end
214
-
215
- def check_file_permission_by_user(access_type, user, path)
216
- access_rule = translate_perm_names(access_type)
217
- access_rule = convert_to_powershell_array(access_rule)
218
-
219
- cmd = inspec.command("@(@((Get-Acl '#{path}').access | Where-Object {$_.AccessControlType -eq 'Allow' -and $_.IdentityReference -eq '#{user}' }) | Where-Object {($_.FileSystemRights.ToString().Split(',') | % {$_.trim()} | ? {#{access_rule} -contains $_}) -ne $null}) | measure | % { $_.Count }")
220
- cmd.stdout.chomp == '0' ? false : true
221
- end
222
-
223
- private
224
-
225
- def convert_to_powershell_array(arr)
226
- if arr.empty?
227
- '@()'
228
- else
229
- %{@('#{arr.join("', '")}')}
230
- end
231
- end
232
-
233
- # Translates a developer-friendly string into a list of acceptable
234
- # FileSystemRights that match it, because Windows has a fun heirarchy
235
- # of permissions that are able to be noted in multiple ways.
236
- #
237
- # See also: https://www.codeproject.com/Reference/871338/AccessControl-FileSystemRights-Permissions-Table
238
- def translate_perm_names(access_type)
239
- names = translate_common_perms(access_type)
240
- names ||= translate_granular_perms(access_type)
241
- names ||= translate_uncommon_perms(access_type)
242
- raise 'Invalid access_type provided' unless names
243
-
244
- names
245
- end
246
-
247
- def translate_common_perms(access_type)
248
- case access_type
249
- when 'full-control'
250
- %w{FullControl}
251
- when 'modify'
252
- translate_perm_names('full-control') + %w{Modify}
253
- when 'read'
254
- translate_perm_names('modify') + %w{ReadAndExecute Read}
255
- when 'write'
256
- translate_perm_names('modify') + %w{Write}
257
- when 'execute'
258
- translate_perm_names('modify') + %w{ReadAndExecute ExecuteFile Traverse}
259
- when 'delete'
260
- translate_perm_names('modify') + %w{Delete}
261
- end
262
- end
263
-
264
- def translate_uncommon_perms(access_type)
265
- case access_type
266
- when 'delete-subdirectories-and-files'
267
- translate_perm_names('full-control') + %w{DeleteSubdirectoriesAndFiles}
268
- when 'change-permissions'
269
- translate_perm_names('full-control') + %w{ChangePermissions}
270
- when 'take-ownership'
271
- translate_perm_names('full-control') + %w{TakeOwnership}
272
- when 'synchronize'
273
- translate_perm_names('full-control') + %w{Synchronize}
274
- end
275
- end
276
-
277
- def translate_granular_perms(access_type)
278
- case access_type
279
- when 'write-data', 'create-files'
280
- translate_perm_names('write') + %w{WriteData CreateFiles}
281
- when 'append-data', 'create-directories'
282
- translate_perm_names('write') + %w{CreateDirectories AppendData}
283
- when 'write-extended-attributes'
284
- translate_perm_names('write') + %w{WriteExtendedAttributes}
285
- when 'write-attributes'
286
- translate_perm_names('write') + %w{WriteAttributes}
287
- when 'read-data', 'list-directory'
288
- translate_perm_names('read') + %w{ReadData ListDirectory}
289
- when 'read-attributes'
290
- translate_perm_names('read') + %w{ReadAttributes}
291
- when 'read-extended-attributes'
292
- translate_perm_names('read') + %w{ReadExtendedAttributes}
293
- when 'read-permissions'
294
- translate_perm_names('read') + %w{ReadPermissions}
295
- end
296
- end
297
- end
298
- end
1
+ # encoding: utf-8
2
+ # copyright: 2015, Vulcano Security GmbH
3
+
4
+ require 'shellwords'
5
+
6
+ module Inspec::Resources
7
+ module FilePermissionsSelector
8
+ def select_file_perms_style(os)
9
+ if os.unix?
10
+ UnixFilePermissions.new(inspec)
11
+ elsif os.windows?
12
+ WindowsFilePermissions.new(inspec)
13
+ end
14
+ end
15
+ end
16
+
17
+ class FileResource < Inspec.resource(1)
18
+ include FilePermissionsSelector
19
+ include LinuxMountParser
20
+
21
+ name 'file'
22
+ supports platform: 'unix'
23
+ supports platform: 'windows'
24
+ desc 'Use the file InSpec audit resource to test all system file types, including files, directories, symbolic links, named pipes, sockets, character devices, block devices, and doors.'
25
+ example "
26
+ describe file('path') do
27
+ it { should exist }
28
+ it { should be_file }
29
+ it { should be_readable }
30
+ it { should be_writable }
31
+ it { should be_executable.by_user('root') }
32
+ it { should be_owned_by 'root' }
33
+ its('mode') { should cmp '0644' }
34
+ end
35
+ "
36
+
37
+ attr_reader :file, :mount_options
38
+ def initialize(path)
39
+ # select permissions style
40
+ @perms_provider = select_file_perms_style(inspec.os)
41
+ @file = inspec.backend.file(path)
42
+ end
43
+
44
+ %w{
45
+ type exist? file? block_device? character_device? socket? directory?
46
+ symlink? pipe? mode mode? owner owned_by? group grouped_into?
47
+ link_path linked_to? mtime size selinux_label immutable?
48
+ product_version file_version version? md5sum sha256sum
49
+ path basename source source_path uid gid
50
+ }.each do |m|
51
+ define_method m.to_sym do |*args|
52
+ file.method(m.to_sym).call(*args)
53
+ end
54
+ end
55
+
56
+ def content
57
+ res = file.content
58
+ return nil if res.nil?
59
+ res.force_encoding('utf-8')
60
+ end
61
+
62
+ def contain(*_)
63
+ raise 'Contain is not supported. Please use standard RSpec matchers.'
64
+ end
65
+
66
+ def readable?(by_usergroup, by_specific_user)
67
+ return false unless exist?
68
+ return skip_resource '`readable?` is not supported on your OS yet.' if @perms_provider.nil?
69
+
70
+ file_permission_granted?('read', by_usergroup, by_specific_user)
71
+ end
72
+
73
+ def writable?(by_usergroup, by_specific_user)
74
+ return false unless exist?
75
+ return skip_resource '`writable?` is not supported on your OS yet.' if @perms_provider.nil?
76
+
77
+ file_permission_granted?('write', by_usergroup, by_specific_user)
78
+ end
79
+
80
+ def executable?(by_usergroup, by_specific_user)
81
+ return false unless exist?
82
+ return skip_resource '`executable?` is not supported on your OS yet.' if @perms_provider.nil?
83
+
84
+ file_permission_granted?('execute', by_usergroup, by_specific_user)
85
+ end
86
+
87
+ def allowed?(permission, opts = {})
88
+ return false unless exist?
89
+ return skip_resource '`allowed?` is not supported on your OS yet.' if @perms_provider.nil?
90
+
91
+ file_permission_granted?(permission, opts[:by], opts[:by_user])
92
+ end
93
+
94
+ def mounted?(expected_options = nil, identical = false)
95
+ mounted = file.mounted
96
+
97
+ # return if no additional parameters have been provided
98
+ return file.mounted? if expected_options.nil?
99
+
100
+ # deprecation warning, this functionality will be removed in future version
101
+ warn "[DEPRECATION] `be_mounted.with and be_mounted.only_with` are deprecated. Please use `mount('#{source_path}')` instead."
102
+
103
+ # we cannot read mount data on non-Linux systems
104
+ return nil if !inspec.os.linux?
105
+
106
+ # parse content if we are on linux
107
+ @mount_options ||= parse_mount_options(mounted.stdout, true)
108
+
109
+ if identical
110
+ # check if the options should be identical
111
+ @mount_options == expected_options
112
+ else
113
+ # otherwise compare the selected values
114
+ @mount_options.contains(expected_options)
115
+ end
116
+ end
117
+
118
+ def suid
119
+ (mode & 04000) > 0
120
+ end
121
+
122
+ alias setuid? suid
123
+
124
+ def sgid
125
+ (mode & 02000) > 0
126
+ end
127
+
128
+ alias setgid? sgid
129
+
130
+ def sticky
131
+ (mode & 01000) > 0
132
+ end
133
+
134
+ alias sticky? sticky
135
+
136
+ def to_s
137
+ "File #{source_path}"
138
+ end
139
+
140
+ private
141
+
142
+ def file_permission_granted?(access_type, by_usergroup, by_specific_user)
143
+ raise '`file_permission_granted?` is not supported on your OS' if @perms_provider.nil?
144
+ if by_specific_user.nil? || by_specific_user.empty?
145
+ @perms_provider.check_file_permission_by_mask(file, access_type, by_usergroup, by_specific_user)
146
+ else
147
+ @perms_provider.check_file_permission_by_user(access_type, by_specific_user, source_path)
148
+ end
149
+ end
150
+ end
151
+
152
+ class FilePermissions
153
+ attr_reader :inspec
154
+ def initialize(inspec)
155
+ @inspec = inspec
156
+ end
157
+ end
158
+
159
+ class UnixFilePermissions < FilePermissions
160
+ def permission_flag(access_type)
161
+ case access_type
162
+ when 'read'
163
+ 'r'
164
+ when 'write'
165
+ 'w'
166
+ when 'execute'
167
+ 'x'
168
+ else
169
+ raise 'Invalid access_type provided'
170
+ end
171
+ end
172
+
173
+ def usergroup_for(usergroup, specific_user)
174
+ if usergroup == 'others'
175
+ 'other'
176
+ elsif (usergroup.nil? || usergroup.empty?) && specific_user.nil?
177
+ 'all'
178
+ else
179
+ usergroup
180
+ end
181
+ end
182
+
183
+ def check_file_permission_by_mask(file, access_type, usergroup, specific_user)
184
+ usergroup = usergroup_for(usergroup, specific_user)
185
+ flag = permission_flag(access_type)
186
+ mask = file.unix_mode_mask(usergroup, flag)
187
+ raise 'Invalid usergroup/owner provided' if mask.nil?
188
+ (file.mode & mask) != 0
189
+ end
190
+
191
+ def check_file_permission_by_user(access_type, user, path)
192
+ flag = permission_flag(access_type)
193
+ if inspec.os.linux?
194
+ perm_cmd = "su -s /bin/sh -c \"test -#{flag} #{path}\" #{user}"
195
+ elsif inspec.os.bsd? || inspec.os.solaris?
196
+ perm_cmd = "sudo -u #{user} test -#{flag} #{path}"
197
+ elsif inspec.os.aix?
198
+ perm_cmd = "su #{user} -c test -#{flag} #{path}"
199
+ elsif inspec.os.hpux?
200
+ perm_cmd = "su #{user} -c \"test -#{flag} #{path}\""
201
+ else
202
+ return skip_resource 'The `file` resource does not support `by_user` on your OS.'
203
+ end
204
+
205
+ cmd = inspec.command(perm_cmd)
206
+ cmd.exit_status == 0 ? true : false
207
+ end
208
+ end
209
+
210
+ class WindowsFilePermissions < FilePermissions
211
+ def check_file_permission_by_mask(_file, _access_type, _usergroup, _specific_user)
212
+ raise '`check_file_permission_by_mask` is not supported on Windows'
213
+ end
214
+
215
+ def check_file_permission_by_user(access_type, user, path)
216
+ access_rule = translate_perm_names(access_type)
217
+ access_rule = convert_to_powershell_array(access_rule)
218
+
219
+ cmd = inspec.command("@(@((Get-Acl '#{path}').access | Where-Object {$_.AccessControlType -eq 'Allow' -and $_.IdentityReference -eq '#{user}' }) | Where-Object {($_.FileSystemRights.ToString().Split(',') | % {$_.trim()} | ? {#{access_rule} -contains $_}) -ne $null}) | measure | % { $_.Count }")
220
+ cmd.stdout.chomp == '0' ? false : true
221
+ end
222
+
223
+ private
224
+
225
+ def convert_to_powershell_array(arr)
226
+ if arr.empty?
227
+ '@()'
228
+ else
229
+ %{@('#{arr.join("', '")}')}
230
+ end
231
+ end
232
+
233
+ # Translates a developer-friendly string into a list of acceptable
234
+ # FileSystemRights that match it, because Windows has a fun heirarchy
235
+ # of permissions that are able to be noted in multiple ways.
236
+ #
237
+ # See also: https://www.codeproject.com/Reference/871338/AccessControl-FileSystemRights-Permissions-Table
238
+ def translate_perm_names(access_type)
239
+ names = translate_common_perms(access_type)
240
+ names ||= translate_granular_perms(access_type)
241
+ names ||= translate_uncommon_perms(access_type)
242
+ raise 'Invalid access_type provided' unless names
243
+
244
+ names
245
+ end
246
+
247
+ def translate_common_perms(access_type)
248
+ case access_type
249
+ when 'full-control'
250
+ %w{FullControl}
251
+ when 'modify'
252
+ translate_perm_names('full-control') + %w{Modify}
253
+ when 'read'
254
+ translate_perm_names('modify') + %w{ReadAndExecute Read}
255
+ when 'write'
256
+ translate_perm_names('modify') + %w{Write}
257
+ when 'execute'
258
+ translate_perm_names('modify') + %w{ReadAndExecute ExecuteFile Traverse}
259
+ when 'delete'
260
+ translate_perm_names('modify') + %w{Delete}
261
+ end
262
+ end
263
+
264
+ def translate_uncommon_perms(access_type)
265
+ case access_type
266
+ when 'delete-subdirectories-and-files'
267
+ translate_perm_names('full-control') + %w{DeleteSubdirectoriesAndFiles}
268
+ when 'change-permissions'
269
+ translate_perm_names('full-control') + %w{ChangePermissions}
270
+ when 'take-ownership'
271
+ translate_perm_names('full-control') + %w{TakeOwnership}
272
+ when 'synchronize'
273
+ translate_perm_names('full-control') + %w{Synchronize}
274
+ end
275
+ end
276
+
277
+ def translate_granular_perms(access_type)
278
+ case access_type
279
+ when 'write-data', 'create-files'
280
+ translate_perm_names('write') + %w{WriteData CreateFiles}
281
+ when 'append-data', 'create-directories'
282
+ translate_perm_names('write') + %w{CreateDirectories AppendData}
283
+ when 'write-extended-attributes'
284
+ translate_perm_names('write') + %w{WriteExtendedAttributes}
285
+ when 'write-attributes'
286
+ translate_perm_names('write') + %w{WriteAttributes}
287
+ when 'read-data', 'list-directory'
288
+ translate_perm_names('read') + %w{ReadData ListDirectory}
289
+ when 'read-attributes'
290
+ translate_perm_names('read') + %w{ReadAttributes}
291
+ when 'read-extended-attributes'
292
+ translate_perm_names('read') + %w{ReadExtendedAttributes}
293
+ when 'read-permissions'
294
+ translate_perm_names('read') + %w{ReadPermissions}
295
+ end
296
+ end
297
+ end
298
+ end