badbucket

README

Description

badbucket is a quick-n-dirty tool to test the configuration of your S3 bucket. It checks for the following:

• Is the bucket listable?
• Are files readable?
• Is the bucket writeable?

badbucket is written in Go and uses the AWS SDK

Installation

go install github.com/zuBux/badbucket/cmd/...

Usage

badbucket -b <bucket_name>

badbucket will automatically detect the region of your bucket

Coming up next

• Implement writable check
• Parse list of s3 buckets
• Automatic region detection
• Concurrent checks

Documentation

Index

• func AreFilesReadable(s *session.Session, bucketName string) (bool, error)
• func DetectBucketRegion(bucketName string) string
• func IsBucketListable(s *s3.S3, bucketName string) (bool, error)
• func IsBucketWriteable(s *session.Session, bucketName string) (bool, error)

Functions

func AreFilesReadable

func AreFilesReadable(s *session.Session, bucketName string) (bool, error)

AreFilesReadable lists objects in an s3 bucket and tries to download the first one

func DetectBucketRegion

func DetectBucketRegion(bucketName string) string

func IsBucketListable

func IsBucketListable(s *s3.S3, bucketName string) (bool, error)

IsBucketListable checks if a bucket is listable

func IsBucketWriteable

func IsBucketWriteable(s *session.Session, bucketName string) (bool, error)