sgdoc 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2a488f37d0d4b8921d508b17f273dbf423d527bf
+  data.tar.gz: 2a01b6e054105d90ebc8291fe1a6d018d2252598
+SHA512:
+  metadata.gz: 48b43aba768af54d2259d23174d2a1d2fe230202bb607077cdf60f0d7218f5321daa9ea6f4ce2013dadae841e57ca38a8e661f791870daa0f1ccc4f4f6313744
+  data.tar.gz: f8a314a60fc2a564ea08059faa525d0a513fd064883df7ea45591d49be22d5244fde22df06998e27ea51b5117d469565d92b0c5be949e86a346593421cd0504e

data/.gitignore

@@ -0,0 +1,15 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+/vendor/
+
+# rspec failure tracking
+.rspec_status
+
+tags

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.4.0
+before_install: gem install bundler -v 1.14.6

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sgdoc.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Yuji Takaesu
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.ja.md

@@ -0,0 +1,33 @@
+# Sgdoc
+
+AWSのセキュリティグループをいい感じでドキュメント化してテキスト出力する
+デフォルト対応はマークダウンのみ
+ipv6関連は未対応
+SGを参照しているサービスはEC2,RDS,ELBを対象とする(その他は適宜追加)
+
+## 有効な場面
+
+- セキュリティグループは結構変えることが多い（それにドキュメントをつい付いしていくのが大変なので自動化できると楽）
+
+## やりたいこと
+
+- [ ] aws-sdkで必要な情報を取得してハッシュ化
+- [ ] Erubisに渡してerbテンプレートで展開する
+    - ドキュメントにはSecurityGroupの内容
+    - 関連付けの情報(EC2, ELB, EC2)
+- [ ] SecurityGroupのIn,Outのポリシーにコメントを入れれるようにしたい(別ファイルでポートのコメント管理。定型文はYamlで管理(0.0.0.0/0など))
+
+
+### Credentialは次の順番で有効になる
+- (これは設定しないのでいらないかな) `:access_key_id` , `:secret_access_key` , and `:session_token` options
+- `ENV['AWS_ACCESS_KEY_ID']`, `ENV['AWS_SECRET_ACCESS_KEY']`
+- HOME/.aws/credentials shared credentials file
+- EC2 instance profile credentials See Plugins::RequestSigner for more details.
+
+## Requirements
+
+Ruby 2.1 or higher
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/README.md

