modsecurity_audit_log_parser 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3fde4e6ff7aa635c2e8a201d4dc084b98137cf50
+  data.tar.gz: b572628e316eac2d617af827c3cd3b01d6978d8c
+SHA512:
+  metadata.gz: c9dd71d05960a666d82a5f773dd4dc2ba3ad28ae9e57aca275c1c614241fb045cd8bb44bbb05697ee835b5596f306f77a017fba64391dbf27bd27d5214fc228f
+  data.tar.gz: 16688e2e480054bc6ec21ff62e4c47e85041d45a7269a37659e3c2ee1add75e558b3264c101c1f9b8af9c98fb5ec2f5fe9c288b102d342e1b834f56c4efd8f44

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.14.3

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in modsecurity_audit_log_parser.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "{}"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright {yyyy} {name of copyright owner}
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -0,0 +1,40 @@
+# ModsecurityAuditLogParser
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/modsecurity_audit_log_parser`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## License
+
+Apache License Version 2.0
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'modsecurity_audit_log_parser'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install modsecurity_audit_log_parser
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Hiroshi Nakamura/modsecurity_audit_log_parser.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/lib/modsecurity_audit_log_parser.rb

@@ -0,0 +1,300 @@
+require 'modsecurity_audit_log_parser/version'
+require 'date'
+
+class ModsecurityAuditLogParser
+  class Log
+    attr_reader :id
+
+    def initialize(id)
+      @id = id
+      @parts = {}
+    end
+
+    def add(part)
+      @parts[part.type] = part
+    end
+
+    MODSEC_TIMESTAMP_FORMAT = '%d/%b/%Y:%H:%M:%S %z'
+    def time
+      if ts = audit_log_header&.timestamp
+        DateTime.strptime(ts, MODSEC_TIMESTAMP_FORMAT).to_time.to_i rescue 0
+      end
+    end
+
+    [:timestamp, :unique_transaction_id, :source_ip_address, :source_port, :destination_ip_address, :destination_port].each do |name|
+      define_method(name) do
+        audit_log_header&.send(name)
+      end
+    end
+
+    def trailers
+      audit_log_trailer&.trailers
+    end
+
+    def rules
+      audit_log_trailer&.rules
+    end
+
+    def audit_log_header
+      @parts['A']
+    end
+
+    def request_headers
+      @parts['B']
+    end
+
+    def request_body
+      @parts['C']
+    end
+
+    def original_response_body
+      @parts['E']
+    end
+
+    def response_header
+      @parts['F']
+    end
+
+    def audit_log_trailer
+      @parts['H']
+    end
+
+    def reduced_multipart_request_body
+      @parts['I']
+    end
+
+    def multipart_files_information
+      @parts['J']
+    end
+
+    def matched_rules_information
+      @parts['K']
+    end
+
+    def to_h
+      @parts.inject(Hash.new) { |r, (k, v)|
+        v.merge!(r)
+        r
+      }
+    end
+  end
+
+  class Part
+    module PartClassMethods
+      def register(type, klass)
+        (@@registry ||= {})[type] = klass
+        @type = type
+      end
+
+      def type
+        @type
+      end
+      
+      def self.class_for_type(type)
+        @@registry[type]
+      end
+    end
+
+    def self.inherited(klass)
+      klass.extend(PartClassMethods)
+    end
+
+    def type
+      self.class.type
+    end
+
+    def self.new_subclass(type)
+      PartClassMethods.class_for_type(type).new
+    end
+
+    def add(line)
+      raise
+    end
+
+    def to_hash
+      hash = {}
+      merge!(hash)
+      hash
+    end
+
+    def merge!(hash)
+      raise
+    end
+  end
+
+  class ContentPart < Part
+    attr_reader :content
+
+    def initialize
+      @content = ''
+    end
+
+    def add(line)
+      @content << line
+    end
+  end
+
+  class AuditLogHeaderPart < Part
+    register('A', self)
+
+    attr_reader :timestamp, :unique_transaction_id, :source_ip_address, :source_port, :destination_ip_address, :destination_port
+
+    def add(line)
+      datetime, rest = line.chomp.split(/\] /, 2)
+      @timestamp = datetime.sub(/\[/, '')
+      @unique_transaction_id, @source_ip_address, @source_port, @destination_ip_address, @destination_port = rest.split(/ /, 5)
+    end
+
+    def merge!(hash)
+      hash[:timestamp] = @timestamp
+      hash[:unique_transaction_id] = @unique_transaction_id
+      hash[:source_ip_address] = @source_ip_address
+      hash[:source_port] = @source_port
+      hash[:destination_ip_address] = @destination_ip_address
+      hash[:destination_port] = @destination_port
+    end
+  end
+
+  class RequestHeadersPart < ContentPart
+    register('B', self)
+
+    def merge!(hash)
+      hash[:request_headers] = @content
+    end
+  end
+
+  class RequestBodyPart < ContentPart
+    register('C', self)
+
+    def merge!(hash)
+      hash[:request_body] = @content
+    end
+  end
+
+  class OriginalResponseBodyPart < ContentPart
+    register('E', self)
+
+    def merge!(hash)
+      hash[:original_response_body] = @content
+    end
+  end
+
+  class ResponseHeadersPart < ContentPart
+    register('F', self)
+
+    def merge!(hash)
+      hash[:response_headers] = @content
+    end
+  end
+
+  class AuditLogTrailerPart < Part
+    register('H', self)
+
+    attr_reader :trailers
+
+    def initialize
+      @trailers = {}
+    end
+
+    def add(line)
+      key, value = line.chomp.split(/: /, 2)
+      if key == 'Message'
+        (@trailers[:Message] ||= '') << value << "\n"
+      elsif key
+        @trailers[key.intern] = value
+      end
+    end
+
+    def rules
+      if pairs = @trailers[:Message]&.scan(/\[(\w+) "([^\\"]*(?:\\.[^\\"]*)*)"\]/)
+        pairs.inject({}) { |r, (k, v)|
+          r["rule_#{k}".intern] = v
+          r
+        }
+      end
+    end
+
+    def merge!(hash)
+      hash.merge!(@trailers)
+      if h = rules
+        hash.merge!(h)
+      end
+    end
+  end
+
+  class ReducedMultipartRequestBodyPart < ContentPart
+    register('I', self)
+
+    def merge!(hash)
+      hash[:reduce_multipart_request_body] = @content
+    end
+  end
+
+  class MultipartFilesInformationPart < ContentPart
+    register('J', self)
+
+    def merge!(hash)
+      hash[:multipart_files_information] = @content
+    end
+  end
+
+  class MatchedRulesInformationPart < ContentPart
+    register('K', self)
+
+    def merge!(hash)
+      hash[:matched_rules_information] = @content
+    end
+  end
+
+  class AuditLogFooterPart < Part
+    register('Z', self)
+
+    def add(line)
+      # ignore
+    end
+
+    def merge!(hash)
+      # ignore
+    end
+  end
+
+  def initialize(targets = 'ABCEFHIJKZ')
+    @targets = targets.split('')
+    @records = []
+  end
+
+  def parse(str)
+    str.each_line do |line|
+      if /\A--([0-9a-z]+)-(.)--/ =~ line
+        id, type = $1, $2
+        if @log.nil? or @log.id != id
+          @log = Log.new(id)
+          @records << @log
+        end
+        unless @targets.include?(type)
+          @part = nil
+          next
+        end
+        @part = Part.new_subclass(type)
+        @log.add(@part)
+      else
+        @part.add(line) if @part
+      end
+    end
+    self
+  end
+
+  # Caller makes sure that all stream was passed to `parse`
+  def shift(*a)
+    @records.shift(*a)
+  end
+end
+
+
+if $0 == __FILE__
+  parser = ModsecurityAuditLogParser.new
+  parser.parse(ARGF)
+  parser.shift(100).each do |log|
+    p log.to_h
+  end
+end

data/lib/modsecurity_audit_log_parser/version.rb

@@ -0,0 +1,3 @@
+class ModsecurityAuditLogParser
+  VERSION = '0.1.1'
+end

data/modsecurity_audit_log_parser.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'modsecurity_audit_log_parser/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "modsecurity_audit_log_parser"
+  spec.version       = ModsecurityAuditLogParser::VERSION
+  spec.authors       = ["Hiroshi Nakamura"]
+  spec.email         = ["nahi@ruby-lang.org"]
+
+  spec.summary       = %q{Modsecurity AuditLog parser library.}
+  spec.description   = %q{For parsing AuditLog.}
+  spec.homepage      = "https://github.com/nahi/modsecurity_audit_log_parser"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |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", "~> 1.14"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

metadata

@@ -0,0 +1,94 @@
+--- !ruby/object:Gem::Specification
+name: modsecurity_audit_log_parser
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Hiroshi Nakamura
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-05-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+description: For parsing AuditLog.
+email:
+- nahi@ruby-lang.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/modsecurity_audit_log_parser.rb
+- lib/modsecurity_audit_log_parser/version.rb
+- modsecurity_audit_log_parser.gemspec
+homepage: https://github.com/nahi/modsecurity_audit_log_parser
+licenses: []
+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: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Modsecurity AuditLog parser library.
+test_files: []