s3

Documentation

Overview

Package s3 provides the data structures and logic necessary to enumerate and integrate AWS S3 resources.

Index

• func EnumerateS3(ctx context.Context, cfg aws.Config, regions []string) methodaws.S3Report
• func ExternalEnumerateS3(ctx context.Context, config methodaws.ExternalS3BucketConfig) methodaws.ExternalS3Report
• type BucketObject
• type LsResourceReport
  • func LsS3Bucket(ctx context.Context, cfg aws.Config, bucketName string) (*LsResourceReport, error)
• type LsResources

Functions

func EnumerateS3

func EnumerateS3(ctx context.Context, cfg aws.Config, regions []string) methodaws.S3Report

func ExternalEnumerateS3

func ExternalEnumerateS3(ctx context.Context, config methodaws.ExternalS3BucketConfig) methodaws.ExternalS3Report

ExternalEnumerateS3 attempts to enumerate a public facing S3 bucket with no credentials

Types

type BucketObject

type BucketObject struct {
	Name string `json:"name" yaml:"name"`
	Size int64  `json:"size" yaml:"size"`
}

BucketObject contains the name and size (in bytes) of an object stored in an S3 bucket.

type LsResourceReport

type LsResourceReport struct {
	Resources LsResources `json:"resources" yaml:"resources"`
	Errors    []string    `json:"errors" yaml:"errors"`
}

LsResourceReport contains the resources discovered in an S3 bucket and any non-fatal errors that occurred during the execution of the `methodaws s3 ls` subcommand.

func LsS3Bucket

func LsS3Bucket(ctx context.Context, cfg aws.Config, bucketName string) (*LsResourceReport, error)

LsS3Bucket retrieves the objects stored in an S3 bucket and returns an LsResourceReport struct

type LsResources

type LsResources struct {
	S3BucketName  *string        `json:"name" yaml:"name"`
	BucketObjects []BucketObject `json:"objects" yaml:"objects"`
}

LsResources contains the S3 bucket name and the objects stored in the bucket.