aws_recon 0.4.4 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 48ccf03d964fff678dc732fcf74d4dcd9c7c06293845bbb9a4f54e9e1ce61a24
-  data.tar.gz: 7c39747a7845fe497be052baae41af8ee45014166d97114abb797d5f6c06e5b9
+  metadata.gz: 7481b13d21571402935b0ce2b67a7cdaaf3d3fc245b49f5569ab249b00a80769
+  data.tar.gz: d755e86dbe27036c6db5aec7a10497f1cf85c4ad64265f673ec10fd1490d9566
 SHA512:
-  metadata.gz: 3b6c26ff3b38dd58c63313b70a609e6b08fe6d16762afb9651bbc81d6cef21d7c46e8b11ad73d40caf0e6abbfd877ef5d5f2fde1536425b70a25afe82b7a4a78
-  data.tar.gz: a74af8ad1b868895d997110a4688bc88266536ad2187c235ba27a0720e3ccce0d18d6959981ab3e82e40bb738944d1402380761f9c3c65ce33cc1649bfddbc4e
+  metadata.gz: a97a2b0b84fd34a79be57dac06caefa77231a7098d2ee221e3d6587d57c51aa181aff4aefeb13bfcfd52578b2f30285ce3e1a2f5f70ed8cff6c37d426f2daaa4
+  data.tar.gz: 7fdab7b7ddebb23fd28d28721966ff1d29a7b3a07c351e6319d3c6cdeb08fc4788869b8c30e2ea5f38a180bfe4cbf55dda05206a9985e568d0ea564d1c7eb19b

data/.github/workflows/check-aws-regions.yml

@@ -0,0 +1,17 @@
+name: check-service-regions
+
+on:
+  schedule:
+    - cron: '40 15 * * *'
+
+jobs:
+  region-check:
+    runs-on: ubuntu-20.04
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+        with:
+          fetch-depth: 1
+      - name: Set version tag
+        run: |
+          cd utils/aws ; ruby check_region_exclusions.rb

data/.solargraph.yml

@@ -0,0 +1,15 @@
+---
+include:
+- "**/*.rb"
+exclude:
+- spec/**/*
+- test/**/*
+- vendor/**/*
+- ".bundle/**/*"
+require: []
+domains: []
+reporters:
+- rubocop
+require_paths: []
+plugins: []
+max_files: 5000

data/lib/aws_recon/aws_recon.rb

@@ -65,6 +65,17 @@ module AwsRecon
       @resources.concat(collection) if @options.output_file
     end
 
+    #
+    # Format @resources as either
+    #
+    def formatted_json
+      if @options.jsonl
+        @resources.map { |r| JSON.generate(r) }.join("\n")
+      else
+        @resources.to_json
+      end
+    end
+
     #
     # main wrapper
     #
@@ -112,7 +123,7 @@ module AwsRecon
       if @options.output_file && !@options.s3
         puts "Saving resources to #{@options.output_file}.\n\n"
 
-        File.write(@options.output_file, @resources.to_json)
+        File.write(@options.output_file, formatted_json)
       end
 
       # write output file to S3 bucket
@@ -128,7 +139,7 @@ module AwsRecon
           # build IO object and gzip it
           io = StringIO.new
           gzip_data = Zlib::GzipWriter.new(io)
-          gzip_data.write(@resources.to_json)
+          gzip_data.write(formatted_json)
           gzip_data.close
 
           # send it to S3

data/lib/aws_recon/collectors/dynamodb.rb

@@ -18,7 +18,7 @@ class DynamoDB < Mapper
 
       struct = OpenStruct.new(response)
       struct.type = 'limits'
-      struct.arn = "arn:aws:dynamodb:#{@region}:#{@account}:limits"
+      struct.arn = "arn:aws:dynamodb:#{@region}:#{@account}/limits"
 
       resources.push(struct.to_h)
     end

data/lib/aws_recon/collectors/ec2.rb

@@ -29,7 +29,7 @@ class EC2 < Mapper
         struct = OpenStruct.new
         struct.attributes = response.account_attributes.map(&:to_h)
         struct.type = 'account'
-        struct.arn = "arn:aws::#{@account}"
+        struct.arn = "arn:aws:ec2::#{@account}:attributes/account_attributes"
 
         resources.push(struct.to_h)
       end
@@ -45,6 +45,7 @@ class EC2 < Mapper
 
         struct = OpenStruct.new(response.to_h)
         struct.type = 'ebs_encryption_settings'
