provider

Documentation

Index

• Constants
• Variables
• func AccountCredentialsFromMap(m map[string]any) (configs.IntegrationCredentials, error)
• func AdjustResource(job describe.DescribeJob, resource *model.Resource) error
• func DescribeByGithub(...) model.ResourceDescriber
• func GetAdditionalParameters(job describe.DescribeJob) (map[string]string, error)
• func GetResourceMetadata(job describe.DescribeJob, resource model.Resource) (map[string]string, error)

Constants

const (
	ErrSubscriptionRequired = "SubscriptionRequiredException"
)

Variables

var ResourceTypes = map[string]model.ResourceType{

	"Github/Actions/Artifact": {
		IntegrationType: configs.IntegrationName,
		ResourceName:    "Github/Actions/Artifact",
		Tags: map[string][]string{
			"category": {"Action"},
		},
		Labels:        map[string]string{},
		Annotations:   map[string]string{},
		ListDescriber: DescribeByGithub(describer.GetAllArtifacts),
		GetDescriber:  nil,
	},

	"Github/Actions/Repository/Runner": {
		IntegrationType: configs.IntegrationName,
		ResourceName:    "Github/Actions/Repository/Runner",
		Tags: map[string][]string{
			"category": {"Action"},
		},
		Labels:        map[string]string{},
		Annotations:   map[string]string{},
		ListDescriber: DescribeByGithub(describer.GetAllRunners),
		GetDescriber:  nil,
	},

	"Github/Actions/Repository/Secret": {
		IntegrationType: configs.IntegrationName,
		ResourceName:    "Github/Actions/Repository/Secret",
		Tags: map[string][]string{
			"category": {"Action"},
		},
		Labels:        map[string]string{},
		Annotations:   map[string]string{},
		ListDescriber: DescribeByGithub(describer.GetAllSecrets),
		GetDescriber:  nil,
	},

	"Github/Actions/Repository/Workflow_run": {
		IntegrationType: configs.IntegrationName,
		ResourceName:    "Github/Actions/Repository/Workflow_run",
		Tags: map[string][]string{
			"category": {"Action"},
		},
		Labels:        map[string]string{},
		Annotations:   map[string]string{},
		ListDescriber: DescribeByGithub(describer.GetAllWorkflowRuns),
		GetDescriber:  nil,
	},

	"Github/Blob": {
		IntegrationType: configs.IntegrationName,
		ResourceName:    "Github/Blob",
		Tags: map[string][]string{
			"category": {"Blob"},
		},
		Labels:        map[string]string{},
		Annotations:   map[string]string{},
		ListDescriber: DescribeByGithub(describer.GetAllBlobs),
		GetDescriber:  nil,
	},

	"Github/Branch": {
		IntegrationType: configs.IntegrationName,
		ResourceName:    "Github/Branch",
		Tags: map[string][]string{
			"category": {"Branch"},
		},
		Labels:        map[string]string{},
		Annotations:   map[string]string{},
		ListDescriber: DescribeByGithub(describer.GetAllBranches),
		GetDescriber:  nil,
	},

	"Github/Branch/Protection": {
		IntegrationType: configs.IntegrationName,
		ResourceName:    "Github/Branch/Protection",
		Tags: map[string][]string{
			"category": {"Branch"},
		},
		Labels:        map[string]string{},
		Annotations:   map[string]string{},
		ListDescriber: DescribeByGithub(describer.GetAllBranchProtections),
		GetDescriber:  nil,
	},

	"Github/Commit": {
		IntegrationType: configs.IntegrationName,
		ResourceName:    "Github/Commit",
		Tags: map[string][]string{
			"category": {"Commit"},
		},
		Labels:        map[string]string{},
		Annotations:   map[string]string{},
		ListDescriber: DescribeByGithub(describer.GetAllCommits),
		GetDescriber:  nil,
	},

	"Github/CommunityProfile": {
		IntegrationType: configs.IntegrationName,
		ResourceName:    "Github/CommunityProfile",
		Tags: map[string][]string{
			"category": {"Community Profile"},
		},
		Labels:        map[string]string{},
		Annotations:   map[string]string{},
		ListDescriber: DescribeByGithub(describer.GetAllCommunityProfiles),
		GetDescriber:  nil,
	},

	"Github/Gitignore": {
		IntegrationType: configs.IntegrationName,
		ResourceName:    "Github/Gitignore",
		Tags: map[string][]string{
			"category": {"Gitignore"},
		},
		Labels:        map[string]string{},
		Annotations:   map[string]string{},
		ListDescriber: DescribeByGithub(describer.GetGitIgnoreTemplateList),
		GetDescriber:  nil,
	},

	"Github/Issue/Comment": {
		IntegrationType: configs.IntegrationName,
		ResourceName:    "Github/Issue/Comment",
		Tags: map[string][]string{
			"category": {"Issue"},
		},
		Labels:        map[string]string{},
		Annotations:   map[string]string{},
		ListDescriber: DescribeByGithub(describer.GetAllIssueComments),
		GetDescriber:  nil,
	},

	"Github/License": {
		IntegrationType: configs.IntegrationName,
		ResourceName:    "Github/License",
		Tags: map[string][]string{
			"category": {"License"},
		},
		Labels:        map[string]string{},
		Annotations:   map[string]string{},
		ListDescriber: DescribeByGithub(describer.GetLicenseList),
		GetDescriber:  nil,
	},

	"Github/Organization/Collaborator": {
		IntegrationType: configs.IntegrationName,
		ResourceName:    "Github/Organization/Collaborator",
		Tags: map[string][]string{
			"category": {"Organization"},
		},
		Labels:        map[string]string{},
		Annotations:   map[string]string{},
		ListDescriber: DescribeByGithub(describer.GetAllOrganizationsCollaborators),
		GetDescriber:  nil,
	},

	"Github/Organization/DependabotAlert": {
		IntegrationType: configs.IntegrationName,
		ResourceName:    "Github/Organization/DependabotAlert",
		Tags: map[string][]string{
			"category": {"Organization"},
		},
		Labels:        map[string]string{},
		Annotations:   map[string]string{},
		ListDescriber: DescribeByGithub(describer.GetAllOrganizationsDependabotAlerts),
		GetDescriber:  nil,
	},

	"Github/Organization/ExternalIdentity": {
		IntegrationType: configs.IntegrationName,
		ResourceName:    "Github/Organization/ExternalIdentity",
		Tags: map[string][]string{
			"category": {"Organization"},
		},
		Labels:        map[string]string{},
		Annotations:   map[string]string{},
		ListDescriber: DescribeByGithub(describer.GetAllExternalIdentities),
		GetDescriber:  nil,
	},

	"Github/Organization/Member": {
		IntegrationType: configs.IntegrationName,
		ResourceName:    "Github/Organization/Member",
		Tags: map[string][]string{
			"category": {"Organization"},
		},
		Labels:        map[string]string{},
		Annotations:   map[string]string{},
		ListDescriber: DescribeByGithub(describer.GetAllMembers),
		GetDescriber:  nil,
	},

	"Github/PullRequest": {
		IntegrationType: configs.IntegrationName,
		ResourceName:    "Github/PullRequest",
		Tags: map[string][]string{
			"category": {"PullRequest"},
		},
		Labels:        map[string]string{},
		Annotations:   map[string]string{},
		ListDescriber: DescribeByGithub(describer.GetAllPullRequests),
		GetDescriber:  nil,
	},

	"Github/Repository/Collaborator": {
		IntegrationType: configs.IntegrationName,
		ResourceName:    "Github/Repository/Collaborator",
		Tags: map[string][]string{
			"category": {"Repository"},
		},
		Labels:        map[string]string{},
		Annotations:   map[string]string{},
		ListDescriber: DescribeByGithub(describer.GetAllRepositoriesCollaborators),
		GetDescriber:  nil,
	},

	"Github/Repository/DependabotAlert": {
		IntegrationType: configs.IntegrationName,
		ResourceName:    "Github/Repository/DependabotAlert",
		Tags: map[string][]string{
			"category": {"Repository"},
		},
		Labels:        map[string]string{},
		Annotations:   map[string]string{},
		ListDescriber: DescribeByGithub(describer.GetAllRepositoriesDependabotAlerts),
		GetDescriber:  nil,
	},

	"Github/Repository/Deployment": {
		IntegrationType: configs.IntegrationName,
		ResourceName:    "Github/Repository/Deployment",
		Tags: map[string][]string{
			"category": {"Repository"},
		},
		Labels:        map[string]string{},
		Annotations:   map[string]string{},
		ListDescriber: DescribeByGithub(describer.GetAllRepositoriesDeployments),
		GetDescriber:  nil,
	},

	"Github/Repository/Environment": {
		IntegrationType: configs.IntegrationName,
		ResourceName:    "Github/Repository/Environment",
		Tags: map[string][]string{
			"category": {"Repository"},
		},
		Labels:        map[string]string{},
		Annotations:   map[string]string{},
		ListDescriber: DescribeByGithub(describer.GetAllRepositoriesEnvironments),
		GetDescriber:  nil,
	},

	"Github/Repository/Ruleset": {
		IntegrationType: configs.IntegrationName,
		ResourceName:    "Github/Repository/Ruleset",
		Tags: map[string][]string{
			"category": {"Repository"},
		},
		Labels:        map[string]string{},
		Annotations:   map[string]string{},
		ListDescriber: DescribeByGithub(describer.GetAllRepositoriesRuleSets),
		GetDescriber:  nil,
	},

	"Github/Repository/SBOM": {
		IntegrationType: configs.IntegrationName,
		ResourceName:    "Github/Repository/SBOM",
		Tags: map[string][]string{
			"category": {"Repository"},
		},
		Labels:        map[string]string{},
		Annotations:   map[string]string{},
		ListDescriber: DescribeByGithub(describer.GetAllRepositoriesSBOMs),
		GetDescriber:  nil,
	},

	"Github/Repository/VulnerabilityAlert": {
		IntegrationType: configs.IntegrationName,
		ResourceName:    "Github/Repository/VulnerabilityAlert",
		Tags: map[string][]string{
			"category": {"Repository"},
		},
		Labels:        map[string]string{},
		Annotations:   map[string]string{},
		ListDescriber: DescribeByGithub(describer.GetAllRepositoriesVulnerabilities),
		GetDescriber:  nil,
	},

	"Github/Stargazer": {
		IntegrationType: configs.IntegrationName,
		ResourceName:    "Github/Stargazer",
		Tags: map[string][]string{
			"category": {"Stargazer"},
		},
		Labels:        map[string]string{},
		Annotations:   map[string]string{},
		ListDescriber: DescribeByGithub(describer.GetAllStargazers),
		GetDescriber:  nil,
	},

	"Github/Tag": {
		IntegrationType: configs.IntegrationName,
		ResourceName:    "Github/Tag",
		Tags: map[string][]string{
			"category": {"Tag"},
		},
		Labels:        map[string]string{},
		Annotations:   map[string]string{},
		ListDescriber: DescribeByGithub(describer.GetAllTags),
		GetDescriber:  nil,
	},

	"Github/Team/Member": {
		IntegrationType: configs.IntegrationName,
		ResourceName:    "Github/Team/Member",
		Tags: map[string][]string{
			"category": {"Team"},
		},
		Labels:        map[string]string{},
		Annotations:   map[string]string{},
		ListDescriber: DescribeByGithub(describer.GetAllTeamsMembers),
		GetDescriber:  nil,
	},

	"Github/Team/Repository": {
		IntegrationType: configs.IntegrationName,
		ResourceName:    "Github/Team/Repository",
		Tags: map[string][]string{
			"category": {"team"},
		},
		Labels:        map[string]string{},
		Annotations:   map[string]string{},
		ListDescriber: DescribeByGithub(describer.GetAllTeamsRepositories),
		GetDescriber:  nil,
	},

	"Github/Traffic/View/Daily": {
		IntegrationType: configs.IntegrationName,
		ResourceName:    "Github/Traffic/View/Daily",
		Tags: map[string][]string{
			"category": {"traffic_view"},
		},
		Labels:        map[string]string{},
		Annotations:   map[string]string{},
		ListDescriber: DescribeByGithub(describer.GetAllTrafficViewDailies),
		GetDescriber:  nil,
	},

	"Github/Traffic/View/Weekly": {
		IntegrationType: configs.IntegrationName,
		ResourceName:    "Github/Traffic/View/Weekly",
		Tags: map[string][]string{
			"category": {"traffic_view"},
		},
		Labels:        map[string]string{},
		Annotations:   map[string]string{},
		ListDescriber: DescribeByGithub(describer.GetAllTrafficViewWeeklies),
		GetDescriber:  nil,
	},

	"Github/Tree": {
		IntegrationType: configs.IntegrationName,
		ResourceName:    "Github/Tree",
		Tags: map[string][]string{
			"category": {"tree"},
		},
		Labels:        map[string]string{},
		Annotations:   map[string]string{},
		ListDescriber: DescribeByGithub(describer.GetAllTrees),
		GetDescriber:  nil,
	},

	"GithubUser": {
		IntegrationType: configs.IntegrationName,
		ResourceName:    "GithubUser",
		Tags: map[string][]string{
			"category": {"user"},
		},
		Labels:        map[string]string{},
		Annotations:   map[string]string{},
		ListDescriber: DescribeByGithub(describer.GetUser),
		GetDescriber:  nil,
	},

	"GithubWorkflow": {
		IntegrationType: configs.IntegrationName,
		ResourceName:    "GithubWorkflow",
		Tags: map[string][]string{
			"category": {"workflow"},
		},
		Labels:        map[string]string{},
		Annotations:   map[string]string{},
		ListDescriber: DescribeByGithub(describer.GetAllWorkflows),
		GetDescriber:  nil,
	},
}

Functions

func AccountCredentialsFromMap

func AccountCredentialsFromMap(m map[string]any) (configs.IntegrationCredentials, error)

AccountCredentialsFromMap TODO: converts a map to a configs.IntegrationCredentials.

func AdjustResource

func AdjustResource(job describe.DescribeJob, resource *model.Resource) error

AdjustResource TODO: Do any needed adjustment on resource object before storing

func DescribeByGithub

func DescribeByGithub(describe func(context.Context, describer.GitHubClient, string, *model.StreamSender) ([]model.Resource, error)) model.ResourceDescriber

func GetAdditionalParameters

func GetAdditionalParameters(job describe.DescribeJob) (map[string]string, error)

GetAdditionalParameters TODO: pass additional parameters needed in describer wrappers in /provider/describer_wrapper.go

func GetResourceMetadata

func GetResourceMetadata(job describe.DescribeJob, resource model.Resource) (map[string]string, error)

GetResourceMetadata TODO: Get metadata as a map to add to the resources