sg

Documentation

Index

• func GenerateCIDRReport(c *cli.Context) error
• func GenerateExternalAWSIPReport() error
• func GenerateMappedEC2Report() error
• func GeneratePortReport(c *cli.Context) error
• func GetSecurityGroups(sgIDs []*string) (map[string]*SecurityGroup, error)
• func ListAttachedSecurityGroups() error
• func ListDetachedSecurityGroups() error
• type AWSIPRanges
• type AWSIPs
• type IPv6Prefix
  • func (p *IPv6Prefix) GetCIDR() (*net.IPNet, error)
• type Prefix
  • func (p *Prefix) GetCIDR() (*net.IPNet, error)
  • func (p *Prefix) GetService() string
• type SecurityGroup
  • func (s *SecurityGroup) Attachments() map[string]int
  • func (s *SecurityGroup) GetAttachmentsAsString() string
  • func (s *SecurityGroup) ID() string
  • func (s *SecurityGroup) Name() string
  • func (s SecurityGroup) ParseRuleToken(token string) (port string, protocol string, sgIDs string)
  • func (s *SecurityGroup) Rules() map[string][]*ec2.IpRange

Functions

func GenerateCIDRReport

func GenerateCIDRReport(c *cli.Context) error

GenerateCIDRReport will generate a report of CIDR block exposure from Security Groups.

func GenerateExternalAWSIPReport

func GenerateExternalAWSIPReport() error

GenerateExternalAWSIPReport

func GenerateMappedEC2Report

func GenerateMappedEC2Report() error

func GeneratePortReport

func GeneratePortReport(c *cli.Context) error

GeneratePortReport will generate a report of PORT exposure from Security Groups.

func GetSecurityGroups

func GetSecurityGroups(sgIDs []*string) (map[string]*SecurityGroup, error)

GetSecurityGroups will retrieve a list of Security Group IDs with mapped ports

func ListAttachedSecurityGroups

func ListAttachedSecurityGroups() error

ListAttachedSecurityGroups generates a report listing out all Security Groups that are attached to a Network Interface

func ListDetachedSecurityGroups

func ListDetachedSecurityGroups() error

ListDetachedSecurityGroups generates a report listing out all Security Groups that are NOT attached to a Network Interface

Types

type AWSIPRanges

type AWSIPRanges struct {
	SyncToken    string        `json:"syncToken"`
	CreateDate   string        `json:"createDate"`
	Prefixes     []*Prefix     `json:"prefixes"`
	IPv6Prefixes []*IPv6Prefix `json:"ipv6_prefixes"`
}

AWSIPRanges is the JSON struct used to parse the AWS IP Range file.

type AWSIPs

type AWSIPs struct {
	// contains filtered or unexported fields
}

AWSIPs is a

type IPv6Prefix

type IPv6Prefix struct {
	IPv6Prefix         string `json:"ipv6_prefix"`
	Region             string `json:"region"`
	NetworkBorderGroup string `json:"network_border_group"`
	Service            string `json:"service"`
}

IPv6Prefix is used with AWSIPRanges.

func (*IPv6Prefix) GetCIDR

func (p *IPv6Prefix) GetCIDR() (*net.IPNet, error)

GetCIDR will extract the IPPrefix as a CIDR definition.

type Prefix

type Prefix struct {
	IPPrefix           string `json:"ip_prefix"`
	Region             string `json:"region"`
	NetworkBorderGroup string `json:"network_border_group"`
	Service            string `json:"service"`
}

Prefix is used with AWSIPRanges.

func (*Prefix) GetCIDR

func (p *Prefix) GetCIDR() (*net.IPNet, error)

GetCIDR will extract the IPPrefix as a CIDR definition.

func (*Prefix) GetService

func (p *Prefix) GetService() string

GetService will extract the AWS service name that the IP is associated with.

type SecurityGroup

type SecurityGroup struct {
	// contains filtered or unexported fields
}

SecurityGroup defines the struct for common SG properties used by this tool.

func (*SecurityGroup) Attachments

func (s *SecurityGroup) Attachments() map[string]int

Attachments will return the map of Attachments

func (*SecurityGroup) GetAttachmentsAsString

func (s *SecurityGroup) GetAttachmentsAsString() string

GetAttachmentsAsString will return a formatted list of AWS attachments

func (*SecurityGroup) ID

func (s *SecurityGroup) ID() string

ID will return the SecurityGroup ID

func (*SecurityGroup) Name

func (s *SecurityGroup) Name() string

Name will return the SecurityGroup Name

func (SecurityGroup) ParseRuleToken

func (s SecurityGroup) ParseRuleToken(token string) (port string, protocol string, sgIDs string)

ParseRuleToken break the Rules token key from the Rules map and return the component parts of [port, protocol, security group IDs]

func (*SecurityGroup) Rules

func (s *SecurityGroup) Rules() map[string][]*ec2.IpRange

Rules will return the SecurityGroup Rules map