+        struct.arn = "arn:aws:ec2:#{@region}:#{@account}:settings/ebs_encryption_settings"
 
         resources.push(struct.to_h)
       end
@@ -63,7 +64,7 @@ class EC2 < Mapper
           reservation.instances.each do |instance|
             struct = OpenStruct.new(instance.to_h)
             struct.type = 'instance'
-            struct.arn = instance.instance_id # no true ARN
+            struct.arn = "arn:aws:ec2:#{@region}:#{@account}:instance/#{instance.instance_id}" # no true ARN
             struct.reservation_id = reservation.reservation_id
 
             # collect instance user_data
@@ -95,7 +96,7 @@ class EC2 < Mapper
         response.vpcs.each do |vpc|
           struct = OpenStruct.new(vpc.to_h)
           struct.type = 'vpc'
-          struct.arn = vpc.vpc_id # no true ARN
+          struct.arn = "arn:aws:ec2:#{@region}:#{@account}:vpc/#{vpc.vpc_id}" # no true ARN
           struct.flow_logs = @client
                              .describe_flow_logs({ filter: [{ name: 'resource-id', values: [vpc.vpc_id] }] })
                              .flow_logs.first.to_h
@@ -113,7 +114,7 @@ class EC2 < Mapper
         response.security_groups.each do |security_group|
           struct = OpenStruct.new(security_group.to_h)
           struct.type = 'security_group'
-          struct.arn = security_group.group_id # no true ARN
+          struct.arn = "arn:aws:ec2:#{@region}:#{@account}:security_group/#{security_group.group_id}" # no true ARN
 
           resources.push(struct.to_h)
         end
@@ -128,7 +129,7 @@ class EC2 < Mapper
         response.network_interfaces.each do |network_interface|
           struct = OpenStruct.new(network_interface.to_h)
           struct.type = 'network_interface'
-          struct.arn = network_interface.network_interface_id # no true ARN
+          struct.arn = "arn:aws:ec2:#{@region}:#{@account}:network_interface/#{network_interface.network_interface_id}" # no true ARN
 
           resources.push(struct.to_h)
         end
@@ -143,7 +144,7 @@ class EC2 < Mapper
         response.network_acls.each do |network_acl|
           struct = OpenStruct.new(network_acl.to_h)
           struct.type = 'network_acl'
-          struct.arn = network_acl.network_acl_id # no true ARN
+          struct.arn = "arn:aws:ec2:#{@region}:#{@account}:network_acl/#{network_acl.network_acl_id}" # no true ARN
 
           resources.push(struct.to_h)
         end
@@ -173,7 +174,7 @@ class EC2 < Mapper
         response.addresses.each do |address|
           struct = OpenStruct.new(address.to_h)
           struct.type = 'eip_address'
-          struct.arn = address.allocation_id
+          struct.arn = "arn:aws:ec2:#{@region}:#{@account}:eip_address/#{address.allocation_id}" # no true ARN
 
           resources.push(struct.to_h)
         end
@@ -188,7 +189,7 @@ class EC2 < Mapper
         response.nat_gateways.each do |gateway|
           struct = OpenStruct.new(gateway.to_h)
           struct.type = 'nat_gateway'
-          struct.arn = gateway.nat_gateway_id # no true ARN
+          struct.arn = "arn:aws:ec2:#{@region}:#{@account}:nat_gateway/#{gateway.nat_gateway_id}" # no true ARN
 
           resources.push(struct.to_h)
         end
@@ -203,7 +204,7 @@ class EC2 < Mapper
         response.internet_gateways.each do |gateway|
           struct = OpenStruct.new(gateway.to_h)
           struct.type = 'internet_gateway'
-          struct.arn = gateway.internet_gateway_id # no true ARN
+          struct.arn = "arn:aws:ec2:#{@region}:#{@account}:internet_gateway/#{gateway.internet_gateway_id}" # no true ARN
 
           resources.push(struct.to_h)
         end
@@ -218,7 +219,7 @@ class EC2 < Mapper
         response.route_tables.each do |table|
           struct = OpenStruct.new(table.to_h)
           struct.type = 'route_table'
-          struct.arn = table.route_table_id # no true ARN
+          struct.arn = "arn:aws:ec2:#{@region}:#{@account}:route_table/#{table.route_table_id}" # no true ARN
 
           resources.push(struct.to_h)
         end
@@ -233,7 +234,7 @@ class EC2 < Mapper
         response.images.each do |image|
           struct = OpenStruct.new(image.to_h)
           struct.type = 'image'
-          struct.arn = image.image_id # no true ARN
+          struct.arn = "arn:aws:ec2:#{@region}:#{@account}:image/#{image.image_id}" # no true ARN
 
           resources.push(struct.to_h)
         end
@@ -248,7 +249,7 @@ class EC2 < Mapper
         response.snapshots.each do |snapshot|
           struct = OpenStruct.new(snapshot.to_h)
           struct.type = 'snapshot'
-          struct.arn = snapshot.snapshot_id # no true ARN
+          struct.arn = "arn:aws:ec2:#{@region}:#{@account}:snapshot/#{snapshot.snapshot_id}" # no true ARN
           struct.create_volume_permissions = @client.describe_snapshot_attribute({
                                                                                    attribute: 'createVolumePermission',
                                                                                    snapshot_id: snapshot.snapshot_id
@@ -267,7 +268,7 @@ class EC2 < Mapper
         response.flow_logs.each do |flow_log|
           struct = OpenStruct.new(flow_log.to_h)
           struct.type = 'flow_log'
-          struct.arn = flow_log.flow_log_id # no true ARN
+          struct.arn = "arn:aws:ec2:#{@region}:#{@account}:flow_log/#{flow_log.flow_log_id}" # no true ARN
 
           resources.push(struct.to_h)
         end
@@ -282,7 +283,7 @@ class EC2 < Mapper
         response.volumes.each do |volume|
           struct = OpenStruct.new(volume.to_h)
           struct.type = 'volume'
-          struct.arn = volume.volume_id # no true ARN
+          struct.arn = "arn:aws:ec2:#{@region}:#{@account}:volume/#{volume.volume_id}" # no true ARN
 
           resources.push(struct.to_h)
         end
@@ -297,7 +298,7 @@ class EC2 < Mapper
         response.vpn_gateways.each do |gateway|
           struct = OpenStruct.new(gateway.to_h)
           struct.type = 'vpn_gateway'
-          struct.arn = gateway.vpn_gateway_id # no true ARN
+          struct.arn = "arn:aws:ec2:#{@region}:#{@account}:vpn_gateway/#{gateway.vpn_gateway_id}" # no true ARN
 
           resources.push(struct.to_h)
         end
@@ -312,7 +313,7 @@ class EC2 < Mapper
         response.vpc_peering_connections.each do |peer|
           struct = OpenStruct.new(peer.to_h)
           struct.type = 'peering_connection'
-          struct.arn = peer.vpc_peering_connection_id # no true ARN
+          struct.arn = "arn:aws:ec2:#{@region}:#{@account}:peering_connection/#{peer.vpc_peering_connection_id}" # no true ARN
 
           resources.push(struct.to_h)
         end

data/lib/aws_recon/collectors/iam.rb

@@ -50,7 +50,7 @@ class IAM < Mapper
                                          policy_document: p.policy_document.parse_policy
                                        }
                                      end
-                                    end
+                                   end
 
         resources.push(struct.to_h)
       end

data/lib/aws_recon/options.rb

@@ -20,6 +20,7 @@ class Parser
     :output_file,
     :output_format,
     :threads,
+    :jsonl,
     :collect_user_data,
     :skip_slow,
     :skip_credential_report,
@@ -35,8 +36,8 @@ class Parser
         aws_regions = ['global'].concat(Aws::EC2::Client.new.describe_regions.regions.map(&:region_name))
       end
     rescue Aws::Errors::ServiceError => e
-      puts "\nAWS Error: #{e.code}\n\n"
-      exit
+      warn "\nAWS Error: #{e.code}\n\n"
+      exit(1)
     end
 
     aws_services = YAML.load(File.read(SERVICES_CONFIG_FILE), symbolize_names: true)
@@ -55,6 +56,7 @@ class Parser
       false,
       false,
       false,
+      false,
       false
     )
 
@@ -116,6 +118,11 @@ class Parser
         args.threads = threads.to_i if (0..Parser::MAX_THREADS).include?(threads.to_i)
       end
 
+      # output NDJSON/JSONL format
+      opts.on('-l', '--json-lines', 'Output NDJSON/JSONL format (default: false)') do
+        args.jsonl = true
+      end
+
       # collect EC2 instance user data
       opts.on('-u', '--user-data', 'Collect EC2 instance user data (default: false)') do
         args.collect_user_data = true

data/lib/aws_recon/services.yaml

@@ -106,7 +106,7 @@
 - name: SecretsManager
   alias: sm
 - name: SecurityHub
-  alias: sh
+  alias: securityhub
   excluded_regions:
     - ap-northeast-3
 - name: Support

data/lib/aws_recon/version.rb

@@ -1,3 +1,3 @@
 module AwsRecon
-  VERSION = "0.4.4"
+  VERSION = "0.5.2"
 end

data/readme.md

@@ -54,13 +54,13 @@ To run locally, first install the gem:
 
 ```
 $ gem install aws_recon
-Fetching aws_recon-0.4.0.gem
+Fetching aws_recon-0.4.5.gem
 Fetching aws-sdk-3.0.1.gem
 Fetching parallel-1.20.1.gem
 ...
 Successfully installed aws-sdk-3.0.1
 Successfully installed parallel-1.20.1
-Successfully installed aws_recon-0.4.0
+Successfully installed aws_recon-0.4.5
 ```
 
 Or add it to your Gemfile using `bundle`:
@@ -72,7 +72,7 @@ Resolving dependencies...
 ...
 Using aws-sdk 3.0.1
 Using parallel-1.20.1
-Using aws_recon 0.4.0
+Using aws_recon 0.4.5
 ```
 
 ## Usage
@@ -249,7 +249,7 @@ Most users will want to limit collection to relevant services and regions. Runni
 ```
 $ aws_recon -h
 
-AWS Recon - AWS Inventory Collector (0.4.0)
+AWS Recon - AWS Inventory Collector (0.4.5)
 
 Usage: aws_recon [options]
     -r, --regions [REGIONS]          Regions to scan, separated by comma (default: all)
@@ -261,6 +261,7 @@ Usage: aws_recon [options]
     -o, --output [OUTPUT]            Specify output file (default: output.json)
     -f, --format [FORMAT]            Specify output format (default: aws)
     -t, --threads [THREADS]          Specify max threads (default: 8, max: 128)
+    -l, --json-lines                 Output NDJSON/JSONL format (default: false)
     -u, --user-data                  Collect EC2 instance user data (default: false)
     -z, --skip-slow                  Skip slow operations (default: false)
     -g, --skip-credential-report     Skip generating IAM credential report (default: false)

data/utils/aws/check_region_exclusions.rb

@@ -0,0 +1,86 @@
+# frozen_string_literal: true
+
+#
+# Check regional service availability against services.yaml exclusions.
+#
+require 'net/http'
+require 'json'
+require 'yaml'
+
+TS = Time.now.to_i
+URL = "https://api.regional-table.region-services.aws.a2z.com/index.json?timestamp=#{TS}000"
+
+region_exclusion_mistmatch = nil
+
+#
+# load current AWS Recon regions
+#
+recon_services = YAML.safe_load(File.read('../../lib/aws_recon/services.yaml'))
+abort('Errors loading AWS Recon services') unless recon_services.is_a?(Array)
+
+#
+# load current AWS regions (non-gov, non-cn)
+#
+regions = YAML.safe_load(File.read('regions.yaml'))
+abort('Errors loading regions') unless regions['Regions']
+
+all_regions = regions['Regions'].map { |r| r['RegionName'] }
+
+#
+# get service/price list from AWS
+#
+uri = URI(URL)
+res = Net::HTTP.get_response(uri)
+abort('Error loading AWS services from API') unless res.code == '200'
+
+map = {}
+
+#
+# load service region availability
+#
+data = res.body
+json = JSON.parse(data)
+
+# iterate through AWS provided services & regions
+json['prices'].each do |p|
+  at = p['attributes']
+  service_name = at['aws:serviceName']
+  service_id, service_region = p['id'].split(':')
+
+  # skip this service unless AWS Recon already has exclusions
+  next unless recon_services.filter { |s| s['alias'] == service_id }&.length&.positive?
+
+  if map.key?(service_name)
+    map[service_name]['regions'] << service_region
+  else
+    map[service_name] = {
+      'id' => service_id,
+      'regions' => [service_region]
+    }
+  end
+end
+
+# iterate through the services AWS Recon knows about
+map.sort.each do |k, v|
+  service_excluded_regions = all_regions.reject { |r| v['regions'].include?(r) }
+
+  aws_recon_service = recon_services.filter { |s| s['alias'] == v['id'] }&.first
+  aws_recon_service_excluded_regions = aws_recon_service['excluded_regions'] || []
+
+  # move on if AWS Recon region exclusions match AWS service region exclusions
+  next unless service_excluded_regions.sort != aws_recon_service_excluded_regions.sort
+
+  region_exclusion_mistmatch = true
+
+  puts "#{k} (#{v['id']})"
+
+  # determine the direction of the exclusion mismatch
+  if (service_excluded_regions - aws_recon_service_excluded_regions).length.positive?
+    puts " + missing region exclusion: #{(service_excluded_regions - aws_recon_service_excluded_regions).join(', ')}"
+  else
+    puts " - unnecessary region exclusion: #{(aws_recon_service_excluded_regions - service_excluded_regions).join(', ')}"
+  end
+end
+
+# exit code 1 if we have any mismatches
+exit 1 if region_exclusion_mistmatch

