Mirrors/inspec
2
0
Fork 0
mirror of https://github.com/inspec/inspec synced 2025-02-27 21:07:32 +00:00
Code Issues Projects Releases Packages Wiki Activity

CFINSPEC-78: Add comments for new matchers & property

Browse source 
Signed-off-by: Sonu Saha <sonu.saha@progress.com>
This commit is contained in:
Sonu Saha 2022-04-14 11:34:46 +05:30
parent 2e243617a5
commit 6d8fbbb543
1 changed files with 15 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

21
lib/inspec/resources/linux_audit_system.rb
View file

@ -11,11 +11,12 @@ module Inspec::Resources
desc "Use the `linux_audit_system` Chef InSpec audit resource to test the configuration of linux audit system." desc "Use the `linux_audit_system` Chef InSpec audit resource to test the configuration of linux audit system."
example <<~EXAMPLE example <<~EXAMPLE
describe "linux_audit_system" do describe linux_audit_system do
its("shoe_size") { should cmp 10 } it { should be_enabled }
end it { should be_running }
describe "linux_audit_system" do its("rules") { should include "-w /etc -p wa" }
it { should be_purple } its("rules") { should include %r{-w /etc -p wa} }
its("rules") { should include %r!-w /etc -p wa! }
end end
EXAMPLE EXAMPLE
@ -32,24 +33,32 @@ module Inspec::Resources
"linux_audit_system" "linux_audit_system"
end end
# The be_enabled matcher checks if the auditing is enabled.
# The enabled flag 1 indicates that the auditing is enabled.
def enabled? def enabled?
auditctl_cmd = inspec.command("#{auditctl_utility} -s | grep enabled") auditctl_cmd = inspec.command("#{auditctl_utility} -s | grep enabled")
raise Inspec::Exceptions::ResourceFailed, "Executing #{auditctl_utility} -s | grep enabled failed: #{auditctl_cmd.stderr}" if auditctl_cmd.exit_status.to_i != 0 raise Inspec::Exceptions::ResourceFailed, "Executing #{auditctl_utility} -s | grep enabled failed: #{auditctl_cmd.stderr}" if auditctl_cmd.exit_status.to_i != 0
# Sample stdout: enabled 1
auditctl_enabled_status = auditctl_cmd.stdout.strip.split auditctl_enabled_status = auditctl_cmd.stdout.strip.split
auditctl_enabled_status[1].to_i == 1 auditctl_enabled_status[1].to_i == 1
end end
# The be_running matcher checks if the audit daemon is running.
# A pid of 0 indicates that the audit daemon is not running.
def running? def running?
auditctl_cmd = inspec.command("#{auditctl_utility} -s | grep pid") auditctl_cmd = inspec.command("#{auditctl_utility} -s | grep pid")
raise Inspec::Exceptions::ResourceFailed, "Executing #{auditctl_utility} -s | grep enabled failed: #{auditctl_cmd.stderr}" if auditctl_cmd.exit_status.to_i != 0 raise Inspec::Exceptions::ResourceFailed, "Executing #{auditctl_utility} -s | grep enabled failed: #{auditctl_cmd.stderr}" if auditctl_cmd.exit_status.to_i != 0
# Sample stdout: pid 682462
auditctl_running_status = auditctl_cmd.stdout.strip.split auditctl_running_status = auditctl_cmd.stdout.strip.split
!auditctl_running_status[1].nil? && auditctl_running_status[1].to_i != 0 !auditctl_running_status[1].nil? && auditctl_running_status[1].to_i != 0
end end
# The rules property returns the array of audit rules obtained on auditctl -l.
# The auditctl -l list all rules, 1 per line.
def rules def rules
auditctl_cmd = inspec.command("#{auditctl_utility} -l") auditctl_cmd = inspec.command("#{auditctl_utility} -l")
@ -60,7 +69,7 @@ module Inspec::Resources
private private
# Method to help the resource's matchers and property # Check if auditctl is available on the system.
def find_auditctl_or_error def find_auditctl_or_error
%w{/usr/sbin/auditctl /sbin/auditctl auditctl}.each do |cmd| %w{/usr/sbin/auditctl /sbin/auditctl auditctl}.each do |cmd|
return cmd if inspec.command(cmd).exist? return cmd if inspec.command(cmd).exist?