aws_security_viz 0.1.7.pre.alpha.pre.145 → 0.2.0.pre.alpha.pre.152

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 81e70d70b82e3e9113db28bfb55d061f7e6c994169873fbc110ae681f63d581b
-  data.tar.gz: 7d8975aeb070a34b7ca6a4e3ee93039eb90404183927bcbec497b4a02c6d22ff
+  metadata.gz: be9db3036820a8e139ef5efdce90c341df24e582dbd8aa7ef7db4b5cfe569926
+  data.tar.gz: 3c64a76b19594f12c42c90afac0fb4577c8be33cf7e1c66bcdf2a85eef7aee24
 SHA512:
-  metadata.gz: 1a535538adadb009119a333e4e0cfbcc88d40db76db39f051839b4b03da57edfd8e14398ff1968f8760086f7aac32a256266ef3a8320c98b3a7adb7913226e34
-  data.tar.gz: 29b361a049411f6b51b2877a3ee9f9a1ba2d81a0002fb6d43882dbec94041c8911b46217d2f7584a7dcfabe668b01973d66be5e7c7752a0820ffdd3ca6e3d374
+  metadata.gz: 378d4705ee99b1b4a8cef8384205d99ccbf8865d3926a83a009c0eb343e9940c88acac971fd8321a93aea622ca3e20832b3a19d87c18d7d5711ab2462c0b7d86
+  data.tar.gz: bf04ed0f86ecef83e8286d97138fca3e485d1d7eeb0333344ecb5ff819b109497b8af687529c6b04122b87d22380afea3e21a052f1df4ba2705a8e31905b3810

data/CHANGELOG.md

@@ -3,6 +3,11 @@ All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
+### Added
+- Add graph navigator renderer using https://grapheco.github.io/InteractiveGraph/
+
+### Changed
+- Renderer no longer identified automatically based on json file extension. 
 
 ## [0.1.6] - 2019-01-14
 ### Added

data/README.md

