zia

Documentation

Index

• Constants
• Variables
• type ApiErr
• type Client
  • func NewClient(config *Configuration) (*Client, error)
  • func (c *Client) BulkDelete(ctx context.Context, endpoint string, payload interface{}) (*http.Response, error)
  • func (c *Client) Create(ctx context.Context, endpoint string, o interface{}) (interface{}, error)
  • func (c *Client) CreateWithNoContent(ctx context.Context, endpoint string, o interface{}) (interface{}, error)
  • func (c *Client) CreateWithRawPayload(ctx context.Context, endpoint string, payload string) ([]byte, error)
  • func (c *Client) CreateWithSlicePayload(ctx context.Context, endpoint string, slice interface{}) ([]byte, error)
  • func (c *Client) Delete(ctx context.Context, endpoint string) error
  • func (c *Client) GenericRequest(ctx context.Context, baseUrl, endpoint, method string, body io.Reader, ...) ([]byte, error)
  • func (c *Client) GetContentType() string
  • func (c *Client) Logout(ctx context.Context) error
  • func (c *Client) Read(ctx context.Context, endpoint string, o interface{}) error
  • func (c *Client) Request(ctx context.Context, endpoint, method string, data []byte, contentType string) ([]byte, error)
  • func (c *Client) Update(ctx context.Context, endpoint string, o interface{}) (interface{}, error)
  • func (c *Client) UpdateWithPut(ctx context.Context, endpoint string, o interface{}) (interface{}, error)
  • func (c *Client) UpdateWithSlicePayload(ctx context.Context, endpoint string, slice interface{}) ([]byte, error)
  • func (c *Client) WithCache(cache bool)
  • func (c *Client) WithCacheCleanWindow(i time.Duration)
  • func (c *Client) WithCacheTtl(i time.Duration)
  • func (client *Client) WithFreshCache()
• type ConfigSetter
  • func WithCache(cache bool) ConfigSetter
  • func WithCacheManager(cacheManager cache.Cache) ConfigSetter
  • func WithCacheMaxSizeMB(size int64) ConfigSetter
  • func WithCacheTti(i time.Duration) ConfigSetter
  • func WithCacheTtl(i time.Duration) ConfigSetter
  • func WithDebug(debug bool) ConfigSetter
  • func WithHttpClientPtr(httpClient *http.Client) ConfigSetter
  • func WithProxyHost(host string) ConfigSetter
  • func WithProxyPassword(pass string) ConfigSetter
  • func WithProxyPort(i int32) ConfigSetter
  • func WithProxyUsername(username string) ConfigSetter
  • func WithRateLimitMaxRetries(maxRetries int32) ConfigSetter
  • func WithRateLimitMaxWait(maxWait time.Duration) ConfigSetter
  • func WithRateLimitMinWait(minWait time.Duration) ConfigSetter
  • func WithRequestTimeout(requestTimeout time.Duration) ConfigSetter
  • func WithTestingDisableHttpsCheck(httpsCheck bool) ConfigSetter
  • func WithUserAgent(userAgent string) ConfigSetter
  • func WithUserAgentExtra(userAgent string) ConfigSetter
  • func WithZiaAPIKey(apiKey string) ConfigSetter
  • func WithZiaCloud(cloud string) ConfigSetter
  • func WithZiaPassword(password string) ConfigSetter
  • func WithZiaUsername(username string) ConfigSetter
• type Configuration
  • func NewConfiguration(conf ...ConfigSetter) (*Configuration, error)
  • func (c *Configuration) AddDefaultHeader(key string, value string)
• type Credentials
• type Session
  • func MakeAuthRequestZIA(credentials *Credentials, url string, client *http.Client, userAgent string) (*Session, error)

Constants

const (
	JSessionIDTimeout = 30 // minutes.

	MaxNumOfRetries     = 100
	RetryWaitMaxSeconds = 20
	RetryWaitMinSeconds = 5
)

const (
	VERSION      = "3.1.4s"
	ZIA_USERNAME = "ZIA_USERNAME"
	ZIA_PASSWORD = "ZIA_PASSWORD"
	ZIA_API_KEY  = "ZIA_API_KEY"
	ZIA_CLOUD    = "ZIA_CLOUD"
)

Variables

var (
	// ContextAccessToken takes a string OAuth2 access token as authentication for the request.
	ContextAccessToken = contextKey("access_token")
)

Types

type ApiErr

type ApiErr struct {
	Code    string `json:"code"`
	Message string `json:"message"`
}

type Client

type Client struct {
	sync.Mutex

	URL        string
	HTTPClient *http.Client
	Logger     logger.Logger
	UserAgent  string
	// contains filtered or unexported fields
}

