oso-oso 0.14.1 → 0.14.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e611289b05e0398183cb6e7f29929b2854b1aaad
-  data.tar.gz: bd8af76c1433c16193b4cf2587cc5ca9f953c5b8
+  metadata.gz: 73973c0ee45c628fe89e2310f004d6d10312a40f
+  data.tar.gz: f8365839689e9eac4caedaa04c85eda33ed09836
 SHA512:
-  metadata.gz: 6778dedbfe11bb27219ed96712e3e93e79d3187455aad86040764e25b34079a4645ec16de0afed876faa88b290e58fad7e22ccd2ee6aaa61529bd1f9b6231a28
-  data.tar.gz: d21fda13edd7176ecc3dad96258f57f19f51b3114ee02c1fb844277befd0abf9a8cfb035df0593a49977a884aa2bc3fbfd6734cc547be0ef5093d149f866c8d7
+  metadata.gz: edc94997d13562f6e989d07d59edf528223c82733263ab988ab679356c82618de505976731d12050e08dd2a12521b243a913ea7cf89b84f59e327bcf0f89eb70
+  data.tar.gz: 50d4be1eeb6b17490336c372ff7617f756ba83315529c3f060d6e11e543a30b8b79b2d6e4c02ce5a45e8d3130526a661c3f89623ac20251e73aa3cc6c65e6937

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    oso-oso (0.14.1)
+    oso-oso (0.14.2)
       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

@@ -242,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
@@ -308,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
 
@@ -147,7 +148,11 @@ module Oso
             answer = host.isa?(instance, class_tag: class_tag)
             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(';')

data/lib/oso/version.rb

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

metadata

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