inspec 1.51.15 → 1.51.18
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 +2922 -2915
- 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 -101
- data/docs/resources/host.md.erb +77 -77
- data/docs/resources/http.md.erb +104 -104
- data/docs/resources/iis_app.md.erb +120 -120
- data/docs/resources/iis_site.md.erb +132 -132
- data/docs/resources/inetd_conf.md.erb +95 -95
- data/docs/resources/ini.md.erb +72 -72
- data/docs/resources/interface.md.erb +55 -55
- 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 +327 -324
- 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 -50
- data/lib/inspec/reporters/base.rb +24 -24
- data/lib/inspec/reporters/cli.rb +395 -395
- data/lib/inspec/reporters/json.rb +138 -134
- data/lib/inspec/reporters/json_min.rb +48 -48
- 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 +342 -340
- data/lib/inspec/runner_mock.rb +41 -41
- data/lib/inspec/runner_rspec.rb +163 -163
- data/lib/inspec/runtime_profile.rb +26 -26
- data/lib/inspec/schema.rb +192 -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/csv.rb
CHANGED
@@ -1,58 +1,58 @@
|
|
1
|
-
# encoding: utf-8
|
2
|
-
# author: Christoph Hartmann
|
3
|
-
# author: Dominik Richter
|
4
|
-
|
5
|
-
# Parses a csv document
|
6
|
-
# This implementation was inspired by a blog post
|
7
|
-
# @see http://technicalpickles.com/posts/parsing-csv-with-ruby
|
8
|
-
module Inspec::Resources
|
9
|
-
class CsvConfig < JsonConfig
|
10
|
-
name 'csv'
|
11
|
-
desc 'Use the csv InSpec audit resource to test configuration data in a CSV file.'
|
12
|
-
example "
|
13
|
-
describe csv('example.csv') do
|
14
|
-
its('name') { should eq(['John', 'Alice']) }
|
15
|
-
end
|
16
|
-
"
|
17
|
-
|
18
|
-
# override the parse method from JsonConfig
|
19
|
-
# Assuming a header row of name,col1,col2, it will output an array of hashes like so:
|
20
|
-
# [
|
21
|
-
# { 'name' => 'row1', 'col1' => 'value1', 'col2' => 'value2' },
|
22
|
-
# { 'name' => 'row2', 'col1' => 'value3', 'col2' => 'value4' }
|
23
|
-
# ]
|
24
|
-
def parse(content)
|
25
|
-
require 'csv'
|
26
|
-
|
27
|
-
# convert empty field to nil
|
28
|
-
CSV::Converters[:blank_to_nil] = lambda do |field|
|
29
|
-
field && field.empty? ? nil : field
|
30
|
-
end
|
31
|
-
|
32
|
-
# implicit conversion of values
|
33
|
-
csv = CSV.new(content, headers: true, converters: [:all, :blank_to_nil])
|
34
|
-
|
35
|
-
# convert to hash
|
36
|
-
csv.to_a.map(&:to_hash)
|
37
|
-
rescue => e
|
38
|
-
raise Inspec::Exceptions::ResourceFailed, "Unable to parse CSV: #{e.message}"
|
39
|
-
end
|
40
|
-
|
41
|
-
# override the value method from JsonConfig
|
42
|
-
# The format of the CSV hash as created by #parse is very different
|
43
|
-
# than what the YAML, JSON, and INI resources create, so using the
|
44
|
-
# #value method from JsonConfig (which uses ObjectTraverser.extract_value)
|
45
|
-
# doesn't make sense here.
|
46
|
-
def value(key)
|
47
|
-
@params.map { |x| x[key.first.to_s] }.compact
|
48
|
-
end
|
49
|
-
|
50
|
-
private
|
51
|
-
|
52
|
-
# used by JsonConfig to build up a full to_s method
|
53
|
-
# based on whether a file path, content, or command was supplied.
|
54
|
-
def resource_base_name
|
55
|
-
'CSV'
|
56
|
-
end
|
57
|
-
end
|
58
|
-
end
|
1
|
+
# encoding: utf-8
|
2
|
+
# author: Christoph Hartmann
|
3
|
+
# author: Dominik Richter
|
4
|
+
|
5
|
+
# Parses a csv document
|
6
|
+
# This implementation was inspired by a blog post
|
7
|
+
# @see http://technicalpickles.com/posts/parsing-csv-with-ruby
|
8
|
+
module Inspec::Resources
|
9
|
+
class CsvConfig < JsonConfig
|
10
|
+
name 'csv'
|
11
|
+
desc 'Use the csv InSpec audit resource to test configuration data in a CSV file.'
|
12
|
+
example "
|
13
|
+
describe csv('example.csv') do
|
14
|
+
its('name') { should eq(['John', 'Alice']) }
|
15
|
+
end
|
16
|
+
"
|
17
|
+
|
18
|
+
# override the parse method from JsonConfig
|
19
|
+
# Assuming a header row of name,col1,col2, it will output an array of hashes like so:
|
20
|
+
# [
|
21
|
+
# { 'name' => 'row1', 'col1' => 'value1', 'col2' => 'value2' },
|
22
|
+
# { 'name' => 'row2', 'col1' => 'value3', 'col2' => 'value4' }
|
23
|
+
# ]
|
24
|
+
def parse(content)
|
25
|
+
require 'csv'
|
26
|
+
|
27
|
+
# convert empty field to nil
|
28
|
+
CSV::Converters[:blank_to_nil] = lambda do |field|
|
29
|
+
field && field.empty? ? nil : field
|
30
|
+
end
|
31
|
+
|
32
|
+
# implicit conversion of values
|
33
|
+
csv = CSV.new(content, headers: true, converters: [:all, :blank_to_nil])
|
34
|
+
|
35
|
+
# convert to hash
|
36
|
+
csv.to_a.map(&:to_hash)
|
37
|
+
rescue => e
|
38
|
+
raise Inspec::Exceptions::ResourceFailed, "Unable to parse CSV: #{e.message}"
|
39
|
+
end
|
40
|
+
|
41
|
+
# override the value method from JsonConfig
|
42
|
+
# The format of the CSV hash as created by #parse is very different
|
43
|
+
# than what the YAML, JSON, and INI resources create, so using the
|
44
|
+
# #value method from JsonConfig (which uses ObjectTraverser.extract_value)
|
45
|
+
# doesn't make sense here.
|
46
|
+
def value(key)
|
47
|
+
@params.map { |x| x[key.first.to_s] }.compact
|
48
|
+
end
|
49
|
+
|
50
|
+
private
|
51
|
+
|
52
|
+
# used by JsonConfig to build up a full to_s method
|
53
|
+
# based on whether a file path, content, or command was supplied.
|
54
|
+
def resource_base_name
|
55
|
+
'CSV'
|
56
|
+
end
|
57
|
+
end
|
58
|
+
end
|
data/lib/resources/dh_params.rb
CHANGED
@@ -1,83 +1,83 @@
|
|
1
|
-
# encoding: utf-8
|
2
|
-
# author: Doc Walker
|
3
|
-
|
4
|
-
require 'openssl'
|
5
|
-
|
6
|
-
class DhParams < Inspec.resource(1)
|
7
|
-
name 'dh_params'
|
8
|
-
|
9
|
-
desc '
|
10
|
-
Use the `dh_params` InSpec audit resource to test Diffie-Hellman (DH)
|
11
|
-
parameters.
|
12
|
-
'
|
13
|
-
|
14
|
-
example "
|
15
|
-
describe dh_params('/path/to/file.dh_pem') do
|
16
|
-
it { should be_dh_params }
|
17
|
-
it { should be_valid }
|
18
|
-
its('generator') { should eq 2 }
|
19
|
-
its('modulus') { should eq '00:91:a0:15:89:e5:bc:38:93:12:02:fc:...' }
|
20
|
-
its('prime_length') { should eq 2048 }
|
21
|
-
its('pem') { should eq '-----BEGIN DH PARAMETERS...' }
|
22
|
-
its('text') { should eq 'PKCS#3 DH Parameters: (2048 bit)...' }
|
23
|
-
end
|
24
|
-
"
|
25
|
-
|
26
|
-
def initialize(filename)
|
27
|
-
@dh_params_path = filename
|
28
|
-
file = inspec.file(@dh_params_path)
|
29
|
-
return skip_resource "Unable to find DH parameters file #{@dh_params_path}" unless file.exist?
|
30
|
-
|
31
|
-
begin
|
32
|
-
@dh_params = OpenSSL::PKey::DH.new file.content
|
33
|
-
rescue
|
34
|
-
@dh_params = nil
|
35
|
-
return skip_resource "Unable to load DH parameters #{@dh_params_path}"
|
36
|
-
end
|
37
|
-
end
|
38
|
-
|
39
|
-
# it { should be_dh_params }
|
40
|
-
def dh_params?
|
41
|
-
!@dh_params.nil?
|
42
|
-
end
|
43
|
-
|
44
|
-
# its('generator') { should eq 2 }
|
45
|
-
def generator
|
46
|
-
return if @dh_params.nil?
|
47
|
-
@dh_params.g.to_i
|
48
|
-
end
|
49
|
-
|
50
|
-
# its('modulus') { should eq '00:91:a0:15:89:e5:bc:38:93:12:02:fc:...' }
|
51
|
-
def modulus
|
52
|
-
return if @dh_params.nil?
|
53
|
-
'00:' + @dh_params.p.to_s(16).downcase.scan(/.{2}/).join(':')
|
54
|
-
end
|
55
|
-
|
56
|
-
# its('pem') { should eq '-----BEGIN DH PARAMETERS...' }
|
57
|
-
def pem
|
58
|
-
return if @dh_params.nil?
|
59
|
-
@dh_params.to_pem
|
60
|
-
end
|
61
|
-
|
62
|
-
# its('prime_length') { should be 2048 }
|
63
|
-
def prime_length
|
64
|
-
return if @dh_params.nil?
|
65
|
-
@dh_params.p.num_bits
|
66
|
-
end
|
67
|
-
|
68
|
-
# its('text') { should eq 'human-readable-text' }
|
69
|
-
def text
|
70
|
-
return if @dh_params.nil?
|
71
|
-
@dh_params.to_text
|
72
|
-
end
|
73
|
-
|
74
|
-
# it { should be_valid }
|
75
|
-
def valid?
|
76
|
-
return if @dh_params.nil?
|
77
|
-
@dh_params.params_ok?
|
78
|
-
end
|
79
|
-
|
80
|
-
def to_s
|
81
|
-
"dh_params #{@dh_params_path}"
|
82
|
-
end
|
83
|
-
end
|
1
|
+
# encoding: utf-8
|
2
|
+
# author: Doc Walker
|
3
|
+
|
4
|
+
require 'openssl'
|
5
|
+
|
6
|
+
class DhParams < Inspec.resource(1)
|
7
|
+
name 'dh_params'
|
8
|
+
|
9
|
+
desc '
|
10
|
+
Use the `dh_params` InSpec audit resource to test Diffie-Hellman (DH)
|
11
|
+
parameters.
|
12
|
+
'
|
13
|
+
|
14
|
+
example "
|
15
|
+
describe dh_params('/path/to/file.dh_pem') do
|
16
|
+
it { should be_dh_params }
|
17
|
+
it { should be_valid }
|
18
|
+
its('generator') { should eq 2 }
|
19
|
+
its('modulus') { should eq '00:91:a0:15:89:e5:bc:38:93:12:02:fc:...' }
|
20
|
+
its('prime_length') { should eq 2048 }
|
21
|
+
its('pem') { should eq '-----BEGIN DH PARAMETERS...' }
|
22
|
+
its('text') { should eq 'PKCS#3 DH Parameters: (2048 bit)...' }
|
23
|
+
end
|
24
|
+
"
|
25
|
+
|
26
|
+
def initialize(filename)
|
27
|
+
@dh_params_path = filename
|
28
|
+
file = inspec.file(@dh_params_path)
|
29
|
+
return skip_resource "Unable to find DH parameters file #{@dh_params_path}" unless file.exist?
|
30
|
+
|
31
|
+
begin
|
32
|
+
@dh_params = OpenSSL::PKey::DH.new file.content
|
33
|
+
rescue
|
34
|
+
@dh_params = nil
|
35
|
+
return skip_resource "Unable to load DH parameters #{@dh_params_path}"
|
36
|
+
end
|
37
|
+
end
|
38
|
+
|
39
|
+
# it { should be_dh_params }
|
40
|
+
def dh_params?
|
41
|
+
!@dh_params.nil?
|
42
|
+
end
|
43
|
+
|
44
|
+
# its('generator') { should eq 2 }
|
45
|
+
def generator
|
46
|
+
return if @dh_params.nil?
|
47
|
+
@dh_params.g.to_i
|
48
|
+
end
|
49
|
+
|
50
|
+
# its('modulus') { should eq '00:91:a0:15:89:e5:bc:38:93:12:02:fc:...' }
|
51
|
+
def modulus
|
52
|
+
return if @dh_params.nil?
|
53
|
+
'00:' + @dh_params.p.to_s(16).downcase.scan(/.{2}/).join(':')
|
54
|
+
end
|
55
|
+
|
56
|
+
# its('pem') { should eq '-----BEGIN DH PARAMETERS...' }
|
57
|
+
def pem
|
58
|
+
return if @dh_params.nil?
|
59
|
+
@dh_params.to_pem
|
60
|
+
end
|
61
|
+
|
62
|
+
# its('prime_length') { should be 2048 }
|
63
|
+
def prime_length
|
64
|
+
return if @dh_params.nil?
|
65
|
+
@dh_params.p.num_bits
|
66
|
+
end
|
67
|
+
|
68
|
+
# its('text') { should eq 'human-readable-text' }
|
69
|
+
def text
|
70
|
+
return if @dh_params.nil?
|
71
|
+
@dh_params.to_text
|
72
|
+
end
|
73
|
+
|
74
|
+
# it { should be_valid }
|
75
|
+
def valid?
|
76
|
+
return if @dh_params.nil?
|
77
|
+
@dh_params.params_ok?
|
78
|
+
end
|
79
|
+
|
80
|
+
def to_s
|
81
|
+
"dh_params #{@dh_params_path}"
|
82
|
+
end
|
83
|
+
end
|
data/lib/resources/directory.rb
CHANGED
@@ -1,25 +1,25 @@
|
|
1
|
-
# encoding: utf-8
|
2
|
-
# author: Dominik Richter
|
3
|
-
# author: Christoph Hartmann
|
4
|
-
|
5
|
-
require 'resources/file'
|
6
|
-
|
7
|
-
module Inspec::Resources
|
8
|
-
class Directory < FileResource
|
9
|
-
name 'directory'
|
10
|
-
desc 'Use the directory InSpec audit resource to test if the file type is a directory. This is equivalent to using the file InSpec audit resource and the be_directory matcher, but provides a simpler and more direct way to test directories. All of the matchers available to file may be used with directory.'
|
11
|
-
example "
|
12
|
-
describe directory('path') do
|
13
|
-
it { should be_directory }
|
14
|
-
end
|
15
|
-
"
|
16
|
-
|
17
|
-
def exist?
|
18
|
-
file.exist? && file.directory?
|
19
|
-
end
|
20
|
-
|
21
|
-
def to_s
|
22
|
-
"Directory #{source_path}"
|
23
|
-
end
|
24
|
-
end
|
25
|
-
end
|
1
|
+
# encoding: utf-8
|
2
|
+
# author: Dominik Richter
|
3
|
+
# author: Christoph Hartmann
|
4
|
+
|
5
|
+
require 'resources/file'
|
6
|
+
|
7
|
+
module Inspec::Resources
|
8
|
+
class Directory < FileResource
|
9
|
+
name 'directory'
|
10
|
+
desc 'Use the directory InSpec audit resource to test if the file type is a directory. This is equivalent to using the file InSpec audit resource and the be_directory matcher, but provides a simpler and more direct way to test directories. All of the matchers available to file may be used with directory.'
|
11
|
+
example "
|
12
|
+
describe directory('path') do
|
13
|
+
it { should be_directory }
|
14
|
+
end
|
15
|
+
"
|
16
|
+
|
17
|
+
def exist?
|
18
|
+
file.exist? && file.directory?
|
19
|
+
end
|
20
|
+
|
21
|
+
def to_s
|
22
|
+
"Directory #{source_path}"
|
23
|
+
end
|
24
|
+
end
|
25
|
+
end
|
data/lib/resources/docker.rb
CHANGED
@@ -1,239 +1,239 @@
|
|
1
|
-
# encoding: utf-8
|
2
|
-
#
|
3
|
-
# Copyright 2017, Christoph Hartmann
|
4
|
-
#
|
5
|
-
# author: Christoph Hartmann
|
6
|
-
# author: Patrick Muench
|
7
|
-
# author: Dominik Richter
|
8
|
-
|
9
|
-
require 'utils/filter'
|
10
|
-
require 'hashie/mash'
|
11
|
-
|
12
|
-
module Inspec::Resources
|
13
|
-
class DockerContainerFilter
|
14
|
-
# use filtertable for containers
|
15
|
-
filter = FilterTable.create
|
16
|
-
filter.add_accessor(:where)
|
17
|
-
.add_accessor(:entries)
|
18
|
-
.add(:commands, field: 'command')
|
19
|
-
.add(:ids, field: 'id')
|
20
|
-
.add(:images, field: 'image')
|
21
|
-
.add(:labels, field: 'labels')
|
22
|
-
.add(:local_volumes, field: 'localvolumes')
|
23
|
-
.add(:mounts, field: 'mounts')
|
24
|
-
.add(:names, field: 'names')
|
25
|
-
.add(:networks, field: 'networks')
|
26
|
-
.add(:ports, field: 'ports')
|
27
|
-
.add(:running_for, field: 'runningfor')
|
28
|
-
.add(:sizes, field: 'size')
|
29
|
-
.add(:status, field: 'status')
|
30
|
-
.add(:exists?) { |x| !x.entries.empty? }
|
31
|
-
.add(:running?) { |x|
|
32
|
-
x.where { status.downcase.start_with?('up') }
|
33
|
-
}
|
34
|
-
filter.connect(self, :containers)
|
35
|
-
|
36
|
-
attr_reader :containers
|
37
|
-
def initialize(containers)
|
38
|
-
@containers = containers
|
39
|
-
end
|
40
|
-
end
|
41
|
-
|
42
|
-
class DockerImageFilter
|
43
|
-
filter = FilterTable.create
|
44
|
-
filter.add_accessor(:where)
|
45
|
-
.add_accessor(:entries)
|
46
|
-
.add(:ids, field: 'id')
|
47
|
-
.add(:repositories, field: 'repository')
|
48
|
-
.add(:tags, field: 'tag')
|
49
|
-
.add(:sizes, field: 'size')
|
50
|
-
.add(:digests, field: 'digest')
|
51
|
-
.add(:created, field: 'createdat')
|
52
|
-
.add(:created_since, field: 'createdsize')
|
53
|
-
.add(:exists?) { |x| !x.entries.empty? }
|
54
|
-
filter.connect(self, :images)
|
55
|
-
|
56
|
-
attr_reader :images
|
57
|
-
def initialize(images)
|
58
|
-
@images = images
|
59
|
-
end
|
60
|
-
end
|
61
|
-
|
62
|
-
class DockerServiceFilter
|
63
|
-
filter = FilterTable.create
|
64
|
-
filter.add_accessor(:where)
|
65
|
-
.add_accessor(:entries)
|
66
|
-
.add(:ids, field: 'id')
|
67
|
-
.add(:names, field: 'name')
|
68
|
-
.add(:modes, field: 'mode')
|
69
|
-
.add(:replicas, field: 'replicas')
|
70
|
-
.add(:images, field: 'image')
|
71
|
-
.add(:ports, field: 'ports')
|
72
|
-
.add(:exists?) { |x| !x.entries.empty? }
|
73
|
-
filter.connect(self, :services)
|
74
|
-
|
75
|
-
attr_reader :services
|
76
|
-
def initialize(services)
|
77
|
-
@services = services
|
78
|
-
end
|
79
|
-
end
|
80
|
-
|
81
|
-
# This resource helps to parse information from the docker host
|
82
|
-
# For compatability with Serverspec we also offer the following resouses:
|
83
|
-
# - docker_container
|
84
|
-
# - docker_image
|
85
|
-
class Docker < Inspec.resource(1)
|
86
|
-
name 'docker'
|
87
|
-
|
88
|
-
desc "
|
89
|
-
A resource to retrieve information about docker
|
90
|
-
"
|
91
|
-
|
92
|
-
example "
|
93
|
-
describe docker.containers do
|
94
|
-
its('images') { should_not include 'u12:latest' }
|
95
|
-
end
|
96
|
-
|
97
|
-
describe docker.images do
|
98
|
-
its('repositories') { should_not include 'inssecure_image' }
|
99
|
-
end
|
100
|
-
|
101
|
-
describe docker.services do
|
102
|
-
its('images') { should_not include 'inssecure_image' }
|
103
|
-
end
|
104
|
-
|
105
|
-
describe docker.version do
|
106
|
-
its('Server.Version') { should cmp >= '1.12'}
|
107
|
-
its('Client.Version') { should cmp >= '1.12'}
|
108
|
-
end
|
109
|
-
|
110
|
-
describe docker.object(id) do
|
111
|
-
its('Configuration.Path') { should eq 'value' }
|
112
|
-
end
|
113
|
-
|
114
|
-
docker.containers.ids.each do |id|
|
115
|
-
# call docker inspect for a specific container id
|
116
|
-
describe docker.object(id) do
|
117
|
-
its(%w(HostConfig Privileged)) { should cmp false }
|
118
|
-
its(%w(HostConfig Privileged)) { should_not cmp true }
|
119
|
-
end
|
120
|
-
end
|
121
|
-
"
|
122
|
-
|
123
|
-
def containers
|
124
|
-
DockerContainerFilter.new(parse_containers)
|
125
|
-
end
|
126
|
-
|
127
|
-
def images
|
128
|
-
DockerImageFilter.new(parse_images)
|
129
|
-
end
|
130
|
-
|
131
|
-
def services
|
132
|
-
DockerServiceFilter.new(parse_services)
|
133
|
-
end
|
134
|
-
|
135
|
-
def version
|
136
|
-
return @version if defined?(@version)
|
137
|
-
data = {}
|
138
|
-
cmd = inspec.command('docker version --format \'{{ json . }}\'')
|
139
|
-
data = JSON.parse(cmd.stdout) if cmd.exit_status == 0
|
140
|
-
@version = Hashie::Mash.new(data)
|
141
|
-
rescue JSON::ParserError => _e
|
142
|
-
return Hashie::Mash.new({})
|
143
|
-
end
|
144
|
-
|
145
|
-
def info
|
146
|
-
return @info if defined?(@info)
|
147
|
-
data = {}
|
148
|
-
# docke info format is only supported for Docker 17.03+
|
149
|
-
cmd = inspec.command('docker info --format \'{{ json . }}\'')
|
150
|
-
data = JSON.parse(cmd.stdout) if cmd.exit_status == 0
|
151
|
-
@info = Hashie::Mash.new(data)
|
152
|
-
rescue JSON::ParserError => _e
|
153
|
-
return Hashie::Mash.new({})
|
154
|
-
end
|
155
|
-
|
156
|
-
# returns information about docker objects
|
157
|
-
def object(id)
|
158
|
-
return @inspect if defined?(@inspect)
|
159
|
-
data = JSON.parse(inspec.command("docker inspect #{id}").stdout)
|
160
|
-
data = data[0] if data.is_a?(Array)
|
161
|
-
@inspect = Hashie::Mash.new(data)
|
162
|
-
rescue JSON::ParserError => _e
|
163
|
-
return Hashie::Mash.new({})
|
164
|
-
end
|
165
|
-
|
166
|
-
def to_s
|
167
|
-
'Docker Host'
|
168
|
-
end
|
169
|
-
|
170
|
-
private
|
171
|
-
|
172
|
-
def parse_json_command(labels, subcommand)
|
173
|
-
# build command
|
174
|
-
format = labels.map { |label| "\"#{label}\": {{json .#{label}}}" }
|
175
|
-
raw = inspec.command("docker #{subcommand} --format '{#{format.join(', ')}}'").stdout
|
176
|
-
output = []
|
177
|
-
# since docker is not outputting valid json, we need to parse each row
|
178
|
-
raw.each_line { |entry|
|
179
|
-
# convert all keys to lower_case to work well with ruby and filter table
|
180
|
-
j = JSON.parse(entry).map { |k, v|
|
181
|
-
[k.downcase, v]
|
182
|
-
}.to_h
|
183
|
-
|
184
|
-
# ensure all keys are there
|
185
|
-
j = ensure_keys(j, labels)
|
186
|
-
|
187
|
-
# strip off any linked container names
|
188
|
-
# Depending on how it was linked, the actual container name may come before
|
189
|
-
# or after the link information, so we'll just look for the first name that
|
190
|
-
# does not include a slash since that is not a valid character in a container name
|
191
|
-
j['names'] = j['names'].split(',').find { |c| !c.include?('/') } if j.key?('names')
|
192
|
-
|
193
|
-
output.push(j)
|
194
|
-
}
|
195
|
-
output
|
196
|
-
rescue JSON::ParserError => _e
|
197
|
-
warn "Could not parse `docker #{subcommand}` output"
|
198
|
-
[]
|
199
|
-
end
|
200
|
-
|
201
|
-
def parse_containers
|
202
|
-
# @see https://github.com/moby/moby/issues/20625, works for docker 1.13+
|
203
|
-
# raw_containers = inspec.command('docker ps -a --no-trunc --format \'{{ json . }}\'').stdout
|
204
|
-
# therefore we stick with older approach
|
205
|
-
labels = %w{Command CreatedAt ID Image Labels Mounts Names Ports RunningFor Size Status}
|
206
|
-
|
207
|
-
# Networks LocalVolumes work with 1.13+ only
|
208
|
-
if !version.empty? && Gem::Version.new(version['Client']['Version']) >= Gem::Version.new('1.13')
|
209
|
-
labels.push('Networks')
|
210
|
-
labels.push('LocalVolumes')
|
211
|
-
end
|
212
|
-
parse_json_command(labels, 'ps -a --no-trunc')
|
213
|
-
end
|
214
|
-
|
215
|
-
def parse_services
|
216
|
-
parse_json_command(%w{ID Name Mode Replicas Image Ports}, 'service ls')
|
217
|
-
end
|
218
|
-
|
219
|
-
def ensure_keys(entry, labels)
|
220
|
-
labels.each { |key|
|
221
|
-
entry[key.downcase] = nil if !entry.key?(key.downcase)
|
222
|
-
}
|
223
|
-
entry
|
224
|
-
end
|
225
|
-
|
226
|
-
def parse_images
|
227
|
-
# docker does not support the `json .` function here, therefore we need to emulate that behavior.
|
228
|
-
raw_images = inspec.command('docker images -a --no-trunc --format \'{ "id": {{json .ID}}, "repository": {{json .Repository}}, "tag": {{json .Tag}}, "size": {{json .Size}}, "digest": {{json .Digest}}, "createdat": {{json .CreatedAt}}, "createdsize": {{json .CreatedSince}} }\'').stdout
|
229
|
-
c_images = []
|
230
|
-
raw_images.each_line { |entry|
|
231
|
-
c_images.push(JSON.parse(entry))
|
232
|
-
}
|
233
|
-
c_images
|
234
|
-
rescue JSON::ParserError => _e
|
235
|
-
warn 'Could not parse `docker images` output'
|
236
|
-
[]
|
237
|
-
end
|
238
|
-
end
|
239
|
-
end
|
1
|
+
# encoding: utf-8
|
2
|
+
#
|
3
|
+
# Copyright 2017, Christoph Hartmann
|
4
|
+
#
|
5
|
+
# author: Christoph Hartmann
|
6
|
+
# author: Patrick Muench
|
7
|
+
# author: Dominik Richter
|
8
|
+
|
9
|
+
require 'utils/filter'
|
10
|
+
require 'hashie/mash'
|
11
|
+
|
12
|
+
module Inspec::Resources
|
13
|
+
class DockerContainerFilter
|
14
|
+
# use filtertable for containers
|
15
|
+
filter = FilterTable.create
|
16
|
+
filter.add_accessor(:where)
|
17
|
+
.add_accessor(:entries)
|
18
|
+
.add(:commands, field: 'command')
|
19
|
+
.add(:ids, field: 'id')
|
20
|
+
.add(:images, field: 'image')
|
21
|
+
.add(:labels, field: 'labels')
|
22
|
+
.add(:local_volumes, field: 'localvolumes')
|
23
|
+
.add(:mounts, field: 'mounts')
|
24
|
+
.add(:names, field: 'names')
|
25
|
+
.add(:networks, field: 'networks')
|
26
|
+
.add(:ports, field: 'ports')
|
27
|
+
.add(:running_for, field: 'runningfor')
|
28
|
+
.add(:sizes, field: 'size')
|
29
|
+
.add(:status, field: 'status')
|
30
|
+
.add(:exists?) { |x| !x.entries.empty? }
|
31
|
+
.add(:running?) { |x|
|
32
|
+
x.where { status.downcase.start_with?('up') }
|
33
|
+
}
|
34
|
+
filter.connect(self, :containers)
|
35
|
+
|
36
|
+
attr_reader :containers
|
37
|
+
def initialize(containers)
|
38
|
+
@containers = containers
|
39
|
+
end
|
40
|
+
end
|
41
|
+
|
42
|
+
class DockerImageFilter
|
43
|
+
filter = FilterTable.create
|
44
|
+
filter.add_accessor(:where)
|
45
|
+
.add_accessor(:entries)
|
46
|
+
.add(:ids, field: 'id')
|
47
|
+
.add(:repositories, field: 'repository')
|
48
|
+
.add(:tags, field: 'tag')
|
49
|
+
.add(:sizes, field: 'size')
|
50
|
+
.add(:digests, field: 'digest')
|
51
|
+
.add(:created, field: 'createdat')
|
52
|
+
.add(:created_since, field: 'createdsize')
|
53
|
+
.add(:exists?) { |x| !x.entries.empty? }
|
54
|
+
filter.connect(self, :images)
|
55
|
+
|
56
|
+
attr_reader :images
|
57
|
+
def initialize(images)
|
58
|
+
@images = images
|
59
|
+
end
|
60
|
+
end
|
61
|
+
|
62
|
+
class DockerServiceFilter
|
63
|
+
filter = FilterTable.create
|
64
|
+
filter.add_accessor(:where)
|
65
|
+
.add_accessor(:entries)
|
66
|
+
.add(:ids, field: 'id')
|
67
|
+
.add(:names, field: 'name')
|
68
|
+
.add(:modes, field: 'mode')
|
69
|
+
.add(:replicas, field: 'replicas')
|
70
|
+
.add(:images, field: 'image')
|
71
|
+
.add(:ports, field: 'ports')
|
72
|
+
.add(:exists?) { |x| !x.entries.empty? }
|
73
|
+
filter.connect(self, :services)
|
74
|
+
|
75
|
+
attr_reader :services
|
76
|
+
def initialize(services)
|
77
|
+
@services = services
|
78
|
+
end
|
79
|
+
end
|
80
|
+
|
81
|
+
# This resource helps to parse information from the docker host
|
82
|
+
# For compatability with Serverspec we also offer the following resouses:
|
83
|
+
# - docker_container
|
84
|
+
# - docker_image
|
85
|
+
class Docker < Inspec.resource(1)
|
86
|
+
name 'docker'
|
87
|
+
|
88
|
+
desc "
|
89
|
+
A resource to retrieve information about docker
|
90
|
+
"
|
91
|
+
|
92
|
+
example "
|
93
|
+
describe docker.containers do
|
94
|
+
its('images') { should_not include 'u12:latest' }
|
95
|
+
end
|
96
|
+
|
97
|
+
describe docker.images do
|
98
|
+
its('repositories') { should_not include 'inssecure_image' }
|
99
|
+
end
|
100
|
+
|
101
|
+
describe docker.services do
|
102
|
+
its('images') { should_not include 'inssecure_image' }
|
103
|
+
end
|
104
|
+
|
105
|
+
describe docker.version do
|
106
|
+
its('Server.Version') { should cmp >= '1.12'}
|
107
|
+
its('Client.Version') { should cmp >= '1.12'}
|
108
|
+
end
|
109
|
+
|
110
|
+
describe docker.object(id) do
|
111
|
+
its('Configuration.Path') { should eq 'value' }
|
112
|
+
end
|
113
|
+
|
114
|
+
docker.containers.ids.each do |id|
|
115
|
+
# call docker inspect for a specific container id
|
116
|
+
describe docker.object(id) do
|
117
|
+
its(%w(HostConfig Privileged)) { should cmp false }
|
118
|
+
its(%w(HostConfig Privileged)) { should_not cmp true }
|
119
|
+
end
|
120
|
+
end
|
121
|
+
"
|
122
|
+
|
123
|
+
def containers
|
124
|
+
DockerContainerFilter.new(parse_containers)
|
125
|
+
end
|
126
|
+
|
127
|
+
def images
|
128
|
+
DockerImageFilter.new(parse_images)
|
129
|
+
end
|
130
|
+
|
131
|
+
def services
|
132
|
+
DockerServiceFilter.new(parse_services)
|
133
|
+
end
|
134
|
+
|
135
|
+
def version
|
136
|
+
return @version if defined?(@version)
|
137
|
+
data = {}
|
138
|
+
cmd = inspec.command('docker version --format \'{{ json . }}\'')
|
139
|
+
data = JSON.parse(cmd.stdout) if cmd.exit_status == 0
|
140
|
+
@version = Hashie::Mash.new(data)
|
141
|
+
rescue JSON::ParserError => _e
|
142
|
+
return Hashie::Mash.new({})
|
143
|
+
end
|
144
|
+
|
145
|
+
def info
|
146
|
+
return @info if defined?(@info)
|
147
|
+
data = {}
|
148
|
+
# docke info format is only supported for Docker 17.03+
|
149
|
+
cmd = inspec.command('docker info --format \'{{ json . }}\'')
|
150
|
+
data = JSON.parse(cmd.stdout) if cmd.exit_status == 0
|
151
|
+
@info = Hashie::Mash.new(data)
|
152
|
+
rescue JSON::ParserError => _e
|
153
|
+
return Hashie::Mash.new({})
|
154
|
+
end
|
155
|
+
|
156
|
+
# returns information about docker objects
|
157
|
+
def object(id)
|
158
|
+
return @inspect if defined?(@inspect)
|
159
|
+
data = JSON.parse(inspec.command("docker inspect #{id}").stdout)
|
160
|
+
data = data[0] if data.is_a?(Array)
|
161
|
+
@inspect = Hashie::Mash.new(data)
|
162
|
+
rescue JSON::ParserError => _e
|
163
|
+
return Hashie::Mash.new({})
|
164
|
+
end
|
165
|
+
|
166
|
+
def to_s
|
167
|
+
'Docker Host'
|
168
|
+
end
|
169
|
+
|
170
|
+
private
|
171
|
+
|
172
|
+
def parse_json_command(labels, subcommand)
|
173
|
+
# build command
|
174
|
+
format = labels.map { |label| "\"#{label}\": {{json .#{label}}}" }
|
175
|
+
raw = inspec.command("docker #{subcommand} --format '{#{format.join(', ')}}'").stdout
|
176
|
+
output = []
|
177
|
+
# since docker is not outputting valid json, we need to parse each row
|
178
|
+
raw.each_line { |entry|
|
179
|
+
# convert all keys to lower_case to work well with ruby and filter table
|
180
|
+
j = JSON.parse(entry).map { |k, v|
|
181
|
+
[k.downcase, v]
|
182
|
+
}.to_h
|
183
|
+
|
184
|
+
# ensure all keys are there
|
185
|
+
j = ensure_keys(j, labels)
|
186
|
+
|
187
|
+
# strip off any linked container names
|
188
|
+
# Depending on how it was linked, the actual container name may come before
|
189
|
+
# or after the link information, so we'll just look for the first name that
|
190
|
+
# does not include a slash since that is not a valid character in a container name
|
191
|
+
j['names'] = j['names'].split(',').find { |c| !c.include?('/') } if j.key?('names')
|
192
|
+
|
193
|
+
output.push(j)
|
194
|
+
}
|
195
|
+
output
|
196
|
+
rescue JSON::ParserError => _e
|
197
|
+
warn "Could not parse `docker #{subcommand}` output"
|
198
|
+
[]
|
199
|
+
end
|
200
|
+
|
201
|
+
def parse_containers
|
202
|
+
# @see https://github.com/moby/moby/issues/20625, works for docker 1.13+
|
203
|
+
# raw_containers = inspec.command('docker ps -a --no-trunc --format \'{{ json . }}\'').stdout
|
204
|
+
# therefore we stick with older approach
|
205
|
+
labels = %w{Command CreatedAt ID Image Labels Mounts Names Ports RunningFor Size Status}
|
206
|
+
|
207
|
+
# Networks LocalVolumes work with 1.13+ only
|
208
|
+
if !version.empty? && Gem::Version.new(version['Client']['Version']) >= Gem::Version.new('1.13')
|
209
|
+
labels.push('Networks')
|
210
|
+
labels.push('LocalVolumes')
|
211
|
+
end
|
212
|
+
parse_json_command(labels, 'ps -a --no-trunc')
|
213
|
+
end
|
214
|
+
|
215
|
+
def parse_services
|
216
|
+
parse_json_command(%w{ID Name Mode Replicas Image Ports}, 'service ls')
|
217
|
+
end
|
218
|
+
|
219
|
+
def ensure_keys(entry, labels)
|
220
|
+
labels.each { |key|
|
221
|
+
entry[key.downcase] = nil if !entry.key?(key.downcase)
|
222
|
+
}
|
223
|
+
entry
|
224
|
+
end
|
225
|
+
|
226
|
+
def parse_images
|
227
|
+
# docker does not support the `json .` function here, therefore we need to emulate that behavior.
|
228
|
+
raw_images = inspec.command('docker images -a --no-trunc --format \'{ "id": {{json .ID}}, "repository": {{json .Repository}}, "tag": {{json .Tag}}, "size": {{json .Size}}, "digest": {{json .Digest}}, "createdat": {{json .CreatedAt}}, "createdsize": {{json .CreatedSince}} }\'').stdout
|
229
|
+
c_images = []
|
230
|
+
raw_images.each_line { |entry|
|
231
|
+
c_images.push(JSON.parse(entry))
|
232
|
+
}
|
233
|
+
c_images
|
234
|
+
rescue JSON::ParserError => _e
|
235
|
+
warn 'Could not parse `docker images` output'
|
236
|
+
[]
|
237
|
+
end
|
238
|
+
end
|
239
|
+
end
|