Documentation
¶
Index ¶
- type AccessRoles
- type Connection
- type ConnectionCount
- type ConnectionHost
- type ConnectionManager
- func (store *ConnectionManager) AccessRoles(connID string) ([]AccessRoles, error)
- func (store *ConnectionManager) Connection(connID string) (*Connection, error)
- func (store *ConnectionManager) ConnectionCounts(timerange TimeRange) (ConnectionCount, error)
- func (store *ConnectionManager) Connections(offset, limit int, sortkey, sortdir string) ([]Connection, error)
- func (store *ConnectionManager) CreateAnomalySettings(settings UebaAnomalySettings) error
- func (store *ConnectionManager) CreateIdForUebaScript() (IDstruct, error)
- func (store *ConnectionManager) CreateSessionIDFileDownload(connID, chanID, fileID string) (string, error)
- func (store *ConnectionManager) CreateSessionIDTrailLog(connID, chanID string) (string, error)
- func (store *ConnectionManager) CreateUebaDataset(uebaDatasetParam DatasetBodyParam) (IDstruct, error)
- func (store *ConnectionManager) DeleteUebaDataset(datasetID string) error
- func (store *ConnectionManager) DownloadStoredFile(connID, chanID, fileID, sessionID, filename string) error
- func (store *ConnectionManager) DownloadTrailLog(connID, chanID, sessionID, format, filter, filename string) error
- func (store *ConnectionManager) DownloadUebaScript(sessionID string) error
- func (store *ConnectionManager) GrantAccessRoleToConnection(connID, roleID string) error
- func (store *ConnectionManager) RevokeAccessRoleFromAllConnections(roleID string) error
- func (store *ConnectionManager) RevokeAccessRoleFromConnection(connID, roleID string) error
- func (store *ConnectionManager) SearchConnections(offset, limit int, sortdir, sortkey string, searchObject ConnectionSearch) ([]Connection, error)
- func (store *ConnectionManager) SetUebaConfigurations(configurations *UebaConfigurations) error
- func (store *ConnectionManager) StartAnalyzing(datasetID string) error
- func (store *ConnectionManager) StopAnalyzing() error
- func (store *ConnectionManager) TerminateConnection(connID string) error
- func (store *ConnectionManager) TerminateConnectionsByTargetHost(hostID string) error
- func (store *ConnectionManager) TerminateConnectionsByUser(userID string) error
- func (store *ConnectionManager) TrainUebaDataset(datasetID string, set_active_after_training bool) (ConnectionCount, error)
- func (store *ConnectionManager) UebaAnomalySettings() (UebaAnomalySettings, error)
- func (store *ConnectionManager) UebaConfigurations() (UebaConfigurations, error)
- func (store *ConnectionManager) UebaDataset(logs bool, bin_count int, datasetID string) (Dataset, error)
- func (store *ConnectionManager) UebaDatasets(logs bool, bin_count int) (uebaDatasetsResult, error)
- func (store *ConnectionManager) UebaInternalStatus() (UebaInternalStatus, error)
- func (store *ConnectionManager) UebaStatus() (*common.ServiceStatus, error)
- func (store *ConnectionManager) UpdateUebaDataset(uebaDatasetParam DatasetBodyParam, datasetID string) error
- type ConnectionRole
- type ConnectionSearch
- type Dataset
- type DatasetBodyParam
- type ExcludeTimeRange
- type Histogram
- type IDstruct
- type Params
- type TimeRange
- type TimestampSearch
- type UebaAnomalySettings
- type UebaConfigurations
- type UebaDatasetQueryParams
- type UebaInternalModelInstance
- type UebaInternalStatus
- type UebaTrainingResult
- type UserData
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AccessRoles ¶
type AccessRoles struct {
ID string `json:"id"`
Name string `json:"name"`
Added string `json:"added"`
}
AccessRoles access roles struct definition
type Connection ¶
type Connection struct {
ID string `json:"id,omitempty"`
ProxyID string `json:"proxy_id,omitempty"`
Type string `json:"type,omitempty"`
UserAgent string `json:"user_agent,omitempty"`
TargetHostAddress string `json:"target_host_address,omitempty"`
TargetHostAccount string `json:"target_host_account,omitempty"`
RemoteAddress string `json:"remote_address,omitempty"`
Connected string `json:"connected,omitempty"`
Disconnected string `json:"disconnected,omitempty"`
Status string `json:"status,omitempty"`
LastActivity string `json:"last_activity,omitempty"`
ForceDisconnect string `json:"force_disconnect,omitempty"`
TerminationReason string `json:"termination_reason,omitempty"`
Created string `json:"created,omitempty"`
Updated string `json:"updated,omitempty"`
UpdatedBy string `json:"updated_by,omitempty"`
TrailID string `json:"trail_id,omitempty"`
IndexStatus string `json:"index_status,omitempty"`
AccessGroupID string `json:"access_group_id,omitempty"`
AuthMethod []string `json:"authentication_method,omitempty"`
BytesIn int `json:"bytes_in,omitempty"`
BytesOut int `json:"bytes_out,omitempty"`
Duration int `json:"duration,omitempty"`
TrailRemoved bool `json:"trail_removed,omitempty"`
AuditEnabled bool `json:"audit_enabled,omitempty"`
TargetHostData ConnectionHost `json:"target_host_data,omitempty"`
UserData UserData `json:"user,omitempty"`
UserRoles []ConnectionRole `json:"user_roles,omitempty"`
TargetHostRoles []ConnectionRole `json:"target_host_roles,omitempty"`
AccessRoles []AccessRoles `json:"access_roles,omitempty"`
}
Connection connection struct definition
type ConnectionCount ¶ added in v1.26.0
type ConnectionCount struct {
Count int `json:"count"`
}
type ConnectionHost ¶
type ConnectionHost struct {
ID string `json:"id,omitempty"`
CommonName string `json:"common_name,omitempty"`
}
ConnectionHost connection host struct definition
type ConnectionManager ¶
type ConnectionManager struct {
// contains filtered or unexported fields
}
ConnectionManager is a connection manager client instance.
func New ¶
func New(api restapi.Connector) *ConnectionManager
New creates a new connection manager client instance, using the argument SDK API client.
func (*ConnectionManager) AccessRoles ¶
func (store *ConnectionManager) AccessRoles(connID string) ([]AccessRoles, error)
AccessRoles get saved access roles for a connection
func (*ConnectionManager) Connection ¶
func (store *ConnectionManager) Connection(connID string) (*Connection, error)
Connection get a single connection
func (*ConnectionManager) ConnectionCounts ¶ added in v1.26.0
func (store *ConnectionManager) ConnectionCounts(timerange TimeRange) (ConnectionCount, error)
ConnectionCounts Get number of connections for dataset with given parameters. All connections, if json empty in body.
func (*ConnectionManager) Connections ¶
func (store *ConnectionManager) Connections(offset, limit int, sortkey, sortdir string) ([]Connection, error)
Connections get all connections
func (*ConnectionManager) CreateAnomalySettings ¶ added in v1.26.0
func (store *ConnectionManager) CreateAnomalySettings(settings UebaAnomalySettings) error
CreateAnomalySettings create Ueba anomaly settings
func (*ConnectionManager) CreateIdForUebaScript ¶ added in v1.26.0
func (store *ConnectionManager) CreateIdForUebaScript() (IDstruct, error)
CreateIdForUebaScript create session ID for Ueba setup script
func (*ConnectionManager) CreateSessionIDFileDownload ¶
func (store *ConnectionManager) CreateSessionIDFileDownload(connID, chanID, fileID string) (string, error)
CreateSessionIDFileDownload create session ID for trail stored file download
func (*ConnectionManager) CreateSessionIDTrailLog ¶
func (store *ConnectionManager) CreateSessionIDTrailLog(connID, chanID string) (string, error)
CreateSessionIDTrailLog create session ID for trail log download
func (*ConnectionManager) CreateUebaDataset ¶ added in v1.26.0
func (store *ConnectionManager) CreateUebaDataset(uebaDatasetParam DatasetBodyParam) (IDstruct, error)
CreateUebaDataset Save new dataset definition.
func (*ConnectionManager) DeleteUebaDataset ¶ added in v1.26.0
func (store *ConnectionManager) DeleteUebaDataset(datasetID string) error
DeleteUebaDataset Delete dataset.
func (*ConnectionManager) DownloadStoredFile ¶
func (store *ConnectionManager) DownloadStoredFile(connID, chanID, fileID, sessionID, filename string) error
DownloadStoredFile download trail stored file transferred within audited connection channel
func (*ConnectionManager) DownloadTrailLog ¶
func (store *ConnectionManager) DownloadTrailLog(connID, chanID, sessionID, format, filter, filename string) error
DownloadTrailLog download trail log of audited connection channel
func (*ConnectionManager) DownloadUebaScript ¶ added in v1.26.0
func (store *ConnectionManager) DownloadUebaScript(sessionID string) error
DownloadUebaScript download ueba setup script.
func (*ConnectionManager) GrantAccessRoleToConnection ¶
func (store *ConnectionManager) GrantAccessRoleToConnection(connID, roleID string) error
GrantAccessRoleToConnection grant a role permission for a connection
func (*ConnectionManager) RevokeAccessRoleFromAllConnections ¶
func (store *ConnectionManager) RevokeAccessRoleFromAllConnections(roleID string) error
RevokeAccessRoleFromAllConnections revoke permissions for a role from connections
func (*ConnectionManager) RevokeAccessRoleFromConnection ¶
func (store *ConnectionManager) RevokeAccessRoleFromConnection(connID, roleID string) error
RevokeAccessRoleFromConnection revoke a permission for a role from a connection
func (*ConnectionManager) SearchConnections ¶
func (store *ConnectionManager) SearchConnections(offset, limit int, sortdir, sortkey string, searchObject ConnectionSearch) ([]Connection, error)
SearchConnections search for connections
func (*ConnectionManager) SetUebaConfigurations ¶ added in v1.26.0
func (store *ConnectionManager) SetUebaConfigurations(configurations *UebaConfigurations) error
SetUebaConfigurations set ueba configurations
func (*ConnectionManager) StartAnalyzing ¶ added in v1.26.0
func (store *ConnectionManager) StartAnalyzing(datasetID string) error
StartAnalyzing start ueba analysis
func (*ConnectionManager) StopAnalyzing ¶ added in v1.26.0
func (store *ConnectionManager) StopAnalyzing() error
StopAnalyzing stop ueba analysis
func (*ConnectionManager) TerminateConnection ¶
func (store *ConnectionManager) TerminateConnection(connID string) error
TerminateConnection terminate connection by ID.
func (*ConnectionManager) TerminateConnectionsByTargetHost ¶
func (store *ConnectionManager) TerminateConnectionsByTargetHost(hostID string) error
TerminateConnectionsByTargetHost terminate connection(s) from host
func (*ConnectionManager) TerminateConnectionsByUser ¶
func (store *ConnectionManager) TerminateConnectionsByUser(userID string) error
TerminateConnectionsByUser terminate connection(s) of a user
func (*ConnectionManager) TrainUebaDataset ¶ added in v1.26.0
func (store *ConnectionManager) TrainUebaDataset(datasetID string, set_active_after_training bool) (ConnectionCount, error)
TrainUebaDataset Train or retrain saved dataset.
func (*ConnectionManager) UebaAnomalySettings ¶ added in v1.26.0
func (store *ConnectionManager) UebaAnomalySettings() (UebaAnomalySettings, error)
UebaAnomalySettings get ueba anomaly settings
func (*ConnectionManager) UebaConfigurations ¶ added in v1.26.0
func (store *ConnectionManager) UebaConfigurations() (UebaConfigurations, error)
UebaConfigurations get ueba configurations
func (*ConnectionManager) UebaDataset ¶ added in v1.26.0
func (store *ConnectionManager) UebaDataset(logs bool, bin_count int, datasetID string) (Dataset, error)
UebaDataset Get dataset by id, possibility to filter training history.
func (*ConnectionManager) UebaDatasets ¶ added in v1.26.0
func (store *ConnectionManager) UebaDatasets(logs bool, bin_count int) (uebaDatasetsResult, error)
UebaDatasets get dataset object list for ueba.
func (*ConnectionManager) UebaInternalStatus ¶ added in v1.26.0
func (store *ConnectionManager) UebaInternalStatus() (UebaInternalStatus, error)
UebaInternalStatus Get Ueba microservice internal status
func (*ConnectionManager) UebaStatus ¶ added in v1.26.0
func (store *ConnectionManager) UebaStatus() (*common.ServiceStatus, error)
UebaStatus Get Ueba service status
func (*ConnectionManager) UpdateUebaDataset ¶ added in v1.26.0
func (store *ConnectionManager) UpdateUebaDataset(uebaDatasetParam DatasetBodyParam, datasetID string) error
UpdateUebaDataset Update dataset.
type ConnectionRole ¶
ConnectionRole connection role struct definition
type ConnectionSearch ¶
type ConnectionSearch struct {
ID []string `json:"id,omitempty"`
ProxyID []string `json:"proxy_id,omitempty"`
Type []string `json:"type,omitempty"`
Mode []string `json:"mode,omitempty"`
UserAgent []string `json:"user_agent,omitempty"`
AuthMethod []string `json:"authentication_method,omitempty"`
UserID []string `json:"user_id,omitempty"`
UserDisplayName []string `json:"user_display_name,omitempty"`
UserRoles []string `json:"user_roles,omitempty"`
TargetHost []string `json:"target_host_id,omitempty"`
TargetHostCommonName []string `json:"target_host_common_name,omitempty"`
TargetHostAddress []string `json:"target_host_address,omitempty"`
TargetHostAccount []string `json:"target_host_account,omitempty"`
TargetHostRoles []string `json:"target_host_roles,omitempty"`
RemoteAddress []string `json:"remote_address,omitempty"`
Status []string `json:"status,omitempty"`
ForceDisconnect []string `json:"force_disconnect,omitempty"`
AccessRoles []string `json:"access_roles,omitempty"`
KeyWords string `json:"keywords,omitempty"`
HasAccessRoles bool `json:"has_access_roles,omitempty"`
Connected TimestampSearch `json:"connected,omitempty"`
Disconnected TimestampSearch `json:"disconnected,omitempty"`
LastActivity TimestampSearch `json:"last_activity,omitempty"`
}
ConnectionSearch connection search struct definition
type Dataset ¶ added in v1.26.0
type Dataset struct {
ID string `db:"id" json:"id" validate:"omitempty,uuid"`
LastTraining *time.Time `db:"last_training" json:"last_training"`
FeatureConfigName string `db:"feature_config_name" json:"-"`
IsActive bool `db:"is_active" json:"is_active"`
UseForInferenceOnceTrained bool `db:"use_for_inference_once_trained" json:"use_for_inference_once_trained"`
Quantile99 float32 `db:"quantile_99" json:"-"`
Quantile999 float32 `db:"quantile_999" json:"-"`
Std float32 `db:"std" json:"-"`
TimeRangeSettings *TimeRange `json:"time_range_settings" validate:"required"`
DBTimeRangeSettings string `db:"time_range_settings" json:"-"`
TrainingResults []UebaTrainingResult `json:"training_results"`
Created *time.Time `db:"created" json:"created,omitempty"`
CreatedBy string `db:"created_by" json:"created_by,omitempty"`
Updated *time.Time `db:"updated" json:"updated,omitempty"`
UpdatedBy string `db:"updated_by" json:"updated_by,omitempty"`
Comment string `db:"comment" json:"comment,omitempty"`
}
Dataset dataset struct definition for Ueba
type DatasetBodyParam ¶ added in v1.26.0
type DatasetBodyParam struct {
ID string `db:"id" json:"id" validate:"omitempty"`
TimeRangeSettings *TimeRange `json:"time_range_settings" validate:"required"`
Created *time.Time `db:"created" json:"created,omitempty"`
CreatedBy string `db:"created_by" json:"created_by,omitempty"`
Updated *time.Time `db:"updated" json:"updated,omitempty"`
UpdatedBy string `db:"updated_by" json:"updated_by,omitempty"`
Comment string `db:"comment" json:"comment,omitempty"`
}
DatasetBodyParam struct definition for body params in ueba dataset api calls
type ExcludeTimeRange ¶ added in v1.26.0
type Params ¶
type Params struct {
Offset int `json:"offset,omitempty"`
Limit int `json:"limit,omitempty"`
Sortdir string `json:"sortdir,omitempty"`
Sortkey string `json:"sortkey,omitempty"`
Format string `json:"format,omitempty"`
Filter string `json:"filter,omitempty"`
}
Params query params definition
type TimeRange ¶ added in v1.26.0
type TimeRange struct {
Start *time.Time `json:"start,omitempty"`
End *time.Time `json:"end,omitempty"`
Exclude []ExcludeTimeRange `json:"exclude,omitempty"`
}
TimeRange time range struct definition
type TimestampSearch ¶
TimestampSearch timestamp search struct definition
type UebaAnomalySettings ¶ added in v1.26.0
type UebaAnomalySettings struct {
Action string `json:"action"`
Threshold float32 `json:"threshold"`
}
UebaAnomalySettings ueba anomaly settings struct definition
type UebaConfigurations ¶ added in v1.26.0
type UebaConfigurations struct {
Address string `json:"address"`
TrustAnchors string `json:"trust_anchors"`
}
UebaConfigurations uebaconfigurations struct definition
type UebaDatasetQueryParams ¶ added in v1.26.0
type UebaDatasetQueryParams struct {
Logs bool `json:"logs,omitempty"`
BinCount int `json:"bin_count,omitempty"`
}
UebaDatasetQueryParams query params definition for Ueba DataSet
type UebaInternalModelInstance ¶ added in v1.26.0
type UebaInternalStatus ¶ added in v1.26.0
type UebaInternalStatus struct {
TrainingStatus string `json:"training_status"`
InferenceStatus string `json:"inference_status"`
DatasetID string `json:"dataset_id" validate:"uuid,omitempty"`
ModelInstanceStatus []UebaInternalModelInstance `json:"model_instance_status"`
}
type UebaTrainingResult ¶ added in v1.26.0
type UebaTrainingResult struct {
DatasetID string `json:"dataset_id"`
Created time.Time `json:"created"`
FeatureConfigName string `json:"feature_config_name"`
Status string `json:"status"`
ErrorCode string `json:"error_code"`
ErrorDetails string `json:"error_details"`
NumConnections int `json:"num_connections"`
Mean float32 `json:"mean"`
Std float32 `json:"std"`
Quantile99 float32 `json:"quantile_99"`
Quantile999 float32 `json:"quantile_999"`
TrainingLog string `json:"training_log"`
TrainingDatasetLoss []float32 `json:"training_dataset_loss"`
ValidationDatasetLoss []float32 `json:"validation_dataset_loss"`
ValidationDatasetHistogram Histogram `json:"validation_dataset_histogram"`
}
UebaTrainingResult ueba training result struct definition