inspec 1.51.6 → 1.51.15
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.rubocop.yml +101 -101
- data/CHANGELOG.md +2915 -2902
- data/Gemfile +53 -53
- data/LICENSE +14 -14
- data/MAINTAINERS.md +31 -31
- data/MAINTAINERS.toml +47 -47
- data/README.md +419 -419
- data/Rakefile +167 -167
- data/bin/inspec +12 -12
- data/docs/.gitignore +2 -2
- data/docs/README.md +40 -40
- data/docs/dsl_inspec.md +258 -258
- data/docs/dsl_resource.md +93 -93
- data/docs/glossary.md +99 -99
- data/docs/habitat.md +191 -191
- data/docs/inspec_and_friends.md +107 -107
- data/docs/matchers.md +165 -165
- data/docs/migration.md +293 -293
- data/docs/plugin_kitchen_inspec.md +49 -49
- data/docs/profiles.md +370 -370
- data/docs/resources/aide_conf.md.erb +78 -78
- data/docs/resources/apache.md.erb +66 -66
- data/docs/resources/apache_conf.md.erb +67 -67
- data/docs/resources/apt.md.erb +70 -70
- data/docs/resources/audit_policy.md.erb +46 -46
- data/docs/resources/auditd.md.erb +78 -78
- data/docs/resources/auditd_conf.md.erb +68 -68
- data/docs/resources/auditd_rules.md.erb +116 -116
- data/docs/resources/bash.md.erb +74 -74
- data/docs/resources/bond.md.erb +89 -89
- data/docs/resources/bridge.md.erb +54 -54
- data/docs/resources/bsd_service.md.erb +65 -65
- data/docs/resources/command.md.erb +137 -137
- data/docs/resources/cpan.md.erb +77 -77
- data/docs/resources/cran.md.erb +63 -63
- data/docs/resources/crontab.md.erb +87 -87
- data/docs/resources/csv.md.erb +53 -53
- data/docs/resources/dh_params.md.erb +216 -216
- data/docs/resources/directory.md.erb +28 -28
- data/docs/resources/docker.md.erb +163 -163
- data/docs/resources/docker_container.md.erb +99 -99
- data/docs/resources/docker_image.md.erb +93 -93
- data/docs/resources/docker_service.md.erb +113 -113
- data/docs/resources/elasticsearch.md.erb +230 -230
- data/docs/resources/etc_fstab.md.erb +124 -124
- data/docs/resources/etc_group.md.erb +74 -74
- data/docs/resources/etc_hosts.md.erb +75 -75
- data/docs/resources/etc_hosts_allow.md.erb +73 -73
- data/docs/resources/etc_hosts_deny.md.erb +73 -73
- data/docs/resources/file.md.erb +512 -512
- data/docs/resources/filesystem.md.erb +40 -40
- data/docs/resources/firewalld.md.erb +105 -105
- data/docs/resources/gem.md.erb +78 -78
- data/docs/resources/group.md.erb +60 -60
- data/docs/resources/grub_conf.md.erb +101 -100
- data/docs/resources/host.md.erb +77 -77
- data/docs/resources/http.md.erb +104 -98
- data/docs/resources/iis_app.md.erb +120 -116
- data/docs/resources/iis_site.md.erb +132 -128
- data/docs/resources/inetd_conf.md.erb +95 -84
- data/docs/resources/ini.md.erb +72 -69
- data/docs/resources/interface.md.erb +55 -46
- data/docs/resources/iptables.md.erb +63 -63
- data/docs/resources/json.md.erb +61 -61
- data/docs/resources/kernel_module.md.erb +106 -106
- data/docs/resources/kernel_parameter.md.erb +58 -58
- data/docs/resources/key_rsa.md.erb +73 -73
- data/docs/resources/launchd_service.md.erb +56 -56
- data/docs/resources/limits_conf.md.erb +66 -66
- data/docs/resources/login_def.md.erb +62 -62
- data/docs/resources/mount.md.erb +68 -68
- data/docs/resources/mssql_session.md.erb +59 -59
- data/docs/resources/mysql_conf.md.erb +98 -98
- data/docs/resources/mysql_session.md.erb +73 -73
- data/docs/resources/nginx.md.erb +78 -78
- data/docs/resources/nginx_conf.md.erb +127 -127
- data/docs/resources/npm.md.erb +59 -59
- data/docs/resources/ntp_conf.md.erb +59 -59
- data/docs/resources/oneget.md.erb +52 -52
- data/docs/resources/oracledb_session.md.erb +51 -51
- data/docs/resources/os.md.erb +140 -140
- data/docs/resources/os_env.md.erb +77 -77
- data/docs/resources/package.md.erb +119 -119
- data/docs/resources/packages.md.erb +66 -66
- data/docs/resources/parse_config.md.erb +102 -102
- data/docs/resources/parse_config_file.md.erb +137 -137
- data/docs/resources/passwd.md.erb +140 -140
- data/docs/resources/pip.md.erb +66 -66
- data/docs/resources/port.md.erb +136 -136
- data/docs/resources/postgres_conf.md.erb +78 -78
- data/docs/resources/postgres_hba_conf.md.erb +92 -92
- data/docs/resources/postgres_ident_conf.md.erb +75 -75
- data/docs/resources/postgres_session.md.erb +68 -68
- data/docs/resources/powershell.md.erb +101 -101
- data/docs/resources/processes.md.erb +107 -107
- data/docs/resources/rabbitmq_config.md.erb +40 -40
- data/docs/resources/registry_key.md.erb +157 -157
- data/docs/resources/runit_service.md.erb +56 -56
- data/docs/resources/security_policy.md.erb +46 -46
- data/docs/resources/service.md.erb +120 -120
- data/docs/resources/shadow.md.erb +143 -143
- data/docs/resources/ssh_config.md.erb +79 -79
- data/docs/resources/sshd_config.md.erb +82 -82
- data/docs/resources/ssl.md.erb +118 -118
- data/docs/resources/sys_info.md.erb +41 -41
- data/docs/resources/systemd_service.md.erb +56 -56
- data/docs/resources/sysv_service.md.erb +56 -56
- data/docs/resources/upstart_service.md.erb +56 -56
- data/docs/resources/user.md.erb +139 -139
- data/docs/resources/users.md.erb +126 -126
- data/docs/resources/vbscript.md.erb +54 -54
- data/docs/resources/virtualization.md.erb +56 -56
- data/docs/resources/windows_feature.md.erb +46 -46
- data/docs/resources/windows_hotfix.md.erb +52 -52
- data/docs/resources/windows_task.md.erb +89 -89
- data/docs/resources/wmi.md.erb +80 -80
- data/docs/resources/x509_certificate.md.erb +150 -150
- data/docs/resources/xinetd_conf.md.erb +155 -155
- data/docs/resources/xml.md.erb +84 -84
- data/docs/resources/yaml.md.erb +68 -68
- data/docs/resources/yum.md.erb +97 -97
- data/docs/resources/zfs_dataset.md.erb +52 -52
- data/docs/resources/zfs_pool.md.erb +46 -46
- data/docs/ruby_usage.md +203 -203
- data/docs/shared/matcher_be.md.erb +1 -1
- data/docs/shared/matcher_cmp.md.erb +43 -43
- data/docs/shared/matcher_eq.md.erb +3 -3
- data/docs/shared/matcher_include.md.erb +1 -1
- data/docs/shared/matcher_match.md.erb +1 -1
- data/docs/shell.md +172 -172
- data/examples/README.md +8 -8
- data/examples/inheritance/README.md +65 -65
- data/examples/inheritance/controls/example.rb +14 -14
- data/examples/inheritance/inspec.yml +15 -15
- data/examples/kitchen-ansible/.kitchen.yml +25 -25
- data/examples/kitchen-ansible/Gemfile +19 -19
- data/examples/kitchen-ansible/README.md +53 -53
- data/examples/kitchen-ansible/files/nginx.repo +6 -6
- data/examples/kitchen-ansible/tasks/main.yml +16 -16
- data/examples/kitchen-ansible/test/integration/default/default.yml +5 -5
- data/examples/kitchen-ansible/test/integration/default/web_spec.rb +28 -28
- data/examples/kitchen-chef/.kitchen.yml +20 -20
- data/examples/kitchen-chef/Berksfile +3 -3
- data/examples/kitchen-chef/Gemfile +19 -19
- data/examples/kitchen-chef/README.md +27 -27
- data/examples/kitchen-chef/metadata.rb +7 -7
- data/examples/kitchen-chef/recipes/default.rb +6 -6
- data/examples/kitchen-chef/recipes/nginx.rb +30 -30
- data/examples/kitchen-chef/test/integration/default/web_spec.rb +28 -28
- data/examples/kitchen-puppet/.kitchen.yml +22 -22
- data/examples/kitchen-puppet/Gemfile +20 -20
- data/examples/kitchen-puppet/Puppetfile +25 -25
- data/examples/kitchen-puppet/README.md +53 -53
- data/examples/kitchen-puppet/manifests/site.pp +33 -33
- data/examples/kitchen-puppet/metadata.json +11 -11
- data/examples/kitchen-puppet/test/integration/default/web_spec.rb +28 -28
- data/examples/meta-profile/README.md +37 -37
- data/examples/meta-profile/controls/example.rb +13 -13
- data/examples/meta-profile/inspec.yml +13 -13
- data/examples/profile-attribute.yml +2 -2
- data/examples/profile-attribute/README.md +14 -14
- data/examples/profile-attribute/controls/example.rb +11 -11
- data/examples/profile-attribute/inspec.yml +8 -8
- data/examples/profile-sensitive/README.md +29 -29
- data/examples/profile-sensitive/controls/sensitive-failures.rb +9 -9
- data/examples/profile-sensitive/controls/sensitive.rb +9 -9
- data/examples/profile-sensitive/inspec.yml +8 -8
- data/examples/profile/README.md +48 -48
- data/examples/profile/controls/example.rb +23 -23
- data/examples/profile/controls/gordon.rb +36 -36
- data/examples/profile/controls/meta.rb +34 -34
- data/examples/profile/inspec.yml +10 -10
- data/examples/profile/libraries/gordon_config.rb +53 -53
- data/inspec.gemspec +47 -47
- data/lib/bundles/README.md +3 -3
- data/lib/bundles/inspec-artifact.rb +7 -7
- data/lib/bundles/inspec-artifact/README.md +1 -1
- data/lib/bundles/inspec-artifact/cli.rb +277 -277
- data/lib/bundles/inspec-compliance.rb +16 -16
- data/lib/bundles/inspec-compliance/.kitchen.yml +20 -20
- data/lib/bundles/inspec-compliance/README.md +185 -185
- data/lib/bundles/inspec-compliance/api.rb +316 -316
- data/lib/bundles/inspec-compliance/api/login.rb +152 -152
- data/lib/bundles/inspec-compliance/bootstrap.sh +41 -41
- data/lib/bundles/inspec-compliance/cli.rb +277 -277
- data/lib/bundles/inspec-compliance/configuration.rb +103 -103
- data/lib/bundles/inspec-compliance/http.rb +86 -86
- data/lib/bundles/inspec-compliance/support.rb +36 -36
- data/lib/bundles/inspec-compliance/target.rb +98 -98
- data/lib/bundles/inspec-compliance/test/integration/default/cli.rb +93 -93
- data/lib/bundles/inspec-habitat.rb +12 -12
- data/lib/bundles/inspec-habitat/cli.rb +36 -36
- data/lib/bundles/inspec-habitat/log.rb +10 -10
- data/lib/bundles/inspec-habitat/profile.rb +390 -390
- data/lib/bundles/inspec-init.rb +8 -8
- data/lib/bundles/inspec-init/README.md +31 -31
- data/lib/bundles/inspec-init/cli.rb +97 -97
- data/lib/bundles/inspec-init/templates/profile/README.md +3 -3
- data/lib/bundles/inspec-init/templates/profile/controls/example.rb +19 -19
- data/lib/bundles/inspec-init/templates/profile/inspec.yml +8 -8
- data/lib/bundles/inspec-supermarket.rb +13 -13
- data/lib/bundles/inspec-supermarket/README.md +45 -45
- data/lib/bundles/inspec-supermarket/api.rb +84 -84
- data/lib/bundles/inspec-supermarket/cli.rb +65 -65
- data/lib/bundles/inspec-supermarket/target.rb +34 -34
- data/lib/fetchers/git.rb +163 -163
- data/lib/fetchers/local.rb +74 -74
- data/lib/fetchers/mock.rb +35 -35
- data/lib/fetchers/url.rb +204 -204
- data/lib/inspec.rb +24 -24
- data/lib/inspec/archive/tar.rb +29 -29
- data/lib/inspec/archive/zip.rb +19 -19
- data/lib/inspec/backend.rb +92 -92
- data/lib/inspec/base_cli.rb +324 -322
- data/lib/inspec/cached_fetcher.rb +66 -66
- data/lib/inspec/cli.rb +298 -298
- data/lib/inspec/completions/bash.sh.erb +45 -45
- data/lib/inspec/completions/fish.sh.erb +34 -34
- data/lib/inspec/completions/zsh.sh.erb +61 -61
- data/lib/inspec/control_eval_context.rb +179 -179
- data/lib/inspec/dependencies/cache.rb +72 -72
- data/lib/inspec/dependencies/dependency_set.rb +92 -92
- data/lib/inspec/dependencies/lockfile.rb +115 -115
- data/lib/inspec/dependencies/requirement.rb +123 -123
- data/lib/inspec/dependencies/resolver.rb +86 -86
- data/lib/inspec/describe.rb +27 -27
- data/lib/inspec/dsl.rb +66 -66
- data/lib/inspec/dsl_shared.rb +33 -33
- data/lib/inspec/env_printer.rb +157 -157
- data/lib/inspec/errors.rb +13 -13
- data/lib/inspec/exceptions.rb +12 -12
- data/lib/inspec/expect.rb +45 -45
- data/lib/inspec/fetcher.rb +45 -45
- data/lib/inspec/file_provider.rb +275 -275
- data/lib/inspec/formatters.rb +3 -3
- data/lib/inspec/formatters/base.rb +208 -208
- data/lib/inspec/formatters/json_rspec.rb +20 -20
- data/lib/inspec/formatters/show_progress.rb +12 -12
- data/lib/inspec/library_eval_context.rb +58 -58
- data/lib/inspec/log.rb +11 -11
- data/lib/inspec/metadata.rb +253 -253
- data/lib/inspec/method_source.rb +24 -24
- data/lib/inspec/objects.rb +14 -14
- data/lib/inspec/objects/attribute.rb +65 -65
- data/lib/inspec/objects/control.rb +61 -61
- data/lib/inspec/objects/describe.rb +92 -92
- data/lib/inspec/objects/each_loop.rb +36 -36
- data/lib/inspec/objects/list.rb +15 -15
- data/lib/inspec/objects/or_test.rb +40 -40
- data/lib/inspec/objects/ruby_helper.rb +15 -15
- data/lib/inspec/objects/tag.rb +27 -27
- data/lib/inspec/objects/test.rb +87 -87
- data/lib/inspec/objects/value.rb +27 -27
- data/lib/inspec/plugins.rb +60 -60
- data/lib/inspec/plugins/cli.rb +24 -24
- data/lib/inspec/plugins/fetcher.rb +86 -86
- data/lib/inspec/plugins/resource.rb +132 -132
- data/lib/inspec/plugins/secret.rb +15 -15
- data/lib/inspec/plugins/source_reader.rb +40 -40
- data/lib/inspec/polyfill.rb +12 -12
- data/lib/inspec/profile.rb +510 -510
- data/lib/inspec/profile_context.rb +207 -207
- data/lib/inspec/profile_vendor.rb +66 -66
- data/lib/inspec/reporters.rb +50 -33
- data/lib/inspec/reporters/base.rb +24 -23
- data/lib/inspec/reporters/cli.rb +395 -395
- data/lib/inspec/reporters/json.rb +134 -132
- data/lib/inspec/reporters/json_min.rb +48 -44
- data/lib/inspec/reporters/junit.rb +77 -77
- data/lib/inspec/require_loader.rb +33 -33
- data/lib/inspec/resource.rb +176 -176
- data/lib/inspec/rule.rb +266 -266
- data/lib/inspec/runner.rb +340 -337
- data/lib/inspec/runner_mock.rb +41 -41
- data/lib/inspec/runner_rspec.rb +163 -185
- data/lib/inspec/runtime_profile.rb +26 -26
- data/lib/inspec/schema.rb +186 -186
- data/lib/inspec/secrets.rb +19 -19
- data/lib/inspec/secrets/yaml.rb +30 -30
- data/lib/inspec/shell.rb +223 -223
- data/lib/inspec/shell_detector.rb +90 -90
- data/lib/inspec/source_reader.rb +29 -29
- data/lib/inspec/version.rb +8 -8
- data/lib/matchers/matchers.rb +397 -397
- data/lib/resources/aide_conf.rb +160 -160
- data/lib/resources/apache.rb +49 -49
- data/lib/resources/apache_conf.rb +158 -158
- data/lib/resources/apt.rb +150 -150
- data/lib/resources/audit_policy.rb +64 -64
- data/lib/resources/auditd.rb +233 -233
- data/lib/resources/auditd_conf.rb +56 -56
- data/lib/resources/auditd_rules.rb +205 -205
- data/lib/resources/bash.rb +36 -36
- data/lib/resources/bond.rb +69 -69
- data/lib/resources/bridge.rb +123 -123
- data/lib/resources/command.rb +69 -69
- data/lib/resources/cpan.rb +60 -60
- data/lib/resources/cran.rb +66 -66
- data/lib/resources/crontab.rb +169 -169
- data/lib/resources/csv.rb +58 -58
- data/lib/resources/dh_params.rb +83 -83
- data/lib/resources/directory.rb +25 -25
- data/lib/resources/docker.rb +239 -239
- data/lib/resources/docker_container.rb +92 -92
- data/lib/resources/docker_image.rb +86 -86
- data/lib/resources/docker_object.rb +57 -57
- data/lib/resources/docker_service.rb +94 -94
- data/lib/resources/elasticsearch.rb +168 -168
- data/lib/resources/etc_fstab.rb +102 -102
- data/lib/resources/etc_group.rb +157 -157
- data/lib/resources/etc_hosts.rb +81 -81
- data/lib/resources/etc_hosts_allow_deny.rb +122 -122
- data/lib/resources/file.rb +298 -298
- data/lib/resources/filesystem.rb +31 -31
- data/lib/resources/firewalld.rb +144 -144
- data/lib/resources/gem.rb +71 -71
- data/lib/resources/groups.rb +213 -213
- data/lib/resources/grub_conf.rb +237 -237
- data/lib/resources/host.rb +300 -300
- data/lib/resources/http.rb +252 -252
- data/lib/resources/iis_app.rb +103 -103
- data/lib/resources/iis_site.rb +147 -147
- data/lib/resources/inetd_conf.rb +63 -63
- data/lib/resources/ini.rb +29 -29
- data/lib/resources/interface.rb +130 -130
- data/lib/resources/iptables.rb +70 -70
- data/lib/resources/json.rb +115 -115
- data/lib/resources/kernel_module.rb +110 -110
- data/lib/resources/kernel_parameter.rb +58 -58
- data/lib/resources/key_rsa.rb +67 -67
- data/lib/resources/limits_conf.rb +56 -56
- data/lib/resources/login_def.rb +67 -67
- data/lib/resources/mount.rb +90 -90
- data/lib/resources/mssql_session.rb +103 -103
- data/lib/resources/mysql.rb +82 -82
- data/lib/resources/mysql_conf.rb +133 -133
- data/lib/resources/mysql_session.rb +72 -72
- data/lib/resources/nginx.rb +97 -97
- data/lib/resources/nginx_conf.rb +228 -228
- data/lib/resources/npm.rb +48 -48
- data/lib/resources/ntp_conf.rb +59 -59
- data/lib/resources/oneget.rb +72 -72
- data/lib/resources/oracledb_session.rb +140 -140
- data/lib/resources/os.rb +46 -46
- data/lib/resources/os_env.rb +76 -76
- data/lib/resources/package.rb +357 -357
- data/lib/resources/packages.rb +112 -112
- data/lib/resources/parse_config.rb +116 -116
- data/lib/resources/passwd.rb +96 -96
- data/lib/resources/pip.rb +89 -89
- data/lib/resources/platform.rb +112 -112
- data/lib/resources/port.rb +771 -771
- data/lib/resources/postgres.rb +132 -132
- data/lib/resources/postgres_conf.rb +122 -122
- data/lib/resources/postgres_hba_conf.rb +101 -101
- data/lib/resources/postgres_ident_conf.rb +79 -79
- data/lib/resources/postgres_session.rb +72 -72
- data/lib/resources/powershell.rb +58 -58
- data/lib/resources/processes.rb +204 -204
- data/lib/resources/rabbitmq_conf.rb +53 -53
- data/lib/resources/registry_key.rb +296 -296
- data/lib/resources/security_policy.rb +181 -181
- data/lib/resources/service.rb +784 -784
- data/lib/resources/shadow.rb +141 -141
- data/lib/resources/ssh_conf.rb +102 -102
- data/lib/resources/ssl.rb +99 -99
- data/lib/resources/sys_info.rb +26 -26
- data/lib/resources/toml.rb +32 -32
- data/lib/resources/users.rb +652 -652
- data/lib/resources/vbscript.rb +70 -70
- data/lib/resources/virtualization.rb +251 -251
- data/lib/resources/windows_feature.rb +85 -85
- data/lib/resources/windows_hotfix.rb +35 -35
- data/lib/resources/windows_task.rb +106 -106
- data/lib/resources/wmi.rb +114 -114
- data/lib/resources/x509_certificate.rb +143 -143
- data/lib/resources/xinetd.rb +112 -112
- data/lib/resources/xml.rb +45 -45
- data/lib/resources/yaml.rb +45 -45
- data/lib/resources/yum.rb +181 -181
- data/lib/resources/zfs_dataset.rb +60 -60
- data/lib/resources/zfs_pool.rb +49 -49
- data/lib/source_readers/flat.rb +39 -39
- data/lib/source_readers/inspec.rb +75 -75
- data/lib/utils/command_wrapper.rb +27 -27
- data/lib/utils/convert.rb +12 -12
- data/lib/utils/database_helpers.rb +77 -77
- data/lib/utils/erlang_parser.rb +192 -192
- data/lib/utils/filter.rb +272 -272
- data/lib/utils/filter_array.rb +27 -27
- data/lib/utils/find_files.rb +44 -44
- data/lib/utils/hash.rb +41 -41
- data/lib/utils/json_log.rb +18 -18
- data/lib/utils/latest_version.rb +22 -22
- data/lib/utils/modulator.rb +12 -12
- data/lib/utils/nginx_parser.rb +85 -85
- data/lib/utils/object_traversal.rb +49 -49
- data/lib/utils/parser.rb +274 -274
- data/lib/utils/plugin_registry.rb +93 -93
- data/lib/utils/simpleconfig.rb +132 -132
- data/lib/utils/spdx.rb +13 -13
- data/lib/utils/spdx.txt +343 -343
- metadata +2 -2
data/lib/resources/os.rb
CHANGED
@@ -1,46 +1,46 @@
|
|
1
|
-
# encoding: utf-8
|
2
|
-
# author: Dominik Richter
|
3
|
-
# author: Christoph Hartmann
|
4
|
-
|
5
|
-
require 'resources/platform'
|
6
|
-
|
7
|
-
module Inspec::Resources
|
8
|
-
class OSResource < PlatformResource
|
9
|
-
name 'os'
|
10
|
-
desc 'Use the os InSpec audit resource to test the platform on which the system is running.'
|
11
|
-
example "
|
12
|
-
describe os[:family] do
|
13
|
-
it { should eq 'redhat' }
|
14
|
-
end
|
15
|
-
|
16
|
-
describe os.redhat? do
|
17
|
-
it { should eq true }
|
18
|
-
end
|
19
|
-
|
20
|
-
describe os.linux? do
|
21
|
-
it { should eq true }
|
22
|
-
end
|
23
|
-
"
|
24
|
-
|
25
|
-
# reuse helper methods from backend
|
26
|
-
%w{aix? redhat? debian? suse? bsd? solaris? linux? unix? windows? hpux? darwin?}.each do |os_family|
|
27
|
-
define_method(os_family.to_sym) do
|
28
|
-
@platform.send(os_family)
|
29
|
-
end
|
30
|
-
end
|
31
|
-
|
32
|
-
# helper to collect a hash object easily
|
33
|
-
def params
|
34
|
-
{
|
35
|
-
name: name,
|
36
|
-
family: @platform[:family],
|
37
|
-
release: @platform[:release],
|
38
|
-
arch: @platform[:arch],
|
39
|
-
}
|
40
|
-
end
|
41
|
-
|
42
|
-
def to_s
|
43
|
-
'Operating System Detection'
|
44
|
-
end
|
45
|
-
end
|
46
|
-
end
|
1
|
+
# encoding: utf-8
|
2
|
+
# author: Dominik Richter
|
3
|
+
# author: Christoph Hartmann
|
4
|
+
|
5
|
+
require 'resources/platform'
|
6
|
+
|
7
|
+
module Inspec::Resources
|
8
|
+
class OSResource < PlatformResource
|
9
|
+
name 'os'
|
10
|
+
desc 'Use the os InSpec audit resource to test the platform on which the system is running.'
|
11
|
+
example "
|
12
|
+
describe os[:family] do
|
13
|
+
it { should eq 'redhat' }
|
14
|
+
end
|
15
|
+
|
16
|
+
describe os.redhat? do
|
17
|
+
it { should eq true }
|
18
|
+
end
|
19
|
+
|
20
|
+
describe os.linux? do
|
21
|
+
it { should eq true }
|
22
|
+
end
|
23
|
+
"
|
24
|
+
|
25
|
+
# reuse helper methods from backend
|
26
|
+
%w{aix? redhat? debian? suse? bsd? solaris? linux? unix? windows? hpux? darwin?}.each do |os_family|
|
27
|
+
define_method(os_family.to_sym) do
|
28
|
+
@platform.send(os_family)
|
29
|
+
end
|
30
|
+
end
|
31
|
+
|
32
|
+
# helper to collect a hash object easily
|
33
|
+
def params
|
34
|
+
{
|
35
|
+
name: name,
|
36
|
+
family: @platform[:family],
|
37
|
+
release: @platform[:release],
|
38
|
+
arch: @platform[:arch],
|
39
|
+
}
|
40
|
+
end
|
41
|
+
|
42
|
+
def to_s
|
43
|
+
'Operating System Detection'
|
44
|
+
end
|
45
|
+
end
|
46
|
+
end
|
data/lib/resources/os_env.rb
CHANGED
@@ -1,76 +1,76 @@
|
|
1
|
-
# encoding: utf-8
|
2
|
-
# copyright: 2015, Vulcano Security GmbH
|
3
|
-
# author: Christoph Hartmann
|
4
|
-
# author: Dominik Richter
|
5
|
-
|
6
|
-
# Usage:
|
7
|
-
#
|
8
|
-
# describe os_env('PATH') do
|
9
|
-
# its('split') { should_not include('') }
|
10
|
-
# its('split') { should_not include('.') }
|
11
|
-
# end
|
12
|
-
|
13
|
-
require 'utils/simpleconfig'
|
14
|
-
|
15
|
-
module Inspec::Resources
|
16
|
-
class OsEnv < Inspec.resource(1)
|
17
|
-
name 'os_env'
|
18
|
-
desc 'Use the os_env InSpec audit resource to test the environment variables for the platform on which the system is running.'
|
19
|
-
example "
|
20
|
-
describe os_env('VARIABLE') do
|
21
|
-
its('matcher') { should eq 1 }
|
22
|
-
end
|
23
|
-
"
|
24
|
-
|
25
|
-
attr_reader :content
|
26
|
-
def initialize(env = nil)
|
27
|
-
@osenv = env
|
28
|
-
end
|
29
|
-
|
30
|
-
def split
|
31
|
-
# we can't take advantage of `File::PATH_SEPARATOR` as code is
|
32
|
-
# evaluated on the host machine
|
33
|
-
path_separator = inspec.os.windows? ? ';' : ':'
|
34
|
-
# -1 is required to catch cases like dir1::dir2:
|
35
|
-
# where we have a trailing :
|
36
|
-
content.nil? ? [] : content.split(path_separator, -1)
|
37
|
-
end
|
38
|
-
|
39
|
-
def content
|
40
|
-
return @content if defined?(@content)
|
41
|
-
@content = value_for(@osenv) unless @osenv.nil?
|
42
|
-
end
|
43
|
-
|
44
|
-
def to_s
|
45
|
-
if @osenv.nil?
|
46
|
-
'Environment variables'
|
47
|
-
else
|
48
|
-
"Environment variable #{@osenv}"
|
49
|
-
end
|
50
|
-
end
|
51
|
-
|
52
|
-
private
|
53
|
-
|
54
|
-
def value_for(env)
|
55
|
-
command = if inspec.os.windows?
|
56
|
-
"${Env:#{env}}"
|
57
|
-
else
|
58
|
-
'env'
|
59
|
-
end
|
60
|
-
|
61
|
-
out = inspec.command(command)
|
62
|
-
|
63
|
-
unless out.exit_status == 0
|
64
|
-
skip_resource "Can't read environment variables on #{inspec.os.name}. "\
|
65
|
-
"Tried `#{command}` which returned #{out.exit_status}"
|
66
|
-
end
|
67
|
-
|
68
|
-
if inspec.os.windows?
|
69
|
-
out.stdout.strip
|
70
|
-
else
|
71
|
-
params = SimpleConfig.new(out.stdout).params
|
72
|
-
params[env]
|
73
|
-
end
|
74
|
-
end
|
75
|
-
end
|
76
|
-
end
|
1
|
+
# encoding: utf-8
|
2
|
+
# copyright: 2015, Vulcano Security GmbH
|
3
|
+
# author: Christoph Hartmann
|
4
|
+
# author: Dominik Richter
|
5
|
+
|
6
|
+
# Usage:
|
7
|
+
#
|
8
|
+
# describe os_env('PATH') do
|
9
|
+
# its('split') { should_not include('') }
|
10
|
+
# its('split') { should_not include('.') }
|
11
|
+
# end
|
12
|
+
|
13
|
+
require 'utils/simpleconfig'
|
14
|
+
|
15
|
+
module Inspec::Resources
|
16
|
+
class OsEnv < Inspec.resource(1)
|
17
|
+
name 'os_env'
|
18
|
+
desc 'Use the os_env InSpec audit resource to test the environment variables for the platform on which the system is running.'
|
19
|
+
example "
|
20
|
+
describe os_env('VARIABLE') do
|
21
|
+
its('matcher') { should eq 1 }
|
22
|
+
end
|
23
|
+
"
|
24
|
+
|
25
|
+
attr_reader :content
|
26
|
+
def initialize(env = nil)
|
27
|
+
@osenv = env
|
28
|
+
end
|
29
|
+
|
30
|
+
def split
|
31
|
+
# we can't take advantage of `File::PATH_SEPARATOR` as code is
|
32
|
+
# evaluated on the host machine
|
33
|
+
path_separator = inspec.os.windows? ? ';' : ':'
|
34
|
+
# -1 is required to catch cases like dir1::dir2:
|
35
|
+
# where we have a trailing :
|
36
|
+
content.nil? ? [] : content.split(path_separator, -1)
|
37
|
+
end
|
38
|
+
|
39
|
+
def content
|
40
|
+
return @content if defined?(@content)
|
41
|
+
@content = value_for(@osenv) unless @osenv.nil?
|
42
|
+
end
|
43
|
+
|
44
|
+
def to_s
|
45
|
+
if @osenv.nil?
|
46
|
+
'Environment variables'
|
47
|
+
else
|
48
|
+
"Environment variable #{@osenv}"
|
49
|
+
end
|
50
|
+
end
|
51
|
+
|
52
|
+
private
|
53
|
+
|
54
|
+
def value_for(env)
|
55
|
+
command = if inspec.os.windows?
|
56
|
+
"${Env:#{env}}"
|
57
|
+
else
|
58
|
+
'env'
|
59
|
+
end
|
60
|
+
|
61
|
+
out = inspec.command(command)
|
62
|
+
|
63
|
+
unless out.exit_status == 0
|
64
|
+
skip_resource "Can't read environment variables on #{inspec.os.name}. "\
|
65
|
+
"Tried `#{command}` which returned #{out.exit_status}"
|
66
|
+
end
|
67
|
+
|
68
|
+
if inspec.os.windows?
|
69
|
+
out.stdout.strip
|
70
|
+
else
|
71
|
+
params = SimpleConfig.new(out.stdout).params
|
72
|
+
params[env]
|
73
|
+
end
|
74
|
+
end
|
75
|
+
end
|
76
|
+
end
|
data/lib/resources/package.rb
CHANGED
@@ -1,357 +1,357 @@
|
|
1
|
-
# encoding: utf-8
|
2
|
-
# author: Christoph Hartmann
|
3
|
-
# author: Dominik Richter
|
4
|
-
|
5
|
-
# Resource to determine package information
|
6
|
-
#
|
7
|
-
# Usage:
|
8
|
-
# describe package('nginx') do
|
9
|
-
# it { should be_installed }
|
10
|
-
# end
|
11
|
-
module Inspec::Resources
|
12
|
-
class Package < Inspec.resource(1)
|
13
|
-
name 'package'
|
14
|
-
desc 'Use the package InSpec audit resource to test if the named package and/or package version is installed on the system.'
|
15
|
-
example "
|
16
|
-
describe package('nginx') do
|
17
|
-
it { should be_installed }
|
18
|
-
it { should_not be_held } # for dpkg platforms that support holding a version from being upgraded
|
19
|
-
its('version') { should eq 1.9.5 }
|
20
|
-
end
|
21
|
-
"
|
22
|
-
|
23
|
-
def initialize(package_name, opts = {}) # rubocop:disable Metrics/AbcSize
|
24
|
-
@package_name = package_name
|
25
|
-
@name = @package_name
|
26
|
-
@cache = nil
|
27
|
-
# select package manager
|
28
|
-
@pkgman = nil
|
29
|
-
|
30
|
-
os = inspec.os
|
31
|
-
if os.debian?
|
32
|
-
@pkgman = Deb.new(inspec)
|
33
|
-
elsif os.redhat? || %w{suse amazon fedora}.include?(os[:family])
|
34
|
-
@pkgman = Rpm.new(inspec, opts)
|
35
|
-
elsif ['arch'].include?(os[:name])
|
36
|
-
@pkgman = Pacman.new(inspec)
|
37
|
-
elsif ['darwin'].include?(os[:family])
|
38
|
-
@pkgman = Brew.new(inspec)
|
39
|
-
elsif inspec.os.windows?
|
40
|
-
@pkgman = WindowsPkg.new(inspec)
|
41
|
-
elsif ['aix'].include?(os[:family])
|
42
|
-
@pkgman = BffPkg.new(inspec)
|
43
|
-
elsif os.solaris?
|
44
|
-
@pkgman = SolarisPkg.new(inspec)
|
45
|
-
elsif ['hpux'].include?(os[:family])
|
46
|
-
@pkgman = HpuxPkg.new(inspec)
|
47
|
-
else
|
48
|
-
raise Inspec::Exceptions::ResourceSkipped, 'The `package` resource is not supported on your OS yet.'
|
49
|
-
end
|
50
|
-
|
51
|
-
evaluate_missing_requirements
|
52
|
-
end
|
53
|
-
|
54
|
-
# returns true if the package is installed
|
55
|
-
def installed?(_provider = nil, _version = nil)
|
56
|
-
info[:installed] == true
|
57
|
-
end
|
58
|
-
|
59
|
-
# returns true it the package is held (if the OS supports it)
|
60
|
-
def held?(_provider = nil, _version = nil)
|
61
|
-
info[:held] == true
|
62
|
-
end
|
63
|
-
|
64
|
-
# returns the package description
|
65
|
-
def info
|
66
|
-
return @cache if !@cache.nil?
|
67
|
-
# All `@pkgman.info` methods return `{}`. This matches that
|
68
|
-
# behavior if `@pkgman` can't be determined, thus avoiding the
|
69
|
-
# `undefined method 'info' for nil:NilClass` error
|
70
|
-
return {} if @pkgman.nil?
|
71
|
-
@pkgman.info(@package_name)
|
72
|
-
end
|
73
|
-
|
74
|
-
# return the package version
|
75
|
-
def version
|
76
|
-
info = @pkgman.info(@package_name)
|
77
|
-
info[:version]
|
78
|
-
end
|
79
|
-
|
80
|
-
def to_s
|
81
|
-
"System Package #{@package_name}"
|
82
|
-
end
|
83
|
-
|
84
|
-
private
|
85
|
-
|
86
|
-
def evaluate_missing_requirements
|
87
|
-
missing_requirements_string = @pkgman.missing_requirements.uniq.join(', ')
|
88
|
-
return if missing_requirements_string.empty?
|
89
|
-
raise Inspec::Exceptions::ResourceSkipped, "The following requirements are not met for this resource: #{missing_requirements_string}"
|
90
|
-
end
|
91
|
-
end
|
92
|
-
|
93
|
-
class PkgManagement
|
94
|
-
attr_reader :inspec
|
95
|
-
def initialize(inspec)
|
96
|
-
@inspec = inspec
|
97
|
-
end
|
98
|
-
|
99
|
-
def missing_requirements
|
100
|
-
# Each provider can provide an Array of missing requirements that will be
|
101
|
-
# combined into a `ResourceSkipped` exception message.
|
102
|
-
[]
|
103
|
-
end
|
104
|
-
end
|
105
|
-
|
106
|
-
# Debian / Ubuntu
|
107
|
-
class Deb < PkgManagement
|
108
|
-
def info(package_name)
|
109
|
-
cmd = inspec.command("dpkg -s #{package_name}")
|
110
|
-
return {} if cmd.exit_status.to_i != 0
|
111
|
-
|
112
|
-
params = SimpleConfig.new(
|
113
|
-
cmd.stdout.chomp,
|
114
|
-
assignment_regex: /^\s*([^:]*?)\s*:\s*(.*?)\s*$/,
|
115
|
-
multiple_values: false,
|
116
|
-
).params
|
117
|
-
# If the package is installed, Status is "install ok installed"
|
118
|
-
# If the package is installed and marked hold, Status is "hold ok installed"
|
119
|
-
# If the package is removed and not purged, Status is "deinstall ok config-files" with exit_status 0
|
120
|
-
# If the package is purged cmd fails with non-zero exit status
|
121
|
-
{
|
122
|
-
name: params['Package'],
|
123
|
-
installed: params['Status'].split(' ')[2] == 'installed',
|
124
|
-
held: params['Status'].split(' ')[0] == 'hold',
|
125
|
-
version: params['Version'],
|
126
|
-
type: 'deb',
|
127
|
-
}
|
128
|
-
end
|
129
|
-
end
|
130
|
-
|
131
|
-
# RHEL family
|
132
|
-
class Rpm < PkgManagement
|
133
|
-
def initialize(inspec, opts)
|
134
|
-
super(inspec)
|
135
|
-
|
136
|
-
@dbpath = opts.fetch(:rpm_dbpath, nil)
|
137
|
-
end
|
138
|
-
|
139
|
-
def missing_requirements
|
140
|
-
missing_requirements = []
|
141
|
-
|
142
|
-
unless @dbpath.nil? || inspec.directory(@dbpath).directory?
|
143
|
-
missing_requirements << "RPMDB #{@dbpath} does not exist"
|
144
|
-
end
|
145
|
-
|
146
|
-
missing_requirements
|
147
|
-
end
|
148
|
-
|
149
|
-
def info(package_name)
|
150
|
-
rpm_cmd = rpm_command(package_name)
|
151
|
-
cmd = inspec.command(rpm_cmd)
|
152
|
-
# CentOS does not return an error code if the package is not installed,
|
153
|
-
# therefore we need to check for emptyness
|
154
|
-
return {} if cmd.exit_status.to_i != 0 || cmd.stdout.chomp.empty?
|
155
|
-
params = SimpleConfig.new(
|
156
|
-
cmd.stdout.chomp,
|
157
|
-
assignment_regex: /^\s*([^:]*?)\s*:\s*(.*?)\s*$/,
|
158
|
-
multiple_values: false,
|
159
|
-
).params
|
160
|
-
# On some (all?) systems, the linebreak before the vendor line is missing
|
161
|
-
if params['Version'] =~ /\s*Vendor:/
|
162
|
-
v = params['Version'].split(' ')[0]
|
163
|
-
else
|
164
|
-
v = params['Version']
|
165
|
-
end
|
166
|
-
# On some (all?) systems, the linebreak before the build line is missing
|
167
|
-
if params['Release'] =~ /\s*Build Date:/
|
168
|
-
r = params['Release'].split(' ')[0]
|
169
|
-
else
|
170
|
-
r = params['Release']
|
171
|
-
end
|
172
|
-
{
|
173
|
-
name: params['Name'],
|
174
|
-
installed: true,
|
175
|
-
version: "#{v}-#{r}",
|
176
|
-
type: 'rpm',
|
177
|
-
}
|
178
|
-
end
|
179
|
-
|
180
|
-
private
|
181
|
-
|
182
|
-
def rpm_command(package_name)
|
183
|
-
cmd = ''
|
184
|
-
cmd += 'rpm -qia'
|
185
|
-
cmd += " --dbpath #{@dbpath}" if @dbpath
|
186
|
-
cmd += ' ' + package_name
|
187
|
-
|
188
|
-
cmd
|
189
|
-
end
|
190
|
-
end
|
191
|
-
|
192
|
-
# MacOS / Darwin implementation
|
193
|
-
class Brew < PkgManagement
|
194
|
-
def info(package_name)
|
195
|
-
brew_path = inspec.command('brew').exist? ? 'brew' : '/usr/local/bin/brew'
|
196
|
-
cmd = inspec.command("#{brew_path} info --json=v1 #{package_name}")
|
197
|
-
return {} if cmd.exit_status.to_i != 0
|
198
|
-
# parse data
|
199
|
-
pkg = JSON.parse(cmd.stdout)[0]
|
200
|
-
{
|
201
|
-
name: pkg['name'],
|
202
|
-
installed: true,
|
203
|
-
version: pkg['installed'][0]['version'],
|
204
|
-
type: 'brew',
|
205
|
-
}
|
206
|
-
rescue JSON::ParserError => e
|
207
|
-
raise Inspec::Exceptions::ResourceFailed,
|
208
|
-
'Failed to parse JSON from `brew` command. ' \
|
209
|
-
"Error: #{e}"
|
210
|
-
end
|
211
|
-
end
|
212
|
-
|
213
|
-
# Arch Linux
|
214
|
-
class Pacman < PkgManagement
|
215
|
-
def info(package_name)
|
216
|
-
cmd = inspec.command("pacman -Qi #{package_name}")
|
217
|
-
return {} if cmd.exit_status.to_i != 0
|
218
|
-
|
219
|
-
params = SimpleConfig.new(
|
220
|
-
cmd.stdout.chomp,
|
221
|
-
assignment_regex: /^\s*([^:]*?)\s*:\s*(.*?)\s*$/,
|
222
|
-
multiple_values: false,
|
223
|
-
).params
|
224
|
-
|
225
|
-
{
|
226
|
-
name: params['Name'],
|
227
|
-
installed: true,
|
228
|
-
version: params['Version'],
|
229
|
-
type: 'pacman',
|
230
|
-
}
|
231
|
-
end
|
232
|
-
end
|
233
|
-
|
234
|
-
class HpuxPkg < PkgManagement
|
235
|
-
def info(package_name)
|
236
|
-
cmd = inspec.command("swlist -l product | grep #{package_name}")
|
237
|
-
return {} if cmd.exit_status.to_i != 0
|
238
|
-
pkg = cmd.stdout.strip.split(' ')
|
239
|
-
{
|
240
|
-
name: pkg[0],
|
241
|
-
installed: true,
|
242
|
-
version: pkg[1],
|
243
|
-
type: 'pkg',
|
244
|
-
}
|
245
|
-
end
|
246
|
-
end
|
247
|
-
|
248
|
-
# Determines the installed packages on Windows using the Windows package registry entries.
|
249
|
-
# @see: http://blogs.technet.com/b/heyscriptingguy/archive/2013/11/15/use-powershell-to-find-installed-software.aspx
|
250
|
-
class WindowsPkg < PkgManagement
|
251
|
-
def info(package_name)
|
252
|
-
search_paths = [
|
253
|
-
'HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall\*',
|
254
|
-
'HKCU:\SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall\*',
|
255
|
-
]
|
256
|
-
|
257
|
-
# add 64 bit search paths
|
258
|
-
if inspec.os.arch == 'x86_64'
|
259
|
-
search_paths << 'HKLM:\SOFTWARE\Wow6432Node\Microsoft\Windows\CurrentVersion\Uninstall\*'
|
260
|
-
search_paths << 'HKCU:\SOFTWARE\Wow6432Node\Microsoft\Windows\CurrentVersion\Uninstall\*'
|
261
|
-
end
|
262
|
-
|
263
|
-
# Find the package
|
264
|
-
cmd = inspec.command <<-EOF.gsub(/^\s*/, '')
|
265
|
-
Get-ItemProperty (@("#{search_paths.join('", "')}") | Where-Object { Test-Path $_ }) |
|
266
|
-
Where-Object { $_.DisplayName -like "#{package_name}" -or $_.PSChildName -like "#{package_name}" } |
|
267
|
-
Select-Object -Property DisplayName,DisplayVersion | ConvertTo-Json
|
268
|
-
EOF
|
269
|
-
|
270
|
-
begin
|
271
|
-
package = JSON.parse(cmd.stdout)
|
272
|
-
rescue JSON::ParserError => e
|
273
|
-
raise Inspec::Exceptions::ResourceFailed,
|
274
|
-
'Failed to parse JSON from PowerShell. ' \
|
275
|
-
"Error: #{e}"
|
276
|
-
end
|
277
|
-
|
278
|
-
# What if we match multiple packages? just pick the first one for now.
|
279
|
-
package = package[0] if package.is_a?(Array)
|
280
|
-
|
281
|
-
{
|
282
|
-
name: package['DisplayName'],
|
283
|
-
installed: true,
|
284
|
-
version: package['DisplayVersion'],
|
285
|
-
type: 'windows',
|
286
|
-
}
|
287
|
-
end
|
288
|
-
end
|
289
|
-
|
290
|
-
# AIX
|
291
|
-
class BffPkg < PkgManagement
|
292
|
-
def info(package_name)
|
293
|
-
cmd = inspec.command("lslpp -cL #{package_name}")
|
294
|
-
return {} if cmd.exit_status.to_i != 0
|
295
|
-
|
296
|
-
bff_pkg = cmd.stdout.split("\n").last.split(':')
|
297
|
-
{
|
298
|
-
name: bff_pkg[1],
|
299
|
-
installed: true,
|
300
|
-
version: bff_pkg[2],
|
301
|
-
type: 'bff',
|
302
|
-
}
|
303
|
-
end
|
304
|
-
end
|
305
|
-
|
306
|
-
# Solaris
|
307
|
-
class SolarisPkg < PkgManagement
|
308
|
-
def info(package_name)
|
309
|
-
if inspec.os[:release].to_i <= 10
|
310
|
-
solaris10_info(package_name)
|
311
|
-
else
|
312
|
-
solaris11_info(package_name)
|
313
|
-
end
|
314
|
-
end
|
315
|
-
|
316
|
-
# solaris 10
|
317
|
-
def solaris10_info(package_name)
|
318
|
-
cmd = inspec.command("pkginfo -l #{package_name}")
|
319
|
-
return {} if cmd.exit_status.to_i != 0
|
320
|
-
|
321
|
-
params = SimpleConfig.new(
|
322
|
-
cmd.stdout.chomp,
|
323
|
-
assignment_regex: /^\s*([^:]*?)\s*:\s*(.*?)\s*$/,
|
324
|
-
multiple_values: false,
|
325
|
-
).params
|
326
|
-
|
327
|
-
# parse 11.10.0,REV=2006.05.18.01.46
|
328
|
-
v = params['VERSION'].split(',')
|
329
|
-
{
|
330
|
-
name: params['PKGINST'],
|
331
|
-
installed: true,
|
332
|
-
version: v[0] + '-' + v[1].split('=')[1],
|
333
|
-
type: 'pkg',
|
334
|
-
}
|
335
|
-
end
|
336
|
-
|
337
|
-
# solaris 11
|
338
|
-
def solaris11_info(package_name)
|
339
|
-
cmd = inspec.command("pkg info #{package_name}")
|
340
|
-
return {} if cmd.exit_status.to_i != 0
|
341
|
-
|
342
|
-
params = SimpleConfig.new(
|
343
|
-
cmd.stdout.chomp,
|
344
|
-
assignment_regex: /^\s*([^:]*?)\s*:\s*(.*?)\s*$/,
|
345
|
-
multiple_values: false,
|
346
|
-
).params
|
347
|
-
|
348
|
-
{
|
349
|
-
name: params['Name'],
|
350
|
-
installed: true,
|
351
|
-
# 0.5.11-0.175.3.1.0.5.0
|
352
|
-
version: "#{params['Version']}-#{params['Branch']}",
|
353
|
-
type: 'pkg',
|
354
|
-
}
|
355
|
-
end
|
356
|
-
end
|
357
|
-
end
|
1
|
+
# encoding: utf-8
|
2
|
+
# author: Christoph Hartmann
|
3
|
+
# author: Dominik Richter
|
4
|
+
|
5
|
+
# Resource to determine package information
|
6
|
+
#
|
7
|
+
# Usage:
|
8
|
+
# describe package('nginx') do
|
9
|
+
# it { should be_installed }
|
10
|
+
# end
|
11
|
+
module Inspec::Resources
|
12
|
+
class Package < Inspec.resource(1)
|
13
|
+
name 'package'
|
14
|
+
desc 'Use the package InSpec audit resource to test if the named package and/or package version is installed on the system.'
|
15
|
+
example "
|
16
|
+
describe package('nginx') do
|
17
|
+
it { should be_installed }
|
18
|
+
it { should_not be_held } # for dpkg platforms that support holding a version from being upgraded
|
19
|
+
its('version') { should eq 1.9.5 }
|
20
|
+
end
|
21
|
+
"
|
22
|
+
|
23
|
+
def initialize(package_name, opts = {}) # rubocop:disable Metrics/AbcSize
|
24
|
+
@package_name = package_name
|
25
|
+
@name = @package_name
|
26
|
+
@cache = nil
|
27
|
+
# select package manager
|
28
|
+
@pkgman = nil
|
29
|
+
|
30
|
+
os = inspec.os
|
31
|
+
if os.debian?
|
32
|
+
@pkgman = Deb.new(inspec)
|
33
|
+
elsif os.redhat? || %w{suse amazon fedora}.include?(os[:family])
|
34
|
+
@pkgman = Rpm.new(inspec, opts)
|
35
|
+
elsif ['arch'].include?(os[:name])
|
36
|
+
@pkgman = Pacman.new(inspec)
|
37
|
+
elsif ['darwin'].include?(os[:family])
|
38
|
+
@pkgman = Brew.new(inspec)
|
39
|
+
elsif inspec.os.windows?
|
40
|
+
@pkgman = WindowsPkg.new(inspec)
|
41
|
+
elsif ['aix'].include?(os[:family])
|
42
|
+
@pkgman = BffPkg.new(inspec)
|
43
|
+
elsif os.solaris?
|
44
|
+
@pkgman = SolarisPkg.new(inspec)
|
45
|
+
elsif ['hpux'].include?(os[:family])
|
46
|
+
@pkgman = HpuxPkg.new(inspec)
|
47
|
+
else
|
48
|
+
raise Inspec::Exceptions::ResourceSkipped, 'The `package` resource is not supported on your OS yet.'
|
49
|
+
end
|
50
|
+
|
51
|
+
evaluate_missing_requirements
|
52
|
+
end
|
53
|
+
|
54
|
+
# returns true if the package is installed
|
55
|
+
def installed?(_provider = nil, _version = nil)
|
56
|
+
info[:installed] == true
|
57
|
+
end
|
58
|
+
|
59
|
+
# returns true it the package is held (if the OS supports it)
|
60
|
+
def held?(_provider = nil, _version = nil)
|
61
|
+
info[:held] == true
|
62
|
+
end
|
63
|
+
|
64
|
+
# returns the package description
|
65
|
+
def info
|
66
|
+
return @cache if !@cache.nil?
|
67
|
+
# All `@pkgman.info` methods return `{}`. This matches that
|
68
|
+
# behavior if `@pkgman` can't be determined, thus avoiding the
|
69
|
+
# `undefined method 'info' for nil:NilClass` error
|
70
|
+
return {} if @pkgman.nil?
|
71
|
+
@pkgman.info(@package_name)
|
72
|
+
end
|
73
|
+
|
74
|
+
# return the package version
|
75
|
+
def version
|
76
|
+
info = @pkgman.info(@package_name)
|
77
|
+
info[:version]
|
78
|
+
end
|
79
|
+
|
80
|
+
def to_s
|
81
|
+
"System Package #{@package_name}"
|
82
|
+
end
|
83
|
+
|
84
|
+
private
|
85
|
+
|
86
|
+
def evaluate_missing_requirements
|
87
|
+
missing_requirements_string = @pkgman.missing_requirements.uniq.join(', ')
|
88
|
+
return if missing_requirements_string.empty?
|
89
|
+
raise Inspec::Exceptions::ResourceSkipped, "The following requirements are not met for this resource: #{missing_requirements_string}"
|
90
|
+
end
|
91
|
+
end
|
92
|
+
|
93
|
+
class PkgManagement
|
94
|
+
attr_reader :inspec
|
95
|
+
def initialize(inspec)
|
96
|
+
@inspec = inspec
|
97
|
+
end
|
98
|
+
|
99
|
+
def missing_requirements
|
100
|
+
# Each provider can provide an Array of missing requirements that will be
|
101
|
+
# combined into a `ResourceSkipped` exception message.
|
102
|
+
[]
|
103
|
+
end
|
104
|
+
end
|
105
|
+
|
106
|
+
# Debian / Ubuntu
|
107
|
+
class Deb < PkgManagement
|
108
|
+
def info(package_name)
|
109
|
+
cmd = inspec.command("dpkg -s #{package_name}")
|
110
|
+
return {} if cmd.exit_status.to_i != 0
|
111
|
+
|
112
|
+
params = SimpleConfig.new(
|
113
|
+
cmd.stdout.chomp,
|
114
|
+
assignment_regex: /^\s*([^:]*?)\s*:\s*(.*?)\s*$/,
|
115
|
+
multiple_values: false,
|
116
|
+
).params
|
117
|
+
# If the package is installed, Status is "install ok installed"
|
118
|
+
# If the package is installed and marked hold, Status is "hold ok installed"
|
119
|
+
# If the package is removed and not purged, Status is "deinstall ok config-files" with exit_status 0
|
120
|
+
# If the package is purged cmd fails with non-zero exit status
|
121
|
+
{
|
122
|
+
name: params['Package'],
|
123
|
+
installed: params['Status'].split(' ')[2] == 'installed',
|
124
|
+
held: params['Status'].split(' ')[0] == 'hold',
|
125
|
+
version: params['Version'],
|
126
|
+
type: 'deb',
|
127
|
+
}
|
128
|
+
end
|
129
|
+
end
|
130
|
+
|
131
|
+
# RHEL family
|
132
|
+
class Rpm < PkgManagement
|
133
|
+
def initialize(inspec, opts)
|
134
|
+
super(inspec)
|
135
|
+
|
136
|
+
@dbpath = opts.fetch(:rpm_dbpath, nil)
|
137
|
+
end
|
138
|
+
|
139
|
+
def missing_requirements
|
140
|
+
missing_requirements = []
|
141
|
+
|
142
|
+
unless @dbpath.nil? || inspec.directory(@dbpath).directory?
|
143
|
+
missing_requirements << "RPMDB #{@dbpath} does not exist"
|
144
|
+
end
|
145
|
+
|
146
|
+
missing_requirements
|
147
|
+
end
|
148
|
+
|
149
|
+
def info(package_name)
|
150
|
+
rpm_cmd = rpm_command(package_name)
|
151
|
+
cmd = inspec.command(rpm_cmd)
|
152
|
+
# CentOS does not return an error code if the package is not installed,
|
153
|
+
# therefore we need to check for emptyness
|
154
|
+
return {} if cmd.exit_status.to_i != 0 || cmd.stdout.chomp.empty?
|
155
|
+
params = SimpleConfig.new(
|
156
|
+
cmd.stdout.chomp,
|
157
|
+
assignment_regex: /^\s*([^:]*?)\s*:\s*(.*?)\s*$/,
|
158
|
+
multiple_values: false,
|
159
|
+
).params
|
160
|
+
# On some (all?) systems, the linebreak before the vendor line is missing
|
161
|
+
if params['Version'] =~ /\s*Vendor:/
|
162
|
+
v = params['Version'].split(' ')[0]
|
163
|
+
else
|
164
|
+
v = params['Version']
|
165
|
+
end
|
166
|
+
# On some (all?) systems, the linebreak before the build line is missing
|
167
|
+
if params['Release'] =~ /\s*Build Date:/
|
168
|
+
r = params['Release'].split(' ')[0]
|
169
|
+
else
|
170
|
+
r = params['Release']
|
171
|
+
end
|
172
|
+
{
|
173
|
+
name: params['Name'],
|
174
|
+
installed: true,
|
175
|
+
version: "#{v}-#{r}",
|
176
|
+
type: 'rpm',
|
177
|
+
}
|
178
|
+
end
|
179
|
+
|
180
|
+
private
|
181
|
+
|
182
|
+
def rpm_command(package_name)
|
183
|
+
cmd = ''
|
184
|
+
cmd += 'rpm -qia'
|
185
|
+
cmd += " --dbpath #{@dbpath}" if @dbpath
|
186
|
+
cmd += ' ' + package_name
|
187
|
+
|
188
|
+
cmd
|
189
|
+
end
|
190
|
+
end
|
191
|
+
|
192
|
+
# MacOS / Darwin implementation
|
193
|
+
class Brew < PkgManagement
|
194
|
+
def info(package_name)
|
195
|
+
brew_path = inspec.command('brew').exist? ? 'brew' : '/usr/local/bin/brew'
|
196
|
+
cmd = inspec.command("#{brew_path} info --json=v1 #{package_name}")
|
197
|
+
return {} if cmd.exit_status.to_i != 0
|
198
|
+
# parse data
|
199
|
+
pkg = JSON.parse(cmd.stdout)[0]
|
200
|
+
{
|
201
|
+
name: pkg['name'],
|
202
|
+
installed: true,
|
203
|
+
version: pkg['installed'][0]['version'],
|
204
|
+
type: 'brew',
|
205
|
+
}
|
206
|
+
rescue JSON::ParserError => e
|
207
|
+
raise Inspec::Exceptions::ResourceFailed,
|
208
|
+
'Failed to parse JSON from `brew` command. ' \
|
209
|
+
"Error: #{e}"
|
210
|
+
end
|
211
|
+
end
|
212
|
+
|
213
|
+
# Arch Linux
|
214
|
+
class Pacman < PkgManagement
|
215
|
+
def info(package_name)
|
216
|
+
cmd = inspec.command("pacman -Qi #{package_name}")
|
217
|
+
return {} if cmd.exit_status.to_i != 0
|
218
|
+
|
219
|
+
params = SimpleConfig.new(
|
220
|
+
cmd.stdout.chomp,
|
221
|
+
assignment_regex: /^\s*([^:]*?)\s*:\s*(.*?)\s*$/,
|
222
|
+
multiple_values: false,
|
223
|
+
).params
|
224
|
+
|
225
|
+
{
|
226
|
+
name: params['Name'],
|
227
|
+
installed: true,
|
228
|
+
version: params['Version'],
|
229
|
+
type: 'pacman',
|
230
|
+
}
|
231
|
+
end
|
232
|
+
end
|
233
|
+
|
234
|
+
class HpuxPkg < PkgManagement
|
235
|
+
def info(package_name)
|
236
|
+
cmd = inspec.command("swlist -l product | grep #{package_name}")
|
237
|
+
return {} if cmd.exit_status.to_i != 0
|
238
|
+
pkg = cmd.stdout.strip.split(' ')
|
239
|
+
{
|
240
|
+
name: pkg[0],
|
241
|
+
installed: true,
|
242
|
+
version: pkg[1],
|
243
|
+
type: 'pkg',
|
244
|
+
}
|
245
|
+
end
|
246
|
+
end
|
247
|
+
|
248
|
+
# Determines the installed packages on Windows using the Windows package registry entries.
|
249
|
+
# @see: http://blogs.technet.com/b/heyscriptingguy/archive/2013/11/15/use-powershell-to-find-installed-software.aspx
|
250
|
+
class WindowsPkg < PkgManagement
|
251
|
+
def info(package_name)
|
252
|
+
search_paths = [
|
253
|
+
'HKLM:\SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall\*',
|
254
|
+
'HKCU:\SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall\*',
|
255
|
+
]
|
256
|
+
|
257
|
+
# add 64 bit search paths
|
258
|
+
if inspec.os.arch == 'x86_64'
|
259
|
+
search_paths << 'HKLM:\SOFTWARE\Wow6432Node\Microsoft\Windows\CurrentVersion\Uninstall\*'
|
260
|
+
search_paths << 'HKCU:\SOFTWARE\Wow6432Node\Microsoft\Windows\CurrentVersion\Uninstall\*'
|
261
|
+
end
|
262
|
+
|
263
|
+
# Find the package
|
264
|
+
cmd = inspec.command <<-EOF.gsub(/^\s*/, '')
|
265
|
+
Get-ItemProperty (@("#{search_paths.join('", "')}") | Where-Object { Test-Path $_ }) |
|
266
|
+
Where-Object { $_.DisplayName -like "#{package_name}" -or $_.PSChildName -like "#{package_name}" } |
|
267
|
+
Select-Object -Property DisplayName,DisplayVersion | ConvertTo-Json
|
268
|
+
EOF
|
269
|
+
|
270
|
+
begin
|
271
|
+
package = JSON.parse(cmd.stdout)
|
272
|
+
rescue JSON::ParserError => e
|
273
|
+
raise Inspec::Exceptions::ResourceFailed,
|
274
|
+
'Failed to parse JSON from PowerShell. ' \
|
275
|
+
"Error: #{e}"
|
276
|
+
end
|
277
|
+
|
278
|
+
# What if we match multiple packages? just pick the first one for now.
|
279
|
+
package = package[0] if package.is_a?(Array)
|
280
|
+
|
281
|
+
{
|
282
|
+
name: package['DisplayName'],
|
283
|
+
installed: true,
|
284
|
+
version: package['DisplayVersion'],
|
285
|
+
type: 'windows',
|
286
|
+
}
|
287
|
+
end
|
288
|
+
end
|
289
|
+
|
290
|
+
# AIX
|
291
|
+
class BffPkg < PkgManagement
|
292
|
+
def info(package_name)
|
293
|
+
cmd = inspec.command("lslpp -cL #{package_name}")
|
294
|
+
return {} if cmd.exit_status.to_i != 0
|
295
|
+
|
296
|
+
bff_pkg = cmd.stdout.split("\n").last.split(':')
|
297
|
+
{
|
298
|
+
name: bff_pkg[1],
|
299
|
+
installed: true,
|
300
|
+
version: bff_pkg[2],
|
301
|
+
type: 'bff',
|
302
|
+
}
|
303
|
+
end
|
304
|
+
end
|
305
|
+
|
306
|
+
# Solaris
|
307
|
+
class SolarisPkg < PkgManagement
|
308
|
+
def info(package_name)
|
309
|
+
if inspec.os[:release].to_i <= 10
|
310
|
+
solaris10_info(package_name)
|
311
|
+
else
|
312
|
+
solaris11_info(package_name)
|
313
|
+
end
|
314
|
+
end
|
315
|
+
|
316
|
+
# solaris 10
|
317
|
+
def solaris10_info(package_name)
|
318
|
+
cmd = inspec.command("pkginfo -l #{package_name}")
|
319
|
+
return {} if cmd.exit_status.to_i != 0
|
320
|
+
|
321
|
+
params = SimpleConfig.new(
|
322
|
+
cmd.stdout.chomp,
|
323
|
+
assignment_regex: /^\s*([^:]*?)\s*:\s*(.*?)\s*$/,
|
324
|
+
multiple_values: false,
|
325
|
+
).params
|
326
|
+
|
327
|
+
# parse 11.10.0,REV=2006.05.18.01.46
|
328
|
+
v = params['VERSION'].split(',')
|
329
|
+
{
|
330
|
+
name: params['PKGINST'],
|
331
|
+
installed: true,
|
332
|
+
version: v[0] + '-' + v[1].split('=')[1],
|
333
|
+
type: 'pkg',
|
334
|
+
}
|
335
|
+
end
|
336
|
+
|
337
|
+
# solaris 11
|
338
|
+
def solaris11_info(package_name)
|
339
|
+
cmd = inspec.command("pkg info #{package_name}")
|
340
|
+
return {} if cmd.exit_status.to_i != 0
|
341
|
+
|
342
|
+
params = SimpleConfig.new(
|
343
|
+
cmd.stdout.chomp,
|
344
|
+
assignment_regex: /^\s*([^:]*?)\s*:\s*(.*?)\s*$/,
|
345
|
+
multiple_values: false,
|
346
|
+
).params
|
347
|
+
|
348
|
+
{
|
349
|
+
name: params['Name'],
|
350
|
+
installed: true,
|
351
|
+
# 0.5.11-0.175.3.1.0.5.0
|
352
|
+
version: "#{params['Version']}-#{params['Branch']}",
|
353
|
+
type: 'pkg',
|
354
|
+
}
|
355
|
+
end
|
356
|
+
end
|
357
|
+
end
|