oso-oso 0.14.0 → 0.15.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e2aee8d8308beb5cb906dff373ef43f8a90c5d3f
-  data.tar.gz: a121f6f4b7534f53934f49aab4e634cbbbe7f0db
+  metadata.gz: 32e04bc53de8b9a2a8820365219be2b0e345e765
+  data.tar.gz: 911eea4f97fe5aba8cb0f97485e7c9c86c68772e
 SHA512:
-  metadata.gz: 6cb9212a01eaa50005a5d3923632741cfbbfff8c28c42a3c7f30b2cf6bf6aeba58fbe4f4c87ff3ccb43deb21dfd2db6e3f95ce7aded5996fe2eb6cb74d5de162
-  data.tar.gz: ef8ec9735a3aba0c18d9da63ea0fda8b36e1d6c6cd3306611b1b126d6587f1381b2e558680058c4c926ed9d736b7fa21c96f92ae179b0df485d24ea3bd1c1791
+  metadata.gz: 70a6be55d3f0291aa53ff067dfdeea504cd261b40f2aeb4c613887c78fb7cf8d86de91e34f169c2e1198fa0f1c49a999dda8d4d608b9e61ca3011cb72925a8cf
+  data.tar.gz: e23bca87576a43d12e54d4206fbb50595f4bc6d8c0c06eb7a090c2fad5978c3a5f63f851d974ec5ec2469f6b9b20246826c58f29654d34ea5fe5fa8ef197d6cd

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    oso-oso (0.14.0)
+    oso-oso (0.15.1)
       ffi (~> 1.0)
 
 GEM

data/lib/oso/polar/ffi/error.rb

@@ -24,7 +24,7 @@ module Oso
         #
         # @return [::Oso::Polar::Error] if there's an FFI error.
         # @return [::Oso::Polar::FFIErrorNotFound] if there isn't one.
-        def self.get # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
+        def self.get(enrich_message) # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength, Metrics/PerceivedComplexity
           error = Rust.get
           return ::Oso::Polar::FFIErrorNotFound if error.null?
 
@@ -40,6 +40,13 @@ module Oso
             subkind, details = nil
           end
 
+          # Enrich error message and stack trace
+          msg = enrich_message.call(msg) if msg
+          if details
+            details['stack_trace'] = enrich_message.call(details['stack_trace']) if details['stack_trace']
+            details['msg'] = enrich_message.call(details['msg']) if details['msg']
+          end
+
           case kind
           when 'Parse'
             parse_error(subkind, msg: msg, details: details)

data/lib/oso/polar/ffi/message.rb

@@ -19,10 +19,11 @@ module Oso
           attach_function :free, :string_free, [Message], :int32
         end
 
-        def process
+        def process(enrich_message)
           message = JSON.parse(to_s)
           kind = message['kind']
           msg = message['msg']
+          msg = enrich_message.call(msg)
 
           case kind
           when 'Print'

data/lib/oso/polar/ffi/polar.rb

@@ -7,6 +7,8 @@ module Oso
     module FFI
       # Wrapper class for Polar FFI pointer + operations.
       class Polar < ::FFI::AutoPointer
+        attr_accessor :enrich_message
+
         Rust = Module.new do
           extend ::FFI::Library
           ffi_lib FFI::LIB_PATH
@@ -30,7 +32,7 @@ module Oso
         # @raise [FFI::Error] if the FFI call returns an error.
         def self.create
           polar = Rust.new
-          raise FFI::Error.get if polar.null?
+          handle_error if polar.null?
 
           polar
         end
@@ -39,14 +41,14 @@ module Oso
         def enable_roles
           result = Rust.enable_roles(self)
           process_messages
-          raise FFI::Error.get if result.zero?
+          handle_error if result.zero?
         end
 
         # @raise [FFI::Error] if the FFI call returns an error.
         def validate_roles_config(config)
           result = Rust.validate_roles_config(self, JSON.dump(config))
           process_messages
-          raise FFI::Error.get if result.zero?
+          handle_error if result.zero?
         end
 
         # @param src [String]
@@ -55,14 +57,14 @@ module Oso
         def load(src, filename: nil)
           loaded = Rust.load(self, src, filename)
           process_messages
-          raise FFI::Error.get if loaded.zero?
+          handle_error if loaded.zero?
         end
 
         # @raise [FFI::Error] if the FFI call returns an error.
         def clear_rules
           cleared = Rust.clear_rules(self)
           process_messages