@@ -0,0 +1,41 @@
+# Sgdoc
+
+Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sgdoc`. To experiment with that code, run `bin/console` for an interactive prompt.
+
+TODO: Delete this and the text above, and describe your gem
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'sgdoc'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install sgdoc
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/sgdoc.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "sgdoc"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/exe/sgdoc

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+
+require 'sgdoc'
+
+Sgdoc::Cli.run(ARGV)

data/lib/sgdoc.rb

@@ -0,0 +1,11 @@
+require 'aws-sdk'
+require 'erubis'
+require 'delegate'
+
+require 'sgdoc/version'
+require 'sgdoc/cli'
+require 'sgdoc/client'
+require 'sgdoc/ec2/instance'
+require 'sgdoc/ec2/security_group'
+require 'sgdoc/ec2/ip_permission'
+require 'sgdoc/ec2/ip_permission_collection'

data/lib/sgdoc/cli.rb

@@ -0,0 +1,15 @@
+module Sgdoc
+  module Cli
+    def self.run(argv)
+      # VPC Information vpc_id, cidr, name
+
+      client = Client.new
+      template_path = File.expand_path('../templates/security_groups.md.erb', __FILE__)
+
+      result = Erubis::Eruby.new(File.read(template_path))
+        .result(security_groups_by_vpc_id: client.security_groups_by_vpc_id, instances_by_vpc_id: client.instances_by_vpc_id)
+
+      puts result
+    end
+  end
+end

data/lib/sgdoc/client.rb

@@ -0,0 +1,24 @@
+module Sgdoc
+  # TODO: VPCから順に構造体にしていく方法にした方がいい
+  class Client
+    attr_reader :security_groups
+
+    def initialize(ec2_client: nil, ec2_resource: nil)
+      @ec2_client = ec2_client || Aws::EC2::Client.new
+      @ec2_resource = ec2_resource || Aws::EC2::Resource.new(client: @ec2_client)
+    end
+
+    def security_groups_by_vpc_id
+      describe_security_groups = @ec2_client.describe_security_groups.security_groups
+      security_groups ||= describe_security_groups.map { |sg| Sgdoc::EC2::SecurityGroup.new(sg) }
+
+      # vpcIDのキーをvpcのオブジェクトにしても良い
+      security_groups.group_by { |sg| sg.vpc_id }
+    end
+
+    def instances_by_vpc_id
+      instances = @ec2_resource.instances.map { |i| Sgdoc::EC2::Instance.new(i) }
+      instances.group_by { |i| i.vpc_id }
+    end
+  end
+end

data/lib/sgdoc/ec2/instance.rb

@@ -0,0 +1,17 @@
+module Sgdoc
+  module EC2
+    class Instance < SimpleDelegator
+      def initialize(aws_instance)
+        super(aws_instance)
+      end
+
+      def name
+        tags.detect { |t| t.key == 'Name' }&.value
+      end
+
+      def group_names_to_s
+        security_groups.map(&:group_name).join(', ')
+      end
+    end
+  end
+end

data/lib/sgdoc/ec2/ip_permission.rb

@@ -0,0 +1,45 @@
+module Sgdoc
+  module EC2
+    class IpPermission < SimpleDelegator
+      ALL_STRING = 'all'
+
+      def initialize(ip_permission:, ip_range: nil, user_id_group_pair: nil)
+        raise StandardError 'Unknown pattern of IpPermission, at least must need ip_range or user_id_group_pair' if ip_range.nil? && user_id_group_pair.nil?
+
+        @ip_range = ip_range
+        @user_id_group_pair = user_id_group_pair
+        super(ip_permission)
+      end
+
+      # http://docs.aws.amazon.com/sdkforruby/api/Aws/EC2/Types/IpPermission.html#ip_protocol-instance_method
+      def protocol
+        ip_protocol == '-1' ? ALL_STRING : ip_protocol
+      end
+
+      # http://docs.aws.amazon.com/sdkforruby/api/Aws/EC2/Types/IpPermission.html#from_port-instance_method
+      # http://docs.aws.amazon.com/sdkforruby/api/Aws/EC2/Types/IpPermission.html#to_port-instance_method
+      def port
+        if protocol == ALL_STRING
+          ALL_STRING
+        elsif from_port == -1 && to_port == -1
+          'ICMP ALL'
+        elsif from_port == -1 || to_port == -1
+          'CUSTOM ICMP'
+        elsif from_port == to_port
+          from_port
+        else
+          "#{from_port} - #{to_port}"
+        end
+      end
+
+      def target
+        @ip_range ? @ip_range.cidr_ip : @user_id_group_pair.group_id
+      end
+
+      def doc_description
+        # TODO desriptionを出力する使用を考える(IPベースの設定ファイルでいいかも)
+        '-'
+      end
+    end
+  end
+end

data/lib/sgdoc/ec2/ip_permission_collection.rb

@@ -0,0 +1,27 @@
+module Sgdoc
+  module EC2
+    class IpPermissionCollection
+      include Enumerable
+
+      def initialize(ip_permissions)
+        # ip_ranges, user_id_group_pairs(security_group) がそれぞれ Source, Destination として定義される
+        # ip_rages, user_id_group_pairsはそれぞれ配列で複数ある場合がある
+        @ip_permissions = ip_permissions.each_with_object([]) do |ip_permission, memo|
+          ip_permission.ip_ranges.each do |ip_range|
+            memo << IpPermission.new(ip_permission: ip_permission, ip_range: ip_range)
+          end
+
+          ip_permission.user_id_group_pairs.each do |user_id_group_pair|
+            memo << IpPermission.new(ip_permission: ip_permission, user_id_group_pair: user_id_group_pair)
+          end
+        end
+      end
+
+      def each
+        @ip_permissions.each do |ip_permission|
+          yield ip_permission
+        end
+      end
+    end
+  end
+end

data/lib/sgdoc/ec2/security_group.rb

@@ -0,0 +1,25 @@
+module Sgdoc
+  module EC2
+    class SecurityGroup < SimpleDelegator
+      def initialize(aws_security_group)
+        super(aws_security_group)
+      end
+
+      def inbound_permissions
+        IpPermissionCollection.new(ip_permissions)
+      end
+
+      def outbound_permissions
+        IpPermissionCollection.new(ip_permissions_egress)
+      end
+
+      def tags_to_json
+        return '-' if tags.empty?
+
+        tags.each_with_object({}) do |tag, memo|
+          memo[tag.key] = tag.value
+        end.to_json
+      end
+    end
+  end
+end

data/lib/sgdoc/templates/security_groups.md.erb

@@ -0,0 +1,44 @@
+<% security_groups_by_vpc_id.each do |vpc_id, security_groups| %>
+# Security Groups (<%= vpc_id %>)
+
+<% security_groups.each do |sg| %>
+## <%= sg.group_name %>
+
+| Group ID | Description | Tags |
+| ---- | ---- | ---- |
+| <%= sg.group_id %> | <%= sg.description %> | <%= sg.tags_to_json %> |
+
+### Inbound
+
+| Protocol | Port | Source | _Description |
+| ---- | ---- | ---- | ---- |
+<% if sg.inbound_permissions.each do |iperm| %>
+| <%= iperm.protocol %> | <%= iperm.port %> | <%= iperm.target %> | <%= iperm.doc_description %> |
+<% end.empty? %>
+| | | | |
+<% end %>
+
+### Outbound
+
+| Protocol | Port | Destination | _Description |
+| ---- | ---- | ---- | ---- |
+<% if sg.outbound_permissions.each do |operm| %>
+| <%= operm.protocol %> | <%= operm.port %> | <%= operm.target %> | <%= operm.doc_description %> |
+<% end.empty? %>
+| | | | |
+<% end %>
+
+<% end %>
+## Instances references
+
+<% if instances = instances_by_vpc_id[vpc_id] %>
+| Instance Name | Instance ID | Security Groups |
+| ---- | ---- | ---- |
+<%   instances.each do |instance| %>
+| <%= instance.name %> | <%= instance.instance_id %> | <%= instance.group_names_to_s %> |
+<%   end %>
+<% else %>
+| | | |
+<% end %>
+
+<% end %>

data/lib/sgdoc/version.rb

@@ -0,0 +1,3 @@
+module Sgdoc
+  VERSION = '0.1.0'
+end

data/sgdoc.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'sgdoc/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'sgdoc'
+  spec.version       = Sgdoc::VERSION
+  spec.authors       = ['Yuji Takaesu']
+  spec.email         = ['taka.esu.user@gmail.com']
+
+  spec.summary       = 'AWS SecurityGroup docs generator'
+  spec.description   = 'Abstrat tools for AWS SecurityGroup docs'
+  spec.homepage      = 'https://github.com/yusabana/sgdoc'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'aws-sdk', '~> 2'
+  spec.add_dependency 'erubis'
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'tapp-awesome_print'
+  spec.add_development_dependency 'pry-byebug'
+end

metadata

@@ -0,0 +1,164 @@
+--- !ruby/object:Gem::Specification
+name: sgdoc
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Yuji Takaesu
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-07-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !ruby/object:Gem::Dependency
+  name: erubis
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: tapp-awesome_print
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Abstrat tools for AWS SecurityGroup docs
+email:
+- taka.esu.user@gmail.com
+executables:
+- sgdoc
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.ja.md
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- exe/sgdoc
+- lib/sgdoc.rb
+- lib/sgdoc/cli.rb
+- lib/sgdoc/client.rb
+- lib/sgdoc/ec2/instance.rb
+- lib/sgdoc/ec2/ip_permission.rb
+- lib/sgdoc/ec2/ip_permission_collection.rb
+- lib/sgdoc/ec2/security_group.rb
+- lib/sgdoc/templates/security_groups.md.erb
+- lib/sgdoc/version.rb
+- sgdoc.gemspec
+homepage: https://github.com/yusabana/sgdoc
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.11
+signing_key: 
+specification_version: 4
+summary: AWS SecurityGroup docs generator
+test_files: []