@@ -42,7 +42,7 @@ To generate the graph using an existing security_groups.json (created using aws-
 To generate a web view
 
 ```
-  $ aws_security_viz -a your_aws_key -s your_aws_secret_key -f aws.json
+  $ aws_security_viz -a your_aws_key -s your_aws_secret_key -f aws.json --renderer navigator
 ```
 
 * Generates two files: aws.json and view.html.

data/exe/aws_security_viz

@@ -13,6 +13,7 @@ opts = Optimist::options do
   opt :filename, 'Output file name', :type => :string, :default => 'aws-security-viz.png'
   opt :config, 'Config file (opts.yml)', :type => :string, :default => 'opts.yml'
   opt :color, 'Colored node edges', :default => false
+  opt :renderer, "Renderer (#{Renderer.all.join('|')})", :default => 'graphviz'
   opt :source_filter, 'Source filter', :default => nil, :type => :string
   opt :target_filter, 'Target filter', :default => nil, :type => :string
 end
@@ -29,5 +30,6 @@ begin
   VisualizeAws.new(config, opts).unleash(opts[:filename])
 rescue Exception => e
   puts "[ERROR] #{e.message}"
+  raise e if config.debug?
   exit 1
 end

data/lib/aws_config.rb

@@ -1,3 +1,5 @@
+require 'yaml'
+
 class AwsConfig
   def initialize(opts={})
     @opts = opts

data/lib/aws_security_viz.rb

@@ -1,8 +1,7 @@
 require_relative 'ec2/security_groups'
 require_relative 'provider/json'
 require_relative 'provider/ec2'
-require_relative 'renderer/graphviz'
-require_relative 'renderer/json'
+require_relative 'renderer/all'
 require_relative 'graph'
 require_relative 'graph_filter'
 require_relative 'exclusions'
@@ -21,20 +20,14 @@ class VisualizeAws
   def unleash(output_file)
     g = build
     g.filter(@options[:source_filter], @options[:target_filter])
-    if output_file.end_with?('json')
-      g.output(Renderer::Json.new(output_file, @config))
-      FileUtils.copy(File.expand_path('../export/html/view.html', __FILE__),
-                     File.expand_path('../view.html', output_file))
-    else
-      g.output(Renderer::GraphViz.new(output_file, @config))
-    end
+    g.output(Renderer.pick(@options[:renderer], output_file, @config))
   end
 
   def build
     g = @config.obfuscate? ? DebugGraph.new(@config) : Graph.new(@config)
     @security_groups.each_with_index { |group, index|
       picker = ColorPicker.new(@options[:color])
-      g.add_node(group.name)
+      g.add_node(group.name, {vpc_id: group.vpc_id, group_id: group.group_id})
       group.traffic.each { |traffic|
         if traffic.ingress
           g.add_edge(traffic.from, traffic.to, :color => picker.color(index, traffic.ingress), :label => traffic.port_range)

data/lib/debug/parse_log.rb

@@ -13,7 +13,7 @@ def debug
   File.readlines('debug-output.log').map do |l| 
     type, left, right = l.split(/\W+/)
     if type=="node"
-      g.add_node(h(left))
+      g.add_node(h(left), {})
     elsif type=="edge"
       g.add_edge(h(left), h(right), {})
     end

data/lib/debug_graph.rb

@@ -6,8 +6,8 @@ class DebugGraph
     @g = Graph.new(config)
   end
 
-  def add_node(name)
-    @g.add_node(h(name)) if name
+  def add_node(name, opts)
+    @g.add_node(h(name), opts) if name
   end
 
   def add_edge(from, to, opts)

data/lib/ec2/security_groups.rb

@@ -29,7 +29,7 @@ end
 class SecurityGroup
   extend Forwardable
 
-  def_delegator :@group, :name
+  def_delegators :@group, :name, :vpc_id, :group_id
 
   def initialize(all_groups, group, config)
     @all_groups = all_groups

data/lib/export/html/navigator.html

@@ -0,0 +1,84 @@
+<html>
+
+<head>
+    <meta http-equiv="Content-Type" content="text/html; charset=utf-8">
+    <title>GraphNavigator</title>
+    <script type="text/javascript" src="https://rawcdn.githack.com/grapheco/InteractiveGraph/0.1.1/dist/igraph/interactive-graph.min.js"></script>
+    <link type="text/css" rel="stylesheet" href="https://rawcdn.githack.com/grapheco/InteractiveGraph/0.1.1/dist/igraph/interactive-graph.min.css">
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.2.1/jquery.min.js" integrity="sha256-hwg4gsxgFZhOsEEamdOYGBf13FyQuiTwlAQgxVSNgt4="
+        crossorigin="anonymous"></script>
+    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/jqueryui/1.12.1/jquery-ui.css" integrity="sha256-p6xU9YulB7E2Ic62/PX+h59ayb3PBJ0WFTEQxq0EjHw="
+        crossorigin="anonymous" />
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/jqueryui/1.12.1/jquery-ui.min.js" integrity="sha256-KM512VNnjElC30ehFwehXjx1YCHPiQkOPmqnrWtpccM="
+        crossorigin="anonymous"></script>
+    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css"
+        integrity="sha256-eZrrJcwDc/3uDhsdt61sL2oOBY362qM3lon1gyExkL0=" crossorigin="anonymous" />
+    <style type="text/css">
+        body {
+            margin: 0px;
+            font-size: 14px;
+        }
+
+        #graphArea {
+            height: 100%;
+            border: 1px solid lightgray;
+        }
+        div.vis-configuration.vis-config-item.vis-config-s3, div.vis-configuration.vis-config-item.vis-config-s2,div.vis-configuration.vis-config-item.vis-config-s0 {
+            background-color: #f7f8fa
+        }
+        .configure {
+            padding: 4px;
+            position: absolute;
+            bottom: 10px;
+            right: 10px;
+            background: #f7f8fa;
+            width: 520px;
+            box-shadow: rgba(116, 112, 112, .555) 1px 1px 10px;
+            z-index: 900
+        }
+    </style>
+
+</head>
+
+<body>
+    <div style="height:100%">
+        <div id="graphArea"></div>
+        <div class="configure">
+            <span class="fa fa-cogs"></span>
+            <a href="#" class="toggle-config">Configure</a>
+            <div id="configOptions" style="display:none"></div>
+        </div>
+    </div>
+
+    <script type="text/javascript">
+        $('.toggle-config').click(function () {
+            $('#configOptions').slideToggle('slow');
+        });
+        function trackAndNavigate(e) {
+            e.nodes.forEach(element => {
+                var deleted = window.nodes.delete(element)
+                if (!deleted) {
+                    window.nodes.add(element);
+                }
+            });
+            if (window.nodes.size >= 2) {
+                var [from, to] = window.nodes;
+                window.location.search = `from=${from}&to=${to}`;
+            }
+        }
+        var file = location.hash.replace(/^#/, '/');
+        var app = new igraph.GraphNavigator(document.getElementById('graphArea'));
+        app.loadGson(file);
+        app._frame._networkOptions.configure = {
+            filter: (option, path) => path.indexOf('physics') !== -1,
+            container: document.getElementById('configOptions'),
+            showButton: false
+        }
+        app._frame.updateNetworkOptions(app._frame._networkOptions)
+
+        window.nodes = new Set();
+        app._frame.on('NETWORK_DBLCLICK', trackAndNavigate);
+    </script>
+</body>
+
+</html>

data/lib/graph.rb

@@ -7,11 +7,13 @@ class Graph
     @config = config
     @underlying = underlying
     @edge_properties = {}
+    @node_properties = {}
   end
 
-  def add_node(name)
-    log("node: #{name}")
+  def add_node(name, opts)
+    log("node: #{name}, opts: #{opts}")
     @underlying.add_vertex(name)
+    @node_properties[name] = opts
   end
 
   def add_edge(from, to, opts)
@@ -25,7 +27,7 @@ class Graph
   end
 
   def output(renderer)
-    @underlying.each_vertex { |v| renderer.add_node(v) }
+    @underlying.each_vertex { |v| renderer.add_node(v, @node_properties[v] || {}) }
     @underlying.each_edge { |u, v|
       renderer.add_edge(u, v, opts(u, v))
     }

data/lib/provider/ec2.rb

@@ -26,7 +26,7 @@ end
 module Ec2
   class SecurityGroup
     extend Forwardable
-    def_delegators :@sg, :name, :group_id
+    def_delegators :@sg, :name, :group_id, :vpc_id
     def initialize(sg)
       @sg = sg
     end

data/lib/provider/json.rb

@@ -22,6 +22,14 @@ module Json
       @sg['GroupName']
     end
 
+    def group_id
+      @sg['GroupId']
+    end
+
+    def vpc_id
+      @sg['VpcId']
+    end
+
     def ip_permissions
       @sg['IpPermissions'].collect { |ip|
         Json::IpPermission.new(ip)

data/lib/renderer/all.rb

@@ -0,0 +1,18 @@
+require_relative 'navigator'
+require_relative 'json'
+require_relative 'graphviz'
+module Renderer
+    ALL = {graphviz: Renderer::GraphViz, json: Renderer::Json, navigator: Renderer::Navigator}
+    def self.pick(r, output_file, config)
+        (ALL[(r || 'graphviz').to_sym]).new(output_file, config)
+    end
+
+    def self.copy_asset(asset, file_name)
+        FileUtils.copy(File.expand_path("../../export/html/#{asset}", __FILE__),
+        File.expand_path(asset, @file_name))
+    end
+
+    def self.all
+        ALL.keys
+    end
+end

data/lib/renderer/graphviz.rb

@@ -14,7 +14,7 @@ module Renderer
       @config = config
     end
 
-    def add_node(name)
+    def add_node(name, opts)
       @g.add_node(name, label: name)
     end
 
@@ -27,7 +27,7 @@ module Renderer
 
     def create_if_missing(name)
       n = @g.get_node(name).first
-      n.nil? ? add_node(name) : n
+      n.nil? ? add_node(name, {}) : n
     end
     
     def output

data/lib/renderer/json.rb

@@ -7,7 +7,7 @@ module Renderer
       @config = config
     end
 
-    def add_node(name)
+    def add_node(name, opts)
       @nodes << {id: name, label: name}
     end
 
@@ -17,7 +17,7 @@ module Renderer
 
     def output
       IO.write(@file_name, {nodes: @nodes, edges: @edges}.to_json)
+      Renderer.copy_asset('view.html', @file_name)
     end
-
   end
 end

data/lib/renderer/navigator.rb

@@ -0,0 +1,32 @@
+require 'set'
+
+module Renderer
+    class Navigator
+      def initialize(file_name, config)
+        @nodes = []
+        @edges = []
+        @file_name = file_name
+        @config = config
+        @categories = Set.new()
+      end
+  
+      def add_node(name, opts)
+        vpc = opts[:vpc_id] || 'default'
+        @nodes << {id: name, label: name, categories: [vpc]}
+        @categories.add(vpc)
+      end
+  
+      def add_edge(from, to, opts)
+        @edges << {id: "#{from}-#{to}", from: from, to: to, label: opts[:label]}
+      end
+  
+      def output
+        IO.write(@file_name, {
+          data: {nodes: @nodes, edges: @edges}, 
+          categories: Hash[@categories.map{|c| [c, c]}]
+        }.to_json)
+        Renderer.copy_asset('navigator.html', @file_name)
+      end
+    end
+  end
+  

data/lib/version.rb

@@ -1,3 +1,3 @@
 module AwsSecurityViz
-  VERSION = '0.1.7'
+  VERSION = '0.2.0'
 end

data/spec/integration/navigator.json

@@ -0,0 +1 @@
+{"categories": {"default":"default"}, "data": {"nodes":[{"id":"app", "label":"app", "categories":["default"]}, {"id":"8.8.8.8/32", "label":"8.8.8.8/32", "categories":["default"]}, {"id":"amazon-elb-sg", "label":"amazon-elb-sg", "categories":["default"]}, {"id":"*", "label":"*", "categories":["default"]}, {"id":"db", "label":"db", "categories":["default"]}], "edges":[{"id":"app-db", "from":"app", "to":"db", "label":"5984/tcp"}, {"id":"8.8.8.8/32-app", "from":"8.8.8.8/32", "to":"app", "label":"80/tcp"}, {"id":"amazon-elb-sg-app", "from":"amazon-elb-sg", "to":"app", "label":"80/tcp"}, {"id":"*-app", "from":"*", "to":"app", "label":"22/tcp"}]}}

data/spec/integration/visualize_aws_spec.rb

@@ -29,7 +29,18 @@ describe VisualizeAws do
 
     it 'should parse json input', :integration => true do
       expect(FileUtils).to receive(:copy)
-      VisualizeAws.new(config, opts).unleash(temp_file.path)
+      VisualizeAws.new(config, opts.merge(:renderer => 'json')).unleash(temp_file.path)
+      expect(JSON.parse(expected_content)).to eq(JSON.parse(actual_content))
+    end
+  end
+
+  context 'json to navigator file' do
+    let(:expected_file) { File.join(File.dirname(__FILE__), 'navigator.json') }
+    let(:temp_file) { Tempfile.new(%w(aws .json)) }
+
+    it 'should parse json input', :integration => true do
+      expect(FileUtils).to receive(:copy)
+      VisualizeAws.new(config, opts.merge(:renderer => 'navigator')).unleash(temp_file.path)
       expect(JSON.parse(expected_content)).to eq(JSON.parse(actual_content))
     end
   end

data/spec/visualize_aws_spec.rb

@@ -7,7 +7,7 @@ class DummyRenderer
     @output = []
   end
 
-  def add_node(name)
+  def add_node(name, opts)
     @output << [:node, name]
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aws_security_viz
 version: !ruby/object:Gem::Version
-  version: 0.1.7.pre.alpha.pre.145
+  version: 0.2.0.pre.alpha.pre.152
 platform: ruby
 authors:
 - Anay Nayak
@@ -191,14 +191,17 @@ files:
 - lib/ec2/security_groups.rb
 - lib/ec2/traffic.rb
 - lib/exclusions.rb
+- lib/export/html/navigator.html
 - lib/export/html/view.html
 - lib/graph.rb
 - lib/graph_filter.rb
 - lib/opts.yml.sample
 - lib/provider/ec2.rb
 - lib/provider/json.rb
+- lib/renderer/all.rb
 - lib/renderer/graphviz.rb
 - lib/renderer/json.rb
+- lib/renderer/navigator.rb
 - lib/version.rb
 - spec/color_picker_spec.rb
 - spec/graph_filter_spec.rb
@@ -206,6 +209,7 @@ files:
 - spec/integration/dummy.dot
 - spec/integration/dummy.json
 - spec/integration/expected.json
+- spec/integration/navigator.json
 - spec/integration/visualize_aws_spec.rb
 - spec/spec_helper.rb
 - spec/visualize_aws_spec.rb
@@ -239,6 +243,7 @@ test_files:
 - spec/integration/dummy.dot
 - spec/integration/dummy.json
 - spec/integration/expected.json
+- spec/integration/navigator.json
 - spec/integration/visualize_aws_spec.rb
 - spec/spec_helper.rb
 - spec/visualize_aws_spec.rb