-          raise FFI::Error.get if cleared.zero?
+          handle_error if cleared.zero?
         end
 
         # @return [FFI::Query] if there are remaining inline queries.
@@ -80,7 +82,7 @@ module Oso
           id = Rust.new_id(self)
           # TODO(gj): I don't think this error check is correct. If getting a new ID fails on the
           # Rust side, it'll probably surface as a panic (e.g., the KB lock is poisoned).
-          raise FFI::Error.get if id.zero?
+          handle_error if id.zero?
 
           id
         end
@@ -91,7 +93,7 @@ module Oso
         def new_query_from_str(str)
           query = Rust.new_query_from_str(self, str, 0)
           process_messages
-          raise FFI::Error.get if query.null?
+          handle_error if query.null?
 
           query
         end
@@ -102,7 +104,7 @@ module Oso
         def new_query_from_term(term)
           query = Rust.new_query_from_term(self, JSON.dump(term), 0)
           process_messages
-          raise FFI::Error.get if query.null?
+          handle_error if query.null?
 
           query
         end
@@ -112,7 +114,7 @@ module Oso
         # @raise [FFI::Error] if the FFI call returns an error.
         def register_constant(value, name:)
           registered = Rust.register_constant(self, name, JSON.dump(value))
-          raise FFI::Error.get if registered.zero?
+          handle_error if registered.zero?
         end
 
         def next_message
@@ -124,9 +126,13 @@ module Oso
             message = next_message
             break if message.null?
 
-            message.process
+            message.process(enrich_message)
           end
         end
+
+        def handle_error
+          raise FFI::Error.get(enrich_message)
+        end
       end
     end
   end

data/lib/oso/polar/ffi/query.rb

@@ -7,6 +7,8 @@ module Oso
     module FFI
       # Wrapper class for Query FFI pointer + operations.
       class Query < ::FFI::AutoPointer
+        attr_accessor :enrich_message
+
         Rust = Module.new do
           extend ::FFI::Library
           ffi_lib FFI::LIB_PATH
@@ -27,7 +29,7 @@ module Oso
         def debug_command(cmd)
           res = Rust.debug_command(self, cmd)
           process_messages
-          raise FFI::Error.get if res.zero?
+          handle_error if res.zero?
         end
 
         # @param result [String]
@@ -35,7 +37,7 @@ module Oso
         # @raise [FFI::Error] if the FFI call returns an error.
         def call_result(result, call_id:)
           res = Rust.call_result(self, call_id, result)
-          raise FFI::Error.get if res.zero?
+          handle_error if res.zero?
         end
 
         # @param result [Boolean]
@@ -44,7 +46,7 @@ module Oso
         def question_result(result, call_id:)
           result = result ? 1 : 0
           res = Rust.question_result(self, call_id, result)
-          raise FFI::Error.get if res.zero?
+          handle_error if res.zero?
         end
 
         # @param result [Boolean]
@@ -52,7 +54,7 @@ module Oso
         # @raise [FFI::Error] if the FFI call returns an error.
         def application_error(message)
           res = Rust.application_error(self, message)
-          raise FFI::Error.get if res.zero?
+          handle_error if res.zero?
         end
 
         # @return [::Oso::Polar::QueryEvent]
@@ -60,7 +62,7 @@ module Oso
         def next_event
           event = Rust.next_event(self)
           process_messages
-          raise FFI::Error.get if event.null?
+          handle_error if event.null?
 
           ::Oso::Polar::QueryEvent.new(JSON.parse(event.to_s))
         end
@@ -74,7 +76,7 @@ module Oso
             message = next_message
             break if message.null?
 
-            message.process
+            message.process(enrich_message)
           end
         end
 
@@ -82,10 +84,14 @@ module Oso
         # @raise [FFI::Error] if the FFI call returns an error.
         def source
           res = Rust.source(self)
-          raise FFI::Error.get if res.null?
+          handle_error if res.null?
 
           res.to_s
         end
+
+        def handle_error
+          raise FFI::Error.get(enrich_message)
+        end
       end
     end
   end

data/lib/oso/polar/host.rb

@@ -149,6 +149,33 @@ module Oso
         raise PolarRuntimeError, "Error constructing instance of #{cls_name}: #{e}"
       end
 
