fluent-auditify 0.1.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 488bfb6e158a298658a1b8487b9f5a366dceae787c7ca8da92fd0b6a20209fe2
-  data.tar.gz: 5feb6c000fe34dbc4da2929bdef8c103f046aaf65cbc80a74f5d6a30634f4909
+  metadata.gz: 0e823faccd2bd005e3878da8342af95d5ee2943bc019d7b961a76464ce1f138b
+  data.tar.gz: 877ea6a2fd26b975c72421228ab97d1d5287f04f64fcef7bd8dd1e542cd7f851
 SHA512:
-  metadata.gz: 37fcbad8013fed868bf58305e3c96509a7ccb209a3729668c44e8f79413ab780d150533da504cf9f8eb6b43de15351f9258b07e4855bfbbc0d62640ab1695273
-  data.tar.gz: c56ba85d05b47b333d07aa4e0a4ab105eb732326d4dc2764e31f865a265cec2b9ab2ed1ceace30bd699448f480f03ad0a1efbb9c31ef8568df5468a368b04fe3
+  metadata.gz: 76ae20f1d2c181edd3bb9aa708ad348e84d61e0a371bfbcbfabd01c5bced5c331e34b53ca155e45ce05d6960831d2d447b344d4dc66a29c782fe4dc644bbf393
+  data.tar.gz: 56df65aeb54848dfe60961bd8581ab0776d14b3a6fade5be889d35e37ae4473549f205f9cf1a719e701095c861d1df4255947f9ef6c896a965bec4bf17dddf0f

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 ## [Unreleased]
 
+## [0.3.0] - 2025-11-23
+
+* Fixed a bug that included .conf can't be exported correctly.
+* Change the scope of parser methods.
+
+## [0.2.0] - 2025-11-15
+
+* Support to load 3rd party plugin.
+
 ## [0.1.0] - 2025-11-14
 
 - Initial release. still in alpha version.

data/lib/fluent/auditify/helper/test.rb

@@ -33,6 +33,7 @@ module Fluent
                    else
                      test_parse_content_with_debug(path_or_content, klass)
                    end
+          object
         end
 
         def test_parse_content_with_debug(content, klass: Fluent::Auditify::Parser::V1ConfigParser)

data/lib/fluent/auditify/parser/v1config.rb

@@ -95,7 +95,7 @@ module Fluent
         # match is reserved word
         rule(:match_directive) do
           space? >> str('<match').as(:match) >> space? >> pattern?.as(:pattern) >> str('>') >> space_or_newline >>
-            (comment | key_value | empty_line.as(:empty_line) | section).repeat.as(:body) >>
+            (comment | key_value | empty_line.as(:empty_line) | key_line | section).repeat.as(:body) >>
             space? >> str('</match>') >> eof?
         end
         rule(:label) do
@@ -109,46 +109,25 @@ module Fluent
         root :conf
 
         # expand @include directive
-        def self.eval(object, base_dir: "", path: "", include: true)
+        def eval(object, options={})
+          base_dir = options[:base_dir] || ''
+          path = options[:path] || ''
           modified = []
-          object.each_with_index do |element, index|
-            element[:__BASE__] = base_dir
-            element[:__PATH__] = path
-            unless element[:include]
-              if element[:empty_line]
-                modified << element
-              elsif element[:body].collect { |v| v[:name].to_s }.any?('@include')
-                # include section
-                modified_body = []
-                element[:body].each do |body_element|
-                  if body_element[:name].to_s == '@include'
-                    parser = Fluent::Auditify::Parser::V1ConfigSectionParser.new
-                    parsed = parser.parse(File.read(File.join(base_dir, body_element[:value])))
-                    parsed.each do |elem|
-                      elem[:__PATH__] = body_element[:value].to_s
-                      modified_body << elem
-                    end
-                  else
-                    modified_body << body_element
-                  end
-                end
-                element[:body] = modified_body
-                modified << element
+          object.each do |directive|
+            directive[:__BASE__] = base_dir
+            directive[:__PATH__] = path
+            unless directive[:include]
+              if directive[:body]
+                modified << eval_body(directive, options)
               else
-                modified << element
+                modified << directive
               end
               next
             end
