aws_security_viz 0.2.5.pre.alpha.pre.35 → 1.0.0

data/lib/aws_security_viz/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module AwsSecurityViz
+  VERSION = "1.0.0"
+end

data/lib/aws_security_viz.rb

@@ -1,43 +1,50 @@
-require_relative 'ec2/security_groups'
-require_relative 'provider/json'
-require_relative 'provider/ec2'
-require_relative 'renderer/all'
-require_relative 'graph'
-require_relative 'graph_filter'
-require_relative 'exclusions'
-require_relative 'debug_graph'
-require_relative 'color_picker'
-require_relative 'aws_config'
+# frozen_string_literal: true
 
-class VisualizeAws
-  def initialize(config, options={})
-    @options = options
-    @config = config
-    provider = options[:source_file].nil? ? Ec2Provider.new(options) : JsonProvider.new(options)
-    @security_groups = SecurityGroups.new(provider, config)
-  end
+require_relative "aws_security_viz/ec2/security_groups"
+require_relative "aws_security_viz/provider/json"
+require_relative "aws_security_viz/provider/ec2"
+require_relative "aws_security_viz/renderer/all"
+require_relative "aws_security_viz/graph"
+require_relative "aws_security_viz/graph_filter"
+require_relative "aws_security_viz/exclusions"
+require_relative "aws_security_viz/aws_config"
+require_relative "aws_security_viz/cli_guard"
 
-  def unleash(output_file)
-    g = build
-    g.filter(@options[:source_filter], @options[:target_filter])
-    g.output(Renderer.pick(@options[:renderer], output_file, @config))
-  end
+module AwsSecurityViz
+  class VisualizeAws
+    def initialize(config, options = {})
+      @options = options
+      @config = config
+      provider = options[:source_file].nil? ? Ec2Provider.new(options) : JsonProvider.new(options)
+      @security_groups = SecurityGroups.new(provider, config)
+    end
+
+    def unleash(output_file)
+      g = build
+      g.filter(@options[:source_filter], @options[:target_filter])
+      g.output(Renderer.pick(@options[:renderer], output_file, @config))
+      g.risky_edge_count
+    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, {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)
-        else
-          g.add_edge(traffic.to, traffic.from, :color => picker.color(index, traffic.ingress), :label => traffic.port_range)
-        end
+    def build
+      g = Graph.new(@config)
+      peer_names = {}
+      @security_groups.each { |group|
+        peer_names.merge!(@security_groups.peer_names(group))
+        g.add_node(group.id, {label: group.name, vpc_id: group.vpc_id, region: group.region, group_id: group.id}.merge(group.unused ? {unused: true} : {}))
+        @security_groups.traffic(group).each { |traffic|
+          edge = {color: traffic.ingress ? :blue : :red, label: traffic.port_range}
+          edge[:risky] = true if traffic.risky
+          edge[:descriptions] = traffic.descriptions unless traffic.descriptions.empty?
+          if traffic.ingress
+            g.add_edge(traffic.from, traffic.to, edge)
+          else
+            g.add_edge(traffic.to, traffic.from, edge)
+          end
+        }
       }
-    }
-    g
+      peer_names.each { |id, name| g.describe_node(id, {label: name}) }
+      g
+    end
   end
-
 end
-

metadata

@@ -1,208 +1,42 @@
 --- !ruby/object:Gem::Specification
 name: aws_security_viz
 version: !ruby/object:Gem::Version
-  version: 0.2.5.pre.alpha.pre.35
+  version: 1.0.0
 platform: ruby
 authors:
 - Anay Nayak
 bindir: exe
 cert_chain: []
-date: 2024-12-30 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 12.0.0
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 12.0.0
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '13.0'
-- !ruby/object:Gem::Dependency
-  name: rspec
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.5.0
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.5'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.5.0
 - !ruby/object:Gem::Dependency
   name: rexml
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.2.2
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '3.2'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 3.2.2
-- !ruby/object:Gem::Dependency
-  name: graphviz
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.1.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.1'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.1.0
-- !ruby/object:Gem::Dependency
-  name: optimist
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3.3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '3.0'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '3.3'
-- !ruby/object:Gem::Dependency
-  name: organic_hash
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.2
+        version: 3.4.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
-        version: 1.0.2
-- !ruby/object:Gem::Dependency
-  name: rgl
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.5.3
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 0.7.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.5.3
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 0.7.0
-- !ruby/object:Gem::Dependency
-  name: webrick
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.8.1
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 1.10.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 1.8.1
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: 3.4.4
 - !ruby/object:Gem::Dependency
   name: aws-sdk-ec2
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.65'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '1.499'
+        version: '1.400'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '1.65'
-    - - "<"
-      - !ruby/object:Gem::Version
-        version: '1.499'
-- !ruby/object:Gem::Dependency
-  name: base64
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.2.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '1.400'
 description: Provides a quick mechanism to visualize your EC2 security groups in multiple
   formats
 email: anayak007+rubygems@gmail.com
