pike

package

v0.2.29 Latest Latest Go to latest Published: Nov 25, 2022 License: Apache-2.0 Imports: 37 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/jameswoolfenden/pike

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func AZUREPolicy(permissions []string) (string, error)
func Apply(target string, region string) error
func Compare(directory string, arn string, init bool) (bool, error)
func CompareIAMPolicy(Policy string, OldPolicy string) (bool, error)
func GCPPolicy(permissions []string) (string, error)
func GetAWSDataPermissions(result ResourceV2) ([]string, error)
func GetAWSPermissions(result ResourceV2) ([]string, error)
func GetAWSResourcePermissions(result ResourceV2) ([]string, error)
func GetAZUREDataPermissions(result ResourceV2) ([]string, error)
func GetAZUREPermissions(result ResourceV2) ([]string, error)
func GetAZUREResourcePermissions(result ResourceV2) ([]string, error)
func GetBlockAttributes(attributes []string, block *hclsyntax.Block) []string
func GetGCPDataPermissions(result ResourceV2) ([]string, error)
func GetGCPPermissions(result ResourceV2) ([]string, error)
func GetGCPResourcePermissions(result ResourceV2) ([]string, error)
func GetHCLType(resourceName string) string
func GetModulePath(block *hclsyntax.Block) string
func GetPermissionMap(raw []byte, attributes []string) ([]string, error)
func GetPolicyVersion(client *iam.Client, PolicyArn string, Version string) (*string, error)
func GetResourceBlocks(file string) (*hclsyntax.Body, error)
func GetTF(dirName string) ([]string, error)
func GetVersion(client *iam.Client, PolicyArn string) (*string, error)
func Init(dirName string) (*string, []string, error)
func InvokeGithubDispatchEvent(repository string, workflowFileName string, branch string) error
func LocateTerraform() (string, error)
func Make(directory string) (*string, error)
func Readme(dirName string, output string, init bool, autoAppend bool) error
func Remote(target string, repository string, region string) error
func ReplaceSection(source string, middle string, autoadd bool) error
func Scan(dirName string, output string, file *string, init bool, write bool) error
func SetRepoSecret(repository string, keyText string, keyName string) (*github.Response, error)
func SortActions(myPolicy string) (*string, error)
func WaitForPolicyChange(client *iam.Client, arn string, Version string, Wait int) (int, error)
func Watch(arn string, wait int) error
func WriteOutput(OutPolicy OutputPolicy, output, location string) error
type AwsOutput
- func AWSPolicy(Permissions []string) (AwsOutput, error)
type OutputPolicy
- func GetPolicy(actions Sorted) (OutputPolicy, error)
- func MakePolicy(dirName string, file *string, init bool) (OutputPolicy, error)
- func (Out OutputPolicy) AsString(format string) string
type Policy
- func NewAWSPolicy(Actions []string) (Policy, error)
type ResourceV2
- func GetResources(file string, dirName string) ([]ResourceV2, error)
type Sorted
- func GetPermission(result ResourceV2) (Sorted, error)
type Statement
- func NewStatement(sid string, effect string, action []string, resource []string) *Statement

Constants ¶

View Source

const Version = "9.9.9"

Version controls the applications version

Variables ¶

This section is empty.

Functions ¶

func AZUREPolicy ¶

func AZUREPolicy(permissions []string) (string, error)

AZUREPolicy creates an Azure role definition

func Apply ¶

func Apply(target string, region string) error

Apply executes tf using prepared role

func Compare ¶

func Compare(directory string, arn string, init bool) (bool, error)

Compare IAC codebase to AWS policy

func CompareIAMPolicy ¶

func CompareIAMPolicy(Policy string, OldPolicy string) (bool, error)

CompareIAMPolicy takes to IAm policies and compares

func GCPPolicy ¶

func GCPPolicy(permissions []string) (string, error)

GCPPolicy create an IAM policy

func GetAWSDataPermissions ¶

func GetAWSDataPermissions(result ResourceV2) ([]string, error)

GetAWSDataPermissions gets permissions required for datasource's

func GetAWSPermissions ¶

func GetAWSPermissions(result ResourceV2) ([]string, error)

GetAWSPermissions for AWS resources

func GetAWSResourcePermissions ¶

func GetAWSResourcePermissions(result ResourceV2) ([]string, error)

GetAWSResourcePermissions looks up permissions required for resources

func GetAZUREDataPermissions ¶

func GetAZUREDataPermissions(result ResourceV2) ([]string, error)

GetAZUREDataPermissions gets permissions required for datasources

func GetAZUREPermissions ¶

func GetAZUREPermissions(result ResourceV2) ([]string, error)

GetAZUREPermissions for GCP resources

func GetAZUREResourcePermissions ¶

func GetAZUREResourcePermissions(result ResourceV2) ([]string, error)

GetAZUREResourcePermissions looks up permissions required for resources

func GetBlockAttributes ¶

func GetBlockAttributes(attributes []string, block *hclsyntax.Block) []string

GetBlockAttributes walks through a blocks getting all blocks and attributes

func GetGCPDataPermissions ¶

func GetGCPDataPermissions(result ResourceV2) ([]string, error)

GetGCPDataPermissions gets permissions required for datasources

