aws_recon 0.4.1 → 0.4.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 212cb7795c7ff6e28ef56336bdd26de0e4d174e71b85f841fb71d60584e6967f
-  data.tar.gz: 2c25dacdbf4124361ae3a76726d72557ba5cb6ac16fbdffd0ae636f8d8ef5f86
+  metadata.gz: f57ce63e04f7bad6fdbecd4e412ed5bee5e20a4a174e13bf84e2ad421a462179
+  data.tar.gz: a40190f6985c6eaa4445e24eb7d7e9161c88423a4a846663be2160b4e2c9a2da
 SHA512:
-  metadata.gz: '08a247b20671f56f119101e26e257489ae71c81461e5cf59d0ccf9538c1f0a81d72bedae93eed1a5f3e9e18de846f4a9000e781b0a69c355355f8fd4195ba129'
-  data.tar.gz: e479cb51db2afc92493b06f17928a9ae6549b8799e345484835219e177c191d29360d3309eec32ba1ea9b5ae3a5e84cfa9c31c61c480c422f0022497d6e46a9b
+  metadata.gz: 7b51e177c7fc4dee6373d35d528db677561895dff0f7d65ce73776672bbef40f3fd951337eb2df160edb5b328bfb762467e13aa8682b991abe062635958bb73d
+  data.tar.gz: 6c08343cc189bcb4366ac29fc7a685726f3fd9bd6789ca5145bddc6d7c42f5effbbbfd867f1353b02780671e2a368599cfc4098b48e10b7efcfac60b66266cab

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/route53.rb

@@ -19,7 +19,7 @@ class Route53 < Mapper
       response.hosted_zones.each do |zone|
         struct = OpenStruct.new(zone.to_h)
         struct.type = 'zone'
-        struct.arn = "aws:route53:#{@region}:#{@account}:zone/#{zone.name}"
+        struct.arn = "arn:aws:route53:#{@region}:#{@account}:zone/#{zone.name}"
         struct.logging_config = @client
                                 .list_query_logging_configs({ hosted_zone_id: zone.id })
                                 .query_logging_configs.first.to_h

data/lib/aws_recon/collectors/s3.rb

@@ -73,6 +73,9 @@ class S3 < Mapper
         end
 
         resources.push(struct.to_h)
+
+      rescue Aws::S3::Errors::NoSuchBucket
+        # skip missing bucket
       end
     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,
@@ -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/version.rb

@@ -1,3 +1,3 @@
 module AwsRecon
-  VERSION = "0.4.1"
+  VERSION = "0.4.6"
 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/cloudformation/aws-recon-cfn-template.yml