-            parser = Fluent::Auditify::Parser::V1ConfigParser.new
-            pattern = File.expand_path(element[:include_path].to_s, base_dir)
-            Dir.glob(pattern).sort.each do |path|
-              included =  parser.parse(File.read(path))
-              included.each do |child|
-                child[:__PATTERN__] = element[:include_path].to_s
-                child[:__PATH__] = Pathname.new(path).relative_path_from(base_dir).to_s
-                child[:__BASE__] = base_dir
-                modified << child
-              end
+            # top-level @include
+            eval_include(directive, options).each do |child|
+              child[:__PARENT__] = path
+              modified << child
             end
           end
           modified
@@ -166,6 +145,65 @@ module Fluent
           end
           nil
         end
+
+        private
+
+        def eval_body(directive, options={})
+          base_dir = options[:base_dir] || ''
+          # include section
+          modified_body = []
+          directive[:body].each do |body_element|
+            if body_element[:name].to_s == '@include'
+              parser = Fluent::Auditify::Parser::V1ConfigSectionParser.new
+              pattern = File.expand_path(body_element[:value].to_s, base_dir)
+              Dir.glob(pattern).sort.each do |path|
+                object = parser.parse(File.read(path))
+                object.each do |element|
+                  element[:__PATTERN__] = body_element[:value].to_s
+                  element[:__PATH__] = File.basename(path)
+                  if element[:section]
+                    element[:body] = eval_body(element, options)[:body]
+                    modified_body << element
+                  else
+                    modified_body << element
+                  end
+                end
+              end
+            elsif body_element[:section]
+              section_body = []
+              body_element[:body].each do |child|
+                child[:__PATH__] = body_element[:__PATH__]
+                section_body << child
+              end
+              body_element[:body] = section_body
+              modified_body << body_element
+            else
+              body_element[:__PATH__] = directive[:__PATH__]
+              modified_body << body_element
+            end
+          end
+          directive[:body] = modified_body
+          directive
+        end
+
+        def eval_include(directive, options={})
+          base_dir = options[:base_dir] || ''
+          parser = Fluent::Auditify::Parser::V1ConfigParser.new
+          pattern = File.expand_path(directive[:include_path].to_s, base_dir)
+          modified = []
+          Dir.glob(pattern).sort.each do |path|
+            included =  parser.parse(File.read(path))
+            included.each do |included_directive|
+              included_directive[:__PATTERN__] = directive[:include_path].to_s
+              included_directive[:__PATH__] = Pathname.new(path).relative_path_from(base_dir).to_s
+              included_directive[:__BASE__] = base_dir
+              included_directive[:body] = eval_body(included_directive, options)[:body]
+              modified << included_directive
+            end
+          end
+          modified
+        end
+
       end
     end
   end

data/lib/fluent/auditify/parsletutil.rb

@@ -13,11 +13,25 @@ module Fluent
         @content = StringIO.new
       end
 
+      def handler_key(object, parent = nil)
+        if object[:__BASE__] and object[:__PATH__]
+          # directive
+          File.join(object[:__BASE__], object[:__PATH__])
+        elsif parent and parent[:__BASE__] and object[:__PATH__]
+          # section, body
+          File.join(parent[:__BASE__], object[:__PATH__])
+        elsif parent and parent[:__BASE__] and parent[:__PATH__]
+          File.join(parent[:__BASE__], parent[:__PATH__])
+        else
+          nil
+        end
+      end
+
       def collect_file_handlers(object)
         handlers = {}
         object.each do |directive|
           if directive[:empty_line]
-            key = directive[:__PATH__]
+            key = handler_key(directive, object)
             unless key and handlers.key?(key)
               if key
                 handlers[key] = File.open(key, 'w+')
@@ -25,14 +39,14 @@ module Fluent
             end
           elsif directive[:source] or directive[:match] or
                directive[:system] or directive[:filter]
-            key = directive[:__PATH__]
+            key = handler_key(directive, object)
             unless key and handlers.key?(key)
               if key
                 handlers[key] = File.open(key, 'w+')
               end
             end
             directive[:body].each do |body|
-              key = body[:__PATH__]
+              key = handler_key(body, directive)
               unless key and handlers.key?(key)
                 if key
                   handlers[key] = File.open(key, 'w+')