data/utils/aws/regions.yaml

@@ -0,0 +1,43 @@
+Regions:
+- Endpoint: ec2.af-south-1.amazonaws.com
+  RegionName: af-south-1
+- Endpoint: ec2.eu-north-1.amazonaws.com
+  RegionName: eu-north-1
+- Endpoint: ec2.ap-south-1.amazonaws.com
+  RegionName: ap-south-1
+- Endpoint: ec2.eu-west-3.amazonaws.com
+  RegionName: eu-west-3
+- Endpoint: ec2.eu-west-2.amazonaws.com
+  RegionName: eu-west-2
+- Endpoint: ec2.eu-south-1.amazonaws.com
+  RegionName: eu-south-1
+- Endpoint: ec2.eu-west-1.amazonaws.com
+  RegionName: eu-west-1
+- Endpoint: ec2.ap-northeast-3.amazonaws.com
+  RegionName: ap-northeast-3
+- Endpoint: ec2.ap-northeast-2.amazonaws.com
+  RegionName: ap-northeast-2
+- Endpoint: ec2.me-south-1.amazonaws.com
+  RegionName: me-south-1
+- Endpoint: ec2.ap-northeast-1.amazonaws.com
+  RegionName: ap-northeast-1
+- Endpoint: ec2.sa-east-1.amazonaws.com
+  RegionName: sa-east-1
+- Endpoint: ec2.ca-central-1.amazonaws.com
+  RegionName: ca-central-1
+- Endpoint: ec2.ap-east-1.amazonaws.com
+  RegionName: ap-east-1
+- Endpoint: ec2.ap-southeast-1.amazonaws.com
+  RegionName: ap-southeast-1
+- Endpoint: ec2.ap-southeast-2.amazonaws.com
+  RegionName: ap-southeast-2
+- Endpoint: ec2.eu-central-1.amazonaws.com
+  RegionName: eu-central-1
+- Endpoint: ec2.us-east-1.amazonaws.com
+  RegionName: us-east-1
+- Endpoint: ec2.us-east-2.amazonaws.com
+  RegionName: us-east-2
+- Endpoint: ec2.us-west-1.amazonaws.com
+  RegionName: us-west-1
+- Endpoint: ec2.us-west-2.amazonaws.com
+  RegionName: us-west-2

data/utils/terraform/ecs.tf

@@ -22,6 +22,7 @@ resource "aws_ecs_task_definition" "aws_recon_task" {
         "--verbose",
         "--format",
         "custom",
+        "--json-lines",
         "--s3-bucket",
         "${aws_s3_bucket.aws_recon.bucket}:${data.aws_region.current.name}",
         "--regions",

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aws_recon
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 0.5.2
 platform: ruby
 authors:
 - Josh Larsen
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-06 00:00:00.000000000 Z
+date: 2021-04-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -163,10 +163,12 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".github/stale.yml"
+- ".github/workflows/check-aws-regions.yml"
 - ".github/workflows/docker-build.yml"
 - ".github/workflows/smoke-test.yml"
 - ".gitignore"
 - ".rubocop.yml"
+- ".solargraph.yml"
 - Dockerfile
 - Gemfile
 - LICENSE.txt
@@ -244,6 +246,8 @@ files:
 - lib/aws_recon/services.yaml
 - lib/aws_recon/version.rb
 - readme.md
+- utils/aws/check_region_exclusions.rb
+- utils/aws/regions.yaml
 - utils/cloudformation/aws-recon-cfn-template.yml
 - utils/terraform/cloudwatch.tf
 - utils/terraform/ecs.tf