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
data/bin/inspec CHANGED
@@ -1,12 +1,12 @@
1
- #!/usr/bin/env ruby
2
- # encoding: utf-8
3
- # Copyright 2015 Dominik Richter
4
- # author: Dominik Richter
5
- # author: Christoph Hartmann
6
-
7
- Encoding.default_external = Encoding::UTF_8
8
- Encoding.default_internal = Encoding::UTF_8
9
-
10
- require_relative '../lib/inspec'
11
- require_relative '../lib/inspec/cli'
12
- Inspec::InspecCLI.start(ARGV)
1
+ #!/usr/bin/env ruby
2
+ # encoding: utf-8
3
+ # Copyright 2015 Dominik Richter
4
+ # author: Dominik Richter
5
+ # author: Christoph Hartmann
6
+
7
+ Encoding.default_external = Encoding::UTF_8
8
+ Encoding.default_internal = Encoding::UTF_8
9
+
10
+ require_relative '../lib/inspec'
11
+ require_relative '../lib/inspec/cli'
12
+ Inspec::InspecCLI.start(ARGV)
data/docs/.gitignore CHANGED
@@ -1,2 +1,2 @@
1
- resources.md
2
- cli.md
1
+ resources.md
2
+ cli.md
data/docs/README.md CHANGED
@@ -1,40 +1,41 @@
1
- # InSpec documentation
2
-
3
- This is the home of the InSpec documentation. This documentation provides an introduction to this mechanism and shows how to write custom tests.
4
-
5
- The goal of this folder is for any community member to clone these docs, make the changes, check if they are valid, and contribute to the project.
6
-
7
- ## How to build docs
8
-
9
- We build docs by:
10
-
11
- 1. Auto-generating docs from code
12
- 2. Transforming markdown+snippets in this folder into pure markdown in `www/source/docs`
13
- 3. Rendering them to the website via instructions in `www/`
14
-
15
- For development, you **only need step 1**!
16
-
17
- **1 Generate docs**
18
-
19
- To generate all docs run:
20
-
21
- ```
22
- bundle exec rake docs
23
- ```
24
-
25
- You can run tasks individually. For a list of tasks run:
26
-
27
- ```
28
- bundle exec rake --tasks docs
29
- ```
30
-
31
- ## Stability Index
32
-
33
- Every available InSpec resource will indicate its stability. As InSpec matures, certain parts are more reliable than others. Brand new features are likely to be redesigned and marked as such.
34
-
35
- The stability indices are as follows:
36
-
37
- * `Stability: Deprecated` - This features will be removed in future versions, because its known for being problematic. Do not rely on it.
38
- * `Stability: Experimental` - New features may change or are removed in future versions
39
- * `Stability: Stable` - API is well established and proofed. Maintaining compatibility is a high priority
40
- * `Stability: Locked` - Only security and performance fixes are allowed
1
+ # InSpec documentation
2
+
3
+ This is the home of the InSpec documentation. This documentation provides an introduction to this mechanism and shows how to write custom tests.
4
+
5
+ The goal of this folder is for any community member to clone these docs, make the changes, check if they are valid, and contribute to the project.
6
+
7
+ ## How to build docs
8
+
9
+ We build docs by:
10
+
11
+ 1. Auto-generating docs from code
12
+ 2. Transforming markdown+snippets in this folder into pure markdown in `www/source/docs`
13
+ 3. Rendering them to the website via instructions in `www/`
14
+
15
+ For development, you **only need step 1**!
16
+
17
+ **1 Generate docs**
18
+
19
+ To generate all docs run:
20
+
21
+ ```
22
+ bundle exec rake docs
23
+ ```
24
+
25
+ You can run tasks individually. For a list of tasks run:
26
+
27
+ ```
28
+ bundle exec rake --tasks docs
29
+ ```
30
+
31
+ ## Stability Index
32
+
33
+ Every available InSpec resource will indicate its stability. As InSpec matures, certain parts are more reliable than others. Brand new features are likely to be redesigned and marked as such.
34
+
35
+ The stability indices are as follows:
36
+
37
+ * `Stability: Deprecated` - This features will be removed in future versions, because its known for being problematic. Do not rely on it.
38
+ * `Stability: Experimental` - New features may change or are removed in future versions
39
+ * `Stability: Stable` - API is well established and proofed. Maintaining compatibility is a high priority
40
+ * `Stability: Locked` - Only security and performance fixes are allowed
41
+
@@ -1,62 +1,62 @@
1
- # What happens when a profile file is loaded
2
-
3
- ## Consult with Harry Tuttle
4
-
5
- [He's not from Central Services or anything.](https://youtu.be/VRfoIyx8KfU?t=2m41s)
6
-
7
- ## Tips
8
-
9
- * In the early days of InSpec / ServerSpec, controls were called "rules". Throughout various places in the code, the word "rule" is used to mean "control". Make the mental subsitution.
10
- * InSpec supports reading profiles from tarballs, local files, git repos, etc. So, don't count on local file reading; instead it uses a special source reader to obtain the contents of the files.
11
-
12
- ## The basics of the stack
13
-
14
- #5 Inspec::Profile.collect_tests(include_list#Array) at lib/inspec/profile.rb:167
15
- #4 Hash.each at lib/inspec/profile.rb:167
16
- #3 block in Inspec::Profile.block in collect_tests(include_list#Array) at lib/inspec/profile.rb:170
17
- #2 Inspec::ProfileContext.load_control_file(*args#Array) at lib/inspec/profile_context.rb:141
18
- #1 Inspec::ProfileContext.control_eval_context at lib/inspec/profile_context.rb:58
19
- #0 #<Class:Inspec::ControlEvalContext>.create(profile_context#Inspec::ProfileContext, resources_dsl#Module) at lib/inspec/control_eval_context.rb:41
20
-
21
- ## A profile context is created
22
-
23
- Like many things in InSpec core, a profile context is an anonymous class. (verify)
24
-
25
- Additionally, a control_eval_context is created. It is an instance of an anonymous class; it has a class<->relationship with its profile context. See `lib/inspec/control_eval_context.rb`.
26
-
27
- ## Each file's contents are instance eval'd against the control_eval_context
28
-
29
- ### DSL methods are executed at this time
30
-
31
- So, if you have a control file with `title` in it, that will call the title method that was defined at `lib/inspec/control_eval_context.rb:60`. Importantly, this also includes the `control` DSL keyword, and also the `describe` keyword (used for bare describes).
32
-
33
- ### Each control and their block are wrapped in an anonymous class
34
-
35
- The anonymous class generator is located at `lib/inspec/control_eval_context.rb:24`. At this point, the terminology switches from `control` to `rule`. Each context class inherits from Inspec::Rule, which provides the constructor.
36
-
37
- The control context class also gets extended with the resource DSL, so anything in the source code for the control can use the resource DSL. This includes all resource names, but importantly, the `describe` DSL keyword.
38
-
39
- Finally, Inspec::Rule provides the control DSL - impact, title, desc, ref, and tags.
40
-
41
- ### The block is instance_eval'd against the control context class
42
-
43
- See `lib/inspec/rule.rb:50`. We're now in two levels of instance eval'ing - the file is gradually being eval'd against the profile context anonymous class, and the current control's block is being instance eval'd against a control context anonymous class.
44
-
45
- At this stage, control-level metadata (impact, title, refs, tags, desc) are evaluated and set as instance vars on the control.
46
-
47
- Any "loose" ruby in the control is also executed at this point.
48
-
49
- And, the describe and describe.one blocks are executed.
50
-
51
- ### TODO: describe blocks are *not* instance-evaled
52
-
53
- ### The control is registered with the profile
54
-
55
- Using the method register_control (dynamically defined on the control eval context), we check for various skip conditions. If none of them apply, the control is then registered with the profile context using register_rule.
56
-
57
- ProfileContext.register_rule's main job is to determine the full ID of the control (within the context of the profile) and either add it to the controls list, or (if another control with the same ID exists), merge it. (This is where overriding happens).
58
-
59
- Note: can skip a control with:
60
- Inspec::Rule.set_skip_rule(control, msg)
61
-
1
+ # What happens when a profile file is loaded
2
+
3
+ ## Consult with Harry Tuttle
4
+
5
+ [He's not from Central Services or anything.](https://youtu.be/VRfoIyx8KfU?t=2m41s)
6
+
7
+ ## Tips
8
+
9
+ * In the early days of InSpec / ServerSpec, controls were called "rules". Throughout various places in the code, the word "rule" is used to mean "control". Make the mental subsitution.
10
+ * InSpec supports reading profiles from tarballs, local files, git repos, etc. So, don't count on local file reading; instead it uses a special source reader to obtain the contents of the files.
11
+
12
+ ## The basics of the stack
13
+
14
+ #5 Inspec::Profile.collect_tests(include_list#Array) at lib/inspec/profile.rb:167
15
+ #4 Hash.each at lib/inspec/profile.rb:167
16
+ #3 block in Inspec::Profile.block in collect_tests(include_list#Array) at lib/inspec/profile.rb:170
17
+ #2 Inspec::ProfileContext.load_control_file(*args#Array) at lib/inspec/profile_context.rb:141
18
+ #1 Inspec::ProfileContext.control_eval_context at lib/inspec/profile_context.rb:58
19
+ #0 #<Class:Inspec::ControlEvalContext>.create(profile_context#Inspec::ProfileContext, resources_dsl#Module) at lib/inspec/control_eval_context.rb:41
20
+
21
+ ## A profile context is created
22
+
23
+ Like many things in InSpec core, a profile context is an anonymous class. (verify)
24
+
25
+ Additionally, a control_eval_context is created. It is an instance of an anonymous class; it has a class<->relationship with its profile context. See `lib/inspec/control_eval_context.rb`.
26
+
27
+ ## Each file's contents are instance eval'd against the control_eval_context
28
+
29
+ ### DSL methods are executed at this time
30
+
31
+ So, if you have a control file with `title` in it, that will call the title method that was defined at `lib/inspec/control_eval_context.rb:60`. Importantly, this also includes the `control` DSL keyword, and also the `describe` keyword (used for bare describes).
32
+
33
+ ### Each control and their block are wrapped in an anonymous class
34
+
35
+ The anonymous class generator is located at `lib/inspec/control_eval_context.rb:24`. At this point, the terminology switches from `control` to `rule`. Each context class inherits from Inspec::Rule, which provides the constructor.
36
+
37
+ The control context class also gets extended with the resource DSL, so anything in the source code for the control can use the resource DSL. This includes all resource names, but importantly, the `describe` DSL keyword.
38
+
39
+ Finally, Inspec::Rule provides the control DSL - impact, title, desc, ref, and tags.
40
+
41
+ ### The block is instance_eval'd against the control context class
42
+
43
+ See `lib/inspec/rule.rb:50`. We're now in two levels of instance eval'ing - the file is gradually being eval'd against the profile context anonymous class, and the current control's block is being instance eval'd against a control context anonymous class.
44
+
45
+ At this stage, control-level metadata (impact, title, refs, tags, desc) are evaluated and set as instance vars on the control.
46
+
47
+ Any "loose" ruby in the control is also executed at this point.
48
+
49
+ And, the describe and describe.one blocks are executed.
50
+
51
+ ### TODO: describe blocks are *not* instance-evaled
52
+
53
+ ### The control is registered with the profile
54
+
55
+ Using the method register_control (dynamically defined on the control eval context), we check for various skip conditions. If none of them apply, the control is then registered with the profile context using register_rule.
56
+
57
+ ProfileContext.register_rule's main job is to determine the full ID of the control (within the context of the profile) and either add it to the controls list, or (if another control with the same ID exists), merge it. (This is where overriding happens).
58
+
59
+ Note: can skip a control with:
60
+ Inspec::Rule.set_skip_rule(control, msg)
61
+
62
62
  ## What else?
data/docs/dsl_inspec.md CHANGED
@@ -1,258 +1,258 @@
1
- ---
2
- title: InSpec DSL
3
- ---
4
-
5
- # InSpec DSL
6
-
7
- InSpec is a run-time framework and rule language used to specify compliance, security, and policy requirements. It includes a collection of resources that help you write auditing controls quickly and easily. The syntax used by both open source and |chef compliance| auditing is the same. The open source |InSpec resource| framework is compatible with |chef compliance|.
8
-
9
- The InSpec DSL is a Ruby DSL for writing audit controls, which includes audit resources that you can invoke.
10
-
11
- The following sections describe the syntax and show some simple examples of using the InSpec resources.
12
-
13
- ## Syntax
14
-
15
- The following resource tests |ssh| server configuration. For example, a simple control may described as:
16
-
17
- ```ruby
18
- describe sshd_config do
19
- its('Port') { should eq('22') }
20
- end
21
- ```
22
-
23
- In various use cases like implementing IT compliance across different departments, it becomes handy to extend the control with metadata. Each control may define an additional ``impact``, ``title`` or ``desc``. An example looks like:
24
-
25
- ```ruby
26
- control 'sshd-8' do
27
- impact 0.6
28
- title 'Server: Configure the service port'
29
- desc '
30
- Always specify which port the SSH server should listen to.
31
- Prevent unexpected settings.
32
- '
33
- tag 'ssh','sshd','openssh-server'
34
- tag cce: 'CCE-27072-8'
35
- ref 'NSA-RH6-STIG - Section 3.5.2.1', url: 'https://www.nsa.gov/ia/_files/os/redhat/rhel5-guide-i731.pdf'
36
-
37
- describe sshd_config do
38
- its('Port') { should eq('22') }
39
- end
40
- end
41
- ```
42
-
43
- where
44
-
45
- * `'sshd-8'` is the name of the control
46
- * `impact`, `title`, and `desc` define metadata that fully describes the importance of the control, its purpose, with a succinct and complete description
47
- * `impact` is an float that measures the importance of the compliance results and must be a value between `0.0` and `1.0`. The value ranges are:
48
- * `0.0 to <0.4` these are controls with minor criticality
49
- * `0.4 to <0.7` these are controls with major criticality
50
- * `0.7 to 1.0` these are critical controls
51
- * `tag` is optional meta-information with with key or key-value pairs
52
- * `ref` is a reference to an external document
53
- * `describe` is a block that contains at least one test. A `control` block must contain at least one `describe` block, but may contain as many as required
54
- * `sshd_config` is an InSpec resource. For the full list of InSpec resources, see InSpec resource documentation
55
- * `its('Port')` is the matcher; `{ should eq('22') }` is the test. A `describe` block must contain at least one matcher, but may contain as many as required
56
-
57
-
58
- ## Advanced concepts
59
-
60
- With InSpec it is possible to check if at least one of a collection of checks is true. For example: If a setting is configured in two different locations, you may want to test if either configuration A or configuration B have been set. This is accomplished via `describe.one`. It defines a block of tests with at least one valid check.
61
-
62
- ```ruby
63
- describe.one do
64
- describe ConfigurationA do
65
- its('setting_1') { should eq true }
66
- end
67
-
68
- describe ConfigurationB do
69
- its('setting_2') { should eq true }
70
- end
71
- end
72
- ```
73
-
74
- #### Sensitive resources
75
-
76
- In some scenarios, you may be writing checks involving resources with sensitive content (e.g. a file resource). In the case of failures, it may be desired to suppress output. This can be done by adding the `:sensitive` flag to the resource definition
77
-
78
- ```ruby
79
- describe file('/tmp/mysecretfile'), :sensitive do
80
- its('content') { should contain 'secret_info' }
81
- end
82
- ```
83
-
84
- ## Examples
85
-
86
- The following examples show simple compliance tests using a single `control` block.
87
-
88
- ## Test System Event Log
89
-
90
- The following test shows how to audit machines running Windows 2012 R2 that password complexity is enabled:
91
-
92
- ```ruby
93
- control 'windows-account-102' do
94
- impact 1.0
95
- title 'Windows Password Complexity is Enabled'
96
- desc 'Password must meet complexity requirement'
97
- describe security_policy do
98
- its('PasswordComplexity') { should eq 1 }
99
- end
100
- end
101
- ```
102
-
103
- ## Are PostgreSQL passwords empty?
104
-
105
- The following test shows how to audit machines running PostgreSQL to ensure that passwords are not empty.
106
-
107
- ```ruby
108
- control 'postgres-7' do
109
- impact 1.0
110
- title "Don't allow empty passwords"
111
- describe postgres_session('user', 'pass').query("SELECT * FROM pg_shadow WHERE passwd IS NULL;") do
112
- its('output') { should eq('') }
113
- end
114
- end
115
- ```
116
-
117
- ## Are MySQL passwords in ENV?
118
-
119
- The following test shows how to audit machines running MySQL to ensure that passwords are not stored in `ENV`:
120
-
121
- ```ruby
122
- control 'mysql-3' do
123
- impact 1.0
124
- title 'Do not store your MySQL password in your ENV'
125
- desc '
126
- Storing credentials in your ENV may easily expose
127
- them to an attacker. Prevent this at all costs.
128
- '
129
- describe command('env') do
130
- its('stdout') { should_not match(/^MYSQL_PWD=/) }
131
- end
132
- end
133
- ```
134
-
135
- ## Is `/etc/ssh` a Directory?
136
-
137
- The following test shows how to audit machines to ensure that `/etc/ssh` is a directory:
138
-
139
- ```ruby
140
- control 'basic-1' do
141
- impact 1.0
142
- title '/etc/ssh should be a directory'
143
- desc '
144
- In order for OpenSSH to function correctly, its
145
- configuration path must be a folder.
146
- '
147
- describe file('/etc/ssh') do
148
- it { should be_directory }
149
- end
150
- end
151
- ```
152
-
153
- ## Is Apache running?
154
-
155
- The following test shows how to audit machines to ensure that Apache is enabled and running:
156
-
157
- ```ruby
158
- control 'apache-1' do
159
- impact 0.3
160
- title 'Apache2 should be configured and running'
161
- describe service(apache.service) do
162
- it { should be_enabled }
163
- it { should be_running }
164
- end
165
- end
166
- ```
167
-
168
- ## Are insecure packages installed ?
169
-
170
- The following test shows how to audit machines for insecure packages:
171
-
172
- ```ruby
173
- control 'cis-os-services-5.1.3' do
174
- impact 0.7
175
- title '5.1.3 Ensure rsh client is not installed'
176
-
177
- describe package('rsh') do
178
- it { should_not be_installed }
179
- end
180
-
181
- describe package('rsh-redone-client') do
182
- it { should_not be_installed }
183
- end
184
- end
185
- ```
186
-
187
- ## Test Windows Registry Keys
188
-
189
- The following test shows how to audit machines to ensure Safe DLL Search Mode is enabled:
190
-
191
- ```ruby
192
- control 'windows-base-101' do
193
- impact 1.0
194
- title 'Safe DLL Search Mode is Enabled'
195
- desc '
196
- @link: https://msdn.microsoft.com/en-us/library/ms682586(v=vs.85).aspx
197
- '
198
- describe registry_key('HKLM\\System\\CurrentControlSet\\Control\\Session Manager') do
199
- it { should exist }
200
- it { should_not have_property_value('SafeDllSearchMode', :type_dword, '0') }
201
- end
202
- end
203
- ```
204
-
205
- ## Exclude specific test
206
-
207
- This shows how to allow skipping certain tests if conditions are not met, by using `only_if`.
208
- In this example the test will not be performed if `redis-cli` command does not exist, because for example package on remote host was not installed.
209
-
210
- ```ruby
211
- control 'nutcracker-connect-redis-001' do
212
- impact 1.0
213
- title 'Check if nutcracker can pass commands to redis'
214
- desc 'execute redis-cli set key command, to check connectivity of the service'
215
-
216
- only_if do
217
- command('redis-cli').exist?
218
- end
219
-
220
- describe command('redis-cli SET test_inspec "HELLO"') do
221
- its(:stdout) { should match(/OK/) }
222
- end
223
- end
224
- ```
225
-
226
- Mixing this with other conditionals (like checking existence of the files etc.) can help to test different test paths using InSpec. This way you can skip certain tests which would 100% fail due to the way servers are prepared, but you know that the same test suites are reused later in different circumstances by different teams.
227
-
228
- ## Additional metadata for controls
229
-
230
-
231
- The following example illustrates various ways to add tags and references to `control`
232
-
233
- ```ruby
234
- control 'ssh-1' do
235
- impact 1.0
236
-
237
- title 'Allow only SSH Protocol 2'
238
- desc 'Only SSH protocol version 2 connections should be permitted.
239
- The default setting in /etc/ssh/sshd_config is correct, and can be
240
- verified by ensuring that the following line appears: Protocol 2'
241
-
242
- tag 'production','development'
243
- tag 'ssh','sshd','openssh-server'
244
-
245
- tag cce: 'CCE-27072-8'
246
- tag disa: 'RHEL-06-000227'
247
-
248
- tag remediation: 'stig_rhel6/recipes/sshd-config.rb'
249
- tag remediation: 'https://supermarket.chef.io/cookbooks/ssh-hardening'
250
-
251
- ref 'NSA-RH6-STIG - Section 3.5.2.1', url: 'https://www.nsa.gov/ia/_files/os/redhat/rhel5-guide-i731.pdf'
252
- ref 'http://people.redhat.com/swells/scap-security-guide/RHEL/6/output/ssg-centos6-guide-C2S.html'
253
-
254
- describe ssh_config do
255
- its ('Protocol') { should eq '2'}
256
- end
257
- end
258
- ```
1
+ ---
2
+ title: InSpec DSL
3
+ ---
4
+
5
+ # InSpec DSL
6
+
7
+ InSpec is a run-time framework and rule language used to specify compliance, security, and policy requirements. It includes a collection of resources that help you write auditing controls quickly and easily. The syntax used by both open source and |chef compliance| auditing is the same. The open source |InSpec resource| framework is compatible with |chef compliance|.
8
+
9
+ The InSpec DSL is a Ruby DSL for writing audit controls, which includes audit resources that you can invoke.
10
+
11
+ The following sections describe the syntax and show some simple examples of using the InSpec resources.
12
+
13
+ ## Syntax
14
+
15
+ The following resource tests |ssh| server configuration. For example, a simple control may described as:
16
+
17
+ ```ruby
18
+ describe sshd_config do
19
+ its('Port') { should eq('22') }
20
+ end
21
+ ```
22
+
23
+ In various use cases like implementing IT compliance across different departments, it becomes handy to extend the control with metadata. Each control may define an additional ``impact``, ``title`` or ``desc``. An example looks like:
24
+
25
+ ```ruby
26
+ control 'sshd-8' do
27
+ impact 0.6
28
+ title 'Server: Configure the service port'
29
+ desc '
30
+ Always specify which port the SSH server should listen to.
31
+ Prevent unexpected settings.
32
+ '
33
+ tag 'ssh','sshd','openssh-server'
34
+ tag cce: 'CCE-27072-8'
35
+ ref 'NSA-RH6-STIG - Section 3.5.2.1', url: 'https://www.nsa.gov/ia/_files/os/redhat/rhel5-guide-i731.pdf'
36
+
37
+ describe sshd_config do
38
+ its('Port') { should eq('22') }
39
+ end
40
+ end
41
+ ```
42
+
43
+ where
44
+
45
+ * `'sshd-8'` is the name of the control
46
+ * `impact`, `title`, and `desc` define metadata that fully describes the importance of the control, its purpose, with a succinct and complete description
47
+ * `impact` is an float that measures the importance of the compliance results and must be a value between `0.0` and `1.0`. The value ranges are:
48
+ * `0.0 to <0.4` these are controls with minor criticality
49
+ * `0.4 to <0.7` these are controls with major criticality
50
+ * `0.7 to 1.0` these are critical controls
51
+ * `tag` is optional meta-information with with key or key-value pairs
52
+ * `ref` is a reference to an external document
53
+ * `describe` is a block that contains at least one test. A `control` block must contain at least one `describe` block, but may contain as many as required
54
+ * `sshd_config` is an InSpec resource. For the full list of InSpec resources, see InSpec resource documentation
55
+ * `its('Port')` is the matcher; `{ should eq('22') }` is the test. A `describe` block must contain at least one matcher, but may contain as many as required
56
+
57
+
58
+ ## Advanced concepts
59
+
60
+ With InSpec it is possible to check if at least one of a collection of checks is true. For example: If a setting is configured in two different locations, you may want to test if either configuration A or configuration B have been set. This is accomplished via `describe.one`. It defines a block of tests with at least one valid check.
61
+
62
+ ```ruby
63
+ describe.one do
64
+ describe ConfigurationA do
65
+ its('setting_1') { should eq true }
66
+ end
67
+
68
+ describe ConfigurationB do
69
+ its('setting_2') { should eq true }
70
+ end
71
+ end
72
+ ```
73
+
74
+ #### Sensitive resources
75
+
76
+ In some scenarios, you may be writing checks involving resources with sensitive content (e.g. a file resource). In the case of failures, it may be desired to suppress output. This can be done by adding the `:sensitive` flag to the resource definition
77
+
78
+ ```ruby
79
+ describe file('/tmp/mysecretfile'), :sensitive do
80
+ its('content') { should contain 'secret_info' }
81
+ end
82
+ ```
83
+
84
+ ## Examples
85
+
86
+ The following examples show simple compliance tests using a single `control` block.
87
+
88
+ ## Test System Event Log
89
+
90
+ The following test shows how to audit machines running Windows 2012 R2 that password complexity is enabled:
91
+
92
+ ```ruby
93
+ control 'windows-account-102' do
94
+ impact 1.0
95
+ title 'Windows Password Complexity is Enabled'
96
+ desc 'Password must meet complexity requirement'
97
+ describe security_policy do
98
+ its('PasswordComplexity') { should eq 1 }
99
+ end
100
+ end
101
+ ```
102
+
103
+ ## Are PostgreSQL passwords empty?
104
+
105
+ The following test shows how to audit machines running PostgreSQL to ensure that passwords are not empty.
106
+
107
+ ```ruby
108
+ control 'postgres-7' do
109
+ impact 1.0
110
+ title "Don't allow empty passwords"
111
+ describe postgres_session('user', 'pass').query("SELECT * FROM pg_shadow WHERE passwd IS NULL;") do
112
+ its('output') { should eq('') }
113
+ end
114
+ end
115
+ ```
116
+
117
+ ## Are MySQL passwords in ENV?
118
+
119
+ The following test shows how to audit machines running MySQL to ensure that passwords are not stored in `ENV`:
120
+
121
+ ```ruby
122
+ control 'mysql-3' do
123
+ impact 1.0
124
+ title 'Do not store your MySQL password in your ENV'
125
+ desc '
126
+ Storing credentials in your ENV may easily expose
127
+ them to an attacker. Prevent this at all costs.
128
+ '
129
+ describe command('env') do
130
+ its('stdout') { should_not match(/^MYSQL_PWD=/) }
131
+ end
132
+ end
133
+ ```
134
+
135
+ ## Is `/etc/ssh` a Directory?
136
+
137
+ The following test shows how to audit machines to ensure that `/etc/ssh` is a directory:
138
+
139
+ ```ruby
140
+ control 'basic-1' do
141
+ impact 1.0
142
+ title '/etc/ssh should be a directory'
143
+ desc '
144
+ In order for OpenSSH to function correctly, its
145
+ configuration path must be a folder.
146
+ '
147
+ describe file('/etc/ssh') do
148
+ it { should be_directory }
149
+ end
150
+ end
151
+ ```
152
+
153
+ ## Is Apache running?
154
+
155
+ The following test shows how to audit machines to ensure that Apache is enabled and running:
156
+
157
+ ```ruby
158
+ control 'apache-1' do
159
+ impact 0.3
160
+ title 'Apache2 should be configured and running'
161
+ describe service(apache.service) do
162
+ it { should be_enabled }
163
+ it { should be_running }
164
+ end
165
+ end
166
+ ```
167
+
168
+ ## Are insecure packages installed ?
169
+
170
+ The following test shows how to audit machines for insecure packages:
171
+
172
+ ```ruby
173
+ control 'cis-os-services-5.1.3' do
174
+ impact 0.7
175
+ title '5.1.3 Ensure rsh client is not installed'
176
+
177
+ describe package('rsh') do
178
+ it { should_not be_installed }
179
+ end
180
+
181
+ describe package('rsh-redone-client') do
182
+ it { should_not be_installed }
183
+ end
184
+ end
185
+ ```
186
+
187
+ ## Test Windows Registry Keys
188
+
189
+ The following test shows how to audit machines to ensure Safe DLL Search Mode is enabled:
190
+
191
+ ```ruby
192
+ control 'windows-base-101' do
193
+ impact 1.0
194
+ title 'Safe DLL Search Mode is Enabled'
195
+ desc '
196
+ @link: https://msdn.microsoft.com/en-us/library/ms682586(v=vs.85).aspx
197
+ '
198
+ describe registry_key('HKLM\\System\\CurrentControlSet\\Control\\Session Manager') do
199
+ it { should exist }
200
+ it { should_not have_property_value('SafeDllSearchMode', :type_dword, '0') }
201
+ end
202
+ end
203
+ ```
204
+
205
+ ## Exclude specific test
206
+
207
+ This shows how to allow skipping certain tests if conditions are not met, by using `only_if`.
208
+ In this example the test will not be performed if `redis-cli` command does not exist, because for example package on remote host was not installed.
209
+
210
+ ```ruby
211
+ control 'nutcracker-connect-redis-001' do
212
+ impact 1.0
213
+ title 'Check if nutcracker can pass commands to redis'
214
+ desc 'execute redis-cli set key command, to check connectivity of the service'
215
+
216
+ only_if do
217
+ command('redis-cli').exist?
218
+ end
219
+
220
+ describe command('redis-cli SET test_inspec "HELLO"') do
221
+ its(:stdout) { should match(/OK/) }
222
+ end
223
+ end
224
+ ```
225
+
226
+ Mixing this with other conditionals (like checking existence of the files etc.) can help to test different test paths using InSpec. This way you can skip certain tests which would 100% fail due to the way servers are prepared, but you know that the same test suites are reused later in different circumstances by different teams.
227
+
228
+ ## Additional metadata for controls
229
+
230
+
231
+ The following example illustrates various ways to add tags and references to `control`
232
+
233
+ ```ruby
234
+ control 'ssh-1' do
235
+ impact 1.0
236
+
237
+ title 'Allow only SSH Protocol 2'
238
+ desc 'Only SSH protocol version 2 connections should be permitted.
239
+ The default setting in /etc/ssh/sshd_config is correct, and can be
240
+ verified by ensuring that the following line appears: Protocol 2'
241
+
242
+ tag 'production','development'
243
+ tag 'ssh','sshd','openssh-server'
244
+
245
+ tag cce: 'CCE-27072-8'
246
+ tag disa: 'RHEL-06-000227'
247
+
248
+ tag remediation: 'stig_rhel6/recipes/sshd-config.rb'
249
+ tag remediation: 'https://supermarket.chef.io/cookbooks/ssh-hardening'
250
+
251
+ ref 'NSA-RH6-STIG - Section 3.5.2.1', url: 'https://www.nsa.gov/ia/_files/os/redhat/rhel5-guide-i731.pdf'
252
+ ref 'http://people.redhat.com/swells/scap-security-guide/RHEL/6/output/ssg-centos6-guide-C2S.html'
253
+
254
+ describe ssh_config do
255
+ its ('Protocol') { should eq '2'}
256
+ end
257
+ end
258
+ ```