@@ -47,55 +61,109 @@ module Fluent
       def export(object, options={})
         # setup rewrite file handles
         @handlers = collect_file_handlers(object)
+        @include_flushed = {}
         object.each do |directive|
-          io = @handlers[directive[:__PATH__]]
+          key = handler_key(directive, object)
           if directive[:system]
-            io.puts("#{' ' * @align * @indent_level}#{directive[:system].to_s}") if io
+            export_line(key, directive[:system].to_s)
             export_body(directive)
-            io.puts('</system>') if io
+            export_line(key, '</system>')
           elsif directive[:source]
-            io.puts "#{' ' * @align * @indent_level}#{directive[:source].to_s}" if io
+            export_line(key, directive[:source].to_s)
             export_body(directive)
-            io.puts('</source>') if io
+            export_line(key, '</source>')
+            if directive[:__PATTERN__] and directive[:__PARENT__]
+              key = File.join(directive[:__BASE__], directive[:__PARENT__])
+              unless @include_flushed[key]
+                export_line(key, "@include #{directive[:__PATTERN__]}")
+                @include_flushed[key] = true
+              end
+            end
           elsif directive[:filter]
-            io.puts "#{' ' * @align * @indent_level}#{directive[:filter].to_s}" if io
+            export_line(key, directive[:filter].to_s)
             export_body(directive)
-            io.puts('</filter>') if io
+            export_line(key, '</filter>')
+            if directive[:__PATTERN__] and directive[:__PARENT__]
+              key = File.join(directive[:__BASE__], directive[:__PARENT__])
+              unless @include_flushed[key]
+                export_line(key, "@include #{directive[:__PATTERN__]}")
+                @include_flushed[key] = true
+              end
+            end
           elsif directive[:match]
-            io.puts "#{' ' * @align * @indent_level}#{directive[:match].to_s}"
+            if directive[:pattern]
+              export_line(key, "#{directive[:match].to_s} #{directive[:pattern]}>")
+            else
+              export_line(key, "#{directive[:match].to_s}>")
+            end
             export_body(directive)
-            io.puts('</match>') if io
+            export_line(key, '</match>')
+          elsif directive[:empty_line]
+            export_line(key, '')
           end
         end
+        @handlers.each do |path, io|
+          io.flush
+          io.fsync
+          io.close
+        end
+        @handlers = []
+      end
+
+      def export_section(section, directive)
+        key = handler_key(section, directive)
+        export_line(key, "<#{section[:section][:name].to_s}>")
+        @indent_level += 1
+        section[:body].each do |kv|
+          key = handler_key(kv, directive)
+          if kv[:value]
+            export_line(key, "#{kv[:name].to_s} #{kv[:value].to_s}")
+          else
+            export_line(key, "#{kv[:name].to_s}")
+          end
+        end
+        @indent_level -= 1
+        export_line(key, "</#{section[:name].to_s}>")
+        export_at_include(section, directive)
+      end
+
+      def export_at_include(object, parent)
+        pattern = object[:__PATTERN__]
+        if pattern
+          unless @include_flushed[pattern]
+            key = handler_key(parent, parent)
+            export_line(key, "@include #{pattern}")
+            @include_flushed[pattern] = true
+          end
+        end
+      end
+
+      def export_line(key, message)
+        io = @handlers[key]
+        if io
+          io.puts("#{' ' * @align * @indent_level}#{message}")
+        end
       end
 
       def export_body(directive)
+        @indent_level += 1
         directive[:body].each do |child|
           if child[:section]
+            export_section(child, directive)
           elsif child[:empty_line]
-            if child[:__PATH__]
-              io = @handlers[child[:__PATH__]]
-              if io
-                io.puts
-              end
-            else
-              io = @handlers[directive[:__PATH__]]
-              if io
-                io.puts
-              end
-            end
+            key = handler_key(child, directive)
+            export_line(key, "")
           elsif child[:value]
-            io = @handlers[child[:__PATH__]]
-            if io
-              io.puts("#{' ' * @align * @indent_level}#{child[:name].to_s} #{child[:value].to_s}")
-            end
+            key = handler_key(child, directive)
+            export_line(key, "#{child[:name].to_s} #{child[:value].to_s}")
+            export_at_include(child, directive)
           elsif child[:name]