func GetGCPPermissions ¶

func GetGCPPermissions(result ResourceV2) ([]string, error)

GetGCPPermissions for GCP resources

func GetGCPResourcePermissions ¶

func GetGCPResourcePermissions(result ResourceV2) ([]string, error)

GetGCPResourcePermissions looks up permissions required for resources

func GetHCLType ¶

func GetHCLType(resourceName string) string

GetHCLType gets the resource Name

func GetModulePath ¶

func GetModulePath(block *hclsyntax.Block) string

GetModulePath extracts the source location from a module

func GetPermissionMap ¶

func GetPermissionMap(raw []byte, attributes []string) ([]string, error)

GetPermissionMap Anonymous parsing

func GetPolicyVersion ¶

func GetPolicyVersion(client *iam.Client, PolicyArn string, Version string) (*string, error)

GetPolicyVersion Obtains the versioned IAM policy

func GetResourceBlocks ¶

func GetResourceBlocks(file string) (*hclsyntax.Body, error)

GetResourceBlocks breaks down a file into resources

func GetTF ¶

func GetTF(dirName string) ([]string, error)

GetTF return tf files in a directory

func GetVersion ¶

func GetVersion(client *iam.Client, PolicyArn string) (*string, error)

GetVersion gets the version of the IAM policy

func Init ¶

func Init(dirName string) (*string, []string, error)

Init can download and install terraform if required and then terraform init your specified directory

func InvokeGithubDispatchEvent ¶

func InvokeGithubDispatchEvent(repository string, workflowFileName string, branch string) error

InvokeGithubDispatchEvent uses your gitHub api key (if sufficiently enabled) to invoke a gitHub action workflow

func LocateTerraform ¶

func LocateTerraform() (string, error)

LocateTerraform finds the Terraform executable or installs it

func Make ¶

func Make(directory string) (*string, error)

Make creates the required role

func Readme ¶

func Readme(dirName string, output string, init bool, autoAppend bool) error

Readme Updates a README.md file

func Remote ¶

func Remote(target string, repository string, region string) error

Remote updates a repo with AWS credentials

func ReplaceSection ¶

func ReplaceSection(source string, middle string, autoadd bool) error

ReplaceSection find a section in a readme and replaces the section

func Scan ¶

func Scan(dirName string, output string, file *string, init bool, write bool) error

Scan looks for resources in a given directory

func SetRepoSecret ¶

func SetRepoSecret(repository string, keyText string, keyName string) (*github.Response, error)

SetRepoSecret sets an encrypted gitHub action secret

func SortActions ¶

func SortActions(myPolicy string) (*string, error)

SortActions sorts the actions list of an IAM policy

func WaitForPolicyChange ¶

func WaitForPolicyChange(client *iam.Client, arn string, Version string, Wait int) (int, error)

WaitForPolicyChange looks at IAM policy change

func Watch ¶

func Watch(arn string, wait int) error

Watch looks at IAM policy for new revisions

func WriteOutput ¶

func WriteOutput(OutPolicy OutputPolicy, output, location string) error

WriteOutput writes out the policy as json or terraform

Types ¶

type AwsOutput ¶

type AwsOutput struct {
	JSONOut   string
	Terraform string
}

AwsOutput structure

func AWSPolicy ¶

func AWSPolicy(Permissions []string) (AwsOutput, error)

AWSPolicy create an IAM policy

type OutputPolicy ¶

type OutputPolicy struct {
	AWS   AwsOutput
	GCP   string
	AZURE string
}

OutputPolicy is the main output type

func GetPolicy ¶

func GetPolicy(actions Sorted) (OutputPolicy, error)

GetPolicy creates new iam polices from a list of Permissions

func MakePolicy ¶

func MakePolicy(dirName string, file *string, init bool) (OutputPolicy, error)

MakePolicy does the guts of determining a policy from code

func (OutputPolicy) AsString ¶

func (Out OutputPolicy) AsString(format string) string

AsString converts object into string

type Policy ¶

type Policy struct {
	Version    string      `json:"Version"`
	Statements []Statement `json:"Statement"`
}

Policy creates iam policies

func NewAWSPolicy ¶

func NewAWSPolicy(Actions []string) (Policy, error)

NewAWSPolicy constructor

type ResourceV2 ¶

type ResourceV2 struct {
	TypeName     string
	Name         string
	ResourceName string
	Provider     string
	Attributes   []string
}

ResourceV2 is what resources get parsed into

func GetResources ¶

func GetResources(file string, dirName string) ([]ResourceV2, error)

GetResources retrieves all the resources in a tf file

type Sorted ¶

type Sorted struct {
	AWS   []string
	GCP   []string
	AZURE []string
}

Sorted is to help split out permission to the relevant auth

func GetPermission ¶

func GetPermission(result ResourceV2) (Sorted, error)

GetPermission determines the IAM permissions required and returns a list of permission

type Statement ¶

type Statement struct {
	Sid      string   `json:"Sid"`
	Effect   string   `json:"Effect"`
	Action   []string `json:"Action"`
	Resource []string `json:"Resource"`
}

Statement is the core of an IAM policy

func NewStatement ¶

func NewStatement(sid string, effect string, action []string, resource []string) *Statement

NewStatement constructor

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL