inspec 2.1.80 → 2.1.81

Sign up to get free protection for your applications and to get access to all the features.
Files changed (510) hide show
  1. checksums.yaml +4 -4
  2. data/.rubocop.yml +101 -101
  3. data/CHANGELOG.md +3177 -3172
  4. data/Gemfile +56 -56
  5. data/LICENSE +14 -14
  6. data/MAINTAINERS.md +33 -33
  7. data/MAINTAINERS.toml +52 -52
  8. data/README.md +453 -453
  9. data/Rakefile +349 -349
  10. data/bin/inspec +12 -12
  11. data/docs/.gitignore +2 -2
  12. data/docs/README.md +40 -40
  13. data/docs/dev/control-eval.md +61 -61
  14. data/docs/dsl_inspec.md +258 -258
  15. data/docs/dsl_resource.md +100 -100
  16. data/docs/glossary.md +99 -99
  17. data/docs/habitat.md +191 -191
  18. data/docs/inspec_and_friends.md +114 -114
  19. data/docs/matchers.md +169 -169
  20. data/docs/migration.md +293 -293
  21. data/docs/platforms.md +118 -118
  22. data/docs/plugin_kitchen_inspec.md +50 -50
  23. data/docs/profiles.md +378 -378
  24. data/docs/reporters.md +105 -105
  25. data/docs/resources/aide_conf.md.erb +75 -75
  26. data/docs/resources/apache.md.erb +67 -67
  27. data/docs/resources/apache_conf.md.erb +68 -68
  28. data/docs/resources/apt.md.erb +71 -71
  29. data/docs/resources/audit_policy.md.erb +47 -47
  30. data/docs/resources/auditd.md.erb +79 -79
  31. data/docs/resources/auditd_conf.md.erb +68 -68
  32. data/docs/resources/aws_cloudtrail_trail.md.erb +155 -155
  33. data/docs/resources/aws_cloudtrail_trails.md.erb +86 -86
  34. data/docs/resources/aws_cloudwatch_alarm.md.erb +91 -91
  35. data/docs/resources/aws_cloudwatch_log_metric_filter.md.erb +154 -154
  36. data/docs/resources/aws_config_delivery_channel.md.erb +101 -101
  37. data/docs/resources/aws_config_recorder.md.erb +86 -86
  38. data/docs/resources/aws_ec2_instance.md.erb +112 -112
  39. data/docs/resources/aws_ec2_instances.md.erb +79 -79
  40. data/docs/resources/aws_iam_access_key.md.erb +129 -129
  41. data/docs/resources/aws_iam_access_keys.md.erb +204 -204
  42. data/docs/resources/aws_iam_group.md.erb +64 -64
  43. data/docs/resources/aws_iam_groups.md.erb +49 -49
  44. data/docs/resources/aws_iam_password_policy.md.erb +82 -82
  45. data/docs/resources/aws_iam_policies.md.erb +87 -87
  46. data/docs/resources/aws_iam_policy.md.erb +245 -245
  47. data/docs/resources/aws_iam_role.md.erb +69 -69
  48. data/docs/resources/aws_iam_root_user.md.erb +76 -76
  49. data/docs/resources/aws_iam_user.md.erb +120 -120
  50. data/docs/resources/aws_iam_users.md.erb +279 -279
  51. data/docs/resources/aws_kms_key.md.erb +177 -177
  52. data/docs/resources/aws_kms_keys.md.erb +89 -89
  53. data/docs/resources/aws_rds_instance.md.erb +66 -66
  54. data/docs/resources/aws_route_table.md.erb +53 -53
  55. data/docs/resources/aws_route_tables.md.erb +55 -55
  56. data/docs/resources/aws_s3_bucket.md.erb +146 -146
  57. data/docs/resources/aws_s3_bucket_object.md.erb +89 -89
  58. data/docs/resources/aws_s3_buckets.md.erb +59 -59
  59. data/docs/resources/aws_security_group.md.erb +296 -296
  60. data/docs/resources/aws_security_groups.md.erb +97 -97
  61. data/docs/resources/aws_sns_subscription.md.erb +130 -130
  62. data/docs/resources/aws_sns_topic.md.erb +69 -69
  63. data/docs/resources/aws_sns_topics.md.erb +58 -58
  64. data/docs/resources/aws_subnet.md.erb +140 -140
  65. data/docs/resources/aws_subnets.md.erb +132 -132
  66. data/docs/resources/aws_vpc.md.erb +125 -125
  67. data/docs/resources/aws_vpcs.md.erb +125 -125
  68. data/docs/resources/azure_generic_resource.md.erb +171 -171
  69. data/docs/resources/azure_resource_group.md.erb +284 -284
  70. data/docs/resources/azure_virtual_machine.md.erb +347 -347
  71. data/docs/resources/azure_virtual_machine_data_disk.md.erb +224 -224
  72. data/docs/resources/bash.md.erb +75 -75
  73. data/docs/resources/bond.md.erb +90 -90
  74. data/docs/resources/bridge.md.erb +57 -57
  75. data/docs/resources/bsd_service.md.erb +67 -67
  76. data/docs/resources/chocolatey_package.md.erb +58 -58
  77. data/docs/resources/command.md.erb +138 -138
  78. data/docs/resources/cpan.md.erb +79 -79
  79. data/docs/resources/cran.md.erb +64 -64
  80. data/docs/resources/crontab.md.erb +89 -89
  81. data/docs/resources/csv.md.erb +54 -54
  82. data/docs/resources/dh_params.md.erb +205 -205
  83. data/docs/resources/directory.md.erb +30 -30
  84. data/docs/resources/docker.md.erb +219 -219
  85. data/docs/resources/docker_container.md.erb +103 -103
  86. data/docs/resources/docker_image.md.erb +94 -94
  87. data/docs/resources/docker_service.md.erb +114 -114
  88. data/docs/resources/elasticsearch.md.erb +242 -242
  89. data/docs/resources/etc_fstab.md.erb +125 -125
  90. data/docs/resources/etc_group.md.erb +75 -75
  91. data/docs/resources/etc_hosts.md.erb +78 -78
  92. data/docs/resources/etc_hosts_allow.md.erb +74 -74
  93. data/docs/resources/etc_hosts_deny.md.erb +74 -74
  94. data/docs/resources/file.md.erb +526 -526
  95. data/docs/resources/filesystem.md.erb +41 -41
  96. data/docs/resources/firewalld.md.erb +107 -107
  97. data/docs/resources/gem.md.erb +79 -79
  98. data/docs/resources/group.md.erb +61 -61
  99. data/docs/resources/grub_conf.md.erb +101 -101
  100. data/docs/resources/host.md.erb +86 -86
  101. data/docs/resources/http.md.erb +197 -197
  102. data/docs/resources/iis_app.md.erb +122 -122
  103. data/docs/resources/iis_site.md.erb +135 -135
  104. data/docs/resources/inetd_conf.md.erb +94 -94
  105. data/docs/resources/ini.md.erb +76 -76
  106. data/docs/resources/interface.md.erb +58 -58
  107. data/docs/resources/iptables.md.erb +64 -64
  108. data/docs/resources/json.md.erb +63 -63
  109. data/docs/resources/kernel_module.md.erb +120 -120
  110. data/docs/resources/kernel_parameter.md.erb +53 -53
  111. data/docs/resources/key_rsa.md.erb +85 -85
  112. data/docs/resources/launchd_service.md.erb +57 -57
  113. data/docs/resources/limits_conf.md.erb +75 -75
  114. data/docs/resources/login_defs.md.erb +71 -71
  115. data/docs/resources/mount.md.erb +69 -69
  116. data/docs/resources/mssql_session.md.erb +60 -60
  117. data/docs/resources/mysql_conf.md.erb +99 -99
  118. data/docs/resources/mysql_session.md.erb +74 -74
  119. data/docs/resources/nginx.md.erb +79 -79
  120. data/docs/resources/nginx_conf.md.erb +138 -138
  121. data/docs/resources/npm.md.erb +60 -60
  122. data/docs/resources/ntp_conf.md.erb +60 -60
  123. data/docs/resources/oneget.md.erb +53 -53
  124. data/docs/resources/oracledb_session.md.erb +52 -52
  125. data/docs/resources/os.md.erb +141 -141
  126. data/docs/resources/os_env.md.erb +91 -91
  127. data/docs/resources/package.md.erb +120 -120
  128. data/docs/resources/packages.md.erb +67 -67
  129. data/docs/resources/parse_config.md.erb +103 -103
  130. data/docs/resources/parse_config_file.md.erb +138 -138
  131. data/docs/resources/passwd.md.erb +141 -141
  132. data/docs/resources/pip.md.erb +67 -67
  133. data/docs/resources/port.md.erb +137 -137
  134. data/docs/resources/postgres_conf.md.erb +79 -79
  135. data/docs/resources/postgres_hba_conf.md.erb +93 -93
  136. data/docs/resources/postgres_ident_conf.md.erb +76 -76
  137. data/docs/resources/postgres_session.md.erb +69 -69
  138. data/docs/resources/powershell.md.erb +102 -102
  139. data/docs/resources/processes.md.erb +109 -109
  140. data/docs/resources/rabbitmq_config.md.erb +41 -41
  141. data/docs/resources/registry_key.md.erb +158 -158
  142. data/docs/resources/runit_service.md.erb +57 -57
  143. data/docs/resources/security_policy.md.erb +47 -47
  144. data/docs/resources/service.md.erb +121 -121
  145. data/docs/resources/shadow.md.erb +146 -146
  146. data/docs/resources/ssh_config.md.erb +73 -73
  147. data/docs/resources/sshd_config.md.erb +83 -83
  148. data/docs/resources/ssl.md.erb +119 -119
  149. data/docs/resources/sys_info.md.erb +42 -42
  150. data/docs/resources/systemd_service.md.erb +57 -57
  151. data/docs/resources/sysv_service.md.erb +57 -57
  152. data/docs/resources/upstart_service.md.erb +57 -57
  153. data/docs/resources/user.md.erb +140 -140
  154. data/docs/resources/users.md.erb +127 -127
  155. data/docs/resources/vbscript.md.erb +55 -55
  156. data/docs/resources/virtualization.md.erb +57 -57
  157. data/docs/resources/windows_feature.md.erb +47 -47
  158. data/docs/resources/windows_hotfix.md.erb +53 -53
  159. data/docs/resources/windows_task.md.erb +95 -95
  160. data/docs/resources/wmi.md.erb +81 -81
  161. data/docs/resources/x509_certificate.md.erb +151 -151
  162. data/docs/resources/xinetd_conf.md.erb +156 -156
  163. data/docs/resources/xml.md.erb +85 -85
  164. data/docs/resources/yaml.md.erb +69 -69
  165. data/docs/resources/yum.md.erb +98 -98
  166. data/docs/resources/zfs_dataset.md.erb +53 -53
  167. data/docs/resources/zfs_pool.md.erb +47 -47
  168. data/docs/ruby_usage.md +203 -203
  169. data/docs/shared/matcher_be.md.erb +1 -1
  170. data/docs/shared/matcher_cmp.md.erb +43 -43
  171. data/docs/shared/matcher_eq.md.erb +3 -3
  172. data/docs/shared/matcher_include.md.erb +1 -1
  173. data/docs/shared/matcher_match.md.erb +1 -1
  174. data/docs/shell.md +217 -217
  175. data/examples/README.md +8 -8
  176. data/examples/inheritance/README.md +65 -65
  177. data/examples/inheritance/controls/example.rb +14 -14
  178. data/examples/inheritance/inspec.yml +15 -15
  179. data/examples/kitchen-ansible/.kitchen.yml +25 -25
  180. data/examples/kitchen-ansible/Gemfile +19 -19
  181. data/examples/kitchen-ansible/README.md +53 -53
  182. data/examples/kitchen-ansible/files/nginx.repo +6 -6
  183. data/examples/kitchen-ansible/tasks/main.yml +16 -16
  184. data/examples/kitchen-ansible/test/integration/default/default.yml +5 -5
  185. data/examples/kitchen-ansible/test/integration/default/web_spec.rb +28 -28
  186. data/examples/kitchen-chef/.kitchen.yml +20 -20
  187. data/examples/kitchen-chef/Berksfile +3 -3
  188. data/examples/kitchen-chef/Gemfile +19 -19
  189. data/examples/kitchen-chef/README.md +27 -27
  190. data/examples/kitchen-chef/metadata.rb +7 -7
  191. data/examples/kitchen-chef/recipes/default.rb +6 -6
  192. data/examples/kitchen-chef/recipes/nginx.rb +30 -30
  193. data/examples/kitchen-chef/test/integration/default/web_spec.rb +28 -28
  194. data/examples/kitchen-puppet/.kitchen.yml +23 -23
  195. data/examples/kitchen-puppet/Gemfile +20 -20
  196. data/examples/kitchen-puppet/Puppetfile +25 -25
  197. data/examples/kitchen-puppet/README.md +53 -53
  198. data/examples/kitchen-puppet/manifests/site.pp +33 -33
  199. data/examples/kitchen-puppet/metadata.json +11 -11
  200. data/examples/kitchen-puppet/modules/.gitkeep +0 -0
  201. data/examples/kitchen-puppet/test/integration/default/web_spec.rb +28 -28
  202. data/examples/meta-profile/README.md +37 -37
  203. data/examples/meta-profile/controls/example.rb +13 -13
  204. data/examples/meta-profile/inspec.yml +13 -13
  205. data/examples/profile-attribute.yml +2 -2
  206. data/examples/profile-attribute/README.md +14 -14
  207. data/examples/profile-attribute/controls/example.rb +11 -11
  208. data/examples/profile-attribute/inspec.yml +8 -8
  209. data/examples/profile-aws/controls/iam_password_policy_expiration.rb +8 -8
  210. data/examples/profile-aws/controls/iam_password_policy_max_age.rb +8 -8
  211. data/examples/profile-aws/controls/iam_root_user_mfa.rb +8 -8
  212. data/examples/profile-aws/controls/iam_users_access_key_age.rb +8 -8
  213. data/examples/profile-aws/controls/iam_users_console_users_mfa.rb +8 -8
  214. data/examples/profile-aws/inspec.yml +11 -11
  215. data/examples/profile-azure/controls/azure_resource_group_example.rb +24 -24
  216. data/examples/profile-azure/controls/azure_vm_example.rb +29 -29
  217. data/examples/profile-azure/inspec.yml +11 -11
  218. data/examples/profile-sensitive/README.md +29 -29
  219. data/examples/profile-sensitive/controls/sensitive-failures.rb +9 -9
  220. data/examples/profile-sensitive/controls/sensitive.rb +9 -9
  221. data/examples/profile-sensitive/inspec.yml +8 -8
  222. data/examples/profile/README.md +48 -48
  223. data/examples/profile/controls/example.rb +23 -23
  224. data/examples/profile/controls/gordon.rb +36 -36
  225. data/examples/profile/controls/meta.rb +34 -34
  226. data/examples/profile/inspec.yml +10 -10
  227. data/examples/profile/libraries/gordon_config.rb +59 -59
  228. data/inspec.gemspec +49 -49
  229. data/lib/bundles/README.md +3 -3
  230. data/lib/bundles/inspec-artifact.rb +7 -7
  231. data/lib/bundles/inspec-artifact/README.md +1 -1
  232. data/lib/bundles/inspec-artifact/cli.rb +277 -277
  233. data/lib/bundles/inspec-compliance.rb +16 -16
  234. data/lib/bundles/inspec-compliance/.kitchen.yml +20 -20
  235. data/lib/bundles/inspec-compliance/README.md +193 -193
  236. data/lib/bundles/inspec-compliance/api.rb +360 -360
  237. data/lib/bundles/inspec-compliance/api/login.rb +193 -193
  238. data/lib/bundles/inspec-compliance/bootstrap.sh +41 -41
  239. data/lib/bundles/inspec-compliance/cli.rb +260 -260
  240. data/lib/bundles/inspec-compliance/configuration.rb +103 -103
  241. data/lib/bundles/inspec-compliance/http.rb +125 -125
  242. data/lib/bundles/inspec-compliance/images/cc-token.png +0 -0
  243. data/lib/bundles/inspec-compliance/support.rb +36 -36
  244. data/lib/bundles/inspec-compliance/target.rb +112 -112
  245. data/lib/bundles/inspec-compliance/test/integration/default/cli.rb +93 -93
  246. data/lib/bundles/inspec-habitat.rb +12 -12
  247. data/lib/bundles/inspec-habitat/cli.rb +36 -36
  248. data/lib/bundles/inspec-habitat/log.rb +10 -10
  249. data/lib/bundles/inspec-habitat/profile.rb +391 -391
  250. data/lib/bundles/inspec-init.rb +8 -8
  251. data/lib/bundles/inspec-init/README.md +31 -31
  252. data/lib/bundles/inspec-init/cli.rb +97 -97
  253. data/lib/bundles/inspec-init/templates/profile/README.md +3 -3
  254. data/lib/bundles/inspec-init/templates/profile/controls/example.rb +19 -19
  255. data/lib/bundles/inspec-init/templates/profile/inspec.yml +8 -8
  256. data/lib/bundles/inspec-init/templates/profile/libraries/.gitkeep +0 -0
  257. data/lib/bundles/inspec-supermarket.rb +13 -13
  258. data/lib/bundles/inspec-supermarket/README.md +45 -45
  259. data/lib/bundles/inspec-supermarket/api.rb +84 -84
  260. data/lib/bundles/inspec-supermarket/cli.rb +73 -73
  261. data/lib/bundles/inspec-supermarket/target.rb +34 -34
  262. data/lib/fetchers/git.rb +163 -163
  263. data/lib/fetchers/local.rb +74 -74
  264. data/lib/fetchers/mock.rb +35 -35
  265. data/lib/fetchers/url.rb +247 -247
  266. data/lib/inspec.rb +24 -24
  267. data/lib/inspec/archive/tar.rb +29 -29
  268. data/lib/inspec/archive/zip.rb +19 -19
  269. data/lib/inspec/backend.rb +93 -93
  270. data/lib/inspec/base_cli.rb +368 -368
  271. data/lib/inspec/cached_fetcher.rb +66 -66
  272. data/lib/inspec/cli.rb +292 -292
  273. data/lib/inspec/completions/bash.sh.erb +45 -45
  274. data/lib/inspec/completions/fish.sh.erb +34 -34
  275. data/lib/inspec/completions/zsh.sh.erb +61 -61
  276. data/lib/inspec/control_eval_context.rb +179 -179
  277. data/lib/inspec/dependencies/cache.rb +72 -72
  278. data/lib/inspec/dependencies/dependency_set.rb +92 -92
  279. data/lib/inspec/dependencies/lockfile.rb +115 -115
  280. data/lib/inspec/dependencies/requirement.rb +123 -123
  281. data/lib/inspec/dependencies/resolver.rb +86 -86
  282. data/lib/inspec/describe.rb +27 -27
  283. data/lib/inspec/dsl.rb +66 -66
  284. data/lib/inspec/dsl_shared.rb +33 -33
  285. data/lib/inspec/env_printer.rb +157 -157
  286. data/lib/inspec/errors.rb +14 -14
  287. data/lib/inspec/exceptions.rb +12 -12
  288. data/lib/inspec/expect.rb +45 -45
  289. data/lib/inspec/fetcher.rb +45 -45
  290. data/lib/inspec/file_provider.rb +275 -275
  291. data/lib/inspec/formatters.rb +3 -3
  292. data/lib/inspec/formatters/base.rb +259 -259
  293. data/lib/inspec/formatters/json_rspec.rb +20 -20
  294. data/lib/inspec/formatters/show_progress.rb +12 -12
  295. data/lib/inspec/library_eval_context.rb +58 -58
  296. data/lib/inspec/log.rb +11 -11
  297. data/lib/inspec/metadata.rb +247 -247
  298. data/lib/inspec/method_source.rb +24 -24
  299. data/lib/inspec/objects.rb +14 -14
  300. data/lib/inspec/objects/attribute.rb +75 -75
  301. data/lib/inspec/objects/control.rb +61 -61
  302. data/lib/inspec/objects/describe.rb +92 -92
  303. data/lib/inspec/objects/each_loop.rb +36 -36
  304. data/lib/inspec/objects/list.rb +15 -15
  305. data/lib/inspec/objects/or_test.rb +40 -40
  306. data/lib/inspec/objects/ruby_helper.rb +15 -15
  307. data/lib/inspec/objects/tag.rb +27 -27
  308. data/lib/inspec/objects/test.rb +87 -87
  309. data/lib/inspec/objects/value.rb +27 -27
  310. data/lib/inspec/plugins.rb +60 -60
  311. data/lib/inspec/plugins/cli.rb +24 -24
  312. data/lib/inspec/plugins/fetcher.rb +86 -86
  313. data/lib/inspec/plugins/resource.rb +135 -135
  314. data/lib/inspec/plugins/secret.rb +15 -15
  315. data/lib/inspec/plugins/source_reader.rb +40 -40
  316. data/lib/inspec/polyfill.rb +12 -12
  317. data/lib/inspec/profile.rb +513 -513
  318. data/lib/inspec/profile_context.rb +208 -208
  319. data/lib/inspec/profile_vendor.rb +66 -66
  320. data/lib/inspec/reporters.rb +60 -60
  321. data/lib/inspec/reporters/automate.rb +76 -76
  322. data/lib/inspec/reporters/base.rb +25 -25
  323. data/lib/inspec/reporters/cli.rb +356 -356
  324. data/lib/inspec/reporters/json.rb +117 -117
  325. data/lib/inspec/reporters/json_min.rb +48 -48
  326. data/lib/inspec/reporters/junit.rb +78 -78
  327. data/lib/inspec/require_loader.rb +33 -33
  328. data/lib/inspec/resource.rb +190 -190
  329. data/lib/inspec/rule.rb +280 -280
  330. data/lib/inspec/runner.rb +345 -345
  331. data/lib/inspec/runner_mock.rb +41 -41
  332. data/lib/inspec/runner_rspec.rb +175 -175
  333. data/lib/inspec/runtime_profile.rb +26 -26
  334. data/lib/inspec/schema.rb +213 -213
  335. data/lib/inspec/secrets.rb +19 -19
  336. data/lib/inspec/secrets/yaml.rb +30 -30
  337. data/lib/inspec/shell.rb +220 -220
  338. data/lib/inspec/shell_detector.rb +90 -90
  339. data/lib/inspec/source_reader.rb +29 -29
  340. data/lib/inspec/version.rb +8 -8
  341. data/lib/matchers/matchers.rb +339 -339
  342. data/lib/resource_support/aws.rb +50 -50
  343. data/lib/resource_support/aws/aws_backend_base.rb +12 -12
  344. data/lib/resource_support/aws/aws_backend_factory_mixin.rb +12 -12
  345. data/lib/resource_support/aws/aws_plural_resource_mixin.rb +21 -21
  346. data/lib/resource_support/aws/aws_resource_mixin.rb +66 -66
  347. data/lib/resource_support/aws/aws_singular_resource_mixin.rb +24 -24
  348. data/lib/resources/aide_conf.rb +151 -151
  349. data/lib/resources/apache.rb +48 -48
  350. data/lib/resources/apache_conf.rb +149 -149
  351. data/lib/resources/apt.rb +149 -149
  352. data/lib/resources/audit_policy.rb +63 -63
  353. data/lib/resources/auditd.rb +231 -231
  354. data/lib/resources/auditd_conf.rb +46 -46
  355. data/lib/resources/aws/aws_cloudtrail_trail.rb +93 -93
  356. data/lib/resources/aws/aws_cloudtrail_trails.rb +47 -47
  357. data/lib/resources/aws/aws_cloudwatch_alarm.rb +62 -62
  358. data/lib/resources/aws/aws_cloudwatch_log_metric_filter.rb +100 -100
  359. data/lib/resources/aws/aws_config_delivery_channel.rb +70 -70
  360. data/lib/resources/aws/aws_config_recorder.rb +93 -93
  361. data/lib/resources/aws/aws_ec2_instance.rb +157 -157
  362. data/lib/resources/aws/aws_ec2_instances.rb +64 -64
  363. data/lib/resources/aws/aws_iam_access_key.rb +106 -106
  364. data/lib/resources/aws/aws_iam_access_keys.rb +149 -149
  365. data/lib/resources/aws/aws_iam_group.rb +58 -58
  366. data/lib/resources/aws/aws_iam_groups.rb +52 -52
  367. data/lib/resources/aws/aws_iam_password_policy.rb +116 -116
  368. data/lib/resources/aws/aws_iam_policies.rb +53 -53
  369. data/lib/resources/aws/aws_iam_policy.rb +291 -291
  370. data/lib/resources/aws/aws_iam_role.rb +55 -55
  371. data/lib/resources/aws/aws_iam_root_user.rb +78 -78
  372. data/lib/resources/aws/aws_iam_user.rb +142 -142
  373. data/lib/resources/aws/aws_iam_users.rb +146 -146
  374. data/lib/resources/aws/aws_kms_key.rb +96 -96
  375. data/lib/resources/aws/aws_kms_keys.rb +53 -53
  376. data/lib/resources/aws/aws_rds_instance.rb +71 -71
  377. data/lib/resources/aws/aws_route_table.rb +63 -63
  378. data/lib/resources/aws/aws_route_tables.rb +60 -60
  379. data/lib/resources/aws/aws_s3_bucket.rb +137 -137
  380. data/lib/resources/aws/aws_s3_bucket_object.rb +82 -82
  381. data/lib/resources/aws/aws_s3_buckets.rb +51 -51
  382. data/lib/resources/aws/aws_security_group.rb +249 -249
  383. data/lib/resources/aws/aws_security_groups.rb +68 -68
  384. data/lib/resources/aws/aws_sns_subscription.rb +78 -78
  385. data/lib/resources/aws/aws_sns_topic.rb +53 -53
  386. data/lib/resources/aws/aws_sns_topics.rb +56 -56
  387. data/lib/resources/aws/aws_subnet.rb +88 -88
  388. data/lib/resources/aws/aws_subnets.rb +53 -53
  389. data/lib/resources/aws/aws_vpc.rb +73 -73
  390. data/lib/resources/aws/aws_vpcs.rb +52 -52
  391. data/lib/resources/azure/azure_backend.rb +377 -377
  392. data/lib/resources/azure/azure_generic_resource.rb +59 -59
  393. data/lib/resources/azure/azure_resource_group.rb +152 -152
  394. data/lib/resources/azure/azure_virtual_machine.rb +264 -264
  395. data/lib/resources/azure/azure_virtual_machine_data_disk.rb +134 -134
  396. data/lib/resources/bash.rb +35 -35
  397. data/lib/resources/bond.rb +69 -69
  398. data/lib/resources/bridge.rb +122 -122
  399. data/lib/resources/chocolatey_package.rb +78 -78
  400. data/lib/resources/command.rb +73 -73
  401. data/lib/resources/cpan.rb +58 -58
  402. data/lib/resources/cran.rb +64 -64
  403. data/lib/resources/crontab.rb +169 -169
  404. data/lib/resources/csv.rb +56 -56
  405. data/lib/resources/dh_params.rb +77 -77
  406. data/lib/resources/directory.rb +25 -25
  407. data/lib/resources/docker.rb +236 -236
  408. data/lib/resources/docker_container.rb +89 -89
  409. data/lib/resources/docker_image.rb +83 -83
  410. data/lib/resources/docker_object.rb +57 -57
  411. data/lib/resources/docker_service.rb +90 -90
  412. data/lib/resources/elasticsearch.rb +169 -169
  413. data/lib/resources/etc_fstab.rb +94 -94
  414. data/lib/resources/etc_group.rb +154 -154
  415. data/lib/resources/etc_hosts.rb +66 -66
  416. data/lib/resources/etc_hosts_allow_deny.rb +112 -112
  417. data/lib/resources/file.rb +298 -298
  418. data/lib/resources/filesystem.rb +31 -31
  419. data/lib/resources/firewalld.rb +143 -143
  420. data/lib/resources/gem.rb +70 -70
  421. data/lib/resources/groups.rb +215 -215
  422. data/lib/resources/grub_conf.rb +227 -227
  423. data/lib/resources/host.rb +306 -306
  424. data/lib/resources/http.rb +253 -253
  425. data/lib/resources/iis_app.rb +101 -101
  426. data/lib/resources/iis_site.rb +148 -148
  427. data/lib/resources/inetd_conf.rb +54 -54
  428. data/lib/resources/ini.rb +29 -29
  429. data/lib/resources/interface.rb +129 -129
  430. data/lib/resources/iptables.rb +80 -80
  431. data/lib/resources/json.rb +111 -111
  432. data/lib/resources/kernel_module.rb +107 -107
  433. data/lib/resources/kernel_parameter.rb +58 -58
  434. data/lib/resources/key_rsa.rb +63 -63
  435. data/lib/resources/limits_conf.rb +46 -46
  436. data/lib/resources/login_def.rb +57 -57
  437. data/lib/resources/mount.rb +88 -88
  438. data/lib/resources/mssql_session.rb +101 -101
  439. data/lib/resources/mysql.rb +82 -82
  440. data/lib/resources/mysql_conf.rb +127 -127
  441. data/lib/resources/mysql_session.rb +85 -85
  442. data/lib/resources/nginx.rb +96 -96
  443. data/lib/resources/nginx_conf.rb +226 -226
  444. data/lib/resources/npm.rb +48 -48
  445. data/lib/resources/ntp_conf.rb +51 -51
  446. data/lib/resources/oneget.rb +71 -71
  447. data/lib/resources/oracledb_session.rb +139 -139
  448. data/lib/resources/os.rb +36 -36
  449. data/lib/resources/os_env.rb +86 -86
  450. data/lib/resources/package.rb +370 -370
  451. data/lib/resources/packages.rb +111 -111
  452. data/lib/resources/parse_config.rb +112 -112
  453. data/lib/resources/passwd.rb +76 -76
  454. data/lib/resources/pip.rb +130 -130
  455. data/lib/resources/platform.rb +109 -109
  456. data/lib/resources/port.rb +771 -771
  457. data/lib/resources/postgres.rb +131 -131
  458. data/lib/resources/postgres_conf.rb +114 -114
  459. data/lib/resources/postgres_hba_conf.rb +90 -90
  460. data/lib/resources/postgres_ident_conf.rb +79 -79
  461. data/lib/resources/postgres_session.rb +71 -71
  462. data/lib/resources/powershell.rb +67 -67
  463. data/lib/resources/processes.rb +204 -204
  464. data/lib/resources/rabbitmq_conf.rb +51 -51
  465. data/lib/resources/registry_key.rb +297 -297
  466. data/lib/resources/security_policy.rb +180 -180
  467. data/lib/resources/service.rb +794 -794
  468. data/lib/resources/shadow.rb +159 -159
  469. data/lib/resources/ssh_conf.rb +97 -97
  470. data/lib/resources/ssl.rb +99 -99
  471. data/lib/resources/sys_info.rb +28 -28
  472. data/lib/resources/toml.rb +32 -32
  473. data/lib/resources/users.rb +654 -654
  474. data/lib/resources/vbscript.rb +68 -68
  475. data/lib/resources/virtualization.rb +247 -247
  476. data/lib/resources/windows_feature.rb +84 -84
  477. data/lib/resources/windows_hotfix.rb +35 -35
  478. data/lib/resources/windows_task.rb +102 -102
  479. data/lib/resources/wmi.rb +110 -110
  480. data/lib/resources/x509_certificate.rb +137 -137
  481. data/lib/resources/xinetd.rb +106 -106
  482. data/lib/resources/xml.rb +46 -46
  483. data/lib/resources/yaml.rb +43 -43
  484. data/lib/resources/yum.rb +180 -180
  485. data/lib/resources/zfs_dataset.rb +60 -60
  486. data/lib/resources/zfs_pool.rb +49 -49
  487. data/lib/source_readers/flat.rb +39 -39
  488. data/lib/source_readers/inspec.rb +75 -75
  489. data/lib/utils/command_wrapper.rb +27 -27
  490. data/lib/utils/convert.rb +12 -12
  491. data/lib/utils/database_helpers.rb +77 -77
  492. data/lib/utils/enumerable_delegation.rb +9 -9
  493. data/lib/utils/erlang_parser.rb +192 -192
  494. data/lib/utils/file_reader.rb +25 -25
  495. data/lib/utils/filter.rb +273 -273
  496. data/lib/utils/filter_array.rb +27 -27
  497. data/lib/utils/find_files.rb +47 -47
  498. data/lib/utils/hash.rb +41 -41
  499. data/lib/utils/json_log.rb +18 -18
  500. data/lib/utils/latest_version.rb +22 -22
  501. data/lib/utils/modulator.rb +12 -12
  502. data/lib/utils/nginx_parser.rb +105 -105
  503. data/lib/utils/object_traversal.rb +49 -49
  504. data/lib/utils/parser.rb +274 -274
  505. data/lib/utils/pkey_reader.rb +15 -15
  506. data/lib/utils/plugin_registry.rb +93 -93
  507. data/lib/utils/simpleconfig.rb +120 -120
  508. data/lib/utils/spdx.rb +13 -13
  509. data/lib/utils/spdx.txt +343 -343
  510. metadata +3 -3
