Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

client

package

Go to main page

Versions in this module

v0

v0.0.3

Sep 4, 2024

v0.0.3-prerelease-ng-upgrade-deps

Sep 4, 2024

v0.0.2

Sep 4, 2024

v0.0.1

Feb 13, 2024

Changes in this version

+ const APIDomain

+ const AlertBasePathKey

+ const AliasBasePathKey

+ const ArtifactBasePathKey

+ const AssetBasePathKey

+ const AzureBlobStoreFeedConfigurationPropertyKey

+ const BackstoryAPIEnvVar

+ const BigQueryAPIEnvVar

+ const ChronicleRegionEnvVar

+ const DetectionEngineAPIKey

+ const EventsBasePathKey

+ const FeedManagementAPIKey

+ const FeedManagementBasePathKey

+ const FeedSourceTypeAPI

+ const FeedSourceTypeAzureBlobStore

+ const FeedSourceTypeGCS

+ const FeedSourceTypeHTTP

+ const FeedSourceTypeS3

+ const FeedSourceTypeSQS

+ const ForwarderAPIEnvVar

+ const GCPBucketFeedConfigurationPropertyKey

+ const GCTIAPIKey

+ const IOCBasePathKey

+ const IngestionAPIEnvVar

+ const IngestionAPIKey

+ const MicrosoftOffice365ManagementActivityFeedLogType

+ const OktaSystemLogFeedLogType

+ const OktaUsersFeedLogType

+ const ProofpointSIEMFeedLogType

+ const QualysVMFeedLogType

+ const RBACAPIKey

+ const ReferenceListsAPIKey

+ const ReferenceListsPathKey

+ const RegionAsiaSouthEast1

+ const RegionEurope

+ const RegionEuropeWest2

+ const RegionUS

+ const RuleBasePathKey

+ const SearchAPIKey

+ const SubjectsBasePathKey

+ const ThinkstCanaryFeedLogType

+ var EnvAPICrendetialsVar = []string

+ var RegionalSubDomains = map[string]map[string]string

+ var Regions = []string

+ func CreateReferenceListUpdateMask(updateLines, updateDescription bool) string

+ func GenerateDefaultBasePaths(region string) map[string]string

+ type AzureBlobStoreFeedConfiguration struct

+ Authentication AzureBlobStoreFeedFeedAuthentication

+ SourceDeleteOptions string

+ SourceType string

+ URI string

+ type AzureBlobStoreFeedFeedAuthentication struct

+ SASToken string

+ SharedKey string

+ type BaseFeed struct

+ Details FeedDetails

+ DisplayName string

+ Name string

+ State string

+ type ChronicleAPIError struct

+ HTTPStatusCode int

+ Message string

+ Result string

+ func (c *ChronicleAPIError) Error() string

+ type Client struct

+ AlertBasePath string

+ AliasBasePath string

+ ArtifactBasePath string

+ AssetBasePath string

+ EventsBasePath string

+ FeedManagementBasePath string

+ IOCBasePath string

+ ReferenceListsBasePath string

+ RuleBasePath string

+ SubjectsBasePath string

+ func NewClient(region string, userAgent string, ctx context.Context, opts ...Option) (*Client, error)

+ func (cli *Client) ChangeAlertingRule(id string, alertingEnabled bool) error

+ func (cli *Client) ChangeEnableFeed(id string, enabled bool) error

+ func (cli *Client) ChangeLiveRule(id string, liveEnabled bool) error

+ func (cli *Client) CreateFeed(displayName, logType, namespace string, labels []Label, ...) (string, error)

+ func (cli *Client) CreateReferenceList(referenceList ReferenceList) (string, error)

+ func (cli *Client) CreateRule(rule Rule) (string, error)

+ func (cli *Client) CreateRuleVersion(rule Rule) error

+ func (cli *Client) CreateSubject(subject Subject) error

+ func (cli *Client) DeleteRule(id string) error

+ func (cli *Client) DeleteSubject(name string) error

