hiera-file 1.0.1 → 1.1.0

data/lib/hiera/backend/file_backend.rb

@@ -1,44 +1,80 @@
+require 'hiera/config'
+
 class Hiera
   module Backend
     class File_backend
       def initialize
         Hiera.debug("Hiera File backend starting")
+
+        if Hiera::Config.include?(:file) and Hiera::Config[:file].has_key? :interpolate
+          @interpolate = Hiera::Config[:file][:interpolate]
+        else
+          @interpolate = true
+        end
       end
 
       def lookup(key, scope, order_override, resolution_type)
         answer = nil
 
-        Hiera.debug("Looking up #{key} in JSON backend")
+        Hiera.debug("Looking up #{key} in File backend")
 
         Backend.datasources(scope, order_override) do |source|
           Hiera.debug("Hiera File_backend: looking for data source '#{source}'")
 
           datadir = Backend.datafile(:file, scope, source, "d") or next
 
-          # Expand the datadir and path, and ensure that the datadir contains
-          # the given key. If the expanded key is outside of the datadir then
-          # this is a directory traversal attack and should be aborted.
-          abs_datadir = File.expand_path(datadir)
-          abs_path    = File.expand_path(File.join(abs_datadir, key))
-          unless abs_path.index(abs_datadir) == 0
-            raise Exception, "Hiera File backend: key lookup outside of datadir '#{key}'"
-          end
+          validate_key_lookup!(datadir, key)
+
+          path = File.join(datadir, key)
+          next unless File.exist?(path)
 
-          next unless File.exist?(abs_path)
-          data = File.read(abs_path)
+          data = File.read(path)
 
           case resolution_type
           when :array
             answer ||= []
-            answer << Backend.parse_answer(data, scope)
+            answer << parse_answer(data, scope)
           else
-            answer = Backend.parse_answer(data, scope)
+            answer = parse_answer(data, scope)
             break
           end
         end
 
         answer
       end
+
+      # Ensure that looked up files are within the datadir to prevent directory traversal
+      #
+      # @param datadir [String] The directory being used for the lookup
+      # @param key     [String] The key being looked up
+      #
+      # @todo Raise a SecurityError instead of an Exception
+      # @raise [Exception] If the path to the data file is outside of the datadir
+      def validate_key_lookup!(datadir, key)
+
+        # Expand the datadir and path, and ensure that the datadir contains
+        # the given key. If the expanded key is outside of the datadir then
+        # this is a directory traversal attack and should be aborted.
+        abs_datadir = File.expand_path(datadir)
+        abs_path    = File.expand_path(File.join(abs_datadir, key))
+        unless abs_path.index(abs_datadir) == 0
+          raise Exception, "Hiera File backend: key lookup outside of datadir '#{key}'"
+        end
+      end
+
+      # Parse the answer according to the chosen interpolation mode
+      #
+      # @param data  [String] The value to parse
+      # @param scope [Hash] The variable scope to use for interpolation
+      #
+      # @return [String] The interpolated data
+      def parse_answer(data, scope)
+        if @interpolate
+          Backend.parse_answer(data, scope)
+        else
+          data
+        end
+      end
     end
   end
 end

data/spec/unit/file_backend_spec.rb

@@ -7,8 +7,9 @@ class Hiera
       before do
         Hiera.stubs(:debug)
         Hiera.stubs(:warn)
-      end
 
+        Hiera::Config.load(:backends => :file)
+      end
 
       describe "#initialize" do
         it "should announce its creation" do # because other specs checks this
@@ -23,8 +24,6 @@ class Hiera
           Backend.stubs(:datasources).multiple_yields(["one"], ["two"])
         end
 
-        subject { File_backend.new }
-
         it "should look for data in all sources" do
           Backend.expects(:datafile).with(:file, {}, "one", "d")
           Backend.expects(:datafile).with(:file, {}, "two", "d")
@@ -59,16 +58,60 @@ class Hiera
             subject.lookup("key", {}, nil, :array).should == ['value one', 'value two']
           end
 
-          it "should parse the answer for scope variables" do
-            scope = {'scope_val' => 'v'}
+          describe "With interpolation" do
+            after do
+              Hiera::Config.load({:file => {}})
+            end
 
-            Backend.expects(:datafile).with(:file, scope, "one", "d").returns("/datadir/one.d")
-            Backend.expects(:datafile).with(:file, scope, "two", "d").never
+            describe "explicitly enabled" do
+              before do
+                Hiera::Config.load({:file => {:interpolate => true}})
+              end
 
-            File.expects(:exist?).with("/datadir/one.d/key").returns true
-            File.expects(:read).with("/datadir/one.d/key").returns '%{scope_val}alue'
+              it "should parse the answer for scope variables" do
+                scope = {'scope_val' => 'v'}
+
+                Backend.expects(:datafile).with(:file, scope, "one", "d").returns("/datadir/one.d")
+                Backend.expects(:datafile).with(:file, scope, "two", "d").never
+
+                File.expects(:exist?).with("/datadir/one.d/key").returns true
+                File.expects(:read).with("/datadir/one.d/key").returns '%{scope_val}alue'
+
+                subject.lookup("key", scope, nil, :priority).should == 'value'
+              end
+            end
+
+            describe "set to default" do
+              it "should parse the answer for scope variables" do
+                scope = {'scope_val' => 'v'}
+
+                Backend.expects(:datafile).with(:file, scope, "one", "d").returns("/datadir/one.d")
+                Backend.expects(:datafile).with(:file, scope, "two", "d").never
+
+                File.expects(:exist?).with("/datadir/one.d/key").returns true
+                File.expects(:read).with("/datadir/one.d/key").returns '%{scope_val}alue'
+
+                subject.lookup("key", scope, nil, :priority).should == 'value'
+              end
+            end
+
+            describe "explicitly disabled" do
+              before do
+                Hiera::Config.load({:file => {:interpolate => false}})
+              end
+
+              it "should not parse the answer for scope variables" do
+                scope = {'scope_val' => 'v'}
+
+                Backend.expects(:datafile).with(:file, scope, "one", "d").returns("/datadir/one.d")
+                Backend.expects(:datafile).with(:file, scope, "two", "d").never
+
+                File.expects(:exist?).with("/datadir/one.d/key").returns true
+                File.expects(:read).with("/datadir/one.d/key").returns '%{scope_val}alue'
 
-            subject.lookup("key", scope, nil, :priority).should == 'value'
+                subject.lookup("key", scope, nil, :priority).should == '%{scope_val}alue'
+              end
+            end
           end
 
           it "should prevent directory traversal attacks" do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hiera-file
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-11 00:00:00.000000000 Z
+date: 2013-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hiera