Documentation
¶
Index ¶
- Constants
- func NewAccessGrantedEvent(metadata EventMetadata, resource, action string, value any) (plog.Logs, error)
- func NewCmkAvailableEvent(metadata EventMetadata, cmkID string) (plog.Logs, error)
- func NewCmkCreateEvent(metadata EventMetadata, cmkID string) (plog.Logs, error)
- func NewCmkDeleteEvent(metadata EventMetadata, cmkID string) (plog.Logs, error)
- func NewCmkDetachEvent(metadata EventMetadata, cmkID string) (plog.Logs, error)
- func NewCmkDisableEvent(metadata EventMetadata, cmkID string) (plog.Logs, error)
- func NewCmkEnableEvent(metadata EventMetadata, cmkID string) (plog.Logs, error)
- func NewCmkOffboardingEvent(metadata EventMetadata, cmkID, systemID string) (plog.Logs, error)
- func NewCmkOnboardingEvent(metadata EventMetadata, cmkID, systemID string) (plog.Logs, error)
- func NewCmkRestoreEvent(metadata EventMetadata, cmkID string) (plog.Logs, error)
- func NewCmkRotateEvent(metadata EventMetadata, cmkID string) (plog.Logs, error)
- func NewCmkSwitchEvent(metadata EventMetadata, systemID, cmkIDOld, cmkIDNew string) (plog.Logs, error)
- func NewCmkTenantDeleteEvent(metadata EventMetadata, cmkID string) (plog.Logs, error)
- func NewCmkTenantModificationEvent(metadata EventMetadata, cmkID, systemID string, c CmkAction) (plog.Logs, error)
- func NewCmkUnavailableEvent(metadata EventMetadata, cmkID string) (plog.Logs, error)
- func NewConfigurationCreateEvent(metadata EventMetadata, objectID string, value any) (plog.Logs, error)
- func NewConfigurationDeleteEvent(metadata EventMetadata, objectID string, value any) (plog.Logs, error)
- func NewConfigurationReadEvent(metadata EventMetadata, objectID, channelType, channelID string, value any) (plog.Logs, error)
- func NewConfigurationUpdateEvent(metadata EventMetadata, objectID string, oldValue, newValue any) (plog.Logs, error)
- func NewCredentialCreateEvent(metadata EventMetadata, credentialID string, c CredentialType) (plog.Logs, error)
- func NewCredentialDeleteEvent(metadata EventMetadata, credentialID string, c CredentialType) (plog.Logs, error)
- func NewCredentialExpirationEvent(metadata EventMetadata, credentialID string, c CredentialType) (plog.Logs, error)
- func NewCredentialRevokationEvent(metadata EventMetadata, credentialID string, c CredentialType) (plog.Logs, error)
- func NewGroupCreateEvent(metadata EventMetadata, objectID string, value any, dpp bool) (plog.Logs, error)
- func NewGroupDeleteEvent(metadata EventMetadata, objectID string, value any, dpp bool) (plog.Logs, error)
- func NewGroupReadEvent(metadata EventMetadata, objectID, channelID, channelType string, value any, ...) (plog.Logs, error)
- func NewGroupUpdateEvent(metadata EventMetadata, objectID, propertyName string, oldValue, newValue any, ...) (plog.Logs, error)
- func NewKeyCreateEvent(metadata EventMetadata, objectID, systemID, cmkID string, t KeyType) (plog.Logs, error)
- func NewKeyDeleteEvent(metadata EventMetadata, objectID, systemID, cmkID string, t KeyType) (plog.Logs, error)
- func NewKeyDisableEvent(metadata EventMetadata, objectID, systemID, cmkID string, t KeyType) (plog.Logs, error)
- func NewKeyEnableEvent(metadata EventMetadata, objectID, systemID, cmkID string, t KeyType) (plog.Logs, error)
- func NewKeyPurgeEvent(metadata EventMetadata, objectID, systemID, cmkID string, t KeyType) (plog.Logs, error)
- func NewKeyRestoreEvent(metadata EventMetadata, objectID, systemID, cmkID string, t KeyType) (plog.Logs, error)
- func NewKeyRotateEvent(metadata EventMetadata, objectID, systemID, cmkID string, t KeyType) (plog.Logs, error)
- func NewTenantOffboardingEvent(metadata EventMetadata, tenantID string) (plog.Logs, error)
- func NewTenantOnboardingEvent(metadata EventMetadata, tenantID string) (plog.Logs, error)
- func NewTenantUpdateEvent(metadata EventMetadata, objectID, propertyName string, oldValue, newValue any) (plog.Logs, error)
- func NewUnauthenticatedRequestEvent(metadata EventMetadata) (plog.Logs, error)
- func NewUnauthorizedRequestEvent(metadata EventMetadata, resource, action string) (plog.Logs, error)
- func NewUserLoginFailureEvent(metadata EventMetadata, objectID string, l LoginMethod, f FailReason, ...) (plog.Logs, error)
- func NewUserLoginSuccessEvent(metadata EventMetadata, objectID string, l LoginMethod, t MfaType, u UserType, ...) (plog.Logs, error)
- func NewWorkflowExecuteEvent(metadata EventMetadata, objectID, channelID, channelType string, value any, ...) (plog.Logs, error)
- func NewWorkflowStartEvent(metadata EventMetadata, objectID, channelID, channelType string, value any, ...) (plog.Logs, error)
- func NewWorkflowTerminateEvent(metadata EventMetadata, objectID, channelID, channelType string, value any, ...) (plog.Logs, error)
- func NewWorkflowUpdateEvent(metadata EventMetadata, objectID string, oldValue, newValue any, dpp bool) (plog.Logs, error)
- type AuditLogger
- type CmkAction
- type CredentialType
- type EventMetadata
- type FailReason
- type KeyCreateActionType
- type KeyReadActionType
- type KeyType
- type KeyUpdateActionType
- type LoginMethod
- type MfaType
- type QueuedAuditLogger
- type QueuedOptions
- type TenantUpdateActionType
- type UserLoginFailureActionType
- type UserType
Constants ¶
const ( ConfigCreateEvent = "configurationCreate" ConfigReadEvent = "configurationRead" ConfigUpdateEvent = "configurationUpdate" ConfigDeleteEvent = "configurationDelete" GroupCreateEvent = "groupCreate" GroupReadEvent = "groupRead" GroupUpdateEvent = "groupUpdate" GroupDeleteEvent = "groupDelete" KeyCreateEvent = "keyCreate" KeyDeleteEvent = "keyDelete" KeyRestoreEvent = "keyRestore" KeyPurgeEvent = "keyPurge" KeyRotateEvent = "keyRotate" KeyEnableEvent = "keyEnable" KeyDisableEvent = "keyDisable" WorkflowStartEvent = "workflowStart" WorkflowUpdateEvent = "workflowUpdate" WorkflowExecuteEvent = "workflowExecute" WorkflowTerminateEvent = "workflowTerminate" UserLoginSuccessEvent = "userLoginSuccess" UserLoginFailureEvent = "userLoginFailure" TenantOnboardingEvent = "tenantOnboarding" TenantOffboardingEvent = "tenantOffboarding" TenantUpdateEvent = "tenantUpdate" CredentialExpirationEvent = "credentialExpiration" CredentialCreateEvent = "credentialCreate" CredentialRevokationEvent = "credentialRevokation" CredentialDeleteEvent = "credentialDelete" CmkOnboardingEvent = "cmkOnboarding" CmkOffboardingEvent = "cmkOffboarding" CmkSwitchEvent = "cmkSwitch" CmkTenantModificationEvent = "cmkTenantModification" CmkTenantDeleteEvent = "cmkTenantDelete" CmkCreateEvent = "cmkCreate" CmkDeleteEvent = "cmkDelete" CmkDetachEvent = "cmkDetach" CmkRestoreEvent = "cmkRestore" CmkEnableEvent = "cmkEnable" CmkDisableEvent = "cmkDisable" CmkRotateEvent = "cmkRotate" CmkAvailableEvent = "cmkAvailable" AccessGrantedEvent = "accessGranted" UnauthenticatedRequestEvent = "unauthenticatedRequest" )
const ( EventTypeKey = "eventType" ObjectIDKey = "objectID" ObjectTypeKey = "objectType" ActionTypeKey = "actionType" ChannelTypeKey = "channelType" ChannelIDKey = "channelID" LoginMethodKey = "loginMethod" MfaTypeKey = "mfaType" UserTypeKey = "userType" FailureReasonKey = "failureReason" CredentialTypeKey = "credentialType" ValueKey = "value" PropertyNameKey = "propertyName" OldValueKey = "oldValue" NewValueKey = "newValue" DppKey = "dpp" UserInitiatorIDKey = "userInitiatorID" TenantIDKey = "tenantID" EventCorrelationIDKey = "eventCorrelationID" SystemIDKey = "systemID" CmkIDKey = "cmkID" CmkIDOldKey = "cmkIDOld" CmkIDNewKey = "cmkIDNew" ResourceKey = "resource" ActionKey = "action" )
const UNSPECIFIED = "UNSPECIFIED"
Variables ¶
This section is empty.
Functions ¶
func NewAccessGrantedEvent ¶ added in v1.20.0
func NewCmkAvailableEvent ¶ added in v1.5.0
func NewCmkAvailableEvent(metadata EventMetadata, cmkID string) (plog.Logs, error)
func NewCmkCreateEvent ¶ added in v0.2.2
func NewCmkCreateEvent(metadata EventMetadata, cmkID string) (plog.Logs, error)
func NewCmkDeleteEvent ¶ added in v0.3.0
func NewCmkDeleteEvent(metadata EventMetadata, cmkID string) (plog.Logs, error)
func NewCmkDetachEvent ¶ added in v1.7.0
func NewCmkDetachEvent(metadata EventMetadata, cmkID string) (plog.Logs, error)
func NewCmkDisableEvent ¶ added in v0.2.2
func NewCmkDisableEvent(metadata EventMetadata, cmkID string) (plog.Logs, error)
func NewCmkEnableEvent ¶ added in v0.2.2
func NewCmkEnableEvent(metadata EventMetadata, cmkID string) (plog.Logs, error)
func NewCmkOffboardingEvent ¶ added in v0.2.2
func NewCmkOffboardingEvent(metadata EventMetadata, cmkID, systemID string) (plog.Logs, error)
func NewCmkOnboardingEvent ¶ added in v0.2.2
func NewCmkOnboardingEvent(metadata EventMetadata, cmkID, systemID string) (plog.Logs, error)
func NewCmkRestoreEvent ¶ added in v0.2.2
func NewCmkRestoreEvent(metadata EventMetadata, cmkID string) (plog.Logs, error)
func NewCmkRotateEvent ¶ added in v0.2.2
func NewCmkRotateEvent(metadata EventMetadata, cmkID string) (plog.Logs, error)
func NewCmkSwitchEvent ¶ added in v0.2.2
func NewCmkSwitchEvent(metadata EventMetadata, systemID, cmkIDOld, cmkIDNew string) (plog.Logs, error)
func NewCmkTenantDeleteEvent ¶ added in v1.7.0
func NewCmkTenantDeleteEvent(metadata EventMetadata, cmkID string) (plog.Logs, error)
func NewCmkTenantModificationEvent ¶ added in v0.2.2
func NewCmkUnavailableEvent ¶ added in v1.5.0
func NewCmkUnavailableEvent(metadata EventMetadata, cmkID string) (plog.Logs, error)
func NewCredentialCreateEvent ¶
func NewCredentialCreateEvent(metadata EventMetadata, credentialID string, c CredentialType) (plog.Logs, error)
func NewCredentialDeleteEvent ¶
func NewCredentialDeleteEvent(metadata EventMetadata, credentialID string, c CredentialType) (plog.Logs, error)
func NewCredentialExpirationEvent ¶
func NewCredentialExpirationEvent(metadata EventMetadata, credentialID string, c CredentialType) (plog.Logs, error)
func NewCredentialRevokationEvent ¶
func NewCredentialRevokationEvent(metadata EventMetadata, credentialID string, c CredentialType) (plog.Logs, error)
func NewGroupCreateEvent ¶
func NewGroupDeleteEvent ¶
func NewGroupReadEvent ¶
func NewGroupUpdateEvent ¶
func NewKeyCreateEvent ¶
func NewKeyDeleteEvent ¶
func NewKeyDisableEvent ¶ added in v0.2.2
func NewKeyEnableEvent ¶ added in v0.2.2
func NewKeyPurgeEvent ¶ added in v0.2.2
func NewKeyRestoreEvent ¶ added in v0.2.2
func NewKeyRotateEvent ¶ added in v0.2.2
func NewTenantOffboardingEvent ¶
func NewTenantOffboardingEvent(metadata EventMetadata, tenantID string) (plog.Logs, error)
func NewTenantOnboardingEvent ¶
func NewTenantOnboardingEvent(metadata EventMetadata, tenantID string) (plog.Logs, error)
func NewTenantUpdateEvent ¶
func NewUnauthenticatedRequestEvent ¶ added in v0.5.0
func NewUnauthenticatedRequestEvent(metadata EventMetadata) (plog.Logs, error)
func NewUnauthorizedRequestEvent ¶ added in v0.5.0
func NewUnauthorizedRequestEvent(metadata EventMetadata, resource, action string) (plog.Logs, error)
func NewUserLoginFailureEvent ¶
func NewUserLoginFailureEvent(metadata EventMetadata, objectID string, l LoginMethod, f FailReason, value any) (plog.Logs, error)
func NewUserLoginSuccessEvent ¶
func NewUserLoginSuccessEvent(metadata EventMetadata, objectID string, l LoginMethod, t MfaType, u UserType, value any) (plog.Logs, error)
func NewWorkflowExecuteEvent ¶
func NewWorkflowStartEvent ¶
func NewWorkflowUpdateEvent ¶
Types ¶
type AuditLogger ¶ added in v0.2.2
type AuditLogger struct {
// contains filtered or unexported fields
}
type CredentialType ¶
type CredentialType string
const ( CREDTYPE_X509CERT CredentialType = "X509_CERTIFICATE" CREDTYPE_KEY CredentialType = "KEY" CREDTYPE_SECRET CredentialType = "SECRET" )
func (CredentialType) IsValid ¶
func (c CredentialType) IsValid() bool
type EventMetadata ¶
func NewEventMetadata ¶
func NewEventMetadata(userInitiatorID, tenantID, eventCorrelationID string) (EventMetadata, error)
type FailReason ¶
type FailReason string
const ( FAILREASON_PASSWORD FailReason = "PASSWORD" FAILREASON_MFAFAIL FailReason = "MFA_FAILED" FAILREASON_USERNOTFOUND FailReason = "USER_NOT_FOUND" FAILREASON_USERLOCKED FailReason = "USER_LOCKED" FAILREASON_USERBLOCKED FailReason = "USER_BLOCKED" FAILREASON_USERUNVERIFIED FailReason = "USER_UNVERIFIED" FAILREASON_USEREXPIRED FailReason = "USER_EXPIRED" FAILREASON_USERINVALID FailReason = "USER_INVALID" FAILREASON_INSECURECONNECT FailReason = "INSECURE_CONNECTION" FAILREASON_METHODDISABLED FailReason = "LOGIN_METHOD_DISABLED" FAILREASON_TOKENEXPIRED FailReason = "TOKEN_EXPIRED" FAILREASON_TOKENREVOKED FailReason = "TOKEN_REVOKED" FAILREASON_TOKENINVALID FailReason = "TOKEN_INVALID" FAILREASON_SESSIONEXPIRED FailReason = "SESSION_EXPIRED" FAILREASON_SESSIONREVOKED FailReason = "SESSION_REVOKED" FAILREASON_CERTEXPIRED FailReason = "CERTIFICATE_EXPIRED" FAILREASON_CERTREVOKED FailReason = "CERTIFICATE_REVOKED" FAILREASON_CERTINVALID FailReason = "CERTIFICATE_INVALID" )
func (FailReason) IsValid ¶
func (r FailReason) IsValid() bool
type KeyCreateActionType ¶
type KeyCreateActionType string
type KeyReadActionType ¶
type KeyReadActionType string
type KeyUpdateActionType ¶
type KeyUpdateActionType string
type LoginMethod ¶
type LoginMethod string
const ( LOGINMETHOD_OPENIDCONNECT LoginMethod = "OPEN_ID_CONNECT" LOGINMETHOD_X509CERT LoginMethod = "X509_CERTIFICATE" )
func (LoginMethod) IsValid ¶
func (l LoginMethod) IsValid() bool
type QueuedAuditLogger ¶ added in v1.21.0
type QueuedAuditLogger struct {
// contains filtered or unexported fields
}
QueuedAuditLogger wraps an AuditLogger with a non-blocking, channel-based queue and background delivery. It is safe for concurrent use by multiple goroutines. Create one with NewQueuedLogger and always Close it to drain buffered events.
func NewQueuedLogger ¶ added in v1.21.0
func NewQueuedLogger(sink *AuditLogger, opts QueuedOptions) *QueuedAuditLogger
NewQueuedLogger returns a QueuedAuditLogger delivering events to sink. It starts the configured number of background workers immediately.
func (*QueuedAuditLogger) Close ¶ added in v1.21.0
func (q *QueuedAuditLogger) Close(ctx context.Context) error
Close stops accepting new events, drains events already queued (with retries), and waits for the background workers to finish. It is idempotent. If ctx is cancelled before the queue is drained, in-flight sends and pending backoffs are aborted and ctx's error is returned; otherwise it returns nil.
func (*QueuedAuditLogger) SendEvent ¶ added in v1.21.0
func (q *QueuedAuditLogger) SendEvent(logs plog.Logs) error
SendEvent enqueues logs for background delivery and returns immediately. It never blocks: if the queue is full the event is dropped and errQueueFull is returned. After Close it returns errLoggerClosed.
type QueuedOptions ¶ added in v1.21.0
type QueuedOptions struct {
// QueueSize is the capacity of the buffered event queue. SendEvent drops
// events (returning errQueueFull) once the queue is full. Defaults to 1024.
QueueSize int
// Workers is the number of background goroutines delivering events to the
// underlying logger. Defaults to 1.
Workers int
// MaxRetries is the number of additional delivery attempts after the first
// one fails. Each retry is spaced by an exponential backoff. Once exhausted
// the event is reported to OnError and dropped. Values <= 0 default to 5.
MaxRetries int
// BaseDelay is the first backoff step. Subsequent steps double it up to
// MaxDelay. Defaults to 100ms.
BaseDelay time.Duration
// MaxDelay caps the backoff step. Defaults to 30s.
MaxDelay time.Duration
// OnError receives errors from background delivery, which cannot be returned
// to a caller: events dropped because the queue was full are not routed here
// (SendEvent returns errQueueFull directly), but events dropped after
// exhausting all retries are. When nil such errors are dropped silently;
// supply a handler (e.g. logging) to observe them.
OnError func(error)
}
QueuedOptions configures a QueuedAuditLogger. The zero value is valid and uses the defaults documented on each field.
type TenantUpdateActionType ¶
type TenantUpdateActionType string
const ( TENANTUPDATE_TESTMODE TenantUpdateActionType = "TEST_MODE" TENANTUPDATE_WORKFLOWENABLE TenantUpdateActionType = "WORKFLOW_ENABLE" TENANTUPDATE_WORKFLOWDISABLE TenantUpdateActionType = "WORKFLOW_DISABLE" )
func (TenantUpdateActionType) IsValid ¶
func (t TenantUpdateActionType) IsValid() bool
type UserLoginFailureActionType ¶
type UserLoginFailureActionType string