+ func (cli *Client) DestroyFeed(name string) error

+ func (cli *Client) GetCredentials(clientScopes []string, accessToken, credentials, envVariable string) (*googleoauth.Credentials, error)

+ func (cli *Client) GetReferenceList(name string) (*ReferenceList, error)

+ func (cli *Client) GetRule(id string) (*Rule, error)

+ func (cli *Client) GetSubject(name string) (*Subject, error)

+ func (cli *Client) ReadFeed(name string) (*BaseFeed, *ConcreteFeedConfiguration, error)

+ func (cli *Client) UpdateFeed(name, displayName, logType, namespace string, labels []Label, ...) error

+ func (cli *Client) UpdateReferenceList(referenceList ReferenceList, updateLines, updateDescription bool) (*ReferenceList, error)

+ func (cli *Client) UpdateSubject(subject Subject) error

+ func (cli *Client) VerifyYARARule(yaraRule string) (bool, error)

+ func (cli *Client) WithAlertBasePath(uri string) *Client

+ func (cli *Client) WithAliasBasePath(uri string) *Client

+ func (cli *Client) WithArtifactBasePath(uri string) *Client

+ func (cli *Client) WithAssetBasePath(uri string) *Client

+ func (cli *Client) WithEventsBasePath(uri string) *Client

+ func (cli *Client) WithFeedManagementBasePath(uri string) *Client

+ func (cli *Client) WithIOCBasePath(uri string) *Client

+ func (cli *Client) WithRuleBasePath(uri string) *Client

+ func (cli *Client) WithSubjectsBasePath(uri string) *Client

+ type ClientRateLimiters struct

+ DetectionCreateRule *rate.Limiter

+ DetectionCreateRuleVersion *rate.Limiter

+ DetectionDeleteRule *rate.Limiter

+ DetectionEnableAlertingRule *rate.Limiter

+ DetectionEnableLiveRule *rate.Limiter

+ DetectionGetRule *rate.Limiter

+ DetectionUpdateRule *rate.Limiter

+ DetectionVerifyYARARule *rate.Limiter

+ FeedManagementCreateFeed *rate.Limiter

+ FeedManagementDeleteFeed *rate.Limiter

+ FeedManagementEnableFeed *rate.Limiter

+ FeedManagementGetFeed *rate.Limiter

+ FeedManagementListFeeds *rate.Limiter

+ FeedManagementUpdateFeed *rate.Limiter

+ RBACCreateSubject *rate.Limiter

+ RBACDeleteSubject *rate.Limiter

+ RBACGetSubject *rate.Limiter

+ RBACUpdateSubject *rate.Limiter

+ ReferenceListsCreateList *rate.Limiter

+ ReferenceListsGetList *rate.Limiter

+ ReferenceListsUpdateList *rate.Limiter

+ func NewClientRateLimiters() *ClientRateLimiters

+ type ConcreteFeedConfiguration interface

+ type FeedDetails struct

+ Labels []Label

+ LogType string

+ Namespace string

+ SourceType string

+ type GCPBucketFeedConfiguration struct

+ SourceDeleteOptions string

+ SourceType string

+ URI string

+ type Label struct

+ Key string

+ Value string

+ type MicrosoftOffice365ManagementActivityFeedAuthentication struct

+ ClientID string

+ ClientSecret string

+ type MicrosoftOffice365ManagementActivityFeedConfiguration struct

+ Authentication MicrosoftOffice365ManagementActivityFeedAuthentication

+ ContentType string

+ Hostname string

+ TenantID string

+ type OktaSystemLogAuthenticationHeaderKeyValues struct

+ Key string

+ Value string

+ type OktaSystemLogFeedAuthentication struct

+ HeaderKeyValues []OktaSystemLogAuthenticationHeaderKeyValues

+ type OktaSystemLogFeedConfiguration struct

+ Authentication OktaSystemLogFeedAuthentication

+ Hostname string