-            io = @handlers[child[:__PATH__]]
-            if io
-              io.puts("#{' ' * @align * @indent_level}#{child[:name].to_s}")
-            end
+            key = handler_key(child, directive)
+            export_line(key, child[:name].to_s)
+            export_at_include(child, directive)
           end
         end
+        @indent_level -= 1
       end
 
       def to_s(object, options={})

data/lib/fluent/auditify/plugin/conf_mask_secrets.rb

@@ -24,6 +24,10 @@ module Fluent::Auditify::Plugin
       :any
     end
 
+    def supported_file_extension?
+      [:conf]
+    end
+
     def mask_body(body)
       modified_body = []
       body.each do |child|

data/lib/fluent/auditify/plugin/conf_plugin_type.rb

@@ -17,7 +17,7 @@ module Fluent::Auditify::Plugin
     end
 
     def supported_file_extension?
-      [:conf, :yaml, :yml]
+      [:conf]
     end
 
     def initialize

data/lib/fluent/auditify/plugin_manager.rb

@@ -47,6 +47,15 @@ module Fluent
             require plugin_path
           end
         end
+
+        Gem::Specification.each { |spec|
+          if spec.name.start_with?('fluent-auditify-plugin-')
+            Dir.glob("#{spec.full_gem_path}/lib/fluent/auditify/plugin/conf_*.rb") do |path|
+              @logger.debug("Loading <#{path}>") if @logger
+              require path
+            end
+          end
+        }
       end
 
       def builtin_plugin_paths
@@ -87,6 +96,21 @@ module Fluent
         end
       end
 
+      def supported_file_extension?(plugin, config)
+        unless plugin.respond_to?(:supported_file_extension?)
+          @logger.info("Plugin: <#{plugin.class}> must implement supported_file_extension?")
+          return false
+        end
+        if config.end_with?('.yml', '.yaml') and
+          plugin.supported_file_extension?.include?(:yaml)
+          return true
+        elsif config.end_with?('.conf') and
+             plugin.supported_file_extension?.include?(:conf)
+          return true
+        end
+        false
+      end
+
       def skip_plugin?(plugin)
         unless supported_plugin?(plugin)
           return true
@@ -123,15 +147,23 @@ module Fluent
 
       def evacuate(options={})
         @workspace_dir = Dir.mktmpdir('fluent-auditify')
+        @logger.debug("Create workspace under <#{@workspace_dir}>")
         @base_dir = File.dirname(options[:config])
-        parser = Fluent::Auditify::Parser::V1ConfigParser.new
-        object = parser.parse(File.read(options[:config]))
-
-        # copy configuration files into workspace
-        touched = [options[:config]]
-        touched << collect_related_config_files(object).collect { |v| File.join(@base_dir, v) }
-        touched.flatten!
-        FileUtils.cp(touched, @workspace_dir)
+
+        if options[:config].end_with?('.conf')
+          parser = Fluent::Auditify::Parser::V1ConfigParser.new
+          object = parser.parse(File.read(options[:config]))
+
+          # copy configuration files into workspace
+          touched = [options[:config]]
+          touched << collect_related_config_files(object).collect { |v| File.join(@base_dir, v) }
+          touched.flatten!
+          @logger.debug("Copy configuration files: <#{touched}>")
+          FileUtils.cp(touched, @workspace_dir)
+        else
+          @logger.debug("Copy configuration files: <#{options[:config]}>")
+          FileUtils.cp(options[:config], @workspace_dir)
+        end
       end
 
       def dispatch(options={})
@@ -140,10 +172,8 @@ module Fluent
           next if skip_plugin?(plugin)
 
           config_path = File.join(@workspace_dir, File.basename(options[:config]))
-          ext = plugin.supported_file_extension?
-          ext_symbol = File.extname(config_path).delete('.').to_sym
-          unless ext.any?(ext_symbol)
-            @logger.debug("#{plugin.class} does not support #{config_path}")
+          unless supported_file_extension?(plugin, config_path)
+            @logger.debug("<#{plugin.class}> is not applicable to <#{config_path}>")
             next
           end
 

data/lib/fluent/auditify/version.rb

@@ -2,6 +2,6 @@
 
 module Fluent
   module Auditify
-    VERSION = "0.1.0"
+    VERSION = "0.3.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fluent-auditify
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Kentaro Hayashi