@@ -0,0 +1,151 @@
+AWSTemplateFormatVersion: '2010-09-09'
+Description: 'Deploys AWS Recon inventory collection resources, scheduled ECS task and corresponding IAM roles and policies.'
+Resources:
+  AWSReconVPC:
+    Type: AWS::EC2::VPC
+    Properties:
+      CidrBlock: '10.75.0.0/27'
+      Tags:
+        - Key: Name
+          Value: aws-recon-CFN
+  AWSReconSubnet:
+    Type: AWS::EC2::Subnet
+    Properties:
+      CidrBlock: '10.75.0.0/28'
+      VpcId: !Ref AWSReconVPC
+      Tags:
+        - Key: Name
+          Value: aws-recon-CFN
+    DependsOn: AWSReconVPC
+  AWSReconSecurityGroup:
+    Type: AWS::EC2::SecurityGroup
+    Properties:
+      GroupDescription: AWS Recon collection egress
+      VpcId: !Ref AWSReconVPC
+      SecurityGroupEgress:
+        - IpProtocol: -1
+          FromPort: 0
+          ToPort: 0
+          CidrIp: 0.0.0.0/0
+      Tags:
+        - Key: Name
+          Value: aws-recon-CFN
+  AWSReconInternetGateway:
+    Type: AWS::EC2::InternetGateway
+    Properties:
+      Tags:
+        - Key: Name
+          Value: aws-recon-CFN
+  AWSReconInternetGatewayAttachment:
+    Type: AWS::EC2::VPCGatewayAttachment
+    Properties:
+      InternetGatewayId: !Ref AWSReconInternetGateway
+      VpcId: !Ref AWSReconVPC
+  AWSReconEgressRouteTable:
+    Type: AWS::EC2::RouteTable
+    Properties:
+      VpcId: !Ref AWSReconVPC
+      Tags:
+        - Key: Name
+          Value: aws-recon-CFN
+  AWSReconSubnetRouteTableAssociation:
+    Type: AWS::EC2::SubnetRouteTableAssociation
+    Properties:
+      SubnetId: !Ref AWSReconSubnet
+      RouteTableId: !Ref AWSReconEgressRouteTable
+  AWSReconEgressRoute:
+    Type: AWS::EC2::Route
+    Properties:
+      DestinationCidrBlock: '0.0.0.0/0'
+      GatewayId: !Ref AWSReconInternetGateway
+      RouteTableId: !Ref AWSReconEgressRouteTable
+  AWSReconECSCluster:
+    Type: AWS::ECS::Cluster
+    Properties:
+      ClusterName: aws-recon-CFN
+      CapacityProviders:
+        - FARGATE
+      Tags:
+        - Key: Name
+          Value: aws-recon-CFN
+    DependsOn: AWSReconSubnet
+  AWSReconECSTask:
+    Type: AWS::ECS::TaskDefinition
+    Properties:
+      Family: aws-recon-CFN
+      RequiresCompatibilities:
+        - FARGATE
+      NetworkMode: awsvpc
+      Cpu: 1024
+      Memory: 2048
+      TaskRoleArn: !Ref AWSReconECSTaskRole
+      ExecutionRoleArn: !Ref AWSReconECSExecutionRole
+      ContainerDefinitions:
+        - Name: aws-recon-CFN
+          Image: 'darkbitio/aws_recon:latest'
+          EntryPoint:
+            - 'aws_recon'
+            - '--verbose'
+            - '--format'
+            - 'custom'
+  AWSReconECSTaskRole:
+    Type: AWS::IAM::Role
+    Properties:
+      RoleName: aws-recon-ecs-task-role
+      ManagedPolicyArns:
+        - 'arn:aws:iam::aws:policy/ReadOnlyAccess'
+      Policies:
+        - PolicyName: AWSReconECSTaskRole
+          PolicyDocument:
+            Version: '2012-10-17'
+            Statement:
+              - Effect: Allow
+                Action: 's3:PutObject'
+                Resource: 'arn:aws:s3:::CHANGEME/*'
+      AssumeRolePolicyDocument:
+        Version: '2012-10-17'
+        Statement:
+          - Effect: Allow
+            Principal:
+              Service:
+                - ecs.amazonaws.com
+                - ecs-tasks.amazonaws.com
+            Action: 'sts:AssumeRole'
+  AWSReconECSExecutionRole:
+    Type: AWS::IAM::Role
+    Properties:
+      RoleName: aws-recon-ecs-execution-role
+      Policies:
+        - PolicyName: AWSReconECSTaskExecutionPolicy
+          PolicyDocument:
+            Version: '2012-10-17'
+            Statement:
+              - Effect: Allow
+                Action:
+                  - 'ecr:GetAuthorizationToken'
+                  - 'ecr:BatchCheckLayerAvailability'
+                  - 'ecr:GetDownloadUrlForLayer'
+                  - 'ecr:BatchGetImage'
+                  - 'logs:CreateLogStream'
+                  - 'logs:PutLogEvents'
+                Resource: '*'
+      AssumeRolePolicyDocument:
+        Version: '2012-10-17'
+        Statement:
+          - Effect: Allow
+            Principal:
+              Service:
+                - ecs-tasks.amazonaws.com
+            Action: 'sts:AssumeRole'
+  AWSReconCloudWatchEventsRole:
+    Type: AWS::IAM::Role
+    Properties:
+      RoleName: aws-recon-events-role
+      AssumeRolePolicyDocument:
+        Version: '2012-10-17'
+        Statement:
+          - Effect: Allow
+            Principal:
+              Service:
+                - events.amazonaws.com
+            Action: 'sts:AssumeRole'

data/{terraform → utils/terraform}/cloudwatch.tf

@@ -1,6 +1,6 @@
 # https://www.terraform.io/docs/providers/aws/r/cloudwatch_event_rule.html
 resource "aws_cloudwatch_event_rule" "default" {
-  name                = "${var.aws_recon_base_name}-${random_id.rule.hex}"
+  name                = "${var.aws_recon_base_name}-${random_id.aws_recon.hex}"
   description         = "AWS Recon scheduled task"
   schedule_expression = var.schedule_expression
 }