@@ -211,61 +45,44 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".dockerignore"
-- ".editorconfig"
-- ".github/dependabot.yml"
-- ".github/workflows/ruby.yml"
-- ".github/workflows/rubygem.yml"
-- ".github/workflows/rubygem_release.yml"
-- ".gitignore"
-- ".tool-versions"
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
-- Dockerfile
-- Gemfile
 - LICENSE.md
 - README.md
-- Rakefile
-- Vagrantfile
-- aws_security_viz.gemspec
-- config/boot.rb
 - exe/aws_security_viz
-- images/sample.png
-- lib/aws_config.rb
 - lib/aws_security_viz.rb
-- lib/color_picker.rb
-- lib/debug/parse_log.rb
-- lib/debug_graph.rb
-- lib/ec2/ip_permission.rb
-- 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
-- spec/integration/aws_expected.json
-- 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
+- lib/aws_security_viz/aws_config.rb
+- lib/aws_security_viz/cli.rb
+- lib/aws_security_viz/cli_guard.rb
+- lib/aws_security_viz/directed_graph.rb
+- lib/aws_security_viz/ec2/security_groups.rb
+- lib/aws_security_viz/exclusions.rb
+- lib/aws_security_viz/export/html/viewer.html
+- lib/aws_security_viz/graph.rb
+- lib/aws_security_viz/graph_filter.rb
+- lib/aws_security_viz/logging.rb
+- lib/aws_security_viz/model.rb
+- lib/aws_security_viz/obfuscation.rb
+- lib/aws_security_viz/opts.yml.sample
+- lib/aws_security_viz/port_label.rb
+- lib/aws_security_viz/provider/ec2.rb
+- lib/aws_security_viz/provider/json.rb
+- lib/aws_security_viz/renderer/all.rb
+- lib/aws_security_viz/renderer/graphviz.rb
+- lib/aws_security_viz/renderer/html.rb
+- lib/aws_security_viz/renderer/json.rb
+- lib/aws_security_viz/renderer/mermaid.rb
+- lib/aws_security_viz/risk.rb
+- lib/aws_security_viz/vendor/cytoscape/LICENSE
+- lib/aws_security_viz/vendor/cytoscape/README.md
+- lib/aws_security_viz/vendor/cytoscape/cytoscape.min.js
+- lib/aws_security_viz/version.rb
 homepage: https://github.com/anaynayak/aws-security-viz
 licenses:
 - MIT
-metadata: {}
+metadata:
+  source_code_uri: https://github.com/anaynayak/aws-security-viz
+  changelog_uri: https://github.com/anaynayak/aws-security-viz/blob/main/CHANGELOG.md
+  rubygems_mfa_required: 'true'
 rdoc_options: []
 require_paths:
 - lib
@@ -273,24 +90,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.0.0
+      version: '3.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.2
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Visualize your aws security groups
-test_files:
-- spec/color_picker_spec.rb
-- spec/graph_filter_spec.rb
-- spec/integration/aws_expected.json
-- 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
+test_files: []

data/.dockerignore

@@ -1,7 +0,0 @@
-.git
-.bundle
-*.svg
-*.dot
-*.png
-.DS_Store
-navigator.html

data/.editorconfig

@@ -1,17 +0,0 @@
-root = true
-
-[*]
-end_of_line = lf
-insert_final_newline = true
-
-[*.rb]
-charset = utf-8
-indent_style = space
-indent_size = 2
-
-[Makefile]
-indent_style = tab
-
-[.travis.yml]
-indent_style = space
-indent_size = 2

data/.github/dependabot.yml

