Add log export for audit logs and SCIM events
Route audit-log and SCIM-event exports through export_jobs with typed arguments, an iam BuildAndUploadExport/SendExportEmail implementation, and a concurrent export-job worker with stale recovery. Stream JSONL via page.WalkAll into S3, and expose the request flow on console, connect, MCP, and CLI. Co-authored-by: Bryan Frimin <bryan@getprobo.com> Signed-off-by: Sacha Al Himdani <sacha@probo.com>
This commit is contained in:
@@ -499,3 +499,24 @@ func NewConnectorNotFoundError(connectorID gid.GID) error {
|
||||
func (e ErrConnectorNotFound) Error() string {
|
||||
return fmt.Sprintf("connector %q not found", e.ConnectorID)
|
||||
}
|
||||
|
||||
type ErrInvalidLogExportTimeRange struct{ message string }
|
||||
|
||||
const maxLogExportTimeRangeYears = 1
|
||||
|
||||
func NewInvalidLogExportTimeRangeError() error {
|
||||
return &ErrInvalidLogExportTimeRange{message: "from_time must be before to_time"}
|
||||
}
|
||||
|
||||
func NewLogExportTimeRangeTooLargeError() error {
|
||||
return &ErrInvalidLogExportTimeRange{
|
||||
message: fmt.Sprintf(
|
||||
"export time range must not exceed %d year",
|
||||
maxLogExportTimeRangeYears,
|
||||
),
|
||||
}
|
||||
}
|
||||
|
||||
func (e ErrInvalidLogExportTimeRange) Error() string {
|
||||
return e.message
|
||||
}
|
||||
|
||||
@@ -106,4 +106,8 @@ const (
|
||||
// Audit log entry actions
|
||||
ActionAuditLogEntryGet = "iam:audit-log-entry:get"
|
||||
ActionAuditLogEntryList = "iam:audit-log-entry:list"
|
||||
|
||||
// Log export actions
|
||||
ActionAuditLogExport = "iam:audit-log:export"
|
||||
ActionSCIMEventExport = "iam:scim-event:export"
|
||||
)
|
||||
|
||||
@@ -242,6 +242,7 @@ var IAMOwnerPolicy = policy.NewPolicy(
|
||||
policy.Allow(
|
||||
ActionAuditLogEntryGet,
|
||||
ActionAuditLogEntryList,
|
||||
ActionAuditLogExport,
|
||||
).
|
||||
WithSID("audit-log-entry-access").
|
||||
When(policy.Equals("principal.organization_id", "resource.organization_id")),
|
||||
@@ -360,15 +361,21 @@ var IAMAdminPolicy = policy.NewPolicy(
|
||||
).
|
||||
WithSID("deny-scim-management"),
|
||||
|
||||
// Can view audit log entries (scoped to own organization)
|
||||
// Can view and export audit log entries (scoped to own organization)
|
||||
policy.Allow(
|
||||
ActionAuditLogEntryGet,
|
||||
ActionAuditLogEntryList,
|
||||
ActionAuditLogExport,
|
||||
).
|
||||
WithSID("audit-log-entry-admin-access").
|
||||
When(
|
||||
policy.Equals("principal.organization_id", "resource.organization_id"),
|
||||
),
|
||||
|
||||
// Can export SCIM events (scoped to own organization)
|
||||
policy.Allow(ActionSCIMEventExport).
|
||||
WithSID("scim-event-export-admin-access").
|
||||
When(policy.Equals("principal.organization_id", "resource.organization_id")),
|
||||
).
|
||||
WithDescription("IAM admin access - can manage members but cannot delete organization or manage SAML/SCIM")
|
||||
|
||||
|
||||
329
pkg/iam/log_export_service.go
Normal file
329
pkg/iam/log_export_service.go
Normal file
@@ -0,0 +1,329 @@
|
||||
// Copyright (c) 2026 Probo Inc <hello@probo.com>.
|
||||
//
|
||||
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
// of this software and associated documentation files (the "Software"), to deal
|
||||
// in the Software without restriction, including without limitation the rights
|
||||
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
// copies of the Software, and to permit persons to whom the Software is
|
||||
// furnished to do so, subject to the following conditions:
|
||||
//
|
||||
// The above copyright notice and this permission notice shall be included in
|
||||
// all copies or substantial portions of the Software.
|
||||
//
|
||||
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
||||
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
||||
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
||||
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
||||
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
||||
// SOFTWARE.
|
||||
|
||||
package iam
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"fmt"
|
||||
"io"
|
||||
"strings"
|
||||
"time"
|
||||
|
||||
"go.gearno.de/crypto/uuid"
|
||||
"go.gearno.de/kit/pg"
|
||||
"go.probo.inc/probo/packages/emails"
|
||||
"go.probo.inc/probo/pkg/coredata"
|
||||
"go.probo.inc/probo/pkg/filemanager"
|
||||
"go.probo.inc/probo/pkg/gid"
|
||||
"go.probo.inc/probo/pkg/mail"
|
||||
"go.probo.inc/probo/pkg/page"
|
||||
)
|
||||
|
||||
type LogExportService struct {
|
||||
pg *pg.Client
|
||||
fm *filemanager.Service
|
||||
bucket string
|
||||
baseURL string
|
||||
}
|
||||
|
||||
func NewLogExportService(
|
||||
pgClient *pg.Client,
|
||||
fm *filemanager.Service,
|
||||
bucket string,
|
||||
baseURL string,
|
||||
) *LogExportService {
|
||||
return &LogExportService{
|
||||
pg: pgClient,
|
||||
fm: fm,
|
||||
bucket: bucket,
|
||||
baseURL: baseURL,
|
||||
}
|
||||
}
|
||||
|
||||
func (s *LogExportService) BuildAndUploadExport(
|
||||
ctx context.Context,
|
||||
scope coredata.Scoper,
|
||||
exportJobID gid.GID,
|
||||
) (*coredata.ExportJob, error) {
|
||||
exportJob := &coredata.ExportJob{}
|
||||
|
||||
if err := s.pg.WithConn(
|
||||
ctx,
|
||||
func(ctx context.Context, conn pg.Querier) error {
|
||||
return exportJob.LoadByID(ctx, conn, scope, exportJobID)
|
||||
},
|
||||
); err != nil {
|
||||
return nil, fmt.Errorf("cannot load export job: %w", err)
|
||||
}
|
||||
|
||||
args, err := exportJob.GetLogExportArguments()
|
||||
if err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
typeName := "audit-log"
|
||||
if exportJob.Type == coredata.ExportJobTypeSCIMEvent {
|
||||
typeName = "scim-event"
|
||||
}
|
||||
|
||||
now := time.Now()
|
||||
fileKey := uuid.MustNewV4().String()
|
||||
fileName := fmt.Sprintf(
|
||||
"%s-export-%s-to-%s.jsonl",
|
||||
typeName,
|
||||
args.FromTime.Format("2006-01-02"),
|
||||
args.ToTime.Format("2006-01-02"),
|
||||
)
|
||||
|
||||
file := coredata.File{
|
||||
ID: gid.New(exportJob.ID.TenantID(), coredata.FileEntityType),
|
||||
OrganizationID: exportJob.OrganizationID,
|
||||
BucketName: s.bucket,
|
||||
MimeType: "application/octet-stream",
|
||||
FileName: fileName,
|
||||
FileKey: fileKey,
|
||||
Visibility: coredata.FileVisibilityPrivate,
|
||||
CreatedAt: now,
|
||||
UpdatedAt: now,
|
||||
}
|
||||
|
||||
pr, pw := io.Pipe()
|
||||
|
||||
var uploadErr error
|
||||
|
||||
var fileSize int64
|
||||
|
||||
uploadDone := make(chan struct{})
|
||||
|
||||
go func() {
|
||||
defer close(uploadDone)
|
||||
|
||||
fileSize, uploadErr = s.fm.PutFile(
|
||||
ctx,
|
||||
&file,
|
||||
pr,
|
||||
map[string]string{
|
||||
"type": typeName + "-export",
|
||||
"export-job-id": exportJob.ID.String(),
|
||||
"organization-id": exportJob.OrganizationID.String(),
|
||||
},
|
||||
filemanager.WithAttachmentContentDisposition(),
|
||||
)
|
||||
_ = pr.CloseWithError(uploadErr)
|
||||
}()
|
||||
|
||||
writeErr := s.streamJSONL(ctx, exportJob, args, scope, pw)
|
||||
if writeErr != nil {
|
||||
_ = pw.CloseWithError(writeErr)
|
||||
} else {
|
||||
_ = pw.Close()
|
||||
}
|
||||
|
||||
<-uploadDone
|
||||
|
||||
if writeErr != nil {
|
||||
return nil, fmt.Errorf("cannot write JSONL: %w", writeErr)
|
||||
}
|
||||
|
||||
if uploadErr != nil {
|
||||
return nil, fmt.Errorf("cannot upload file to S3: %w", uploadErr)
|
||||
}
|
||||
|
||||
file.FileSize = fileSize
|
||||
|
||||
if err := s.pg.WithTx(
|
||||
ctx,
|
||||
func(ctx context.Context, tx pg.Tx) error {
|
||||
if err := file.Insert(ctx, tx, scope); err != nil {
|
||||
return fmt.Errorf("cannot insert file: %w", err)
|
||||
}
|
||||
|
||||
exportJob.FileID = &file.ID
|
||||
if err := exportJob.Update(ctx, tx, scope); err != nil {
|
||||
return fmt.Errorf("cannot update export job: %w", err)
|
||||
}
|
||||
|
||||
return nil
|
||||
},
|
||||
); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return exportJob, nil
|
||||
}
|
||||
|
||||
func (s *LogExportService) SendExportEmail(
|
||||
ctx context.Context,
|
||||
scope coredata.Scoper,
|
||||
fileID gid.GID,
|
||||
recipientName string,
|
||||
recipientEmail mail.Addr,
|
||||
) error {
|
||||
return s.pg.WithTx(
|
||||
ctx,
|
||||
func(ctx context.Context, tx pg.Tx) error {
|
||||
file := &coredata.File{}
|
||||
if err := file.LoadByID(ctx, tx, scope, fileID); err != nil {
|
||||
return fmt.Errorf("cannot load file: %w", err)
|
||||
}
|
||||
|
||||
downloadURL := s.fm.GenerateFileURL(file)
|
||||
|
||||
emailPresenter := emails.NewPresenter(s.baseURL, recipientName)
|
||||
|
||||
isSCIMEvent := strings.HasPrefix(file.FileName, "scim-event-export")
|
||||
|
||||
subject, textBody, htmlBody, err := emailPresenter.RenderLogExport(ctx, downloadURL, isSCIMEvent)
|
||||
if err != nil {
|
||||
return fmt.Errorf("cannot render log export email: %w", err)
|
||||
}
|
||||
|
||||
email := coredata.NewEmail(
|
||||
recipientName,
|
||||
recipientEmail,
|
||||
subject,
|
||||
textBody,
|
||||
htmlBody,
|
||||
nil,
|
||||
)
|
||||
if err := email.Insert(ctx, tx); err != nil {
|
||||
return fmt.Errorf("cannot insert email: %w", err)
|
||||
}
|
||||
|
||||
return nil
|
||||
},
|
||||
)
|
||||
}
|
||||
|
||||
func (s *LogExportService) streamJSONL(
|
||||
ctx context.Context,
|
||||
exportJob *coredata.ExportJob,
|
||||
args *coredata.LogExportArguments,
|
||||
scope coredata.Scoper,
|
||||
pw io.Writer,
|
||||
) error {
|
||||
return s.pg.WithConn(
|
||||
ctx,
|
||||
func(ctx context.Context, conn pg.Querier) error {
|
||||
enc := json.NewEncoder(pw)
|
||||
|
||||
switch exportJob.Type {
|
||||
case coredata.ExportJobTypeAuditLog:
|
||||
return s.streamAuditLogEntries(ctx, conn, scope, exportJob.OrganizationID, args, enc)
|
||||
case coredata.ExportJobTypeSCIMEvent:
|
||||
return s.streamSCIMEvents(ctx, conn, scope, exportJob.OrganizationID, args, enc)
|
||||
default:
|
||||
return fmt.Errorf("unsupported log export type: %q", exportJob.Type)
|
||||
}
|
||||
},
|
||||
)
|
||||
}
|
||||
|
||||
func (s *LogExportService) streamAuditLogEntries(
|
||||
ctx context.Context,
|
||||
conn pg.Querier,
|
||||
scope coredata.Scoper,
|
||||
organizationID gid.GID,
|
||||
args *coredata.LogExportArguments,
|
||||
enc *json.Encoder,
|
||||
) error {
|
||||
filter := coredata.NewAuditLogEntryFilter().
|
||||
WithCreatedAtGte(args.FromTime).
|
||||
WithCreatedAtLt(args.ToTime)
|
||||
|
||||
return page.WalkAll(
|
||||
ctx,
|
||||
page.OrderBy[coredata.AuditLogEntryOrderField]{
|
||||
Field: coredata.AuditLogEntryOrderFieldCreatedAt,
|
||||
Direction: page.OrderDirectionAsc,
|
||||
},
|
||||
func(ctx context.Context, cursor *page.Cursor[coredata.AuditLogEntryOrderField]) ([]*coredata.AuditLogEntry, error) {
|
||||
var batch coredata.AuditLogEntries
|
||||
if err := batch.LoadByOrganizationID(
|
||||
ctx,
|
||||
conn,
|
||||
scope,
|
||||
organizationID,
|
||||
cursor,
|
||||
filter,
|
||||
); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return batch, nil
|
||||
},
|
||||
func(entries []*coredata.AuditLogEntry) error {
|
||||
for _, entry := range entries {
|
||||
if err := enc.Encode(entry); err != nil {
|
||||
return fmt.Errorf("cannot encode audit log entry: %w", err)
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
},
|
||||
)
|
||||
}
|
||||
|
||||
func (s *LogExportService) streamSCIMEvents(
|
||||
ctx context.Context,
|
||||
conn pg.Querier,
|
||||
scope coredata.Scoper,
|
||||
organizationID gid.GID,
|
||||
args *coredata.LogExportArguments,
|
||||
enc *json.Encoder,
|
||||
) error {
|
||||
filter := coredata.NewSCIMEventFilter().
|
||||
WithCreatedAtGte(args.FromTime).
|
||||
WithCreatedAtLt(args.ToTime)
|
||||
|
||||
return page.WalkAll(
|
||||
ctx,
|
||||
page.OrderBy[coredata.SCIMEventOrderField]{
|
||||
Field: coredata.SCIMEventOrderFieldCreatedAt,
|
||||
Direction: page.OrderDirectionAsc,
|
||||
},
|
||||
func(ctx context.Context, cursor *page.Cursor[coredata.SCIMEventOrderField]) ([]*coredata.SCIMEvent, error) {
|
||||
var batch coredata.SCIMEvents
|
||||
if err := batch.LoadByOrganizationID(
|
||||
ctx,
|
||||
conn,
|
||||
scope,
|
||||
organizationID,
|
||||
cursor,
|
||||
filter,
|
||||
); err != nil {
|
||||
return nil, err
|
||||
}
|
||||
|
||||
return batch, nil
|
||||
},
|
||||
func(events []*coredata.SCIMEvent) error {
|
||||
for _, event := range events {
|
||||
if err := enc.Encode(event); err != nil {
|
||||
return fmt.Errorf("cannot encode SCIM event: %w", err)
|
||||
}
|
||||
}
|
||||
|
||||
return nil
|
||||
},
|
||||
)
|
||||
}
|
||||
@@ -109,5 +109,7 @@ var IAMOAuth2ScopeMappings = map[coredata.OAuth2Scope][]string{
|
||||
ActionSCIMBridgeUpdate,
|
||||
ActionSCIMBridgeDelete,
|
||||
ActionOAuth2ConsentApprove,
|
||||
ActionAuditLogExport,
|
||||
ActionSCIMEventExport,
|
||||
},
|
||||
}
|
||||
|
||||
@@ -22,6 +22,7 @@ package iam
|
||||
|
||||
import (
|
||||
"context"
|
||||
"encoding/json"
|
||||
"errors"
|
||||
"fmt"
|
||||
"io"
|
||||
@@ -1565,7 +1566,14 @@ func (s OrganizationService) ListSCIMEvents(
|
||||
err := s.pg.WithConn(
|
||||
ctx,
|
||||
func(ctx context.Context, conn pg.Querier) error {
|
||||
err := scimEvents.LoadByOrganizationID(ctx, conn, scope, organizationID, cursor)
|
||||
err := scimEvents.LoadByOrganizationID(
|
||||
ctx,
|
||||
conn,
|
||||
scope,
|
||||
organizationID,
|
||||
cursor,
|
||||
coredata.NewSCIMEventFilter(),
|
||||
)
|
||||
if err != nil {
|
||||
return fmt.Errorf("cannot load scim events: %w", err)
|
||||
}
|
||||
@@ -2353,7 +2361,7 @@ func (s *OrganizationService) ListAuditLogEntries(
|
||||
err := s.pg.WithConn(
|
||||
ctx,
|
||||
func(ctx context.Context, conn pg.Querier) error {
|
||||
if err := entries.LoadAllByOrganizationID(ctx, conn, scope, organizationID, cursor, filter); err != nil {
|
||||
if err := entries.LoadByOrganizationID(ctx, conn, scope, organizationID, cursor, filter); err != nil {
|
||||
return fmt.Errorf("cannot load audit log entries: %w", err)
|
||||
}
|
||||
|
||||
@@ -2393,3 +2401,71 @@ func (s *OrganizationService) CountAuditLogEntries(
|
||||
|
||||
return count, err
|
||||
}
|
||||
|
||||
type RequestLogExportRequest struct {
|
||||
OrganizationID gid.GID
|
||||
Type coredata.ExportJobType
|
||||
FromTime time.Time
|
||||
ToTime time.Time
|
||||
RecipientEmail mail.Addr
|
||||
RecipientName string
|
||||
}
|
||||
|
||||
func (s *OrganizationService) RequestLogExport(
|
||||
ctx context.Context,
|
||||
scope coredata.Scoper,
|
||||
req RequestLogExportRequest,
|
||||
) (*coredata.ExportJob, error) {
|
||||
if !req.FromTime.Before(req.ToTime) {
|
||||
return nil, NewInvalidLogExportTimeRangeError()
|
||||
}
|
||||
|
||||
if req.ToTime.After(req.FromTime.AddDate(maxLogExportTimeRangeYears, 0, 0)) {
|
||||
return nil, NewLogExportTimeRangeTooLargeError()
|
||||
}
|
||||
|
||||
switch req.Type {
|
||||
case coredata.ExportJobTypeAuditLog, coredata.ExportJobTypeSCIMEvent:
|
||||
default:
|
||||
return nil, fmt.Errorf("unsupported log export type: %q", req.Type)
|
||||
}
|
||||
|
||||
arguments, err := json.Marshal(coredata.LogExportArguments{
|
||||
FromTime: req.FromTime,
|
||||
ToTime: req.ToTime,
|
||||
})
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("cannot marshal log export arguments: %w", err)
|
||||
}
|
||||
|
||||
exportJob := &coredata.ExportJob{}
|
||||
|
||||
err = s.pg.WithTx(
|
||||
ctx,
|
||||
func(ctx context.Context, tx pg.Tx) error {
|
||||
now := time.Now()
|
||||
|
||||
exportJob = &coredata.ExportJob{
|
||||
ID: gid.New(scope.GetTenantID(), coredata.ExportJobEntityType),
|
||||
OrganizationID: req.OrganizationID,
|
||||
Type: req.Type,
|
||||
Arguments: arguments,
|
||||
Status: coredata.ExportJobStatusPending,
|
||||
RecipientEmail: req.RecipientEmail,
|
||||
RecipientName: req.RecipientName,
|
||||
CreatedAt: now,
|
||||
}
|
||||
|
||||
if err := exportJob.Insert(ctx, tx, scope); err != nil {
|
||||
return fmt.Errorf("cannot insert export job: %w", err)
|
||||
}
|
||||
|
||||
return nil
|
||||
},
|
||||
)
|
||||
if err != nil {
|
||||
return nil, fmt.Errorf("cannot request log export: %w", err)
|
||||
}
|
||||
|
||||
return exportJob, nil
|
||||
}
|
||||
|
||||
@@ -82,6 +82,7 @@ type (
|
||||
OAuth2ScopeRegistry *oauth2scope.Registry
|
||||
|
||||
samlDomainVerifier *SAMLDomainVerifier
|
||||
LogExports *LogExportService
|
||||
}
|
||||
|
||||
Config struct {
|
||||
@@ -241,6 +242,13 @@ func NewService(
|
||||
cfg.DomainVerificationResolverAddr,
|
||||
)
|
||||
|
||||
svc.LogExports = NewLogExportService(
|
||||
pgClient,
|
||||
fm,
|
||||
cfg.Bucket,
|
||||
cfg.BaseURL.String(),
|
||||
)
|
||||
|
||||
return svc, nil
|
||||
}
|
||||
|
||||
|
||||
Reference in New Issue
Block a user