func NewClient

func NewClient(config *Configuration) (*Client, error)

func (*Client) BulkDelete

func (c *Client) BulkDelete(ctx context.Context, endpoint string, payload interface{}) (*http.Response, error)

BulkDelete sends an HTTP POST request for bulk deletion and expects a 204 No Content response.

func (*Client) Create

func (c *Client) Create(ctx context.Context, endpoint string, o interface{}) (interface{}, error)

Create sends an HTTP POST request.

func (*Client) CreateWithNoContent

func (c *Client) CreateWithNoContent(ctx context.Context, endpoint string, o interface{}) (interface{}, error)

Create sends an HTTP POST request and supports 204 No Content responses.

func (*Client) CreateWithRawPayload

func (c *Client) CreateWithRawPayload(ctx context.Context, endpoint string, payload string) ([]byte, error)

CreateWithRawPayload sends an HTTP POST request with a raw string payload.

func (*Client) CreateWithSlicePayload

func (c *Client) CreateWithSlicePayload(ctx context.Context, endpoint string, slice interface{}) ([]byte, error)

func (*Client) Delete

func (c *Client) Delete(ctx context.Context, endpoint string) error

Delete ...

func (*Client) GenericRequest

func (c *Client) GenericRequest(ctx context.Context, baseUrl, endpoint, method string, body io.Reader, urlParams url.Values, contentType string) ([]byte, error)

Request ... // Needs to review this function.

func (*Client) GetContentType

func (c *Client) GetContentType() string

func (*Client) Logout

func (c *Client) Logout(ctx context.Context) error

func (*Client) Read

func (c *Client) Read(ctx context.Context, endpoint string, o interface{}) error

Read ...

func (*Client) Request

func (c *Client) Request(ctx context.Context, endpoint, method string, data []byte, contentType string) ([]byte, error)

Request ... // Needs to review this function.

func (*Client) Update

func (c *Client) Update(ctx context.Context, endpoint string, o interface{}) (interface{}, error)

Update ...

func (*Client) UpdateWithPut

func (c *Client) UpdateWithPut(ctx context.Context, endpoint string, o interface{}) (interface{}, error)

Update ...

func (*Client) UpdateWithSlicePayload

func (c *Client) UpdateWithSlicePayload(ctx context.Context, endpoint string, slice interface{}) ([]byte, error)

func (*Client) WithCache

func (c *Client) WithCache(cache bool)

func (*Client) WithCacheCleanWindow

func (c *Client) WithCacheCleanWindow(i time.Duration)

func (*Client) WithCacheTtl

func (c *Client) WithCacheTtl(i time.Duration)

func (*Client) WithFreshCache

func (client *Client) WithFreshCache()

type ConfigSetter

type ConfigSetter func(*Configuration)

func WithCache

func WithCache(cache bool) ConfigSetter

func WithCacheManager

func WithCacheManager(cacheManager cache.Cache) ConfigSetter

func WithCacheMaxSizeMB

func WithCacheMaxSizeMB(size int64) ConfigSetter

func WithCacheTti

func WithCacheTti(i time.Duration) ConfigSetter

func WithCacheTtl

func WithCacheTtl(i time.Duration) ConfigSetter

func WithDebug

func WithDebug(debug bool) ConfigSetter

func WithHttpClientPtr

func WithHttpClientPtr(httpClient *http.Client) ConfigSetter

WithHttpClient sets the HttpClient in the Config.

func WithProxyHost

func WithProxyHost(host string) ConfigSetter

func WithProxyPassword

func WithProxyPassword(pass string) ConfigSetter

func WithProxyPort

func WithProxyPort(i int32) ConfigSetter

func WithProxyUsername

func WithProxyUsername(username string) ConfigSetter

func WithRateLimitMaxRetries

func WithRateLimitMaxRetries(maxRetries int32) ConfigSetter

func WithRateLimitMaxWait

func WithRateLimitMaxWait(maxWait time.Duration) ConfigSetter

func WithRateLimitMinWait

func WithRateLimitMinWait(minWait time.Duration) ConfigSetter

func WithRequestTimeout

func WithRequestTimeout(requestTimeout time.Duration) ConfigSetter

func WithTestingDisableHttpsCheck

func WithTestingDisableHttpsCheck(httpsCheck bool) ConfigSetter

func WithUserAgent

func WithUserAgent(userAgent string) ConfigSetter

func WithUserAgentExtra

func WithUserAgentExtra(userAgent string) ConfigSetter

WithUserAgent sets the UserAgent in the Config.

func WithZiaAPIKey

func WithZiaAPIKey(apiKey string) ConfigSetter

