@stackonward/cli 0.0.1 → 1.0.0

package/dist/resources/templates/go-backend/internal/core/audit/dto.go

@@ -0,0 +1,468 @@
+package audit
+
+import (
+	"encoding/json"
+	"sort"
+	"strings"
+	"time"
+
+	"gorm.io/datatypes"
+
+	"{{module}}/internal/common/types"
+)
+
+const (
+	// operationEnvelopeMaxBytes 对齐 sys_operation_logs JSONB 证据字段的写入上限。
+	operationEnvelopeMaxBytes = 4096
+	// operationRecordStatusStarted 表示控制面操作已在业务处理前落库。
+	operationRecordStatusStarted = "started"
+	// operationRecordStatusCompleted 表示控制面操作已完成并写入响应与授权裁决。
+	operationRecordStatusCompleted = "completed"
+)
+
+// AccessEntry L1 中间件产生的访问日志条目（Service 输入）
+type AccessEntry struct {
+	// 分布式追踪 ID
+	TraceID string
+	// HTTP 请求唯一 ID
+	RequestID string
+	// 操作者类型
+	ActorType ActorType
+	// 操作者业务用户 ID（来自认证上下文，对应 p_user_users.id）
+	ActorID types.UserID
+	// 认证主体类型
+	AuthSubjectType string
+	// IAM 主体 ID
+	IAMPrincipalID int64
+	// 凭证公开 ID
+	CredentialPublicID string
+	// Token 指纹
+	TokenFingerprint string
+	// 认证机制
+	AuthMechanism string
+	// 客户端 IP 地址
+	ActorIP string
+	// 客户端 User-Agent
+	ActorUserAgent string
+	// HTTP 方法
+	HTTPMethod string
+	// 请求路径
+	HTTPPath string
+	// HTTP 状态码
+	HTTPStatus int16
+	// 所属产品标识
+	ProductCode string
+	// 资源类型
+	ResourceType string
+	// 资源 ID
+	ResourceID string
+	// 请求是否成功
+	IsSuccess bool
+	// 失败原因
+	ErrorMessage string
+	// 请求处理耗时（毫秒）
+	DurationMS int32
+}
+
+// AuditEntry L2/L3 产生的审计日志条目（Service 输入）
+type AuditEntry struct {
+	// 领域事件唯一标识；非事件型 L3 审计为空
+	EventID string
+	// 领域事件发生时间；事件重投时保持不变以构成幂等键
+	OccurredAt time.Time
+	// 分布式追踪 ID
+	TraceID string
+	// 关联的 HTTP 请求 ID
+	RequestID string
+	// 操作者类型
+	ActorType ActorType
+	// 操作者业务用户 ID（来自认证上下文，对应 p_user_users.id）
+	ActorID types.UserID
+	// 认证主体类型
+	AuthSubjectType string
+	// IAM 主体 ID
+	IAMPrincipalID int64
+	// 凭证公开 ID
+	CredentialPublicID string
+	// Token 指纹
+	TokenFingerprint string
+	// 认证机制
+	AuthMechanism string
+	// 客户端 IP 地址
+	ActorIP string
+	// 客户端 User-Agent
+	ActorUserAgent string
+	// 操作动作
+	Action AuditAction
+	// 业务分类
+	Category AuditCategory
+	// 风险级别
+	RiskLevel RiskLevel
+	// 资源类型
+	ResourceType string
+	// 资源 ID
+	ResourceID string
+	// 所属产品标识
+	ProductCode string
+	// 所属租户 ID
+	TenantID string
+	// 数据变更前后快照
+	Changes *ChangesPayload
+	// 扩展上下文信息
+	Metadata *MetadataPayload
+	// 操作是否成功
+	IsSuccess bool
+	// 失败原因
+	ErrorMessage string
+}
+
+// LoginEntry L2 认证事件产生的登录日志条目（Service 输入）
+type LoginEntry struct {
+	// 认证身份 ID（对应 p_identity_identities.id）
+	IdentityID types.IdentityID
+	// 操作者类型
+	ActorType ActorType
+	// 客户端 IP 地址
+	ActorIP string
+	// 客户端 User-Agent
+	ActorUserAgent string
+	// 认证动作
+	LoginAction LoginAction
+	// 登录方式
+	LoginMethod LoginMethod
+	// 操作是否成功
+	IsSuccess bool
+	// 失败原因
+	FailureReason string
+	// 登录的目标产品
+	ProductCode string
+	// 会话 ID
+	SessionID string
+	// 关联的 HTTP 请求 ID
+	RequestID string
+	// 设备类型
+	DeviceType string
+	// 设备指纹哈希
+	DeviceFingerprint string
+	// 操作系统
+	OSName string
+	// 浏览器
+	BrowserName string
+	// 国家代码
+	GeoCountry string
+	// 城市
+	GeoCity string
+}
+
+// BeginOperationEntry 管理端操作开始记录（业务处理器执行前同步写入）
+type BeginOperationEntry struct {
+	// 分布式追踪 ID
+	TraceID string
+	// HTTP 请求唯一 ID
+	RequestID string
+	// 操作者类型
+	ActorType ActorType
+	// 操作者业务用户 ID
+	ActorID types.UserID
+	// 认证主体类型
+	AuthSubjectType string
+	// IAM 主体 ID
+	IAMPrincipalID int64
+	// 凭证公开 ID
+	CredentialPublicID string
+	// Token 指纹
+	TokenFingerprint string
+	// 认证机制
+	AuthMechanism string
+	// 客户端 IP 地址
+	ActorIP string
+	// 客户端 User-Agent
+	ActorUserAgent string
+	// 操作动作
+	OperationAction AuditAction
+	// 操作分类
+	OperationCategory AuditCategory
+	// 风险级别
+	RiskLevel RiskLevel
+	// 来源模块
+	SourceModule string
+	// HTTP 方法
+	HTTPMethod string
+	// 请求路径
+	HTTPPath string
+	// 所属产品标识
+	ProductCode string
+	// 所属租户 ID
+	TenantID string
+	// 资源类型
+	ResourceType string
+	// 资源 ID
+	ResourceID string
+	// 请求证据上下文
+	RequestContext datatypes.JSON
+	// 操作元数据
+	OperationMetadata datatypes.JSON
+}
+
+// CompleteOperationEntry 管理端操作完成记录（业务处理器执行后同步更新）
+type CompleteOperationEntry struct {
+	// HTTP 请求唯一 ID
+	RequestID string
+	// IAM 主体 ID
+	IAMPrincipalID int64
+	// IAM 动作
+	IAMAction string
+	// IAM 资源
+	IAMResource string
+	// 授权是否允许
+	DecisionAllowed bool
+	// 授权原因码
+	DecisionReasonCode string
+	// 授权原因类别
+	DecisionReasonKind string
+	// HTTP 状态码
+	HTTPStatus int16
+	// 请求处理耗时（毫秒）
+	DurationMS int32
+	// 请求是否成功
+	IsSuccess bool
+	// 失败原因
+	ErrorMessage string
+	// 响应证据上下文
+	ResponseContext datatypes.JSON
+	// 策略裁决上下文
+	PolicyViolation datatypes.JSON
+}
+
+// OperationRequestEnvelopeInput 请求证据上下文输入。
+type OperationRequestEnvelopeInput struct {
+	// 路由模板
+	RouteTemplate string
+	// 查询参数名集合
+	QueryKeyNames []string
+	// 路由参数名集合
+	RouteParamNames []string
+	// Content-Type
+	ContentType string
+	// 产品标识
+	ProductCode string
+	// 租户 ID
+	TenantID string
+}
+
+// OperationResponseEnvelopeInput 响应证据上下文输入。
+type OperationResponseEnvelopeInput struct {
+	// HTTP 状态码
+	Status int
+	// 错误码
+	ErrorCode string
+	// 错误类型
+	ErrorType string
+	// 错误数量
+	ErrorCount int
+	// 校验字段数量
+	ValidationFieldCount int
+	// 响应大小分级
+	ResponseSizeClass string
+}
+
+// OperationMetadataEnvelopeInput 操作元数据输入。
+type OperationMetadataEnvelopeInput struct {
+	// 来源模块
+	SourceModule string
+	// 路由名称
+	RouteName string
+	// 处理器名称
+	Handler string
+	// 菜单键
+	MenuKey string
+	// 资源提示
+	ResourceHint string
+	// 关联请求 ID
+	RelatedRequestID string
+}
+
+// OperationPolicyEnvelopeInput 授权裁决证据输入。
+type OperationPolicyEnvelopeInput struct {
+	// IAM 动作
+	IAMAction string
+	// IAM 资源
+	IAMResource string
+	// 是否允许
+	Allowed bool
+	// 原因码
+	ReasonCode string
+	// 原因类别
+	ReasonKind string
+	// 数据范围摘要
+	ScopeConstraintSummary string
+}
+
+// BuildOperationRequestContext 构建请求证据上下文，只保留白名单字段。
+func BuildOperationRequestContext(input OperationRequestEnvelopeInput) datatypes.JSON {
+	queryKeys := uniqueSortedStrings(input.QueryKeyNames)
+	routeParamNames := uniqueSortedStrings(input.RouteParamNames)
+	return buildBoundedOperationEnvelope([]operationEnvelopeField{
+		{Key: "route_template", Value: strings.TrimSpace(input.RouteTemplate)},
+		{Key: "query_key_names", Value: queryKeys, Optional: true},
+		{Key: "route_param_names", Value: routeParamNames, Optional: true},
+		{Key: "content_type", Value: strings.TrimSpace(input.ContentType), Optional: true},
+		{Key: "product_code", Value: strings.TrimSpace(input.ProductCode), Optional: true},
+		{Key: "tenant_id", Value: strings.TrimSpace(input.TenantID), Optional: true},
+	}, []string{"route_param_names", "query_key_names", "content_type", "tenant_id", "product_code"})
+}
+
+// BuildOperationResponseContext 构建响应证据上下文，不读取响应正文。
+func BuildOperationResponseContext(input OperationResponseEnvelopeInput) datatypes.JSON {
+	return buildBoundedOperationEnvelope([]operationEnvelopeField{
+		{Key: "status", Value: input.Status},
+		{Key: "error_code", Value: strings.TrimSpace(input.ErrorCode), Optional: true},
+		{Key: "error_type", Value: strings.TrimSpace(input.ErrorType), Optional: true},
+		{Key: "error_count", Value: input.ErrorCount, Optional: true},
+		{Key: "validation_field_count", Value: input.ValidationFieldCount, Optional: true},
+		{Key: "response_size_class", Value: strings.TrimSpace(input.ResponseSizeClass), Optional: true},
+	}, []string{"validation_field_count", "response_size_class", "error_count", "error_type", "error_code"})
+}
+
+// BuildOperationMetadata 构建操作元数据，只承载路由与模块安全标识。
+func BuildOperationMetadata(input OperationMetadataEnvelopeInput) datatypes.JSON {
+	return buildBoundedOperationEnvelope([]operationEnvelopeField{
+		{Key: "source_module", Value: strings.TrimSpace(input.SourceModule)},
+		{Key: "route_name", Value: strings.TrimSpace(input.RouteName), Optional: true},
+		{Key: "handler", Value: strings.TrimSpace(input.Handler), Optional: true},
+		{Key: "menu_key", Value: strings.TrimSpace(input.MenuKey), Optional: true},
+		{Key: "resource_hint", Value: strings.TrimSpace(input.ResourceHint), Optional: true},
+		{Key: "related_request_id", Value: strings.TrimSpace(input.RelatedRequestID), Optional: true},
+	}, []string{"related_request_id", "resource_hint", "menu_key", "handler", "route_name"})
+}
+
+// BuildOperationPolicyViolation 构建授权裁决证据，不保存原始策略 JSON。
+func BuildOperationPolicyViolation(input OperationPolicyEnvelopeInput) datatypes.JSON {
+	return buildBoundedOperationEnvelope([]operationEnvelopeField{
+		{Key: "iam_action", Value: strings.TrimSpace(input.IAMAction)},
+		{Key: "iam_resource", Value: strings.TrimSpace(input.IAMResource)},
+		{Key: "allowed", Value: input.Allowed},
+		{Key: "reason_code", Value: strings.TrimSpace(input.ReasonCode), Optional: true},
+		{Key: "reason_kind", Value: strings.TrimSpace(input.ReasonKind), Optional: true},
+		{Key: "scope_constraint_summary", Value: strings.TrimSpace(input.ScopeConstraintSummary), Optional: true},
+	}, []string{"scope_constraint_summary", "reason_kind", "reason_code", "iam_resource", "iam_action"})
+}
+
+type operationEnvelopeField struct {
+	Key string
+	// Value 只承载构建器传入的受控标量、字符串切片或字符串映射。
+	Value    any
+	Optional bool
+}
+
+func buildBoundedOperationEnvelope(fields []operationEnvelopeField, dropOrder []string) datatypes.JSON {
+	values := make(map[string]any, len(fields))
+	optionalKeys := make(map[string]struct{}, len(fields))
+	for _, field := range fields {
+		if field.Key == "" || isEmptyEnvelopeValue(field.Value) {
+			continue
+		}
+		values[field.Key] = field.Value
+		if field.Optional {
+			optionalKeys[field.Key] = struct{}{}
+		}
+	}
+	if len(values) == 0 {
+		return datatypes.JSON([]byte("{}"))
+	}
+
+	for {
+		payload, err := json.Marshal(values)
+		if err != nil {
+			return datatypes.JSON([]byte("{}"))
+		}
+		if len(payload) <= operationEnvelopeMaxBytes {
+			return datatypes.JSON(payload)
+		}
+		removed := false
+		for _, key := range dropOrder {
+			if _, optional := optionalKeys[key]; !optional {
+				continue
+			}
+			if _, exists := values[key]; !exists {
+				continue
+			}
+			delete(values, key)
+			removed = true
+			break
+		}
+		if !removed {
+			return datatypes.JSON([]byte("{}"))
+		}
+	}
+}
+
+func isEmptyEnvelopeValue(value any) bool {
+	switch v := value.(type) {
+	case nil:
+		return true
+	case string:
+		return v == ""
+	case []string:
+		return len(v) == 0
+	case map[string]string:
+		return len(v) == 0
+	case int:
+		return v == 0
+	default:
+		return false
+	}
+}
+
+func uniqueSortedStrings(values []string) []string {
+	if len(values) == 0 {
+		return nil
+	}
+	seen := make(map[string]struct{}, len(values))
+	out := make([]string, 0, len(values))
+	for _, value := range values {
+		item := strings.TrimSpace(value)
+		if item == "" || isSensitiveEnvelopeKey(item) {
+			continue
+		}
+		if _, ok := seen[item]; ok {
+			continue
+		}
+		seen[item] = struct{}{}
+		out = append(out, item)
+	}
+	sort.Strings(out)
+	return out
+}
+
+func isSensitiveEnvelopeKey(key string) bool {
+	normalized := strings.ToLower(strings.TrimSpace(key))
+	for _, token := range []string{"authorization", "cookie", "password", "secret", "token", "credential", "email", "phone"} {
+		if strings.Contains(normalized, token) {
+			return true
+		}
+	}
+	return false
+}
+
+// StatsRequest 统计请求
+type StatsRequest struct {
+	// 开始时间（必填）
+	DateFrom time.Time `form:"date_from" binding:"required" time_format:"2006-01-02T15:04:05Z07:00"`
+	// 结束时间（必填）
+	DateTo time.Time `form:"date_to" binding:"required" time_format:"2006-01-02T15:04:05Z07:00"`
+}
+
+// ExportRequest 导出请求
+type ExportRequest struct {
+	// 开始时间（必填）
+	DateFrom time.Time `json:"date_from" binding:"required"`
+	// 结束时间（必填）
+	DateTo time.Time `json:"date_to" binding:"required"`
+	// 业务分类过滤（可选）
+	Category *string `json:"category" binding:"omitempty,oneof=auth identity user commerce config content storage system"`
+	// 风险级别过滤（可选）
+	RiskLevel *string `json:"risk_level" binding:"omitempty,oneof=critical high medium low"`
+	// 导出格式（默认 csv）
+	Format string `json:"format" binding:"omitempty,oneof=csv json"`
+}