@@ -1,15 +0,0 @@
-# To get started with Dependabot version updates, you'll need to specify which
-# package ecosystems to update and where the package manifests are located.
-# Please see the documentation for all configuration options:
-# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
-
-version: 2
-updates:
-  - package-ecosystem: "bundler" # See documentation for possible values
-    directory: "/" # Location of package manifests
-    schedule:
-      interval: "weekly"
-  - package-ecosystem: "github-actions"
-    directory: "/"
-    schedule:
-      interval: "weekly"

data/.github/workflows/ruby.yml

@@ -1,34 +0,0 @@
-name: Ruby
-
-on:
-  push:
-  pull_request:
-  schedule:
-    - cron:  '0 0 * * SAT'
-
-jobs:
-  test:
-    runs-on: ${{matrix.os}}-latest
-    strategy:
-      matrix:
-        os:
-          - ubuntu
-          - macos
-
-        ruby:
-          - 3.1
-          - 3.2
-          - 3.3
-          - 3.4
-
-    steps:
-      - uses: actions/checkout@v4
-      - name: Set up Ruby
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: ${{matrix.ruby}}
-      - name: Install dependencies
-        run: bundle install
-      - name: Run tests
-        run: bundle exec rspec spec --tag '~integration'
-

data/.github/workflows/rubygem.yml

@@ -1,29 +0,0 @@
-name: Ruby Gem
-
-on:
-  push:
-    branches: [main]
-
-jobs:
-  build:
-    name: Build + Publish
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v4
-      - name: Set up Ruby 3
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: 3.4
-
-      - name: Publish to RubyGems
-        run: |
-          mkdir -p $HOME/.gem
-          touch $HOME/.gem/credentials
-          chmod 0600 $HOME/.gem/credentials
-          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
-          gem build *.gemspec
-          gem push *.gem
-        env:
-          GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"
-          ALPHA_BUILD_NUMBER: "${{github.run_number}}"

data/.github/workflows/rubygem_release.yml

@@ -1,27 +0,0 @@
-name: Ruby Gem Release
-
-on:
-  release:
-
-jobs:
-  build:
-    name: Build + Publish
-    runs-on: ubuntu-latest
-
-    steps:
-      - uses: actions/checkout@v4
-      - name: Set up Ruby 3
-        uses: ruby/setup-ruby@v1
-        with:
-          ruby-version: 3.2
-
-      - name: Publish to RubyGems
-        run: |
-          mkdir -p $HOME/.gem
-          touch $HOME/.gem/credentials
-          chmod 0600 $HOME/.gem/credentials
-          printf -- "---\n:rubygems_api_key: ${GEM_HOST_API_KEY}\n" > $HOME/.gem/credentials
-          gem build *.gemspec
-          gem push *.gem
-        env:
-          GEM_HOST_API_KEY: "${{secrets.RUBYGEMS_AUTH_TOKEN}}"

data/.gitignore

@@ -1,43 +0,0 @@
-*.gem
-*.rbc
-/.config
-/coverage/
-/InstalledFiles
-/pkg/
-/spec/reports/
-/test/tmp/
-/test/version_tmp/
-/tmp/
-/data/
-
-## Documentation cache and generated files:
-/.yardoc/
-/_yardoc/
-/doc/
-/rdoc/
-
-## Environment normalisation:
-/.bundle/
-/lib/bundler/man/
-
-.ruby-version
-.rbenv-gemsets
-.gems
-.envrc
-
-# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
-.rvmrc
-
-opts.yml
-
-.vagrant
-Gemfile.lock
-
-# in case you run the sample commands in this directory..
-viz.svg
-aws.json
-navigator.html
-*.png
-*.dot
-*.svg
-.DS_Store

data/.tool-versions

@@ -1 +0,0 @@
-ruby 3.4

data/CODE_OF_CONDUCT.md

@@ -1,46 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at whynospam-awsviz@yahoo.co.in. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/

data/Dockerfile

@@ -1,9 +0,0 @@
-FROM ruby:3.4-alpine
-RUN apk add --update \
-        build-base \
-        graphviz \
-        ttf-freefont
-RUN gem install aws_security_viz --pre
-RUN apk del build-base
-WORKDIR /aws-security-viz
-CMD ["aws_security_viz"]

data/Gemfile

@@ -1,3 +0,0 @@
-source 'https://rubygems.org'
-
-gemspec