WithZiaAPIKey sets the ApiKey in the Config.

func WithZiaCloud

func WithZiaCloud(cloud string) ConfigSetter

WithZiaAPIKey sets the ApiKey in the Config.

func WithZiaPassword

func WithZiaPassword(password string) ConfigSetter

WithZiaPassword sets the Password in the Config.

func WithZiaUsername

func WithZiaUsername(username string) ConfigSetter

ConfigSetter type defines a function that modifies a Config struct. WithZiaUsername sets the Username in the Config.

type Configuration

type Configuration struct {
	sync.Mutex
	Logger         logger.Logger
	HTTPClient     *http.Client
	BaseURL        *url.URL
	DefaultHeader  map[string]string `json:"defaultHeader,omitempty"`
	UserAgent      string            `json:"userAgent,omitempty"`
	Debug          bool              `json:"debug,omitempty"`
	UserAgentExtra string
	Context        context.Context
	ZIA            struct {
		Client struct {
			ZIAUsername string `yaml:"username" envconfig:"ZIA_USERNAME"`
			ZIAPassword string `yaml:"password" envconfig:"ZIA_PASSWORD"`
			ZIAApiKey   string `yaml:"apiKey" envconfig:"ZIA_API_KEY"`
			ZIACloud    string `yaml:"cloud" envconfig:"ZIA_CLOUD"`
			Cache       struct {
				Enabled               bool          `yaml:"enabled" envconfig:"ZIA_CLIENT_CACHE_ENABLED"`
				DefaultTtl            time.Duration `yaml:"defaultTtl" envconfig:"ZIA_CLIENT_CACHE_DEFAULT_TTL"`
				DefaultTti            time.Duration `yaml:"defaultTti" envconfig:"ZIA_CLIENT_CACHE_DEFAULT_TTI"`
				DefaultCacheMaxSizeMB int64         `yaml:"defaultTti" envconfig:"ZIA_CLIENT_CACHE_DEFAULT_SIZE"`
			} `yaml:"cache"`
			Proxy struct {
				Port     int32  `yaml:"port" envconfig:"ZIA_CLIENT_PROXY_PORT"`
				Host     string `yaml:"host" envconfig:"ZIA_CLIENT_PROXY_HOST"`
				Username string `yaml:"username" envconfig:"ZIA_CLIENT_PROXY_USERNAME"`
				Password string `yaml:"password" envconfig:"ZIA_CLIENT_PROXY_PASSWORD"`
			} `yaml:"proxy"`
			RequestTimeout time.Duration `yaml:"requestTimeout" envconfig:"ZIA_CLIENT_REQUEST_TIMEOUT"`
			RateLimit      struct {
				MaxRetries   int32         `yaml:"maxRetries" envconfig:"ZIA_CLIENT_RATE_LIMIT_MAX_RETRIES"`
				RetryWaitMin time.Duration `yaml:"minWait" envconfig:"ZIA_CLIENT_RATE_LIMIT_MIN_WAIT"`
				RetryWaitMax time.Duration `yaml:"maxWait" envconfig:"ZIA_CLIENT_RATE_LIMIT_MAX_WAIT"`
			} `yaml:"rateLimit"`
		} `yaml:"client"`
		Testing struct {
			DisableHttpsCheck bool `yaml:"disableHttpsCheck" envconfig:"ZIA_TESTING_DISABLE_HTTPS_CHECK"`
		} `yaml:"testing"`
	} `yaml:"zia"`
	CacheManager cache.Cache
}

func NewConfiguration

func NewConfiguration(conf ...ConfigSetter) (*Configuration, error)

func (*Configuration) AddDefaultHeader

func (c *Configuration) AddDefaultHeader(key string, value string)

AddDefaultHeader adds a new HTTP header to the default header in the request

type Credentials

type Credentials struct {
	Username  string `json:"username"`
	Password  string `json:"password"`
	APIKey    string `json:"apiKey"`
	TimeStamp string `json:"timestamp"`
}

Credentials ...

type Session

type Session struct {
	AuthType           string `json:"authType"`
	ObfuscateAPIKey    bool   `json:"obfuscateApiKey"`
	PasswordExpiryTime int    `json:"passwordExpiryTime"`
	PasswordExpiryDays int    `json:"passwordExpiryDays"`
	Source             string `json:"source"`
	JSessionID         string `json:"jSessionID,omitempty"`
}

Session ...

func MakeAuthRequestZIA

func MakeAuthRequestZIA(credentials *Credentials, url string, client *http.Client, userAgent string) (*Session, error)

MakeAuthRequestZIA authenticates using the provided credentials and returns the session or an error.