@@ -24,7 +24,3 @@ resource "aws_cloudwatch_event_target" "default" {
     }
   }
 }
-
-resource "random_id" "rule" {
-  byte_length = 4
-}

data/{terraform → utils/terraform}/ecs.tf

@@ -1,14 +1,10 @@
 resource "aws_ecs_cluster" "aws_recon" {
-  name               = "${var.aws_recon_base_name}-${random_id.cluster.hex}"
+  name               = "${var.aws_recon_base_name}-${random_id.aws_recon.hex}"
   capacity_providers = [local.ecs_task_provider]
 }
 
-resource "random_id" "cluster" {
-  byte_length = 4
-}
-
 resource "aws_ecs_task_definition" "aws_recon_task" {
-  family                   = "${var.aws_recon_base_name}-${random_id.cluster.hex}"
+  family                   = "${var.aws_recon_base_name}-${random_id.aws_recon.hex}"
   task_role_arn            = aws_iam_role.aws_recon_role.arn
   execution_role_arn       = aws_iam_role.ecs_task_execution.arn
   requires_compatibilities = [local.ecs_task_provider]
@@ -18,12 +14,14 @@ resource "aws_ecs_task_definition" "aws_recon_task" {
 
   container_definitions = jsonencode([
     {
-      name             = "${var.aws_recon_base_name}-${random_id.cluster.hex}"
+      name             = "${var.aws_recon_base_name}-${random_id.aws_recon.hex}"
       image            = "${var.aws_recon_container_name}:${var.aws_recon_container_version}"
       assign_public_ip = true
       entryPoint = [
         "aws_recon",
         "--verbose",
+        "--format",
+        "custom",
         "--s3-bucket",
         "${aws_s3_bucket.aws_recon.bucket}:${data.aws_region.current.name}",
         "--regions",
@@ -42,7 +40,7 @@ resource "aws_ecs_task_definition" "aws_recon_task" {
 }
 
 resource "aws_cloudwatch_log_group" "aws_recon" {
-  name              = "/ecs/${var.aws_recon_base_name}-${random_id.cluster.hex}"
+  name              = "/ecs/${var.aws_recon_base_name}-${random_id.aws_recon.hex}"
   retention_in_days = var.retention_period
 }
 

data/utils/terraform/output.tf

@@ -0,0 +1,15 @@
+output "aws_recon_ecs_cluster" {
+  value = aws_ecs_cluster.aws_recon.name
+}
+
+output "aws_recon_ecs_scheduled_task" {
+  value = aws_cloudwatch_event_rule.default.name
+}
+
+output "aws_recon_s3_bucket" {
+  value = aws_s3_bucket.aws_recon.bucket
+}
+
+output "aws_recon_task_manual_run_command" {
+  value = "\nOne-off task run command:\n\naws ecs run-task --task-definition ${aws_ecs_task_definition.aws_recon_task.family} --cluster ${aws_ecs_cluster.aws_recon.name} --launch-type FARGATE --network-configuration \"awsvpcConfiguration={subnets=[${aws_subnet.subnet.id}],securityGroups=[${aws_security_group.sg.id}],assignPublicIp=ENABLED}\"\n"
+}

data/{terraform → utils/terraform}/s3.tf

@@ -1,6 +1,7 @@
 resource "aws_s3_bucket" "aws_recon" {
-  bucket = "${var.aws_recon_base_name}-${random_id.bucket.hex}-${data.aws_iam_account_alias.current.id}"
-  acl    = "private"
+  bucket        = "${var.aws_recon_base_name}-${random_id.aws_recon.hex}-${data.aws_iam_account_alias.current.id}"
+  acl           = "private"
+  force_destroy = true
 
   lifecycle_rule {
     id      = "expire-after-${var.retention_period}-days"
@@ -12,8 +13,8 @@ resource "aws_s3_bucket" "aws_recon" {
   }
 }
 
-resource "random_id" "bucket" {
-  byte_length = 4
+resource "random_id" "aws_recon" {
+  byte_length = 6
 }
 
 data "aws_iam_account_alias" "current" {}

data/{terraform → utils/terraform}/vars.tf

@@ -41,6 +41,7 @@ variable "aws_regions" {
   ]
 }
 
+# must be one of: 0, 1, 3, 5, 7, 14, 30, 60, 90, 120, 150, 180, 365
 variable "retention_period" {
   type    = number
   default = 30

data/{terraform → utils/terraform}/vpc.tf

@@ -3,24 +3,23 @@
 resource "aws_vpc" "vpc" {
   cidr_block = local.cidr_block
   tags = {
-    Name = "${var.aws_recon_base_name}-${random_id.vpc.hex}"
+    Name = "${var.aws_recon_base_name}-${random_id.aws_recon.hex}"
   }
 }
 
 # Create subnet
 resource "aws_subnet" "subnet" {
-  vpc_id                  = aws_vpc.vpc.id
-  cidr_block              = local.subnet_cidr_block
-  availability_zone       = data.aws_availability_zones.available.names[0]
-  map_public_ip_on_launch = true
+  vpc_id            = aws_vpc.vpc.id
+  cidr_block        = local.subnet_cidr_block
+  availability_zone = data.aws_availability_zones.available.names[0]
 
   tags = {
-    Name = "${var.aws_recon_base_name}-${random_id.vpc.hex}-public"
+    Name = "${var.aws_recon_base_name}-${random_id.aws_recon.hex}-public"
   }
 }
 
 resource "aws_security_group" "sg" {
-  name        = "${var.aws_recon_base_name}-${random_id.vpc.hex}"
+  name        = "${var.aws_recon_base_name}-${random_id.aws_recon.hex}"
   description = "Allow AWS Recon collection egress"
   vpc_id      = aws_vpc.vpc.id
 
@@ -32,7 +31,7 @@ resource "aws_security_group" "sg" {
   }
 
   tags = {
-    Name = "${var.aws_recon_base_name}-${random_id.vpc.hex}"
+    Name = "${var.aws_recon_base_name}-${random_id.aws_recon.hex}"
   }
 }
 
@@ -40,7 +39,7 @@ resource "aws_internet_gateway" "igw" {
   vpc_id = aws_vpc.vpc.id
 
   tags = {
-    Name = "${var.aws_recon_base_name}-${random_id.vpc.hex}"
+    Name = "${var.aws_recon_base_name}-${random_id.aws_recon.hex}"
   }
 }
 
@@ -53,7 +52,7 @@ resource "aws_route_table" "rt" {
   }
 
   tags = {
-    Name = "${var.aws_recon_base_name}-${random_id.vpc.hex}"
+    Name = "${var.aws_recon_base_name}-${random_id.aws_recon.hex}"
   }
 }
 
@@ -67,10 +66,6 @@ locals {
   subnet_cidr_block = cidrsubnet(local.cidr_block, 8, 0)
 }
 
-resource "random_id" "vpc" {
-  byte_length = 4
-}
-
 data "aws_region" "current" {}
 
 data "aws_availability_zones" "available" {

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: aws_recon
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.4.6
 platform: ruby
 authors:
 - Josh Larsen
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-04-01 00:00:00.000000000 Z
+date: 2021-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: aws-sdk
@@ -244,15 +244,16 @@ files:
 - lib/aws_recon/services.yaml
 - lib/aws_recon/version.rb
 - readme.md
-- terraform/cloudwatch.tf
-- terraform/ecs.tf
-- terraform/iam.tf
-- terraform/main.tf
-- terraform/output.tf
-- terraform/readme.md
-- terraform/s3.tf
-- terraform/vars.tf
-- terraform/vpc.tf
+- utils/cloudformation/aws-recon-cfn-template.yml
+- utils/terraform/cloudwatch.tf
+- utils/terraform/ecs.tf
+- utils/terraform/iam.tf
+- utils/terraform/main.tf
+- utils/terraform/output.tf
+- utils/terraform/readme.md
+- utils/terraform/s3.tf
+- utils/terraform/vars.tf
+- utils/terraform/vpc.tf
 homepage: https://github.com/darkbitio/aws-recon
 licenses:
 - MIT

data/terraform/output.tf

@@ -1,13 +0,0 @@
-output "aws_recon_s3_bucket" {
-  value = aws_s3_bucket.aws_recon.bucket
-}
-
-output "aws_recon_ecs_cluster" {
-  value = aws_ecs_cluster.aws_recon.name
-}
-
-output "aws_recon_ecs_scheduled_task" {
-  value = aws_cloudwatch_event_rule.default.name
-}
-
-