+      OPS = {
+        'Lt' => :<,
+        'Gt' => :>,
+        'Eq' => :==,
+        'Geq' => :>=,
+        'Leq' => :<=,
+        'Neq' => :!=
+      }.freeze
+
+      # Compare two values
+      #
+      # @param op [String] operation to perform.
+      # @param args [Array<Object>] left and right args to operation.
+      # @raise [PolarRuntimeError] if operation fails or is unsupported.
+      # @return [Boolean]
+      def operator(operation, args)
+        left, right = args
+        op = OPS[operation]
+        raise PolarRuntimeError, "Unsupported external operation '#{left.class} #{operation} #{right.class}'" if op.nil?
+
+        begin
+          left.__send__ op, right
+        rescue StandardError
+          raise PolarRuntimeError, "External operation '#{left.class} #{operation} #{right.class}' failed."
+        end
+      end
+
       # Check if the left class is more specific than the right class
       # with respect to the given instance.
       #
@@ -174,17 +201,6 @@ module Oso
         instance.is_a? cls
       end
 
-      # Check if two instances unify
-      #
-      # @param left_instance_id [Integer]
-      # @param right_instance_id [Integer]
-      # @return [Boolean]
-      def unify?(left_instance_id, right_instance_id)
-        left_instance = get_instance(left_instance_id)
-        right_instance = get_instance(right_instance_id)
-        left_instance == right_instance
-      end
-
       # Turn a Ruby value into a Polar term that's ready to be sent across the
       # FFI boundary.
       #
@@ -226,7 +242,7 @@ module Oso
                     { 'Pattern' => { 'Instance' => { 'tag' => value.tag, 'fields' => dict['Dictionary'] } } }
                   end
                 else
-                  { 'ExternalInstance' => { 'instance_id' => cache_instance(value), 'repr' => value.to_s } }
+                  { 'ExternalInstance' => { 'instance_id' => cache_instance(value), 'repr' => nil } }
                 end
         { 'value' => value }
       end
@@ -292,6 +308,12 @@ module Oso
           raise UnexpectedPolarTypeError, tag
         end
       end
+
+      def enrich_message(msg)
+        msg.gsub(/\^\{id: ([0-9]+)\}/) do
+          get_instance(Regexp.last_match[1].to_i).to_s
+        end
+      end
     end
   end
 end

data/lib/oso/polar/polar.rb

@@ -34,9 +34,10 @@ module Oso
       # @return [Host]
       attr_reader :host
 
-      def initialize
+      def initialize # rubocop:disable Metrics/MethodLength
         @ffi_polar = FFI::Polar.create
         @host = Host.new(ffi_polar)
+        @ffi_polar.enrich_message = @host.method(:enrich_message)
         @polar_roles_enabled = false
 
         # Register global constants.

data/lib/oso/polar/query.rb

@@ -13,6 +13,7 @@ module Oso
       def initialize(ffi_query, host:)
         @calls = {}
         @ffi_query = ffi_query
+        ffi_query.enrich_message = host.method(:enrich_message)
         @host = host
       end
 
@@ -146,13 +147,12 @@ module Oso
             class_tag = event.data['class_tag']
             answer = host.isa?(instance, class_tag: class_tag)
             question_result(answer, call_id: event.data['call_id'])
-          when 'ExternalUnify'
-            left_instance_id = event.data['left_instance_id']
-            right_instance_id = event.data['right_instance_id']
-            answer = host.unify?(left_instance_id, right_instance_id)
-            question_result(answer, call_id: event.data['call_id'])
           when 'Debug'
-            puts event.data['message'] if event.data['message']
+            msg = event.data['message']
+            if msg
+              msg = host.enrich_message(msg) if msg
+              puts msg
+            end
             print 'debug> '
             begin
               input = $stdin.readline.chomp.chomp(';')
@@ -162,7 +162,10 @@ module Oso
             command = JSON.dump(host.to_polar(input))
             ffi_query.debug_command(command)
           when 'ExternalOp'
-            raise UnimplementedOperationError, 'comparison operators'
+            op = event.data['operator']
+            args = event.data['args'].map(&host.method(:to_ruby))
+            answer = host.operator(op, args)
+            question_result(answer, call_id: event.data['call_id'])
           when 'NextExternal'
             call_id = event.data['call_id']
             iterable = event.data['iterable']

data/lib/oso/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Oso
-  VERSION = '0.14.0'
+  VERSION = '0.15.1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: oso-oso
 version: !ruby/object:Gem::Version
-  version: 0.14.0
+  version: 0.15.1
 platform: ruby
 authors:
 - Oso Security, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-07-16 00:00:00.000000000 Z
+date: 2021-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi