dgi_audit_log_parser 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: cfe0f22dffe2af8402075e859e53a3b5d4aa7ba5069203074c984ba5f000890e
+  data.tar.gz: 310826d4fecd470aa4e65ebd9c3d558850ec9f98081ac1d987b51e11090212ed
+SHA512:
+  metadata.gz: 45ec4bc87fb328a731e3188107de52c43dac50c7e3dcf2bc657f66b6c0db87be6be89f2b3cf04b4d31e83a462b48c1c9360904f8609cb5f0f7ba367bceb2405b
+  data.tar.gz: 1cb65f9cf7ecdb4d4e482a4f03b32360117c10f5f6b44fb0b121ba69673ea82644ae18717c561f25133df57cce3738fc4d48b4220536b2aa65a5ea2bb459d916

data/.github/workflows/ruby.yml

@@ -0,0 +1,28 @@
+name: Ruby
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby-version: ['2.6', '2.7', '3.0']
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby-version }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - name: Run tests
+      run: bundle exec rake

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+Gemfile.lock
+test.rb
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in audit_log_parser.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 winebarrel
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,107 @@
+# audit_log_parser
+
+It is a library for parsing [linux's audit log](https://github.com/linux-audit/audit-documentation/wiki).
+
+[![Gem Version](https://badge.fury.io/rb/dgi_audit_log_parser.svg)](https://badge.fury.io/rb/dgi_audit_log_parser)
+[![](https://img.shields.io/badge/rubydoc-reference-blue.svg)](https://www.rubydoc.info/gems/dgi_audit_log_parser)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dgi_audit_log_parser'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dgi_audit_log_parser
+
+## Usage
+
+```ruby
+#!/usr/bin/env ruby
+require 'audit_log_parser'
+require 'pp'
+
+audit_log1 = <<EOS
+type=SYSCALL msg=audit(1364481363.243:24287): arch=c000003e syscall=2 success=no exit=-13 a0=7fffd19c5592 a1=0 a2=7fffd19c4b50 a3=a items=1 ppid=2686 pid=3538 auid=500 uid=500 gid=500 euid=500 suid=500 fsuid=500 egid=500 sgid=500 fsgid=500 tty=pts0 ses=1 comm="cat" exe="/bin/cat" subj=unconfined_u:unconfined_r:unconfined_t:s0-s0:c0.c1023 key="sshd_config"
+EOS
+
+pp AuditLogParser.parse_line(audit_log1)
+#=> {"header"=>{"type"=>"SYSCALL", "msg"=>"audit(1364481363.243:24287)"},
+#    "body"=>
+#     {"arch"=>"c000003e",
+#      "syscall"=>"2",
+#      "success"=>"no",
+#      "exit"=>"-13",
+#      "a0"=>"7fffd19c5592",
+#      "a1"=>"0",
+#      "a2"=>"7fffd19c4b50",
+#      "a3"=>"a",
+#      "items"=>"1",
+#      "ppid"=>"2686",
+#      "pid"=>"3538",
+#      "auid"=>"500",
+#      "uid"=>"500",
+#      "gid"=>"500",
+#      "euid"=>"500",
+#      "suid"=>"500",
+#      "fsuid"=>"500",
+#      "egid"=>"500",
+#      "sgid"=>"500",
+#      "fsgid"=>"500",
+#      "tty"=>"pts0",
+#      "ses"=>"1",
+#      "comm"=>"\"cat\"",
+#      "exe"=>"\"/bin/cat\"",
+#      "subj"=>"unconfined_u:unconfined_r:unconfined_t:s0-s0:c0.c1023",
+#      "key"=>"\"sshd_config\""}}
+
+audit_log2 = <<EOS
+type=USER_AUTH msg=audit(1364475353.159:24270): user pid=3280 uid=500 auid=500 ses=1 subj=unconfined_u:unconfined_r:unconfined_t:s0-s0:c0.c1023 msg='op=PAM:authentication acct="root" exe="/bin/su" hostname=? addr=? terminal=pts/0 res=failed'
+EOS
+
+pp AuditLogParser.parse_line(audit_log2)
+#=> {"header"=>{"type"=>"USER_AUTH", "msg"=>"audit(1364475353.159:24270)"},
+#    "body"=>
+#     {"user pid"=>"3280",
+#      "uid"=>"500",
+#      "auid"=>"500",
+#      "ses"=>"1",
+#      "subj"=>"unconfined_u:unconfined_r:unconfined_t:s0-s0:c0.c1023",
+#      "msg"=>
+#       {"op"=>"PAM:authentication",
+#        "acct"=>"\"root\"",
+#        "exe"=>"\"/bin/su\"",
+#        "hostname"=>"?",
+#        "addr"=>"?",
+#        "terminal"=>"pts/0",
+#        "res"=>"failed"}}}
+
+audit_log3 = <<EOS
+type=PATH msg=audit(1364481363.243:24287): item=0 name="/etc/ssh/sshd_config" inode=409248 dev=fd:00 mode=0100600 ouid=0 ogid=0 rdev=00:00 obj=system_u:object_r:etc_t:s0
+EOS
+
+pp AuditLogParser.parse_line(audit_log3, flatten: true)
+#=> {"header_type"=>"PATH",
+#    "header_msg"=>"audit(1364481363.243:24287)",
+#    "body_item"=>"0",
+#    "body_name"=>"\"/etc/ssh/sshd_config\"",
+#    "body_inode"=>"409248",
+#    "body_dev"=>"fd:00",
+#    "body_mode"=>"0100600",
+#    "body_ouid"=>"0",
+#    "body_ogid"=>"0",
+#    "body_rdev"=>"00:00",
+#    "body_obj"=>"system_u:object_r:etc_t:s0"}
+```
+
+## Related Links
+
+* [7.6. Understanding Audit Log Files - Red Hat Customer Portal](https://access.redhat.com/documentation/en-us/red_hat_enterprise_linux/6/html/security_guide/sec-understanding_audit_log_files)
+* [SPEC Writing Good Events · linux-audit/audit-documentation Wiki](https://github.com/linux-audit/audit-documentation/wiki/SPEC-Writing-Good-Events)

data/Rakefile

@@ -0,0 +1,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/audit_log_parser.gemspec

@@ -0,0 +1,29 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'audit_log_parser/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'dgi_audit_log_parser'
+  spec.version       = AuditLogParser::VERSION
+  spec.authors       = ['winebarrel', 'aeber']
+  spec.email         = ['']
+
+  spec.summary       = %q{It is a library for parsing.}
+  spec.description   = %q{It is a library for parsing.}
+  spec.homepage      = 'https://github.com/dg-i/audit_log_parser'
+  spec.license       = 'MIT'
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "audit_log_parser"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/audit_log_parser/version.rb

@@ -0,0 +1,3 @@
+class AuditLogParser
+  VERSION = '1.0.1'
+end

data/lib/audit_log_parser.rb

@@ -0,0 +1,106 @@
+require 'strscan'
+require 'audit_log_parser/version'
+
+class AuditLogParser
+  class Error < StandardError; end
+
+  def self.parse(src, flatten: false)
+    src.each_line.map do |line|
+      parse_line(line, flatten: flatten)
+    end
+  end
+
+  def self.parse_line(line, flatten: false)
+    line = line.strip
+
+    if line !~ /type=\w+ msg=audit\([\d.:]+\): */
+      raise Error, "Invalid audit log header: #{line.inspect}"
+    end
+
+    header, body = line.split(/\): */, 2)
+    header << ')'
+    header.sub!(/: *\z/, '')
+    header = parse_header(header)
+    unless body.empty?
+      body, enriched = body.split('\u001D', 2)
+    end
+    body = parse_body(body)
+    if enriched.nil?
+      result = {'header' => header, 'body' => body}
+    else
+      result = {'header' => header, 'body' => body, 'enriched'=>enriched.strip}
+    end
+    flatten ? flatten_hash(result) : result
+  end
+
+  def self.parse_header(header)
+    result = {}
+
+    header.split(' ').each do |kv|
+      key, value = kv.split('=', 2)
+      result[key] = value
+    end
+
+    result
+  end
+  private_class_method :parse_header
+
+  def self.parse_body(body)
+    if body.empty?
+      return {}
+    elsif !body.include?('=')
+      raise Error, "Invalid audit log body: #{body.inspect}"
+    end
+
+    result = {}
+    ss = StringScanner.new(body)
+
+    while key = ss.scan_until(/=/)
+      if key.include?(', ')
+        msg, key = key.split(', ', 2)
+        result['_message'] = msg.strip
+      end
+
+      key.chomp!('=').strip!
+      value = ss.getch
+
+      case value
+      when nil
+        break
+      when ' '
+        next
+      when '"'
+        value << ss.scan_until(/"/)
+      when "'"
+        nest = ss.scan_until(/'/)
+        nest.chomp!("'")
+        value = parse_body(nest)
+      else
+        value << ss.scan_until(/( |\z)/)
+        value.chomp!(' ')
+      end
+
+      result[key] = value
+    end
+
+    unless ss.rest.empty?
+      raise "must not happen: #{body}"
+    end
+
+    result
+  end
+  private_class_method :parse_body
+
+  def self.flatten_hash(h)
+    h.flat_map {|key, value|
+      if value.is_a?(Hash)
+        flatten_hash(value).map do |sub_key, sub_value|
+          ["#{key}_#{sub_key}", sub_value]
+        end
+      else
+        [[key, value]]
+      end
+    }.to_h
+  end
+  private_class_method :flatten_hash
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: dgi_audit_log_parser
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- winebarrel
+- aeber
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-10-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: It is a library for parsing.
+email:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/ruby.yml"
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- audit_log_parser.gemspec
+- bin/console
+- bin/setup
+- lib/audit_log_parser.rb
+- lib/audit_log_parser/version.rb
+homepage: https://github.com/dg-i/audit_log_parser
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.25
+signing_key:
+specification_version: 4
+summary: It is a library for parsing.
+test_files: []