@@ -1,180 +1,180 @@
1
- # encoding: utf-8
2
- #
3
- # Security Configuration and Analysis
4
- #
5
- # Export local security policy:
6
- # secedit /export /cfg secpol.cfg
7
- #
8
- # @link http://www.microsoft.com/en-us/download/details.aspx?id=25250
9
- #
10
- # In Windows, some security options are managed differently that the local GPO
11
- # All local GPO parameters can be examined via Registry, but not all security
12
- # parameters. Therefore we need a combination of Registry and secedit output
13
-
14
- require 'hashie'
15
-
16
- module Inspec::Resources
17
- # known and supported MS privilege rights
18
- # @see https://technet.microsoft.com/en-us/library/dd277311.aspx
19
- # @see https://msdn.microsoft.com/en-us/library/windows/desktop/bb530716(v=vs.85).aspx
20
- MS_PRIVILEGES_RIGHTS = [
21
- 'SeNetworkLogonRight',
22
- 'SeBackupPrivilege',
23
- 'SeChangeNotifyPrivilege',
24
- 'SeSystemtimePrivilege',
25
- 'SeCreatePagefilePrivilege',
26
- 'SeDebugPrivilege',
27
- 'SeRemoteShutdownPrivilege',
28
- 'SeAuditPrivilege',
29
- 'SeIncreaseQuotaPrivilege',
30
- 'SeIncreaseBasePriorityPrivilege',
31
- 'SeLoadDriverPrivilege',
32
- 'SeBatchLogonRight',
33
- 'SeServiceLogonRight',
34
- 'SeInteractiveLogonRight',
35
- 'SeSecurityPrivilege',
36
- 'SeSystemEnvironmentPrivilege',
37
- 'SeProfileSingleProcessPrivilege',
38
- 'SeSystemProfilePrivilege',
39
- 'SeAssignPrimaryTokenPrivilege',
40
- 'SeRestorePrivilege',
41
- 'SeShutdownPrivilege',
42
- 'SeTakeOwnershipPrivilege',
43
- 'SeUndockPrivilege',
44
- 'SeManageVolumePrivilege',
45
- 'SeRemoteInteractiveLogonRight',
46
- 'SeImpersonatePrivilege',
47
- 'SeCreateGlobalPrivilege',
48
- 'SeIncreaseWorking',
49
- 'SeTimeZonePrivilege',
50
- 'SeCreateSymbolicLinkPrivilege',
51
- 'SeDenyNetworkLogonRight', # Deny access to this computer from the network
52
- 'SeDenyInteractiveLogonRight', # Deny logon locally
53
- 'SeDenyBatchLogonRight', # Deny logon as a batch job
54
- 'SeDenyServiceLogonRight', # Deny logon as a service
55
- 'SeTcbPrivilege',
56
- 'SeMachineAccountPrivilege',
57
- 'SeCreateTokenPrivilege',
58
- 'SeCreatePermanentPrivilege',
59
- 'SeEnableDelegationPrivilege',
60
- 'SeLockMemoryPrivilege',
61
- 'SeSyncAgentPrivilege',
62
- 'SeUnsolicitedInputPrivilege',
63
- 'SeTrustedCredManAccessPrivilege',
64
- 'SeRelabelPrivilege', # the privilege to change a Windows integrity label (new to Windows Vista)
65
- 'SeDenyRemoteInteractiveLogonRight', # Deny logon through Terminal Services
66
- ].freeze
67
-
68
- class SecurityPolicy < Inspec.resource(1)
69
- name 'security_policy'
70
- supports platform: 'windows'
71
- desc 'Use the security_policy InSpec audit resource to test security policies on the Microsoft Windows platform.'
72
- example "
73
- describe security_policy do
74
- its('SeNetworkLogonRight') { should include 'S-1-5-11' }
75
- end
76
-
77
- describe security_policy(translate_sid: true) do
78
- its('SeNetworkLogonRight') { should include 'NT AUTHORITY\\Authenticated Users' }
79
- end
80
- "
81
-
82
- def initialize(opts = {})
83
- @translate_sid = opts[:translate_sid] || false
84
- end
85
-
86
- def content
87
- read_content
88
- end
89
-
90
- def params(*opts)
91
- opts.inject(read_params) do |res, nxt|
92
- res.respond_to?(:key) ? res[nxt] : nil
93
- end
94
- end
95
-
96
- def method_missing(name)
97
- params = read_params
98
- return nil if params.nil?
99
-
100
- # deep search for hash key
101
- params.extend Hashie::Extensions::DeepFind
102
- res = params.deep_find(name.to_s)
103
-
104
- # return an empty array if configuration does not include rights configuration
105
- return [] if res.nil? && MS_PRIVILEGES_RIGHTS.include?(name.to_s)
106
- res
107
- end
108
-
109
- def to_s
110
- 'Security Policy'
111
- end
112
-
113
- private
114
-
115
- def read_content
116
- return @content if defined?(@content)
117
-
118
- # using process pid to prevent any race conditions with multiple runners
119
- export_file = "win_secpol-#{Process.pid}.cfg"
120
-
121
- # export the security policy
122
- cmd = inspec.command("secedit /export /cfg #{export_file}")
123
- return nil if cmd.exit_status.to_i != 0
124
-
125
- # store file content
126
- cmd = inspec.command("Get-Content #{export_file}")
127
- return skip_resource "Can't read security policy" if cmd.exit_status.to_i != 0
128
-
129
- @content = cmd.stdout
130
- ensure
131
- # delete temp file
132
- inspec.command("Remove-Item #{export_file}").exit_status.to_i
133
- end
134
-
135
- def read_params
136
- return @params if defined?(@params)
137
- return @params = {} if read_content.nil?
138
-
139
- conf = SimpleConfig.new(
140
- @content,
141
- assignment_regex: /^\s*(.*)=\s*(\S*)\s*$/,
142
- )
143
- @params = convert_hash(conf.params)
144
- end
145
-
146
- # extracts the values, this methods detects:
147
- # numbers and SIDs and optimizes them for further usage
148
- def extract_value(val)
149
- if val =~ /^\d+$/
150
- val.to_i
151
- # special handling for SID array
152
- elsif val =~ /[,]{0,1}\*\S/
153
- if @translate_sid
154
- val.split(',').map { |v|
155
- object_name = inspec.command("(New-Object System.Security.Principal.SecurityIdentifier(\"#{v.sub('*S', 'S')}\")).Translate( [System.Security.Principal.NTAccount]).Value").stdout.to_s.strip
156
- object_name.empty? || object_name.nil? ? v.sub('*S', 'S') : object_name
157
- }
158
- else
159
- val.split(',').map { |v|
160
- v.sub('*S', 'S')
161
- }
162
- end
163
- # special handling for string values with "
164
- elsif !(m = /^\"(.*)\"$/.match(val)).nil?
165
- m[1]
166
- else
167
- val
168
- end
169
- end
170
-
171
- def convert_hash(hash)
172
- new_hash = {}
173
- hash.each do |k, v|
174
- v.is_a?(Hash) ? value = convert_hash(v) : value = extract_value(v)
175
- new_hash[k.strip] = value
176
- end
177
- new_hash
178
- end
179
- end
180
- end
1
+ # encoding: utf-8
2
+ #
3
+ # Security Configuration and Analysis
4
+ #
5
+ # Export local security policy:
6
+ # secedit /export /cfg secpol.cfg
7
+ #
8
+ # @link http://www.microsoft.com/en-us/download/details.aspx?id=25250
9
+ #
10
+ # In Windows, some security options are managed differently that the local GPO
11
+ # All local GPO parameters can be examined via Registry, but not all security
12
+ # parameters. Therefore we need a combination of Registry and secedit output
13
+
14
+ require 'hashie'
15
+
16
+ module Inspec::Resources
17
+ # known and supported MS privilege rights
18
+ # @see https://technet.microsoft.com/en-us/library/dd277311.aspx
19
+ # @see https://msdn.microsoft.com/en-us/library/windows/desktop/bb530716(v=vs.85).aspx
20
+ MS_PRIVILEGES_RIGHTS = [
21
+ 'SeNetworkLogonRight',
22
+ 'SeBackupPrivilege',
23
+ 'SeChangeNotifyPrivilege',
24
+ 'SeSystemtimePrivilege',
25
+ 'SeCreatePagefilePrivilege',
26
+ 'SeDebugPrivilege',
27
+ 'SeRemoteShutdownPrivilege',
28
+ 'SeAuditPrivilege',
29
+ 'SeIncreaseQuotaPrivilege',
30
+ 'SeIncreaseBasePriorityPrivilege',
31
+ 'SeLoadDriverPrivilege',
32
+ 'SeBatchLogonRight',
33
+ 'SeServiceLogonRight',
34
+ 'SeInteractiveLogonRight',
35
+ 'SeSecurityPrivilege',
36
+ 'SeSystemEnvironmentPrivilege',
37
+ 'SeProfileSingleProcessPrivilege',
38
+ 'SeSystemProfilePrivilege',
39
+ 'SeAssignPrimaryTokenPrivilege',
40
+ 'SeRestorePrivilege',
41
+ 'SeShutdownPrivilege',
42
+ 'SeTakeOwnershipPrivilege',
43
+ 'SeUndockPrivilege',
44
+ 'SeManageVolumePrivilege',
45
+ 'SeRemoteInteractiveLogonRight',
46
+ 'SeImpersonatePrivilege',
47
+ 'SeCreateGlobalPrivilege',
48
+ 'SeIncreaseWorking',
49
+ 'SeTimeZonePrivilege',
50
+ 'SeCreateSymbolicLinkPrivilege',
51
+ 'SeDenyNetworkLogonRight', # Deny access to this computer from the network
52
+ 'SeDenyInteractiveLogonRight', # Deny logon locally
53
+ 'SeDenyBatchLogonRight', # Deny logon as a batch job
54
+ 'SeDenyServiceLogonRight', # Deny logon as a service
55
+ 'SeTcbPrivilege',
56
+ 'SeMachineAccountPrivilege',
57
+ 'SeCreateTokenPrivilege',
58
+ 'SeCreatePermanentPrivilege',
59
+ 'SeEnableDelegationPrivilege',
60
+ 'SeLockMemoryPrivilege',
61
+ 'SeSyncAgentPrivilege',
62
+ 'SeUnsolicitedInputPrivilege',
63
+ 'SeTrustedCredManAccessPrivilege',
64
+ 'SeRelabelPrivilege', # the privilege to change a Windows integrity label (new to Windows Vista)
65
+ 'SeDenyRemoteInteractiveLogonRight', # Deny logon through Terminal Services
66
+ ].freeze
67
+
68
+ class SecurityPolicy < Inspec.resource(1)
69
+ name 'security_policy'
70
+ supports platform: 'windows'
71
+ desc 'Use the security_policy InSpec audit resource to test security policies on the Microsoft Windows platform.'
72
+ example "
73
+ describe security_policy do
74
+ its('SeNetworkLogonRight') { should include 'S-1-5-11' }
75
+ end
76
+
77
+ describe security_policy(translate_sid: true) do
78
+ its('SeNetworkLogonRight') { should include 'NT AUTHORITY\\Authenticated Users' }
79
+ end
80
+ "
81
+
82
+ def initialize(opts = {})
83
+ @translate_sid = opts[:translate_sid] || false
84
+ end
85
+
86
+ def content
87
+ read_content
88
+ end
89
+
90
+ def params(*opts)
91
+ opts.inject(read_params) do |res, nxt|
92
+ res.respond_to?(:key) ? res[nxt] : nil
93
+ end
94
+ end
95
+
96
+ def method_missing(name)
97
+ params = read_params
98
+ return nil if params.nil?
99
+
100
+ # deep search for hash key
101
+ params.extend Hashie::Extensions::DeepFind
102
+ res = params.deep_find(name.to_s)
103
+
104
+ # return an empty array if configuration does not include rights configuration
105
+ return [] if res.nil? && MS_PRIVILEGES_RIGHTS.include?(name.to_s)
106
+ res
107
+ end
108
+
109
+ def to_s
110
+ 'Security Policy'
111
+ end
112
+
113
+ private
114
+
115
+ def read_content
116
+ return @content if defined?(@content)
117
+
118
+ # using process pid to prevent any race conditions with multiple runners
119
+ export_file = "win_secpol-#{Process.pid}.cfg"
120
+
121
+ # export the security policy
122
+ cmd = inspec.command("secedit /export /cfg #{export_file}")
123
+ return nil if cmd.exit_status.to_i != 0
124
+
125
+ # store file content
126
+ cmd = inspec.command("Get-Content #{export_file}")
127
+ return skip_resource "Can't read security policy" if cmd.exit_status.to_i != 0
128
+
129
+ @content = cmd.stdout
130
+ ensure
131
+ # delete temp file
132
+ inspec.command("Remove-Item #{export_file}").exit_status.to_i
133
+ end
134
+
135
+ def read_params
136
+ return @params if defined?(@params)
137
+ return @params = {} if read_content.nil?
138
+
139
+ conf = SimpleConfig.new(
140
+ @content,
141
+ assignment_regex: /^\s*(.*)=\s*(\S*)\s*$/,
142
+ )
143
+ @params = convert_hash(conf.params)
144
+ end
145
+
146
+ # extracts the values, this methods detects:
147
+ # numbers and SIDs and optimizes them for further usage
148
+ def extract_value(val)
149
+ if val =~ /^\d+$/
150
+ val.to_i
151
+ # special handling for SID array
152
+ elsif val =~ /[,]{0,1}\*\S/
153
+ if @translate_sid
154
+ val.split(',').map { |v|
155
+ object_name = inspec.command("(New-Object System.Security.Principal.SecurityIdentifier(\"#{v.sub('*S', 'S')}\")).Translate( [System.Security.Principal.NTAccount]).Value").stdout.to_s.strip
156
+ object_name.empty? || object_name.nil? ? v.sub('*S', 'S') : object_name
157
+ }
158
+ else
159
+ val.split(',').map { |v|
160
+ v.sub('*S', 'S')
161
+ }
162
+ end
163
+ # special handling for string values with "
164
+ elsif !(m = /^\"(.*)\"$/.match(val)).nil?
165
+ m[1]
166
+ else
167
+ val
168
+ end
169
+ end
170
+
171
+ def convert_hash(hash)
172
+ new_hash = {}
173
+ hash.each do |k, v|
174
+ v.is_a?(Hash) ? value = convert_hash(v) : value = extract_value(v)
175
+ new_hash[k.strip] = value
176
+ end
177
+ new_hash
178
+ end
179
+ end
180
+ end
@@ -1,794 +1,794 @@
1
- # encoding: utf-8
2
-
3
- require 'hashie'
4
- require 'utils/file_reader'
5
-
6
- module Inspec::Resources
7
- class Runlevels < Hash
8
- attr_accessor :owner
9
-
10
- def self.from_hash(owner, hash = {}, filter = nil)
11
- res = Runlevels.new(owner)
12
- filter = filter.first if filter.is_a?(Array) && filter.length <= 1
13
-
14
- ks = case filter
15
- when nil
16
- hash.keys
17
- when Regexp
18
- hash.keys.find_all { |x| x.to_s =~ filter }
19
- when Array
20
- f = filter.map(&:to_s)
21
- hash.keys.find_all { |x| f.include?(x.to_s) }
22
- when Numeric
23
- hash.keys.include?(filter) ? [filter] : []
24
- else
25
- hash.keys.find_all { |x| x == filter }
26
- end
27
-
28
- ks.each { |k| res[k] = hash[k] }
29
- res
30
- end
31
-
32
- def initialize(owner, default = false)
33
- @owner = owner
34
- super(default)
35
- end
36
-
37
- def filter(f)
38
- Runlevels.from_hash(owner, self, f)
39
- end
40
-
41
- # Check if all runlevels are enabled
42
- #
43
- # @return [boolean] true if all runlevels are enabled
44
- def enabled?
45
- values.all?
46
- end
47
-
48
- # Check if all runlevels are disabled
49
- #
50
- # @return [boolean] true if all runlevels are disabled
51
- def disabled?
52
- values.none?
53
- end
54
-
55
- def to_s
56
- "#{owner} runlevels #{keys.join(', ')}"
57
- end
58
- end
59
-
60
- # We detect the init system for each operating system, based on the operating
61
- # system.
62
- #
63
- # Fedora 15 : systemd
64
- # RedHat 7 : systemd
65
- # Ubuntu 15.04 : systemd
66
- # Ubuntu < 15.04 : upstart
67
- #
68
- # TODO: extend the logic to detect the running init system, independently of OS
69
- class Service < Inspec.resource(1)
70
- name 'service'
71
- supports platform: 'unix'
72
- supports platform: 'windows'
73
- desc 'Use the service InSpec audit resource to test if the named service is installed, running and/or enabled.'
74
- example "
75
- describe service('service_name') do
76
- it { should be_installed }
77
- it { should be_enabled }
78
- it { should be_running }
79
- its('type') { should be 'systemd' }
80
- its ('startmode') { should be 'Auto'}
81
- end
82
-
83
- describe service('service_name').runlevels(3, 5) do
84
- it { should be_enabled }
85
- end
86
-
87
- describe service('service_name').params do
88
- its('UnitFileState') { should eq 'enabled' }
89
- end
90
- "
91
-
92
- attr_reader :service_ctl
93
-
94
- def initialize(service_name, service_ctl = nil)
95
- @service_name = service_name
96
- @service_mgmt = nil
97
- @service_ctl ||= service_ctl
98
- @cache = nil
99
- @service_mgmt = select_service_mgmt
100
-
101
- return skip_resource 'The `service` resource is not supported on your OS yet.' if @service_mgmt.nil?
102
- end
103
-
104
- def select_service_mgmt # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/MethodLength
105
- os = inspec.os
106
- platform = os[:name]
107
-
108
- # Ubuntu
109
- # @see: https://wiki.ubuntu.com/SystemdForUpstartUsers
110
- # Ubuntu 15.04 : Systemd
111
- # Systemd runs with PID 1 as /sbin/init.
112
- # Upstart runs with PID 1 as /sbin/upstart.
113
- # Ubuntu < 15.04 : Upstart
114
- # Upstart runs with PID 1 as /sbin/init.
115
- # Systemd runs with PID 1 as /lib/systemd/systemd.
116
- if %w{ubuntu}.include?(platform)
117
- version = os[:release].to_f
118
- if version < 15.04
119
- Upstart.new(inspec, service_ctl)
120
- else
121
- Systemd.new(inspec, service_ctl)
122
- end
123
- elsif %w{linuxmint}.include?(platform)
124
- version = os[:release].to_f
125
- if version < 18
126
- Upstart.new(inspec, service_ctl)
127
- else
128
- Systemd.new(inspec, service_ctl)
129
- end
130
- elsif %w{debian}.include?(platform)
131
- version = os[:release].to_i
132
- if version > 7
133
- Systemd.new(inspec, service_ctl)
134
- else
135
- SysV.new(inspec, service_ctl || '/usr/sbin/service')
136
- end
137
- elsif %w{redhat fedora centos oracle}.include?(platform)
138
- version = os[:release].to_i
139
- if (%w{redhat centos oracle}.include?(platform) && version >= 7) || (platform == 'fedora' && version >= 15)
140
- Systemd.new(inspec, service_ctl)
141
- else
142
- SysV.new(inspec, service_ctl || '/sbin/service')
143
- end
144
- elsif %w{wrlinux}.include?(platform)
145
- SysV.new(inspec, service_ctl)
146
- elsif %w{mac_os_x}.include?(platform)
147
- LaunchCtl.new(inspec, service_ctl)
148
- elsif os.windows?
149
- WindowsSrv.new(inspec)
150
- elsif %w{freebsd}.include?(platform)
151
- BSDInit.new(inspec, service_ctl)
152
- elsif %w{arch}.include?(platform)
153
- Systemd.new(inspec, service_ctl)
154
- elsif %w{coreos}.include?(platform)
155
- Systemd.new(inspec, service_ctl)
156
- elsif %w{suse opensuse}.include?(platform)
157
- if os[:release].to_i >= 12
158
- Systemd.new(inspec, service_ctl)
159
- else
160
- SysV.new(inspec, service_ctl || '/sbin/service')
161
- end
162
- elsif %w{aix}.include?(platform)
163
- SrcMstr.new(inspec)
164
- elsif %w{amazon}.include?(platform)
165
- if os[:release] =~ /^20\d\d/
166
- Upstart.new(inspec, service_ctl)
167
- else
168
- Systemd.new(inspec, service_ctl)
169
- end
170
- elsif os.solaris?
171
- Svcs.new(inspec)
172
- end
173
- end
174
-
175
- def info
176
- return nil if @service_mgmt.nil?
177
- @cache ||= @service_mgmt.info(@service_name)
178
- end
179
-
180
- # verifies if the service is enabled
181
- def enabled?(_level = nil)
182
- return false if info.nil?
183
- info[:enabled]
184
- end
185
-
186
- def params
187
- return {} if info.nil?
188
- Hashie::Mash.new(info[:params] || {})
189
- end
190
-
191
- # verifies the service is registered
192
- def installed?(_name = nil, _version = nil)
193
- return false if info.nil?
194
- info[:installed]
195
- end
196
-
197
- # verifies the service is currently running
198
- def running?(_under = nil)
199
- return false if info.nil?
200
- info[:running]
201
- end
202
-
203
- # get all runlevels that are available and their configuration
204
- def runlevels(*args)
205
- return Runlevels.new(self) if info.nil? or info[:runlevels].nil?
206
- Runlevels.from_hash(self, info[:runlevels], args)
207
- end
208
-
209
- # returns the service type from info
210
- def type
211
- return nil if info.nil?
212
- info[:type]
213
- end
214
-
215
- # returns the service name from info
216
- def name
217
- return @service_name if info.nil?
218
- info[:name]
219
- end
220
-
221
- # returns the service description from info
222
- def description
223
- return nil if info.nil?
224
- info[:description]
225
- end
226
-
227
- # returns the service start up mode from info
228
- def startmode
229
- return nil if info.nil?
230
- info[:startmode]
231
- end
232
-
233
- def to_s
234
- "Service #{@service_name}"
235
- end
236
-
237
- private :info
238
- end
239
-
240
- class ServiceManager
241
- attr_reader :inspec, :service_ctl
242
- def initialize(inspec, service_ctl = nil)
243
- @inspec = inspec
244
- @service_ctl ||= service_ctl
245
- end
246
- end
247
-
248
- # @see: http://www.freedesktop.org/software/systemd/man/systemctl.html
249
- # @see: http://www.freedesktop.org/software/systemd/man/systemd-system.conf.html
250
- class Systemd < ServiceManager
251
- def initialize(inspec, service_ctl = nil)
252
- @service_ctl = service_ctl || 'systemctl'
253
- super
254
- end
255
-
256
- def is_enabled?(service_name)
257
- result = inspec.command("#{service_ctl} is-enabled #{service_name} --quiet")
258
- return true if result.exit_status == 0
259
-
260
- # Some systems may not have a `.service` file for a particular service
261
- # which causes the `systemctl is-enabled` check to fail despite the
262
- # service being enabled. In that event we fallback to `sysv_service`.
263
- if result.stderr =~ /Failed to get.*No such file or directory/
264
- return inspec.sysv_service(service_name).enabled?
265
- end
266
-
267
- false
268
- end
269
-
270
- def is_active?(service_name)
271
- inspec.command("#{service_ctl} is-active #{service_name} --quiet").exit_status == 0
272
- end
273
-
274
- def info(service_name)
275
- cmd = inspec.command("#{service_ctl} show --all #{service_name}")
276
- return nil if cmd.exit_status.to_i != 0
277
-
278
- # parse data
279
- params = SimpleConfig.new(
280
- cmd.stdout.chomp,
281
- assignment_regex: /^\s*([^=]*?)\s*=\s*(.*?)\s*$/,
282
- multiple_values: false,
283
- ).params
284
-
285
- # LoadState values eg. loaded, not-found
286
- installed = params['LoadState'] == 'loaded'
287
-
288
- {
289
- name: params['Id'],
290
- description: params['Description'],
291
- installed: installed,
292
- running: is_active?(service_name),
293
- enabled: is_enabled?(service_name),
294
- type: 'systemd',
295
- params: params,
296
- }
297
- end
298
- end
299
-
300
- # AIX services
301
- class SrcMstr < ServiceManager
302
- attr_reader :name
303
-
304
- def info(service_name)
305
- @name = service_name
306
- running = status?
307
- return nil if running.nil?
308
-
309
- {
310
- name: service_name,
311
- description: nil,
312
- installed: true,
313
- running: running,
314
- enabled: enabled?,
315
- type: 'srcmstr',
316
- }
317
- end
318
-
319
- private
320
-
321
- def status?
322
- status_cmd = inspec.command("lssrc -s #{@name}")
323
- return nil if status_cmd.exit_status.to_i != 0
324
- status_cmd.stdout.split(/\n/).last.chomp =~ /active$/ ? true : false
325
- end
326
-
327
- def enabled?
328
- enabled_rc_tcpip? || enabled_inittab?
329
- end
330
-
331
- def enabled_rc_tcpip?
332
- inspec.command(
333
- "grep -v ^# /etc/rc.tcpip | grep 'start ' | grep -Eq '(/{0,1}| )#{name} '",
334
- ).exit_status == 0
335
- end
336
-
337
- def enabled_inittab?
338
- inspec.command("lsitab #{name}").exit_status == 0
339
- end
340
- end
341
-
342
- # @see: http://upstart.ubuntu.com
343
- class Upstart < ServiceManager
344
- include FileReader
345
-
346
- def initialize(service_name, service_ctl = nil)
347
- @service_ctl = service_ctl || 'initctl'
348
- super
349
- end
350
-
351
- def info(service_name)
352
- # get the status of upstart service
353
- status = inspec.command("#{service_ctl} status #{service_name}")
354
-
355
- # fallback for systemv services, those are not handled via `initctl`
356
- return SysV.new(inspec).info(service_name) if status.exit_status.to_i != 0 || status.stdout == ''
357
-
358
- # @see: http://upstart.ubuntu.com/cookbook/#job-states
359
- # grep for running to indicate the service is there
360
- running = !status.stdout[%r{start/running}].nil?
361
- enabled = info_enabled(service_name)
362
-
363
- {
364
- name: service_name,
365
- description: nil,
366
- installed: true,
367
- running: running,
368
- enabled: enabled,
369
- type: 'upstart',
370
- }
371
- end
372
-
373
- private
374
-
375
- def info_enabled(service_name)
376
- # check if a service is enabled
377
- config = read_file_content("/etc/init/#{service_name}.conf", allow_empty: true)
378
-
379
- !config.match(/^\s*start on/).nil?
380
- end
381
-
382
- def version
383
- @version ||= begin
384
- out = inspec.command("#{service_ctl} --version").stdout
385
- Gem::Version.new(out[/\(upstart ([^\)]+)\)/, 1])
386
- end
387
- end
388
- end
389
-
390
- class SysV < ServiceManager
391
- RUNLEVELS = { 0=>false, 1=>false, 2=>false, 3=>false, 4=>false, 5=>false, 6=>false }.freeze
392
-
393
- def initialize(service_name, service_ctl = nil)
394
- @service_ctl = service_ctl || 'service'
395
- super
396
- end
397
-
398
- def info(service_name)
399
- # check if service is installed
400
- # read all available services via ls /etc/init.d/
401
- srvlist = inspec.command('ls -1 /etc/init.d/')
402
- return nil if srvlist.exit_status != 0
403
-
404
- # check if the service is in list
405
- service = srvlist.stdout.split("\n").select { |srv| srv == service_name }
406
-
407
- # abort if we could not find any service
408
- return nil if service.empty?
409
-
410
- # read all enabled services from runlevel
411
- # on rhel via: 'chkconfig --list', is not installed by default
412
- # bash: for i in `find /etc/rc*.d -name S*`; do basename $i | sed -r 's/^S[0-9]+//'; done | sort | uniq
413
- enabled_services_cmd = inspec.command('find /etc/rc*.d /etc/init.d/rc*.d -name "S*"').stdout
414
- service_line = %r{rc(?<runlevel>[0-6])\.d/S[^/]*?#{Regexp.escape service_name}$}
415
- all_services = enabled_services_cmd.split("\n").map { |line|
416
- service_line.match(line)
417
- }.compact
418
- enabled = !all_services.empty?
419
-
420
- # Determine a list of runlevels which this service is activated for
421
- runlevels = RUNLEVELS.dup
422
- all_services.each { |x| runlevels[x[:runlevel].to_i] = true }
423
-
424
- # check if service is really running
425
- # service throws an exit code if the service is not installed or
426
- # not enabled
427
-
428
- cmd = inspec.command("#{service_ctl} #{service_name} status")
429
- running = cmd.exit_status == 0
430
- {
431
- name: service_name,
432
- description: nil,
433
- installed: true,
434
- running: running,
435
- enabled: enabled,
436
- runlevels: runlevels,
437
- type: 'sysv',
438
- }
439
- end
440
- end
441
-
442
- # @see: https://www.freebsd.org/doc/en/articles/linux-users/startup.html
443
- # @see: https://www.freebsd.org/cgi/man.cgi?query=rc.conf&sektion=5
444
- class BSDInit < ServiceManager
445
- def initialize(service_name, service_ctl = nil)
446
- @service_ctl = service_ctl || 'service'
447
- super
448
- end
449
-
450
- def info(service_name)
451
- # check if service is enabled
452
- # services are enabled in /etc/rc.conf and /etc/defaults/rc.conf
453
- # via #{service_name}_enable="YES"
454
- # service SERVICE status returns the following result if not activated:
455
- # Cannot 'status' sshd. Set sshd_enable to YES in /etc/rc.conf or use 'onestatus' instead of 'status'.
456
- # gather all enabled services
457
- cmd = inspec.command("#{service_ctl} -e")
458
- return nil if cmd.exit_status != 0
459
-
460
- # search for the service
461
- srv = /(^.*#{service_name}$)/.match(cmd.stdout)
462
- return nil if srv.nil? || srv[0].nil?
463
- enabled = true
464
-
465
- # check if the service is running
466
- # if the service is not available or not running, we always get an error code
467
- cmd = inspec.command("#{service_ctl} #{service_name} onestatus")
468
- running = cmd.exit_status == 0
469
-
470
- {
471
- name: service_name,
472
- description: nil,
473
- installed: true,
474
- running: running,
475
- enabled: enabled,
476
- type: 'bsd-init',
477
- }
478
- end
479
- end
480
-
481
- class Runit < ServiceManager
482
- def initialize(service_name, service_ctl = nil)
483
- @service_ctl = service_ctl || 'sv'
484
- super
485
- end
486
-
487
- # rubocop:disable Style/DoubleNegation
488
- def info(service_name)
489
- # get the status of runit service
490
- cmd = inspec.command("#{service_ctl} status #{service_name}")
491
- # return nil unless cmd.exit_status == 0 # NOTE(sr) why do we do this?
492
-
493
- installed = cmd.exit_status == 0
494
- running = installed && !!(cmd.stdout =~ /^run:/)
495
- enabled = installed && (running || !!(cmd.stdout =~ /normally up/) || !!(cmd.stdout =~ /want up/))
496
-
497
- {
498
- name: service_name,
499
- description: nil,
500
- installed: installed,
501
- running: running,
502
- enabled: enabled,
503
- type: 'runit',
504
- }
505
- end
506
- end
507
-
508
- # MacOS / Darwin
509
- # new launctl on macos 10.10
510
- class LaunchCtl < ServiceManager
511
- def initialize(service_name, service_ctl = nil)
512
- @service_ctl = service_ctl || 'launchctl'
513
- super
514
- end
515
-
516
- def info(service_name)
517
- # get the status of upstart service
518
- cmd = inspec.command("#{service_ctl} list")
519
- return nil if cmd.exit_status != 0
520
-
521
- # search for the service
522
- srv = /(^.*#{service_name}.*)/.match(cmd.stdout)
523
- return nil if srv.nil? || srv[0].nil?
524
-
525
- # extract values from service
526
- parsed_srv = /^(?<pid>[0-9-]+)\t(?<exit>[0-9]+)\t(?<name>\S*)$/.match(srv[0])
527
- enabled = !parsed_srv['name'].nil? # it's in the list
528
-
529
- # check if the service is running
530
- pid = parsed_srv['pid']
531
- running = pid != '-'
532
-
533
- # extract service label
534
- srv = parsed_srv['name'] || service_name
535
-
536
- {
537
- name: srv,
538
- description: nil,
539
- installed: true,
540
- running: running,
541
- enabled: enabled,
542
- type: 'darwin',
543
- }
544
- end
545
- end
546
-
547
- # Determine the service state from Windows
548
- # Uses Powershell to retrieve the information
549
- class WindowsSrv < ServiceManager
550
- # Determine service details
551
- # PS: Get-Service -Name 'dhcp'| Select-Object -Property Name, DisplayName, Status | ConvertTo-Json
552
- # {
553
- # "Name": "dhcp",
554
- # "DisplayName": "DHCP Client",
555
- # "Status": 4
556
- # }
557
- #
558
- # Until StartMode is not added to Get-Service, we need to do a workaround
559
- # @see: https://connect.microsoft.com/PowerShell/feedback/details/424948/i-would-like-to-see-the-property-starttype-added-to-get-services
560
- # Also see: https://msdn.microsoft.com/en-us/library/aa384896(v=vs.85).aspx
561
- # Use the following powershell to determine the start mode
562
- # PS: Get-WmiObject -Class Win32_Service | Where-Object {$_.Name -eq $name -or $_.DisplayName -eq $name} | Select-Object -Prop
563
- # erty Name, StartMode, State, Status | ConvertTo-Json
564
- # {
565
- # "Name": "Dhcp",
566
- # "StartMode": "Auto",
567
- # "State": "Running",
568
- # "Status": "OK"
569
- # }
570
- #
571
- # Windows Services have the following status code:
572
- # @see: https://msdn.microsoft.com/en-us/library/windows/desktop/ms685996(v=vs.85).aspx
573
- # - 1: Stopped
574
- # - 2: Starting
575
- # - 3: Stopping
576
- # - 4: Running
577
- # - 5: Continue Pending
578
- # - 6: Pause Pending
579
- # - 7: Paused
580
- def info(service_name)
581
- cmd = inspec.command("New-Object -Type PSObject | Add-Member -MemberType NoteProperty -Name Service -Value (Get-Service -Name '#{service_name}'| Select-Object -Property Name, DisplayName, Status) -PassThru | Add-Member -MemberType NoteProperty -Name WMI -Value (Get-WmiObject -Class Win32_Service | Where-Object {$_.Name -eq '#{service_name}' -or $_.DisplayName -eq '#{service_name}'} | Select-Object -Property StartMode) -PassThru | ConvertTo-Json")
582
-
583
- # cannot rely on exit code for now, successful command returns exit code 1
584
- # return nil if cmd.exit_status != 0
585
- # try to parse json
586
- begin
587
- service = JSON.parse(cmd.stdout)
588
- rescue JSON::ParserError => _e
589
- return nil
590
- end
591
-
592
- # check that we got a response
593
- return nil if service.nil? || service['Service'].nil?
594
-
595
- {
596
- name: service['Service']['Name'],
597
- description: service['Service']['DisplayName'],
598
- installed: true,
599
- running: service_running?(service),
600
- enabled: service_enabled?(service),
601
- startmode: service['WMI']['StartMode'],
602
- type: 'windows',
603
- }
604
- end
605
-
606
- private
607
-
608
- # detect if service is enabled
609
- def service_enabled?(service)
610
- !service['WMI'].nil? &&
611
- !service['WMI']['StartMode'].nil? &&
612
- (service['WMI']['StartMode'] == 'Auto' ||
613
- service['WMI']['StartMode'] == 'Manual')
614
- end
615
-
616
- # detect if service is running
617
- def service_running?(service)
618
- !service['Service']['Status'].nil? && service['Service']['Status'] == 4
619
- end
620
- end
621
-
622
- # Solaris services
623
- class Svcs < ServiceManager
624
- def initialize(service_name, service_ctl = nil)
625
- @service_ctl = service_ctl || 'svcs'
626
- super
627
- end
628
-
629
- def info(service_name)
630
- # get the status of runit service
631
- cmd = inspec.command("#{service_ctl} -l #{service_name}")
632
- return nil if cmd.exit_status != 0
633
-
634
- params = SimpleConfig.new(
635
- cmd.stdout.chomp,
636
- assignment_regex: /^(\w+)\s*(.*)$/,
637
- multiple_values: false,
638
- ).params
639
-
640
- installed = cmd.exit_status == 0
641
- running = installed && (params['state'] == 'online')
642
- enabled = installed && (params['enabled'] == 'true')
643
-
644
- {
645
- name: service_name,
646
- description: params['name'],
647
- installed: installed,
648
- running: running,
649
- enabled: enabled,
650
- type: 'svcs',
651
- }
652
- end
653
- end
654
-
655
- # specific resources for specific service managers
656
-
657
- class SystemdService < Service
658
- name 'systemd_service'
659
- supports platform: 'unix'
660
- desc 'Use the systemd_service InSpec audit resource to test if the named service (controlled by systemd) is installed, running and/or enabled.'
661
- example "
662
- # to override service mgmt auto-detection
663
- describe systemd_service('service_name') do
664
- it { should be_installed }
665
- it { should be_enabled }
666
- it { should be_running }
667
- end
668
-
669
- # to set a non-standard systemctl path
670
- describe systemd_service('service_name', '/path/to/systemctl') do
671
- it { should be_running }
672
- end
673
- "
674
-
675
- def select_service_mgmt
676
- Systemd.new(inspec, service_ctl)
677
- end
678
- end
679
-
680
- class UpstartService < Service
681
- name 'upstart_service'
682
- supports platform: 'unix'
683
- desc 'Use the upstart_service InSpec audit resource to test if the named service (controlled by upstart) is installed, running and/or enabled.'
684
- example "
685
- # to override service mgmt auto-detection
686
- describe upstart_service('service_name') do
687
- it { should be_installed }
688
- it { should be_enabled }
689
- it { should be_running }
690
- end
691
-
692
- # to set a non-standard initctl path
693
- describe upstart_service('service_name', '/path/to/initctl') do
694
- it { should be_running }
695
- end
696
- "
697
-
698
- def select_service_mgmt
699
- Upstart.new(inspec, service_ctl)
700
- end
701
- end
702
-
703
- class SysVService < Service
704
- name 'sysv_service'
705
- supports platform: 'unix'
706
- desc 'Use the sysv_service InSpec audit resource to test if the named service (controlled by SysV) is installed, running and/or enabled.'
707
- example "
708
- # to override service mgmt auto-detection
709
- describe sysv_service('service_name') do
710
- it { should be_installed }
711
- it { should be_enabled }
712
- it { should be_running }
713
- end
714
-
715
- # to set a non-standard service path
716
- describe sysv_service('service_name', '/path/to/service') do
717
- it { should be_running }
718
- end
719
- "
720
-
721
- def select_service_mgmt
722
- SysV.new(inspec, service_ctl)
723
- end
724
- end
725
-
726
- class BSDService < Service
727
- name 'bsd_service'
728
- supports platform: 'unix'
729
- desc 'Use the bsd_service InSpec audit resource to test if the named service (controlled by BSD init) is installed, running and/or enabled.'
730
- example "
731
- # to override service mgmt auto-detection
732
- describe bsd_service('service_name') do
733
- it { should be_installed }
734
- it { should be_enabled }
735
- it { should be_running }
736
- end
737
-
738
- # to set a non-standard service path
739
- describe bsd_service('service_name', '/path/to/service') do
740
- it { should be_running }
741
- end
742
- "
743
-
744
- def select_service_mgmt
745
- BSDInit.new(inspec, service_ctl)
746
- end
747
- end
748
-
749
- class LaunchdService < Service
750
- name 'launchd_service'
751
- supports platform: 'unix'
752
- desc 'Use the launchd_service InSpec audit resource to test if the named service (controlled by launchd) is installed, running and/or enabled.'
753
- example "
754
- # to override service mgmt auto-detection
755
- describe launchd_service('service_name') do
756
- it { should be_installed }
757
- it { should be_enabled }
758
- it { should be_running }
759
- end
760
-
761
- # to set a non-standard launchctl path
762
- describe launchd_service('service_name', '/path/to/launchctl') do
763
- it { should be_running }
764
- end
765
- "
766
-
767
- def select_service_mgmt
768
- LaunchCtl.new(inspec, service_ctl)
769
- end
770
- end
771
-
772
- class RunitService < Service
773
- name 'runit_service'
774
- supports platform: 'unix'
775
- desc 'Use the runit_service InSpec audit resource to test if the named service (controlled by runit) is installed, running and/or enabled.'
776
- example "
777
- # to override service mgmt auto-detection
778
- describe runit_service('service_name') do
779
- it { should be_installed }
780
- it { should be_enabled }
781
- it { should be_running }
782
- end
783
-
784
- # to set a non-standard sv path
785
- describe runit_service('service_name', '/path/to/sv') do
786
- it { should be_running }
787
- end
788
- "
789
-
790
- def select_service_mgmt
791
- Runit.new(inspec, service_ctl)
792
- end
793
- end
794
- end
1
+ # encoding: utf-8
2
+
3
+ require 'hashie'
4
+ require 'utils/file_reader'
5
+
6
+ module Inspec::Resources
7
+ class Runlevels < Hash
8
+ attr_accessor :owner
9
+
10
+ def self.from_hash(owner, hash = {}, filter = nil)
11
+ res = Runlevels.new(owner)
12
+ filter = filter.first if filter.is_a?(Array) && filter.length <= 1
13
+
14
+ ks = case filter
15
+ when nil
16
+ hash.keys
17
+ when Regexp
18
+ hash.keys.find_all { |x| x.to_s =~ filter }
19
+ when Array
20
+ f = filter.map(&:to_s)
21
+ hash.keys.find_all { |x| f.include?(x.to_s) }
22
+ when Numeric
23
+ hash.keys.include?(filter) ? [filter] : []
24
+ else
25
+ hash.keys.find_all { |x| x == filter }
26
+ end
27
+
28
+ ks.each { |k| res[k] = hash[k] }
29
+ res
30
+ end
31
+
32
+ def initialize(owner, default = false)
33
+ @owner = owner
34
+ super(default)
35
+ end
36
+
37
+ def filter(f)
38
+ Runlevels.from_hash(owner, self, f)
39
+ end
40
+
41
+ # Check if all runlevels are enabled
42
+ #
43
+ # @return [boolean] true if all runlevels are enabled
44
+ def enabled?
45
+ values.all?
46
+ end
47
+
48
+ # Check if all runlevels are disabled
49
+ #
50
+ # @return [boolean] true if all runlevels are disabled
51
+ def disabled?
52
+ values.none?
53
+ end
54
+
55
+ def to_s
56
+ "#{owner} runlevels #{keys.join(', ')}"
57
+ end
58
+ end
59
+
60
+ # We detect the init system for each operating system, based on the operating
61
+ # system.
62
+ #
63
+ # Fedora 15 : systemd
64
+ # RedHat 7 : systemd
65
+ # Ubuntu 15.04 : systemd
66
+ # Ubuntu < 15.04 : upstart
67
+ #
68
+ # TODO: extend the logic to detect the running init system, independently of OS
69
+ class Service < Inspec.resource(1)
70
+ name 'service'
71
+ supports platform: 'unix'
72
+ supports platform: 'windows'
73
+ desc 'Use the service InSpec audit resource to test if the named service is installed, running and/or enabled.'
74
+ example "
75
+ describe service('service_name') do
76
+ it { should be_installed }
77
+ it { should be_enabled }
78
+ it { should be_running }
79
+ its('type') { should be 'systemd' }
80
+ its ('startmode') { should be 'Auto'}
81
+ end
82
+
83
+ describe service('service_name').runlevels(3, 5) do
84
+ it { should be_enabled }
85
+ end
86
+
87
+ describe service('service_name').params do
88
+ its('UnitFileState') { should eq 'enabled' }
89
+ end
90
+ "
91
+
92
+ attr_reader :service_ctl
93
+
94
+ def initialize(service_name, service_ctl = nil)
95
+ @service_name = service_name
96
+ @service_mgmt = nil
97
+ @service_ctl ||= service_ctl
98
+ @cache = nil
99
+ @service_mgmt = select_service_mgmt
100
+
101
+ return skip_resource 'The `service` resource is not supported on your OS yet.' if @service_mgmt.nil?
102
+ end
103
+
104
+ def select_service_mgmt # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/PerceivedComplexity, Metrics/MethodLength
105
+ os = inspec.os
106
+ platform = os[:name]
107
+
108
+ # Ubuntu
109
+ # @see: https://wiki.ubuntu.com/SystemdForUpstartUsers
110
+ # Ubuntu 15.04 : Systemd
111
+ # Systemd runs with PID 1 as /sbin/init.
112
+ # Upstart runs with PID 1 as /sbin/upstart.
113
+ # Ubuntu < 15.04 : Upstart
114
+ # Upstart runs with PID 1 as /sbin/init.
115
+ # Systemd runs with PID 1 as /lib/systemd/systemd.
116
+ if %w{ubuntu}.include?(platform)
117
+ version = os[:release].to_f
118
+ if version < 15.04
119
+ Upstart.new(inspec, service_ctl)
120
+ else
121
+ Systemd.new(inspec, service_ctl)
122
+ end
123
+ elsif %w{linuxmint}.include?(platform)
124
+ version = os[:release].to_f
125
+ if version < 18
126
+ Upstart.new(inspec, service_ctl)
127
+ else
128
+ Systemd.new(inspec, service_ctl)
129
+ end
130
+ elsif %w{debian}.include?(platform)
131
+ version = os[:release].to_i
132
+ if version > 7
133
+ Systemd.new(inspec, service_ctl)
134
+ else
135
+ SysV.new(inspec, service_ctl || '/usr/sbin/service')
136
+ end
137
+ elsif %w{redhat fedora centos oracle}.include?(platform)
138
+ version = os[:release].to_i
139
+ if (%w{redhat centos oracle}.include?(platform) && version >= 7) || (platform == 'fedora' && version >= 15)
140
+ Systemd.new(inspec, service_ctl)
141
+ else
142
+ SysV.new(inspec, service_ctl || '/sbin/service')
143
+ end
144
+ elsif %w{wrlinux}.include?(platform)
145
+ SysV.new(inspec, service_ctl)
146
+ elsif %w{mac_os_x}.include?(platform)
147
+ LaunchCtl.new(inspec, service_ctl)
148
+ elsif os.windows?
149
+ WindowsSrv.new(inspec)
150
+ elsif %w{freebsd}.include?(platform)
151
+ BSDInit.new(inspec, service_ctl)
152
+ elsif %w{arch}.include?(platform)
153
+ Systemd.new(inspec, service_ctl)
154
+ elsif %w{coreos}.include?(platform)
155
+ Systemd.new(inspec, service_ctl)
156
+ elsif %w{suse opensuse}.include?(platform)
157
+ if os[:release].to_i >= 12
158
+ Systemd.new(inspec, service_ctl)
159
+ else
160
+ SysV.new(inspec, service_ctl || '/sbin/service')
161
+ end
162
+ elsif %w{aix}.include?(platform)
163
+ SrcMstr.new(inspec)
164
+ elsif %w{amazon}.include?(platform)
165
+ if os[:release] =~ /^20\d\d/
166
+ Upstart.new(inspec, service_ctl)
167
+ else
168
+ Systemd.new(inspec, service_ctl)
169
+ end
170
+ elsif os.solaris?
171
+ Svcs.new(inspec)
172
+ end
173
+ end
174
+
175
+ def info
176
+ return nil if @service_mgmt.nil?
177
+ @cache ||= @service_mgmt.info(@service_name)
178
+ end
179
+
180
+ # verifies if the service is enabled
181
+ def enabled?(_level = nil)
182
+ return false if info.nil?
183
+ info[:enabled]
184
+ end
185
+
186
+ def params
187
+ return {} if info.nil?
188
+ Hashie::Mash.new(info[:params] || {})
189
+ end
190
+
191
+ # verifies the service is registered
192
+ def installed?(_name = nil, _version = nil)
193
+ return false if info.nil?
194
+ info[:installed]
195
+ end
196
+
197
+ # verifies the service is currently running
198
+ def running?(_under = nil)
199
+ return false if info.nil?
200
+ info[:running]
201
+ end
202
+
203
+ # get all runlevels that are available and their configuration
204
+ def runlevels(*args)
205
+ return Runlevels.new(self) if info.nil? or info[:runlevels].nil?
206
+ Runlevels.from_hash(self, info[:runlevels], args)
207
+ end
208
+
209
+ # returns the service type from info
210
+ def type
211
+ return nil if info.nil?
212
+ info[:type]
213
+ end
214
+
215
+ # returns the service name from info
216
+ def name
217
+ return @service_name if info.nil?
218
+ info[:name]
219
+ end
220
+
221
+ # returns the service description from info
222
+ def description
223
+ return nil if info.nil?
224
+ info[:description]
225
+ end
226
+
227
+ # returns the service start up mode from info
228
+ def startmode
229
+ return nil if info.nil?
230
+ info[:startmode]
231
+ end
232
+
233
+ def to_s
234
+ "Service #{@service_name}"
235
+ end
236
+
237
+ private :info
238
+ end
239
+
240
+ class ServiceManager
241
+ attr_reader :inspec, :service_ctl
242
+ def initialize(inspec, service_ctl = nil)
243
+ @inspec = inspec
244
+ @service_ctl ||= service_ctl
245
+ end
246
+ end
247
+
248
+ # @see: http://www.freedesktop.org/software/systemd/man/systemctl.html
249
+ # @see: http://www.freedesktop.org/software/systemd/man/systemd-system.conf.html
250
+ class Systemd < ServiceManager
251
+ def initialize(inspec, service_ctl = nil)
252
+ @service_ctl = service_ctl || 'systemctl'
253
+ super
254
+ end
255
+
256
+ def is_enabled?(service_name)
257
+ result = inspec.command("#{service_ctl} is-enabled #{service_name} --quiet")
258
+ return true if result.exit_status == 0
259
+
260
+ # Some systems may not have a `.service` file for a particular service
261
+ # which causes the `systemctl is-enabled` check to fail despite the
262
+ # service being enabled. In that event we fallback to `sysv_service`.
263
+ if result.stderr =~ /Failed to get.*No such file or directory/
264
+ return inspec.sysv_service(service_name).enabled?
265
+ end
266
+
267
+ false
268
+ end
269
+
270
+ def is_active?(service_name)
271
+ inspec.command("#{service_ctl} is-active #{service_name} --quiet").exit_status == 0
272
+ end
273
+
274
+ def info(service_name)
275
+ cmd = inspec.command("#{service_ctl} show --all #{service_name}")
276
+ return nil if cmd.exit_status.to_i != 0
277
+
278
+ # parse data
279
+ params = SimpleConfig.new(
280
+ cmd.stdout.chomp,
281
+ assignment_regex: /^\s*([^=]*?)\s*=\s*(.*?)\s*$/,
282
+ multiple_values: false,
283
+ ).params
284
+
285
+ # LoadState values eg. loaded, not-found
286
+ installed = params['LoadState'] == 'loaded'
287
+
288
+ {
289
+ name: params['Id'],
290
+ description: params['Description'],
291
+ installed: installed,
292
+ running: is_active?(service_name),
293
+ enabled: is_enabled?(service_name),
294
+ type: 'systemd',
295
+ params: params,
296
+ }
297
+ end
298
+ end
299
+
300
+ # AIX services
301
+ class SrcMstr < ServiceManager
302
+ attr_reader :name
303
+
304
+ def info(service_name)
305
+ @name = service_name
306
+ running = status?
307
+ return nil if running.nil?
308
+
309
+ {
310
+ name: service_name,
311
+ description: nil,
312
+ installed: true,
313
+ running: running,
314
+ enabled: enabled?,
315
+ type: 'srcmstr',
316
+ }
317
+ end
318
+
319
+ private
320
+
321
+ def status?
322
+ status_cmd = inspec.command("lssrc -s #{@name}")
323
+ return nil if status_cmd.exit_status.to_i != 0
324
+ status_cmd.stdout.split(/\n/).last.chomp =~ /active$/ ? true : false
325
+ end
326
+
327
+ def enabled?
328
+ enabled_rc_tcpip? || enabled_inittab?
329
+ end
330
+
331
+ def enabled_rc_tcpip?
332
+ inspec.command(
333
+ "grep -v ^# /etc/rc.tcpip | grep 'start ' | grep -Eq '(/{0,1}| )#{name} '",
334
+ ).exit_status == 0
335
+ end
336
+
337
+ def enabled_inittab?
338
+ inspec.command("lsitab #{name}").exit_status == 0
339
+ end
340
+ end
341
+
342
+ # @see: http://upstart.ubuntu.com
343
+ class Upstart < ServiceManager
344
+ include FileReader
345
+
346
+ def initialize(service_name, service_ctl = nil)
347
+ @service_ctl = service_ctl || 'initctl'
348
+ super
349
+ end
350
+
351
+ def info(service_name)
352
+ # get the status of upstart service
353
+ status = inspec.command("#{service_ctl} status #{service_name}")
354
+
355
+ # fallback for systemv services, those are not handled via `initctl`
356
+ return SysV.new(inspec).info(service_name) if status.exit_status.to_i != 0 || status.stdout == ''
357
+
358
+ # @see: http://upstart.ubuntu.com/cookbook/#job-states
359
+ # grep for running to indicate the service is there
360
+ running = !status.stdout[%r{start/running}].nil?
361
+ enabled = info_enabled(service_name)
362
+
363
+ {
364
+ name: service_name,
365
+ description: nil,
366
+ installed: true,
367
+ running: running,
368
+ enabled: enabled,
369
+ type: 'upstart',
370
+ }
371
+ end
372
+
373
+ private
374
+
375
+ def info_enabled(service_name)
376
+ # check if a service is enabled
377
+ config = read_file_content("/etc/init/#{service_name}.conf", allow_empty: true)
378
+
379
+ !config.match(/^\s*start on/).nil?
380
+ end
381
+
382
+ def version
383
+ @version ||= begin
384
+ out = inspec.command("#{service_ctl} --version").stdout
385
+ Gem::Version.new(out[/\(upstart ([^\)]+)\)/, 1])
386
+ end
387
+ end
388
+ end
389
+
390
+ class SysV < ServiceManager
391
+ RUNLEVELS = { 0=>false, 1=>false, 2=>false, 3=>false, 4=>false, 5=>false, 6=>false }.freeze
392
+
393
+ def initialize(service_name, service_ctl = nil)
394
+ @service_ctl = service_ctl || 'service'
395
+ super
396
+ end
397
+
398
+ def info(service_name)
399
+ # check if service is installed
400
+ # read all available services via ls /etc/init.d/
401
+ srvlist = inspec.command('ls -1 /etc/init.d/')
402
+ return nil if srvlist.exit_status != 0
403
+
404
+ # check if the service is in list
405
+ service = srvlist.stdout.split("\n").select { |srv| srv == service_name }
406
+
407
+ # abort if we could not find any service
408
+ return nil if service.empty?
409
+
410
+ # read all enabled services from runlevel
411
+ # on rhel via: 'chkconfig --list', is not installed by default
412
+ # bash: for i in `find /etc/rc*.d -name S*`; do basename $i | sed -r 's/^S[0-9]+//'; done | sort | uniq
413
+ enabled_services_cmd = inspec.command('find /etc/rc*.d /etc/init.d/rc*.d -name "S*"').stdout
414
+ service_line = %r{rc(?<runlevel>[0-6])\.d/S[^/]*?#{Regexp.escape service_name}$}
415
+ all_services = enabled_services_cmd.split("\n").map { |line|
416
+ service_line.match(line)
417
+ }.compact
418
+ enabled = !all_services.empty?
419
+
420
+ # Determine a list of runlevels which this service is activated for
421
+ runlevels = RUNLEVELS.dup
422
+ all_services.each { |x| runlevels[x[:runlevel].to_i] = true }
423
+
424
+ # check if service is really running
425
+ # service throws an exit code if the service is not installed or
426
+ # not enabled
427
+
428
+ cmd = inspec.command("#{service_ctl} #{service_name} status")
429
+ running = cmd.exit_status == 0
430
+ {
431
+ name: service_name,
432
+ description: nil,
433
+ installed: true,
434
+ running: running,
435
+ enabled: enabled,
436
+ runlevels: runlevels,
437
+ type: 'sysv',
438
+ }
439
+ end
440
+ end
441
+
442
+ # @see: https://www.freebsd.org/doc/en/articles/linux-users/startup.html
443
+ # @see: https://www.freebsd.org/cgi/man.cgi?query=rc.conf&sektion=5
444
+ class BSDInit < ServiceManager
445
+ def initialize(service_name, service_ctl = nil)
446
+ @service_ctl = service_ctl || 'service'
447
+ super
448
+ end
449
+
450
+ def info(service_name)
451
+ # check if service is enabled
452
+ # services are enabled in /etc/rc.conf and /etc/defaults/rc.conf
453
+ # via #{service_name}_enable="YES"
454
+ # service SERVICE status returns the following result if not activated:
455
+ # Cannot 'status' sshd. Set sshd_enable to YES in /etc/rc.conf or use 'onestatus' instead of 'status'.
456
+ # gather all enabled services
457
+ cmd = inspec.command("#{service_ctl} -e")
458
+ return nil if cmd.exit_status != 0
459
+
460
+ # search for the service
461
+ srv = /(^.*#{service_name}$)/.match(cmd.stdout)
462
+ return nil if srv.nil? || srv[0].nil?
463
+ enabled = true
464
+
465
+ # check if the service is running
466
+ # if the service is not available or not running, we always get an error code
467
+ cmd = inspec.command("#{service_ctl} #{service_name} onestatus")
468
+ running = cmd.exit_status == 0
469
+
470
+ {
471
+ name: service_name,
472
+ description: nil,
473
+ installed: true,
474
+ running: running,
475
+ enabled: enabled,
476
+ type: 'bsd-init',
477
+ }
478
+ end
479
+ end
480
+
481
+ class Runit < ServiceManager
482
+ def initialize(service_name, service_ctl = nil)
483
+ @service_ctl = service_ctl || 'sv'
484
+ super
485
+ end
486
+
487
+ # rubocop:disable Style/DoubleNegation
488
+ def info(service_name)
489
+ # get the status of runit service
490
+ cmd = inspec.command("#{service_ctl} status #{service_name}")
491
+ # return nil unless cmd.exit_status == 0 # NOTE(sr) why do we do this?
492
+
493
+ installed = cmd.exit_status == 0
494
+ running = installed && !!(cmd.stdout =~ /^run:/)
495
+ enabled = installed && (running || !!(cmd.stdout =~ /normally up/) || !!(cmd.stdout =~ /want up/))
496
+
497
+ {
498
+ name: service_name,
499
+ description: nil,
500
+ installed: installed,
501
+ running: running,
502
+ enabled: enabled,
503
+ type: 'runit',
504
+ }
505
+ end
506
+ end
507
+
508
+ # MacOS / Darwin
509
+ # new launctl on macos 10.10
510
+ class LaunchCtl < ServiceManager
511
+ def initialize(service_name, service_ctl = nil)
512
+ @service_ctl = service_ctl || 'launchctl'
513
+ super
514
+ end
515
+
516
+ def info(service_name)
517
+ # get the status of upstart service
518
+ cmd = inspec.command("#{service_ctl} list")
519
+ return nil if cmd.exit_status != 0
520
+
521
+ # search for the service
522
+ srv = /(^.*#{service_name}.*)/.match(cmd.stdout)
523
+ return nil if srv.nil? || srv[0].nil?
524
+
525
+ # extract values from service
526
+ parsed_srv = /^(?<pid>[0-9-]+)\t(?<exit>[0-9]+)\t(?<name>\S*)$/.match(srv[0])
527
+ enabled = !parsed_srv['name'].nil? # it's in the list
528
+
529
+ # check if the service is running
530
+ pid = parsed_srv['pid']
531
+ running = pid != '-'
532
+
533
+ # extract service label
534
+ srv = parsed_srv['name'] || service_name
535
+
536
+ {
537
+ name: srv,
538
+ description: nil,
539
+ installed: true,
540
+ running: running,
541
+ enabled: enabled,
542
+ type: 'darwin',
543
+ }
544
+ end
545
+ end
546
+
547
+ # Determine the service state from Windows
548
+ # Uses Powershell to retrieve the information
549
+ class WindowsSrv < ServiceManager
550
+ # Determine service details
551
+ # PS: Get-Service -Name 'dhcp'| Select-Object -Property Name, DisplayName, Status | ConvertTo-Json
552
+ # {
553
+ # "Name": "dhcp",
554
+ # "DisplayName": "DHCP Client",
555
+ # "Status": 4
556
+ # }
557
+ #
558
+ # Until StartMode is not added to Get-Service, we need to do a workaround
559
+ # @see: https://connect.microsoft.com/PowerShell/feedback/details/424948/i-would-like-to-see-the-property-starttype-added-to-get-services
560
+ # Also see: https://msdn.microsoft.com/en-us/library/aa384896(v=vs.85).aspx
561
+ # Use the following powershell to determine the start mode
562
+ # PS: Get-WmiObject -Class Win32_Service | Where-Object {$_.Name -eq $name -or $_.DisplayName -eq $name} | Select-Object -Prop
563
+ # erty Name, StartMode, State, Status | ConvertTo-Json
564
+ # {
565
+ # "Name": "Dhcp",
566
+ # "StartMode": "Auto",
567
+ # "State": "Running",
568
+ # "Status": "OK"
569
+ # }
570
+ #
571
+ # Windows Services have the following status code:
572
+ # @see: https://msdn.microsoft.com/en-us/library/windows/desktop/ms685996(v=vs.85).aspx
573
+ # - 1: Stopped
574
+ # - 2: Starting
575
+ # - 3: Stopping
576
+ # - 4: Running
577
+ # - 5: Continue Pending
578
+ # - 6: Pause Pending
579
+ # - 7: Paused
580
+ def info(service_name)
581
+ cmd = inspec.command("New-Object -Type PSObject | Add-Member -MemberType NoteProperty -Name Service -Value (Get-Service -Name '#{service_name}'| Select-Object -Property Name, DisplayName, Status) -PassThru | Add-Member -MemberType NoteProperty -Name WMI -Value (Get-WmiObject -Class Win32_Service | Where-Object {$_.Name -eq '#{service_name}' -or $_.DisplayName -eq '#{service_name}'} | Select-Object -Property StartMode) -PassThru | ConvertTo-Json")
582
+
583
+ # cannot rely on exit code for now, successful command returns exit code 1
584
+ # return nil if cmd.exit_status != 0
585
+ # try to parse json
586
+ begin
587
+ service = JSON.parse(cmd.stdout)
588
+ rescue JSON::ParserError => _e
589
+ return nil
590
+ end
591
+
592
+ # check that we got a response
593
+ return nil if service.nil? || service['Service'].nil?
594
+
595
+ {
596
+ name: service['Service']['Name'],
597
+ description: service['Service']['DisplayName'],
598
+ installed: true,
599
+ running: service_running?(service),
600
+ enabled: service_enabled?(service),
601
+ startmode: service['WMI']['StartMode'],
602
+ type: 'windows',
603
+ }
604
+ end
605
+
606
+ private
607
+
608
+ # detect if service is enabled
609
+ def service_enabled?(service)
610
+ !service['WMI'].nil? &&
611
+ !service['WMI']['StartMode'].nil? &&
612
+ (service['WMI']['StartMode'] == 'Auto' ||
613
+ service['WMI']['StartMode'] == 'Manual')
614
+ end
615
+
616
+ # detect if service is running
617
+ def service_running?(service)
618
+ !service['Service']['Status'].nil? && service['Service']['Status'] == 4
619
+ end
620
+ end
621
+
622
+ # Solaris services
623
+ class Svcs < ServiceManager
624
+ def initialize(service_name, service_ctl = nil)
625
+ @service_ctl = service_ctl || 'svcs'
626
+ super
627
+ end
628
+
629
+ def info(service_name)
630
+ # get the status of runit service
631
+ cmd = inspec.command("#{service_ctl} -l #{service_name}")
632
+ return nil if cmd.exit_status != 0
633
+
634
+ params = SimpleConfig.new(
635
+ cmd.stdout.chomp,
636
+ assignment_regex: /^(\w+)\s*(.*)$/,
637
+ multiple_values: false,
638
+ ).params
639
+
640
+ installed = cmd.exit_status == 0
641
+ running = installed && (params['state'] == 'online')
642
+ enabled = installed && (params['enabled'] == 'true')
643
+
644
+ {
645
+ name: service_name,
646
+ description: params['name'],
647
+ installed: installed,
648
+ running: running,
649
+ enabled: enabled,
650
+ type: 'svcs',
651
+ }
652
+ end
653
+ end
654
+
655
+ # specific resources for specific service managers
656
+
657
+ class SystemdService < Service
658
+ name 'systemd_service'
659
+ supports platform: 'unix'
660
+ desc 'Use the systemd_service InSpec audit resource to test if the named service (controlled by systemd) is installed, running and/or enabled.'
661
+ example "
662
+ # to override service mgmt auto-detection
663
+ describe systemd_service('service_name') do
664
+ it { should be_installed }
665
+ it { should be_enabled }
666
+ it { should be_running }
667
+ end
668
+
669
+ # to set a non-standard systemctl path
670
+ describe systemd_service('service_name', '/path/to/systemctl') do
671
+ it { should be_running }
672
+ end
673
+ "
674
+
675
+ def select_service_mgmt
676
+ Systemd.new(inspec, service_ctl)
677
+ end
678
+ end
679
+
680
+ class UpstartService < Service
681
+ name 'upstart_service'
682
+ supports platform: 'unix'
683
+ desc 'Use the upstart_service InSpec audit resource to test if the named service (controlled by upstart) is installed, running and/or enabled.'
684
+ example "
685
+ # to override service mgmt auto-detection
686
+ describe upstart_service('service_name') do
687
+ it { should be_installed }
688
+ it { should be_enabled }
689
+ it { should be_running }
690
+ end
691
+
692
+ # to set a non-standard initctl path
693
+ describe upstart_service('service_name', '/path/to/initctl') do
694
+ it { should be_running }
695
+ end
696
+ "
697
+
698
+ def select_service_mgmt
699
+ Upstart.new(inspec, service_ctl)
700
+ end
701
+ end
702
+
703
+ class SysVService < Service
704
+ name 'sysv_service'
705
+ supports platform: 'unix'
706
+ desc 'Use the sysv_service InSpec audit resource to test if the named service (controlled by SysV) is installed, running and/or enabled.'
707
+ example "
708
+ # to override service mgmt auto-detection
709
+ describe sysv_service('service_name') do
710
+ it { should be_installed }
711
+ it { should be_enabled }
712
+ it { should be_running }
713
+ end
714
+
715
+ # to set a non-standard service path
716
+ describe sysv_service('service_name', '/path/to/service') do
717
+ it { should be_running }
718
+ end
719
+ "
720
+
721
+ def select_service_mgmt
722
+ SysV.new(inspec, service_ctl)
723
+ end
724
+ end
725
+
726
+ class BSDService < Service
727
+ name 'bsd_service'
728
+ supports platform: 'unix'
729
+ desc 'Use the bsd_service InSpec audit resource to test if the named service (controlled by BSD init) is installed, running and/or enabled.'
730
+ example "
731
+ # to override service mgmt auto-detection
732
+ describe bsd_service('service_name') do
733
+ it { should be_installed }
734
+ it { should be_enabled }
735
+ it { should be_running }
736
+ end
737
+
738
+ # to set a non-standard service path
739
+ describe bsd_service('service_name', '/path/to/service') do
740
+ it { should be_running }
741
+ end
742
+ "
743
+
744
+ def select_service_mgmt
745
+ BSDInit.new(inspec, service_ctl)
746
+ end
747
+ end
748
+
749
+ class LaunchdService < Service
750
+ name 'launchd_service'
751
+ supports platform: 'unix'
752
+ desc 'Use the launchd_service InSpec audit resource to test if the named service (controlled by launchd) is installed, running and/or enabled.'
753
+ example "
754
+ # to override service mgmt auto-detection
755
+ describe launchd_service('service_name') do
756
+ it { should be_installed }
757
+ it { should be_enabled }
758
+ it { should be_running }
759
+ end
760
+
761
+ # to set a non-standard launchctl path
762
+ describe launchd_service('service_name', '/path/to/launchctl') do
763
+ it { should be_running }
764
+ end
765
+ "
766
+
767
+ def select_service_mgmt
768
+ LaunchCtl.new(inspec, service_ctl)
769
+ end
770
+ end
771
+
772
+ class RunitService < Service
773
+ name 'runit_service'
774
+ supports platform: 'unix'
775
+ desc 'Use the runit_service InSpec audit resource to test if the named service (controlled by runit) is installed, running and/or enabled.'
776
+ example "
777
+ # to override service mgmt auto-detection
778
+ describe runit_service('service_name') do
779
+ it { should be_installed }
780
+ it { should be_enabled }
781
+ it { should be_running }
782
+ end
783
+
784
+ # to set a non-standard sv path
785
+ describe runit_service('service_name', '/path/to/sv') do
786
+ it { should be_running }
787
+ end
788
+ "
789
+
790
+ def select_service_mgmt
791
+ Runit.new(inspec, service_ctl)
792
+ end
793
+ end
794
+ end