+ type OktaUsersAuthenticationHeaderKeyValues struct

+ Key string

+ Value string

+ type OktaUsersFeedAuthentication struct

+ HeaderKeyValues []OktaUsersAuthenticationHeaderKeyValues

+ type OktaUsersFeedConfiguration struct

+ Authentication OktaUsersFeedAuthentication

+ Hostname string

+ ManagerIDReferenceField string

+ type Option func(*Client) error

+ func WithBackstoryAPIAccessToken(accesstoken string) Option

+ func WithBackstoryAPICredentials(credentials string) Option

+ func WithBackstoryAPIEnvVar() Option

+ func WithBigQueryAPIAccessToken(accesstoken string) Option

+ func WithBigQueryAPICredentials(credentials string) Option

+ func WithBigQueryAPIEnvVar() Option

+ func WithForwarderAPIAccessToken(accesstoken string) Option

+ func WithForwarderAPICredentials(credentials string) Option

+ func WithForwarderAPIEnvVar() Option

+ func WithIngestionAPIAccessToken(accesstoken string) Option

+ func WithIngestionAPICredentials(credentials string) Option

+ func WithIngestionAPIEnvVar() Option

+ func WithRequestAttempts(attempts uint) Option

+ func WithRequestTimeout(timeout time.Duration) Option

+ type Permission struct

+ CreateTime string

+ Description string

+ Name string

+ Title string

+ type ProofpointSIEMFeedAuthentication struct

+ Secret string

+ User string

+ type ProofpointSIEMFeedConfiguration struct

+ Authentication ProofpointSIEMFeedAuthentication

+ type QualysVMFeedAuthentication struct

+ Secret string

+ User string

+ type QualysVMFeedConfiguration struct

+ Authentication QualysVMFeedAuthentication

+ Hostname string

+ type ReferenceList struct

+ ContentType ReferenceListContentType

+ CreateTime string

+ Description string

+ Lines []string

+ Name string

+ type ReferenceListContentType string

+ const ReferenceListContentTypeCIDR

+ const ReferenceListContentTypeDefault

+ const ReferenceListContentTypeREGEX

+ type ReferenceListResponseContenType struct

+ ContentType ReferenceListContentType

+ type ReferenceListResponseCreateTime struct

+ CreateTime string

+ type Role struct

+ CreateTime string

+ Description string

+ IsDefault string

+ Name string

+ Permissions []Permission

+ Title string

+ type Rule struct

+ AlertingEnabled bool

+ CompilationError string

+ CompilationState string

+ ID string

+ LiveEnabled bool

+ Metadata map[string]string

+ Name string

+ Text string

+ Type string

+ VersionCreateTime string

+ VersionID string

+ type S3FeedAuthentication struct

+ AccessKeyID string

+ Region string

+ SecretAccessKey string

+ type S3FeedConfiguration struct

+ Authentication S3FeedAuthentication

+ SourceDeleteOptions string

+ SourceType string

+ URI string

+ type SQSFeedAuthentication struct

+ S3Authentication *SQSFeedAuthenticationCred

+ SQSAuthentication SQSFeedAuthenticationCred

+ type SQSFeedAuthenticationCred struct

+ AccessKeyID string

+ SecretAccessKey string

+ type SQSFeedConfiguration struct

+ AccountNumber string

+ Authentication SQSFeedAuthentication

+ Queue string

+ Region string

+ SourceDeleteOptions string

+ type Subject struct

+ Name string

+ Roles []Role

+ Type string

+ type ThinkstCanaryAuthenticationHeaderKeyValues struct

+ Key string

+ Value string

+ type ThinkstCanaryFeedAuthentication struct

+ HeaderKeyValues []ThinkstCanaryAuthenticationHeaderKeyValues

+ type ThinkstCanaryFeedConfiguration struct

+ Authentication ThinkstCanaryFeedAuthentication

+ Hostname string

+ type YARALValidation struct

+ Context string

+ Valid bool