package/dist/resources/templates/go-backend/internal/core/audit/dto_admin.go

@@ -0,0 +1,172 @@
+package audit
+
+import (
+	"strings"
+	"time"
+
+	"{{module}}/internal/common/types"
+)
+
+// AdminListAccessLogsRequest 管理端访问日志查询参数
+type AdminListAccessLogsRequest struct {
+	types.AdminPageParams
+	// 关键词
+	Keyword *string `form:"keyword"`
+	// IAM 主体 ID
+	PrincipalID *int64 `form:"principal_id"`
+	// 操作者 ID
+	ActorID *int64 `form:"actor_id"`
+	// HTTP 方法
+	HTTPMethod *string `form:"http_method"`
+	// HTTP 状态码
+	HTTPStatus *int16 `form:"http_status"`
+	// 产品标识
+	ProductCode *string `form:"product_code"`
+	// 资源类型
+	ResourceType *string `form:"resource_type"`
+	// 资源 ID
+	ResourceID *string `form:"resource_id"`
+	// 是否成功
+	IsSuccess *bool `form:"is_success"`
+	// 开始时间（RFC3339）
+	DateFrom *time.Time `form:"date_from" time_format:"2006-01-02T15:04:05Z07:00"`
+	// 结束时间（RFC3339）
+	DateTo *time.Time `form:"date_to" time_format:"2006-01-02T15:04:05Z07:00"`
+	// 请求 ID
+	RequestID *string `form:"request_id"`
+	// 追踪 ID
+	TraceID *string `form:"trace_id"`
+	// 路径关键词
+	PathKeyword *string `form:"path_keyword"`
+}
+
+// AdminListAuditLogsRequest 管理端审计日志查询参数
+type AdminListAuditLogsRequest struct {
+	types.AdminPageParams
+	// 关键词（事件 ID、资源 ID、追踪 ID、请求 ID）
+	Keyword *string `form:"keyword" binding:"omitempty,max=200"`
+	// IAM 主体 ID
+	PrincipalID *int64 `form:"principal_id"`
+	// 操作者 ID
+	ActorID *int64 `form:"actor_id"`
+	// 操作者类型
+	ActorType *ActorType `form:"actor_type"`
+	// 操作动作
+	Action *AuditAction `form:"action"`
+	// 业务分类
+	Category *AuditCategory `form:"category"`
+	// 风险级别
+	RiskLevel *RiskLevel `form:"risk_level"`
+	// 资源类型
+	ResourceType *string `form:"resource_type"`
+	// 资源类型集合（逗号分隔；用于治理视图把同一类审计资源收敛为一个读模型）
+	ResourceTypes *string `form:"resource_types" binding:"omitempty,max=500"`
+	// 资源 ID
+	ResourceID *string `form:"resource_id"`
+	// 是否同时包含 metadata.related_resource_* 命中的关联资源记录
+	IncludeRelated *bool `form:"include_related"`
+	// 是否在列表响应中携带 changes / metadata 载荷
+	IncludePayload *bool `form:"include_payload"`
+	// 产品标识
+	ProductCode *string `form:"product_code"`
+	// 租户 ID
+	TenantID *string `form:"tenant_id"`
+	// 是否成功
+	IsSuccess *bool `form:"is_success"`
+	// 开始时间（RFC3339）
+	DateFrom *time.Time `form:"date_from" time_format:"2006-01-02T15:04:05Z07:00"`
+	// 结束时间（RFC3339）
+	DateTo *time.Time `form:"date_to" time_format:"2006-01-02T15:04:05Z07:00"`
+	// 追踪 ID
+	TraceID *string `form:"trace_id"`
+	// 请求 ID
+	RequestID *string `form:"request_id"`
+}
+
+// ResourceTypeValues 返回去空白、去重后的资源类型过滤集合。
+func (r *AdminListAuditLogsRequest) ResourceTypeValues() []string {
+	if r == nil || r.ResourceTypes == nil {
+		return nil
+	}
+	parts := strings.Split(*r.ResourceTypes, ",")
+	values := make([]string, 0, len(parts))
+	seen := make(map[string]struct{}, len(parts))
+	for _, part := range parts {
+		value := strings.TrimSpace(part)
+		if value == "" {
+			continue
+		}
+		if _, ok := seen[value]; ok {
+			continue
+		}
+		seen[value] = struct{}{}
+		values = append(values, value)
+	}
+	return values
+}
+
+// AdminListLoginLogsRequest 管理端登录日志查询参数
+type AdminListLoginLogsRequest struct {
+	types.AdminPageParams
+	// 关键词
+	Keyword *string `form:"keyword"`
+	// 客户端 IP
+	ActorIP *string `form:"actor_ip"`
+	// 认证动作
+	LoginAction *LoginAction `form:"login_action"`
+	// 登录方式
+	LoginMethod *LoginMethod `form:"login_method"`
+	// 是否成功
+	IsSuccess *bool `form:"is_success"`
+	// 产品标识
+	ProductCode *string `form:"product_code"`
+	// 开始时间（RFC3339）
+	DateFrom *time.Time `form:"date_from" time_format:"2006-01-02T15:04:05Z07:00"`
+	// 结束时间（RFC3339）
+	DateTo *time.Time `form:"date_to" time_format:"2006-01-02T15:04:05Z07:00"`
+	// 请求 ID
+	RequestID *string `form:"request_id"`
+}
+
+// AdminListOperationLogsRequest 管理端操作日志查询参数
+type AdminListOperationLogsRequest struct {
+	types.AdminPageParams
+	// 关键词
+	Keyword *string `form:"keyword"`
+	// IAM 主体 ID
+	PrincipalID *int64 `form:"principal_id"`
+	// 操作者 ID
+	ActorID *int64 `form:"actor_id"`
+	// 操作动作
+	OperationAction *AuditAction `form:"operation_action"`
+	// 操作分类
+	OperationCategory *AuditCategory `form:"operation_category"`
+	// 风险级别
+	RiskLevel *RiskLevel `form:"risk_level"`
+	// IAM 动作
+	IAMAction *string `form:"iam_action"`
+	// 资源类型
+	ResourceType *string `form:"resource_type"`
+	// 资源 ID
+	ResourceID *string `form:"resource_id"`
+	// HTTP 方法
+	HTTPMethod *string `form:"http_method"`
+	// HTTP 状态码
+	HTTPStatus *int16 `form:"http_status"`
+	// 产品标识
+	ProductCode *string `form:"product_code"`
+	// 租户 ID
+	TenantID *string `form:"tenant_id"`
+	// 是否成功
+	IsSuccess *bool `form:"is_success"`
+	// 记录状态
+	RecordStatus *string `form:"record_status"`
+	// 开始时间（RFC3339）
+	DateFrom *time.Time `form:"date_from" time_format:"2006-01-02T15:04:05Z07:00"`
+	// 结束时间（RFC3339）
+	DateTo *time.Time `form:"date_to" time_format:"2006-01-02T15:04:05Z07:00"`
+	// 请求 ID
+	RequestID *string `form:"request_id"`
+	// 追踪 ID
+	TraceID *string `form:"trace_id"`
+}