Documentation
¶
Index ¶
- Constants
- Variables
- func RegisterPolicyAuditServiceServer(s grpc.ServiceRegistrar, srv PolicyAuditServiceServer)
- type ClaimFacts
- func (*ClaimFacts) Descriptor() ([]byte, []int)deprecated
- func (x *ClaimFacts) GetResolvedAt() *timestamppb.Timestamp
- func (x *ClaimFacts) GetRole() v11.ClaimRole
- func (x *ClaimFacts) GetSource() FactSource
- func (x *ClaimFacts) GetStatus() ClaimStatus
- func (x *ClaimFacts) GetSubject() string
- func (*ClaimFacts) ProtoMessage()
- func (x *ClaimFacts) ProtoReflect() protoreflect.Message
- func (x *ClaimFacts) Reset()
- func (x *ClaimFacts) String() string
- type ClaimStatus
- func (ClaimStatus) Descriptor() protoreflect.EnumDescriptor
- func (x ClaimStatus) Enum() *ClaimStatus
- func (ClaimStatus) EnumDescriptor() ([]byte, []int)deprecated
- func (x ClaimStatus) Number() protoreflect.EnumNumber
- func (x ClaimStatus) String() string
- func (ClaimStatus) Type() protoreflect.EnumType
- type FactSource
- type GetRecordRequest
- type GetRecordResponse
- func (*GetRecordResponse) Descriptor() ([]byte, []int)deprecated
- func (x *GetRecordResponse) GetEvaluations() []*PolicyEvaluation
- func (x *GetRecordResponse) GetExcluded() bool
- func (x *GetRecordResponse) GetRecord() *v1.Record
- func (*GetRecordResponse) ProtoMessage()
- func (x *GetRecordResponse) ProtoReflect() protoreflect.Message
- func (x *GetRecordResponse) Reset()
- func (x *GetRecordResponse) String() string
- type IdentityFacts
- func (*IdentityFacts) Descriptor() ([]byte, []int)deprecated
- func (x *IdentityFacts) GetIdentity() *ClaimFacts
- func (x *IdentityFacts) GetOwner() *ClaimFacts
- func (*IdentityFacts) ProtoMessage()
- func (x *IdentityFacts) ProtoReflect() protoreflect.Message
- func (x *IdentityFacts) Reset()
- func (x *IdentityFacts) String() string
- type ListExcludedRecordsRequest
- func (*ListExcludedRecordsRequest) Descriptor() ([]byte, []int)deprecated
- func (x *ListExcludedRecordsRequest) GetLimit() uint32
- func (x *ListExcludedRecordsRequest) GetOffset() uint32
- func (*ListExcludedRecordsRequest) ProtoMessage()
- func (x *ListExcludedRecordsRequest) ProtoReflect() protoreflect.Message
- func (x *ListExcludedRecordsRequest) Reset()
- func (x *ListExcludedRecordsRequest) String() string
- type ListExcludedRecordsResponse
- func (*ListExcludedRecordsResponse) Descriptor() ([]byte, []int)deprecated
- func (x *ListExcludedRecordsResponse) GetCid() string
- func (x *ListExcludedRecordsResponse) GetEvaluations() []*PolicyEvaluation
- func (*ListExcludedRecordsResponse) ProtoMessage()
- func (x *ListExcludedRecordsResponse) ProtoReflect() protoreflect.Message
- func (x *ListExcludedRecordsResponse) Reset()
- func (x *ListExcludedRecordsResponse) String() string
- type Operation
- type OperationContext
- func (*OperationContext) Descriptor() ([]byte, []int)deprecated
- func (x *OperationContext) GetOperation() Operation
- func (x *OperationContext) GetSourcePeerId() string
- func (*OperationContext) ProtoMessage()
- func (x *OperationContext) ProtoReflect() protoreflect.Message
- func (x *OperationContext) Reset()
- func (x *OperationContext) String() string
- type OperationInput
- func (*OperationInput) Descriptor() ([]byte, []int)deprecated
- func (x *OperationInput) GetContext() *OperationContext
- func (x *OperationInput) GetIdentityResolvedAt() *timestamppb.Timestamp
- func (x *OperationInput) GetIndexedAt() *timestamppb.Timestamp
- func (x *OperationInput) GetNow() *timestamppb.Timestamp
- func (x *OperationInput) GetOwnerResolvedAt() *timestamppb.Timestamp
- func (x *OperationInput) GetRecord() *structpb.Struct
- func (x *OperationInput) GetRecordCid() string
- func (x *OperationInput) GetScannedAt() *timestamppb.Timestamp
- func (x *OperationInput) GetSignatureVerifiedAt() *timestamppb.Timestamp
- func (x *OperationInput) GetVerdicts() map[string]*Verdict
- func (*OperationInput) ProtoMessage()
- func (x *OperationInput) ProtoReflect() protoreflect.Message
- func (x *OperationInput) Reset()
- func (x *OperationInput) String() string
- type PolicyAuditServiceClient
- type PolicyAuditServiceServer
- type PolicyAuditService_ListExcludedRecordsClient
- type PolicyAuditService_ListExcludedRecordsServer
- type PolicyEvaluation
- func (*PolicyEvaluation) Descriptor() ([]byte, []int)deprecated
- func (x *PolicyEvaluation) GetCompliant() bool
- func (x *PolicyEvaluation) GetPolicyId() string
- func (x *PolicyEvaluation) GetPolicyVersion() string
- func (x *PolicyEvaluation) GetReason() string
- func (x *PolicyEvaluation) GetStatus() string
- func (x *PolicyEvaluation) GetUpdatedAt() *timestamppb.Timestamp
- func (*PolicyEvaluation) ProtoMessage()
- func (x *PolicyEvaluation) ProtoReflect() protoreflect.Message
- func (x *PolicyEvaluation) Reset()
- func (x *PolicyEvaluation) String() string
- type RecordMeta
- func (*RecordMeta) Descriptor() ([]byte, []int)deprecated
- func (x *RecordMeta) GetIdentity() *IdentityFacts
- func (x *RecordMeta) GetScan() *ScanFacts
- func (x *RecordMeta) GetSignature() *SignatureFacts
- func (*RecordMeta) ProtoMessage()
- func (x *RecordMeta) ProtoReflect() protoreflect.Message
- func (x *RecordMeta) Reset()
- func (x *RecordMeta) String() string
- type RecordState
- func (*RecordState) Descriptor() ([]byte, []int)deprecated
- func (x *RecordState) GetIndexedAt() *timestamppb.Timestamp
- func (x *RecordState) GetMeta() *RecordMeta
- func (x *RecordState) GetRecord() *structpb.Struct
- func (x *RecordState) GetRecordCid() string
- func (*RecordState) ProtoMessage()
- func (x *RecordState) ProtoReflect() protoreflect.Message
- func (x *RecordState) Reset()
- func (x *RecordState) String() string
- type ScanFacts
- func (*ScanFacts) Descriptor() ([]byte, []int)deprecated
- func (x *ScanFacts) GetFindingCount() uint32
- func (x *ScanFacts) GetIsSafe() bool
- func (x *ScanFacts) GetMaxSeverity() v1.Severity
- func (x *ScanFacts) GetScannedAt() *timestamppb.Timestamp
- func (x *ScanFacts) GetScanners() []*ScannerResult
- func (x *ScanFacts) GetSource() FactSource
- func (x *ScanFacts) GetStatus() ScanStatus
- func (*ScanFacts) ProtoMessage()
- func (x *ScanFacts) ProtoReflect() protoreflect.Message
- func (x *ScanFacts) Reset()
- func (x *ScanFacts) String() string
- type ScanStatus
- type ScannerResult
- func (*ScannerResult) Descriptor() ([]byte, []int)deprecated
- func (x *ScannerResult) GetFindingCount() uint32
- func (x *ScannerResult) GetMaxSeverity() v1.Severity
- func (x *ScannerResult) GetScannedAt() *timestamppb.Timestamp
- func (x *ScannerResult) GetScannerType() v1.ScannerType
- func (x *ScannerResult) GetStatus() ScanStatus
- func (*ScannerResult) ProtoMessage()
- func (x *ScannerResult) ProtoReflect() protoreflect.Message
- func (x *ScannerResult) Reset()
- func (x *ScannerResult) String() string
- type SignatureFacts
- func (*SignatureFacts) Descriptor() ([]byte, []int)deprecated
- func (x *SignatureFacts) GetSignerIdentity() string
- func (x *SignatureFacts) GetSignerIssuer() string
- func (x *SignatureFacts) GetSource() FactSource
- func (x *SignatureFacts) GetStatus() SignatureStatus
- func (x *SignatureFacts) GetVerifiedAt() *timestamppb.Timestamp
- func (*SignatureFacts) ProtoMessage()
- func (x *SignatureFacts) ProtoReflect() protoreflect.Message
- func (x *SignatureFacts) Reset()
- func (x *SignatureFacts) String() string
- type SignatureStatus
- func (SignatureStatus) Descriptor() protoreflect.EnumDescriptor
- func (x SignatureStatus) Enum() *SignatureStatus
- func (SignatureStatus) EnumDescriptor() ([]byte, []int)deprecated
- func (x SignatureStatus) Number() protoreflect.EnumNumber
- func (x SignatureStatus) String() string
- func (SignatureStatus) Type() protoreflect.EnumType
- type UnimplementedPolicyAuditServiceServer
- type UnsafePolicyAuditServiceServer
- type Verdict
- func (*Verdict) Descriptor() ([]byte, []int)deprecated
- func (x *Verdict) GetCompliant() bool
- func (x *Verdict) GetCompliantAndCurrent() bool
- func (x *Verdict) GetEvaluatedAt() *timestamppb.Timestamp
- func (x *Verdict) GetPolicyVersion() string
- func (x *Verdict) GetReason() string
- func (x *Verdict) GetStatus() VerdictStatus
- func (*Verdict) ProtoMessage()
- func (x *Verdict) ProtoReflect() protoreflect.Message
- func (x *Verdict) Reset()
- func (x *Verdict) String() string
- type VerdictStatus
- func (VerdictStatus) Descriptor() protoreflect.EnumDescriptor
- func (x VerdictStatus) Enum() *VerdictStatus
- func (VerdictStatus) EnumDescriptor() ([]byte, []int)deprecated
- func (x VerdictStatus) Number() protoreflect.EnumNumber
- func (x VerdictStatus) String() string
- func (VerdictStatus) Type() protoreflect.EnumType
Constants ¶
const ( PolicyAuditService_GetRecord_FullMethodName = "/agntcy.dir.policy.v1.PolicyAuditService/GetRecord" PolicyAuditService_ListExcludedRecords_FullMethodName = "/agntcy.dir.policy.v1.PolicyAuditService/ListExcludedRecords" )
Variables ¶
var ( Operation_name = map[int32]string{ 0: "OPERATION_UNSPECIFIED", 1: "OPERATION_PUSH", 2: "OPERATION_AUTOSYNC", 3: "OPERATION_INDEX", 4: "OPERATION_PULL", 5: "OPERATION_SEARCH", 6: "OPERATION_PRUNE", } Operation_value = map[string]int32{ "OPERATION_UNSPECIFIED": 0, "OPERATION_PUSH": 1, "OPERATION_AUTOSYNC": 2, "OPERATION_INDEX": 3, "OPERATION_PULL": 4, "OPERATION_SEARCH": 5, "OPERATION_PRUNE": 6, } )
Enum value maps for Operation.
var ( VerdictStatus_name = map[int32]string{ 0: "VERDICT_STATUS_UNSPECIFIED", 1: "VERDICT_STATUS_UNEVALUATED", 2: "VERDICT_STATUS_EVALUATED", 3: "VERDICT_STATUS_FAILED", 4: "VERDICT_STATUS_SUPERSEDED", } VerdictStatus_value = map[string]int32{ "VERDICT_STATUS_UNSPECIFIED": 0, "VERDICT_STATUS_UNEVALUATED": 1, "VERDICT_STATUS_EVALUATED": 2, "VERDICT_STATUS_FAILED": 3, "VERDICT_STATUS_SUPERSEDED": 4, } )
Enum value maps for VerdictStatus.
var ( FactSource_name = map[int32]string{ 0: "FACT_SOURCE_UNSPECIFIED", 1: "FACT_SOURCE_LOCAL", 2: "FACT_SOURCE_IMPORTED", } FactSource_value = map[string]int32{ "FACT_SOURCE_UNSPECIFIED": 0, "FACT_SOURCE_LOCAL": 1, "FACT_SOURCE_IMPORTED": 2, } )
Enum value maps for FactSource.
var ( SignatureStatus_name = map[int32]string{ 0: "SIGNATURE_STATUS_UNSPECIFIED", 1: "SIGNATURE_STATUS_UNSIGNED", 2: "SIGNATURE_STATUS_UNVERIFIED", 3: "SIGNATURE_STATUS_VERIFIED", 4: "SIGNATURE_STATUS_REVOKED", } SignatureStatus_value = map[string]int32{ "SIGNATURE_STATUS_UNSPECIFIED": 0, "SIGNATURE_STATUS_UNSIGNED": 1, "SIGNATURE_STATUS_UNVERIFIED": 2, "SIGNATURE_STATUS_VERIFIED": 3, "SIGNATURE_STATUS_REVOKED": 4, } )
Enum value maps for SignatureStatus.
var ( ScanStatus_name = map[int32]string{ 0: "SCAN_STATUS_UNSPECIFIED", 1: "SCAN_STATUS_UNSCANNED", 2: "SCAN_STATUS_COMPLETED", 3: "SCAN_STATUS_PARTIAL", 4: "SCAN_STATUS_FAILED", } ScanStatus_value = map[string]int32{ "SCAN_STATUS_UNSPECIFIED": 0, "SCAN_STATUS_UNSCANNED": 1, "SCAN_STATUS_COMPLETED": 2, "SCAN_STATUS_PARTIAL": 3, "SCAN_STATUS_FAILED": 4, } )
Enum value maps for ScanStatus.
var ( ClaimStatus_name = map[int32]string{ 0: "CLAIM_STATUS_UNSPECIFIED", 1: "CLAIM_STATUS_UNCLAIMED", 2: "CLAIM_STATUS_UNVERIFIED", 3: "CLAIM_STATUS_VERIFIED", 4: "CLAIM_STATUS_FAILED", } ClaimStatus_value = map[string]int32{ "CLAIM_STATUS_UNSPECIFIED": 0, "CLAIM_STATUS_UNCLAIMED": 1, "CLAIM_STATUS_UNVERIFIED": 2, "CLAIM_STATUS_VERIFIED": 3, "CLAIM_STATUS_FAILED": 4, } )
Enum value maps for ClaimStatus.
var File_agntcy_dir_policy_v1_policy_audit_service_proto protoreflect.FileDescriptor
var File_agntcy_dir_policy_v1_policy_evaluation_proto protoreflect.FileDescriptor
var File_agntcy_dir_policy_v1_policy_input_proto protoreflect.FileDescriptor
var PolicyAuditService_ServiceDesc = grpc.ServiceDesc{ ServiceName: "agntcy.dir.policy.v1.PolicyAuditService", HandlerType: (*PolicyAuditServiceServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "GetRecord", Handler: _PolicyAuditService_GetRecord_Handler, }, }, Streams: []grpc.StreamDesc{ { StreamName: "ListExcludedRecords", Handler: _PolicyAuditService_ListExcludedRecords_Handler, ServerStreams: true, }, }, Metadata: "agntcy/dir/policy/v1/policy_audit_service.proto", }
PolicyAuditService_ServiceDesc is the grpc.ServiceDesc for PolicyAuditService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterPolicyAuditServiceServer ¶
func RegisterPolicyAuditServiceServer(s grpc.ServiceRegistrar, srv PolicyAuditServiceServer)
Types ¶
type ClaimFacts ¶
type ClaimFacts struct {
// What this claim asserts. Equal to the field of IdentityFacts it is
// reached through, and carried so that a ClaimFacts is meaningful alone.
Role v11.ClaimRole `protobuf:"varint,1,opt,name=role,proto3,enum=agntcy.dir.identity.v1.ClaimRole" json:"role,omitempty"`
// What this node knows about the claim.
Status ClaimStatus `protobuf:"varint,2,opt,name=status,proto3,enum=agntcy.dir.policy.v1.ClaimStatus" json:"status,omitempty"`
// Whether this node resolved the claim or imported a peer's result.
Source FactSource `protobuf:"varint,3,opt,name=source,proto3,enum=agntcy.dir.policy.v1.FactSource" json:"source,omitempty"`
// The identity URI claimed (e.g. "did:web:acme.com:agents:finance").
//
// This is what the record asserts, and it is only trustworthy in
// combination with status: an unverified subject is a string the publisher
// chose. A policy scoping rules by owner must check both.
Subject string `protobuf:"bytes,4,opt,name=subject,proto3" json:"subject,omitempty"`
// When resolution last ran. Absent if it never has.
ResolvedAt *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=resolved_at,json=resolvedAt,proto3,oneof" json:"resolved_at,omitempty"`
// contains filtered or unexported fields
}
ClaimFacts is what this node knows about one claim.
func (*ClaimFacts) Descriptor
deprecated
func (*ClaimFacts) Descriptor() ([]byte, []int)
Deprecated: Use ClaimFacts.ProtoReflect.Descriptor instead.
func (*ClaimFacts) GetResolvedAt ¶
func (x *ClaimFacts) GetResolvedAt() *timestamppb.Timestamp
func (*ClaimFacts) GetRole ¶
func (x *ClaimFacts) GetRole() v11.ClaimRole
func (*ClaimFacts) GetSource ¶
func (x *ClaimFacts) GetSource() FactSource
func (*ClaimFacts) GetStatus ¶
func (x *ClaimFacts) GetStatus() ClaimStatus
func (*ClaimFacts) GetSubject ¶
func (x *ClaimFacts) GetSubject() string
func (*ClaimFacts) ProtoMessage ¶
func (*ClaimFacts) ProtoMessage()
func (*ClaimFacts) ProtoReflect ¶
func (x *ClaimFacts) ProtoReflect() protoreflect.Message
func (*ClaimFacts) Reset ¶
func (x *ClaimFacts) Reset()
func (*ClaimFacts) String ¶
func (x *ClaimFacts) String() string
type ClaimStatus ¶
type ClaimStatus int32
ClaimStatus is what this node knows about an identity or ownership claim.
const ( ClaimStatus_CLAIM_STATUS_UNSPECIFIED ClaimStatus = 0 // The record asserts no claim of this role. ClaimStatus_CLAIM_STATUS_UNCLAIMED ClaimStatus = 1 // A claim is attached but has not been resolved. ClaimStatus_CLAIM_STATUS_UNVERIFIED ClaimStatus = 2 // The claim was resolved and held. ClaimStatus_CLAIM_STATUS_VERIFIED ClaimStatus = 3 // Resolution ran and the claim did not hold. ClaimStatus_CLAIM_STATUS_FAILED ClaimStatus = 4 )
func (ClaimStatus) Descriptor ¶
func (ClaimStatus) Descriptor() protoreflect.EnumDescriptor
func (ClaimStatus) Enum ¶
func (x ClaimStatus) Enum() *ClaimStatus
func (ClaimStatus) EnumDescriptor
deprecated
func (ClaimStatus) EnumDescriptor() ([]byte, []int)
Deprecated: Use ClaimStatus.Descriptor instead.
func (ClaimStatus) Number ¶
func (x ClaimStatus) Number() protoreflect.EnumNumber
func (ClaimStatus) String ¶
func (x ClaimStatus) String() string
func (ClaimStatus) Type ¶
func (ClaimStatus) Type() protoreflect.EnumType
type FactSource ¶
type FactSource int32
FactSource says whether this node observed a fact or imported it.
Not decoration. Autosync pulls a record's referrers - signature, public key, scan report - from the peer that announced it, and ingest writes the peer's scan report into the same table the local scanner writes to. So a record can carry scan metadata that is the peer's own assertion about its own record, indistinguishable by shape from something this node checked. A policy that interprets security state needs to be able to tell the two apart.
const ( FactSource_FACT_SOURCE_UNSPECIFIED FactSource = 0 // Produced by this node: its scanner, its verifier, its resolver. FactSource_FACT_SOURCE_LOCAL FactSource = 1 // Received from a peer alongside the record. An assertion, not an // observation. FactSource_FACT_SOURCE_IMPORTED FactSource = 2 )
func (FactSource) Descriptor ¶
func (FactSource) Descriptor() protoreflect.EnumDescriptor
func (FactSource) Enum ¶
func (x FactSource) Enum() *FactSource
func (FactSource) EnumDescriptor
deprecated
func (FactSource) EnumDescriptor() ([]byte, []int)
Deprecated: Use FactSource.Descriptor instead.
func (FactSource) Number ¶
func (x FactSource) Number() protoreflect.EnumNumber
func (FactSource) String ¶
func (x FactSource) String() string
func (FactSource) Type ¶
func (FactSource) Type() protoreflect.EnumType
type GetRecordRequest ¶
type GetRecordRequest struct {
// The record's CID.
Cid string `protobuf:"bytes,1,opt,name=cid,proto3" json:"cid,omitempty"`
// contains filtered or unexported fields
}
GetRecordRequest names the record to return.
func (*GetRecordRequest) Descriptor
deprecated
func (*GetRecordRequest) Descriptor() ([]byte, []int)
Deprecated: Use GetRecordRequest.ProtoReflect.Descriptor instead.
func (*GetRecordRequest) GetCid ¶
func (x *GetRecordRequest) GetCid() string
func (*GetRecordRequest) ProtoMessage ¶
func (*GetRecordRequest) ProtoMessage()
func (*GetRecordRequest) ProtoReflect ¶
func (x *GetRecordRequest) ProtoReflect() protoreflect.Message
func (*GetRecordRequest) Reset ¶
func (x *GetRecordRequest) Reset()
func (*GetRecordRequest) String ¶
func (x *GetRecordRequest) String() string
type GetRecordResponse ¶
type GetRecordResponse struct {
// The record.
Record *v1.Record `protobuf:"bytes,1,opt,name=record,proto3" json:"record,omitempty"`
// Whether the record fails an enforced policy at the version in force, so
// that reads enforcing the policies exclude it.
Excluded bool `protobuf:"varint,2,opt,name=excluded,proto3" json:"excluded,omitempty"`
// Every verdict recorded for the record.
Evaluations []*PolicyEvaluation `protobuf:"bytes,3,rep,name=evaluations,proto3" json:"evaluations,omitempty"`
// contains filtered or unexported fields
}
GetRecordResponse is the record and why it is or is not excluded.
func (*GetRecordResponse) Descriptor
deprecated
func (*GetRecordResponse) Descriptor() ([]byte, []int)
Deprecated: Use GetRecordResponse.ProtoReflect.Descriptor instead.
func (*GetRecordResponse) GetEvaluations ¶
func (x *GetRecordResponse) GetEvaluations() []*PolicyEvaluation
func (*GetRecordResponse) GetExcluded ¶
func (x *GetRecordResponse) GetExcluded() bool
func (*GetRecordResponse) GetRecord ¶
func (x *GetRecordResponse) GetRecord() *v1.Record
func (*GetRecordResponse) ProtoMessage ¶
func (*GetRecordResponse) ProtoMessage()
func (*GetRecordResponse) ProtoReflect ¶
func (x *GetRecordResponse) ProtoReflect() protoreflect.Message
func (*GetRecordResponse) Reset ¶
func (x *GetRecordResponse) Reset()
func (*GetRecordResponse) String ¶
func (x *GetRecordResponse) String() string
type IdentityFacts ¶
type IdentityFacts struct {
// The record's own claimed identity. Absent if it claims none.
Identity *ClaimFacts `protobuf:"bytes,1,opt,name=identity,proto3,oneof" json:"identity,omitempty"`
// The record's claimed owning entity. Absent if it claims none.
Owner *ClaimFacts `protobuf:"bytes,2,opt,name=owner,proto3,oneof" json:"owner,omitempty"`
// contains filtered or unexported fields
}
IdentityFacts is what this node knows about who a record is and who owns it.
The two roles are separate fields rather than a list, because a policy almost always wants one of them by name and should not have to filter.
func (*IdentityFacts) Descriptor
deprecated
func (*IdentityFacts) Descriptor() ([]byte, []int)
Deprecated: Use IdentityFacts.ProtoReflect.Descriptor instead.
func (*IdentityFacts) GetIdentity ¶
func (x *IdentityFacts) GetIdentity() *ClaimFacts
func (*IdentityFacts) GetOwner ¶
func (x *IdentityFacts) GetOwner() *ClaimFacts
func (*IdentityFacts) ProtoMessage ¶
func (*IdentityFacts) ProtoMessage()
func (*IdentityFacts) ProtoReflect ¶
func (x *IdentityFacts) ProtoReflect() protoreflect.Message
func (*IdentityFacts) Reset ¶
func (x *IdentityFacts) Reset()
func (*IdentityFacts) String ¶
func (x *IdentityFacts) String() string
type ListExcludedRecordsRequest ¶
type ListExcludedRecordsRequest struct {
// At most this many records. Zero means no limit.
Limit uint32 `protobuf:"varint,1,opt,name=limit,proto3" json:"limit,omitempty"`
// Skip this many records first.
Offset uint32 `protobuf:"varint,2,opt,name=offset,proto3" json:"offset,omitempty"`
// contains filtered or unexported fields
}
ListExcludedRecordsRequest pages through the excluded records.
func (*ListExcludedRecordsRequest) Descriptor
deprecated
func (*ListExcludedRecordsRequest) Descriptor() ([]byte, []int)
Deprecated: Use ListExcludedRecordsRequest.ProtoReflect.Descriptor instead.
func (*ListExcludedRecordsRequest) GetLimit ¶
func (x *ListExcludedRecordsRequest) GetLimit() uint32
func (*ListExcludedRecordsRequest) GetOffset ¶
func (x *ListExcludedRecordsRequest) GetOffset() uint32
func (*ListExcludedRecordsRequest) ProtoMessage ¶
func (*ListExcludedRecordsRequest) ProtoMessage()
func (*ListExcludedRecordsRequest) ProtoReflect ¶
func (x *ListExcludedRecordsRequest) ProtoReflect() protoreflect.Message
func (*ListExcludedRecordsRequest) Reset ¶
func (x *ListExcludedRecordsRequest) Reset()
func (*ListExcludedRecordsRequest) String ¶
func (x *ListExcludedRecordsRequest) String() string
type ListExcludedRecordsResponse ¶
type ListExcludedRecordsResponse struct {
// The record's CID.
Cid string `protobuf:"bytes,1,opt,name=cid,proto3" json:"cid,omitempty"`
// Every verdict recorded for the record.
Evaluations []*PolicyEvaluation `protobuf:"bytes,2,rep,name=evaluations,proto3" json:"evaluations,omitempty"`
// contains filtered or unexported fields
}
ListExcludedRecordsResponse is one excluded record.
func (*ListExcludedRecordsResponse) Descriptor
deprecated
func (*ListExcludedRecordsResponse) Descriptor() ([]byte, []int)
Deprecated: Use ListExcludedRecordsResponse.ProtoReflect.Descriptor instead.
func (*ListExcludedRecordsResponse) GetCid ¶
func (x *ListExcludedRecordsResponse) GetCid() string
func (*ListExcludedRecordsResponse) GetEvaluations ¶
func (x *ListExcludedRecordsResponse) GetEvaluations() []*PolicyEvaluation
func (*ListExcludedRecordsResponse) ProtoMessage ¶
func (*ListExcludedRecordsResponse) ProtoMessage()
func (*ListExcludedRecordsResponse) ProtoReflect ¶
func (x *ListExcludedRecordsResponse) ProtoReflect() protoreflect.Message
func (*ListExcludedRecordsResponse) Reset ¶
func (x *ListExcludedRecordsResponse) Reset()
func (*ListExcludedRecordsResponse) String ¶
func (x *ListExcludedRecordsResponse) String() string
type Operation ¶
type Operation int32
Operation is a point in a record's lifecycle at which a policy may decide.
There is deliberately no OPERATION_EVALUATE. Evaluation is not an operation: it is decoupled from any lifecycle point and runs whenever the reconciler gets to it, which is why its results are cached, versioned and invalidated. It is a producer of facts, configured as one, and it is the reason this file declares two input messages instead of one.
const ( Operation_OPERATION_UNSPECIFIED Operation = 0 // A client pushing a record to this node. Operation_OPERATION_PUSH Operation = 1 // This node pulling a record announced by a trusted peer. Admission, like // push, but for a record this node did not publish - which is why it is a // separate operation rather than a flag on push. Operation_OPERATION_AUTOSYNC Operation = 2 // The indexer making a record searchable. Operation_OPERATION_INDEX Operation = 3 // A read of one record by CID, local or federated. Operation_OPERATION_PULL Operation = 4 // A query returning a set of records. The only operation whose decision // must be reached per query rather than per record, because it has to be // known before rows are selected and paginated; its policies are therefore // restricted to what can be compiled to SQL. Operation_OPERATION_SEARCH Operation = 5 // The reconciler deleting a record. // // Polarity matters here and it is safety-critical. Absence of a verdict // reads as not-compliant, so a prune policy must require a *positive* // "should delete" rather than negating an acceptability verdict: negation // would mean "delete anything we have not yet looked at". Operation_OPERATION_PRUNE Operation = 6 )
func (Operation) Descriptor ¶
func (Operation) Descriptor() protoreflect.EnumDescriptor
func (Operation) EnumDescriptor
deprecated
func (Operation) Number ¶
func (x Operation) Number() protoreflect.EnumNumber
func (Operation) Type ¶
func (Operation) Type() protoreflect.EnumType
type OperationContext ¶
type OperationContext struct {
// Which operation is being decided.
Operation Operation `protobuf:"varint,1,opt,name=operation,proto3,enum=agntcy.dir.policy.v1.Operation" json:"operation,omitempty"`
// The authenticated libp2p peer ID the record is being pulled from. Set for
// OPERATION_AUTOSYNC only.
//
// This is not an authorization input: the peer allow-set is matched against
// the authenticated peer ID before any policy runs, so a peer that is not
// trusted never reaches one. It is here so that a policy can hold a
// particular peer to particular rules.
SourcePeerId *string `protobuf:"bytes,2,opt,name=source_peer_id,json=sourcePeerId,proto3,oneof" json:"source_peer_id,omitempty"`
// contains filtered or unexported fields
}
OperationContext is what varies by operation: the circumstances of the request, as opposed to facts about the record.
This message is expected to grow. Caller authorization is the next thing to land in it, which is why OperationInput is named for its purpose rather than its content.
func (*OperationContext) Descriptor
deprecated
func (*OperationContext) Descriptor() ([]byte, []int)
Deprecated: Use OperationContext.ProtoReflect.Descriptor instead.
func (*OperationContext) GetOperation ¶
func (x *OperationContext) GetOperation() Operation
func (*OperationContext) GetSourcePeerId ¶
func (x *OperationContext) GetSourcePeerId() string
func (*OperationContext) ProtoMessage ¶
func (*OperationContext) ProtoMessage()
func (*OperationContext) ProtoReflect ¶
func (x *OperationContext) ProtoReflect() protoreflect.Message
func (*OperationContext) Reset ¶
func (x *OperationContext) Reset()
func (*OperationContext) String ¶
func (x *OperationContext) String() string
type OperationInput ¶
type OperationInput struct {
// The record's OASF content. Same shape and same reason as RecordState.
Record *structpb.Struct `protobuf:"bytes,1,opt,name=record,proto3" json:"record,omitempty"`
// The record's content identifier.
RecordCid string `protobuf:"bytes,2,opt,name=record_cid,json=recordCid,proto3" json:"record_cid,omitempty"`
// Every configured evaluation policy's verdict, keyed by policy ID
// (provider ":" name, e.g. "cel:has-provenance").
//
// Always populated for every configured evaluation policy, including those
// with nothing recorded yet, so that a lookup never fails on a missing key
// and "not yet evaluated" is a state a policy can read rather than an
// error it has to survive.
Verdicts map[string]*Verdict `` /* 143-byte string literal not displayed */
// The circumstances of this operation.
Context *OperationContext `protobuf:"bytes,4,opt,name=context,proto3" json:"context,omitempty"`
// The current time, captured once for the whole evaluation so that every
// comparison within one decision sees the same instant.
Now *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=now,proto3" json:"now,omitempty"`
// When the record was first indexed by this node.
IndexedAt *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=indexed_at,json=indexedAt,proto3" json:"indexed_at,omitempty"`
// When each producer last recorded a result, absent until it has.
//
// These timestamps are here, rather than only in the evaluation layer,
// because they need no vocabulary to interpret, while the statuses they
// belong to do. Without them a reasonable rule would be inexpressible:
// "serve only records scanned within the last seven days" needs live time
// and scanned_at together, so neither layer could answer it alone.
ScannedAt *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=scanned_at,json=scannedAt,proto3,oneof" json:"scanned_at,omitempty"`
SignatureVerifiedAt *timestamppb.Timestamp `` /* 126-byte string literal not displayed */
IdentityResolvedAt *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=identity_resolved_at,json=identityResolvedAt,proto3,oneof" json:"identity_resolved_at,omitempty"`
OwnerResolvedAt *timestamppb.Timestamp `protobuf:"bytes,10,opt,name=owner_resolved_at,json=ownerResolvedAt,proto3,oneof" json:"owner_resolved_at,omitempty"`
// contains filtered or unexported fields
}
OperationInput is what an operation policy sees: a record, the verdicts recorded about it, and the circumstances of the operation.
It carries no RecordMeta. Metadata is *reduced* to verdicts by the evaluation layer, and an operation decides on the recorded reduction, so that anything interpreting security state has its interpretation audited rather than re-derived inline at every operation.
func (*OperationInput) Descriptor
deprecated
func (*OperationInput) Descriptor() ([]byte, []int)
Deprecated: Use OperationInput.ProtoReflect.Descriptor instead.
func (*OperationInput) GetContext ¶
func (x *OperationInput) GetContext() *OperationContext
func (*OperationInput) GetIdentityResolvedAt ¶
func (x *OperationInput) GetIdentityResolvedAt() *timestamppb.Timestamp
func (*OperationInput) GetIndexedAt ¶
func (x *OperationInput) GetIndexedAt() *timestamppb.Timestamp
func (*OperationInput) GetNow ¶
func (x *OperationInput) GetNow() *timestamppb.Timestamp
func (*OperationInput) GetOwnerResolvedAt ¶
func (x *OperationInput) GetOwnerResolvedAt() *timestamppb.Timestamp
func (*OperationInput) GetRecord ¶
func (x *OperationInput) GetRecord() *structpb.Struct
func (*OperationInput) GetRecordCid ¶
func (x *OperationInput) GetRecordCid() string
func (*OperationInput) GetScannedAt ¶
func (x *OperationInput) GetScannedAt() *timestamppb.Timestamp
func (*OperationInput) GetSignatureVerifiedAt ¶
func (x *OperationInput) GetSignatureVerifiedAt() *timestamppb.Timestamp
func (*OperationInput) GetVerdicts ¶
func (x *OperationInput) GetVerdicts() map[string]*Verdict
func (*OperationInput) ProtoMessage ¶
func (*OperationInput) ProtoMessage()
func (*OperationInput) ProtoReflect ¶
func (x *OperationInput) ProtoReflect() protoreflect.Message
func (*OperationInput) Reset ¶
func (x *OperationInput) Reset()
func (*OperationInput) String ¶
func (x *OperationInput) String() string
type PolicyAuditServiceClient ¶
type PolicyAuditServiceClient interface {
// GetRecord returns a record by CID whether or not the enforced policies
// exclude it, with its policy verdicts.
GetRecord(ctx context.Context, in *GetRecordRequest, opts ...grpc.CallOption) (*GetRecordResponse, error)
// ListExcludedRecords lists the indexed records the enforced policies
// exclude, with their verdicts.
ListExcludedRecords(ctx context.Context, in *ListExcludedRecordsRequest, opts ...grpc.CallOption) (PolicyAuditService_ListExcludedRecordsClient, error)
}
PolicyAuditServiceClient is the client API for PolicyAuditService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.
PolicyAuditService lets an auditor see records the enforced content policies exclude from every other read. It is a separate service so that it is authorized on its own: only a policy naming the caller's SPIFFE ID grants it, never one for a whole trust domain, and the server offers it only when authorization is enabled. Every call is audit-logged.
func NewPolicyAuditServiceClient ¶
func NewPolicyAuditServiceClient(cc grpc.ClientConnInterface) PolicyAuditServiceClient
type PolicyAuditServiceServer ¶
type PolicyAuditServiceServer interface {
// GetRecord returns a record by CID whether or not the enforced policies
// exclude it, with its policy verdicts.
GetRecord(context.Context, *GetRecordRequest) (*GetRecordResponse, error)
// ListExcludedRecords lists the indexed records the enforced policies
// exclude, with their verdicts.
ListExcludedRecords(*ListExcludedRecordsRequest, PolicyAuditService_ListExcludedRecordsServer) error
}
PolicyAuditServiceServer is the server API for PolicyAuditService service. All implementations should embed UnimplementedPolicyAuditServiceServer for forward compatibility.
PolicyAuditService lets an auditor see records the enforced content policies exclude from every other read. It is a separate service so that it is authorized on its own: only a policy naming the caller's SPIFFE ID grants it, never one for a whole trust domain, and the server offers it only when authorization is enabled. Every call is audit-logged.
type PolicyAuditService_ListExcludedRecordsClient ¶
type PolicyAuditService_ListExcludedRecordsClient interface {
Recv() (*ListExcludedRecordsResponse, error)
grpc.ClientStream
}
type PolicyAuditService_ListExcludedRecordsServer ¶
type PolicyAuditService_ListExcludedRecordsServer interface {
Send(*ListExcludedRecordsResponse) error
grpc.ServerStream
}
type PolicyEvaluation ¶
type PolicyEvaluation struct {
// The policy's identifier, as its evaluator reports it.
PolicyId string `protobuf:"bytes,1,opt,name=policy_id,json=policyId,proto3" json:"policy_id,omitempty"`
// The policy version the record was evaluated under.
PolicyVersion string `protobuf:"bytes,2,opt,name=policy_version,json=policyVersion,proto3" json:"policy_version,omitempty"`
// "evaluated", or "failed" when the evaluator could not decide.
Status string `protobuf:"bytes,3,opt,name=status,proto3" json:"status,omitempty"`
// Whether the record complies. Only meaningful when status is "evaluated":
// a failed evaluation is never compliant.
Compliant bool `protobuf:"varint,4,opt,name=compliant,proto3" json:"compliant,omitempty"`
// Why the evaluator decided as it did, or why it failed.
Reason string `protobuf:"bytes,5,opt,name=reason,proto3" json:"reason,omitempty"`
// When the verdict was last written.
UpdatedAt *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=updated_at,json=updatedAt,proto3" json:"updated_at,omitempty"`
// contains filtered or unexported fields
}
PolicyEvaluation is a record's verdict under one content policy.
func (*PolicyEvaluation) Descriptor
deprecated
func (*PolicyEvaluation) Descriptor() ([]byte, []int)
Deprecated: Use PolicyEvaluation.ProtoReflect.Descriptor instead.
func (*PolicyEvaluation) GetCompliant ¶
func (x *PolicyEvaluation) GetCompliant() bool
func (*PolicyEvaluation) GetPolicyId ¶
func (x *PolicyEvaluation) GetPolicyId() string
func (*PolicyEvaluation) GetPolicyVersion ¶
func (x *PolicyEvaluation) GetPolicyVersion() string
func (*PolicyEvaluation) GetReason ¶
func (x *PolicyEvaluation) GetReason() string
func (*PolicyEvaluation) GetStatus ¶
func (x *PolicyEvaluation) GetStatus() string
func (*PolicyEvaluation) GetUpdatedAt ¶
func (x *PolicyEvaluation) GetUpdatedAt() *timestamppb.Timestamp
func (*PolicyEvaluation) ProtoMessage ¶
func (*PolicyEvaluation) ProtoMessage()
func (*PolicyEvaluation) ProtoReflect ¶
func (x *PolicyEvaluation) ProtoReflect() protoreflect.Message
func (*PolicyEvaluation) Reset ¶
func (x *PolicyEvaluation) Reset()
func (*PolicyEvaluation) String ¶
func (x *PolicyEvaluation) String() string
type RecordMeta ¶
type RecordMeta struct {
// What this node knows about the record's signing.
Signature *SignatureFacts `protobuf:"bytes,1,opt,name=signature,proto3" json:"signature,omitempty"`
// What the scanners found.
Scan *ScanFacts `protobuf:"bytes,2,opt,name=scan,proto3" json:"scan,omitempty"`
// What this node knows about the record's identity and ownership.
Identity *IdentityFacts `protobuf:"bytes,3,opt,name=identity,proto3" json:"identity,omitempty"`
// contains filtered or unexported fields
}
RecordMeta is everything this node has observed about a record, as facts a policy can read.
Each group is a projection, not a database row: columns are renamed and omitted freely so that a schema change does not break every policy, and so that nothing a policy has no business deciding over is exposed.
func (*RecordMeta) Descriptor
deprecated
func (*RecordMeta) Descriptor() ([]byte, []int)
Deprecated: Use RecordMeta.ProtoReflect.Descriptor instead.
func (*RecordMeta) GetIdentity ¶
func (x *RecordMeta) GetIdentity() *IdentityFacts
func (*RecordMeta) GetScan ¶
func (x *RecordMeta) GetScan() *ScanFacts
func (*RecordMeta) GetSignature ¶
func (x *RecordMeta) GetSignature() *SignatureFacts
func (*RecordMeta) ProtoMessage ¶
func (*RecordMeta) ProtoMessage()
func (*RecordMeta) ProtoReflect ¶
func (x *RecordMeta) ProtoReflect() protoreflect.Message
func (*RecordMeta) Reset ¶
func (x *RecordMeta) Reset()
func (*RecordMeta) String ¶
func (x *RecordMeta) String() string
type RecordState ¶
type RecordState struct {
// The record's OASF content, as pushed. Left as a Struct rather than typed,
// because OASF has no compile-time schema here and a policy must be able to
// read fields of schema versions this build does not know about.
Record *structpb.Struct `protobuf:"bytes,1,opt,name=record,proto3" json:"record,omitempty"`
// The record's content identifier.
RecordCid string `protobuf:"bytes,2,opt,name=record_cid,json=recordCid,proto3" json:"record_cid,omitempty"`
// When the record was first indexed by this node. Present because it is a
// property of the record's state, not of the current moment; an evaluation
// policy may read it, but comparing it against "now" is what the operation
// layer is for.
IndexedAt *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=indexed_at,json=indexedAt,proto3" json:"indexed_at,omitempty"`
// What this node has observed about the record. Groups are empty where
// nothing has been produced yet, which at push time is all of them.
Meta *RecordMeta `protobuf:"bytes,4,opt,name=meta,proto3" json:"meta,omitempty"`
// contains filtered or unexported fields
}
RecordState is what an evaluation policy sees: a record and what this node has observed about it.
Named for its content, because by the nature of the layer its content is closed. Evaluation is asynchronous and per record, so it will never carry a caller, a request, or a wall clock.
func (*RecordState) Descriptor
deprecated
func (*RecordState) Descriptor() ([]byte, []int)
Deprecated: Use RecordState.ProtoReflect.Descriptor instead.
func (*RecordState) GetIndexedAt ¶
func (x *RecordState) GetIndexedAt() *timestamppb.Timestamp
func (*RecordState) GetMeta ¶
func (x *RecordState) GetMeta() *RecordMeta
func (*RecordState) GetRecord ¶
func (x *RecordState) GetRecord() *structpb.Struct
func (*RecordState) GetRecordCid ¶
func (x *RecordState) GetRecordCid() string
func (*RecordState) ProtoMessage ¶
func (*RecordState) ProtoMessage()
func (*RecordState) ProtoReflect ¶
func (x *RecordState) ProtoReflect() protoreflect.Message
func (*RecordState) Reset ¶
func (x *RecordState) Reset()
func (*RecordState) String ¶
func (x *RecordState) String() string
type ScanFacts ¶
type ScanFacts struct {
// How far scanning got overall.
Status ScanStatus `protobuf:"varint,1,opt,name=status,proto3,enum=agntcy.dir.policy.v1.ScanStatus" json:"status,omitempty"`
// Whether this node scanned the record or imported a peer's report.
Source FactSource `protobuf:"varint,2,opt,name=source,proto3,enum=agntcy.dir.policy.v1.FactSource" json:"source,omitempty"`
// The highest severity found by any scanner.
//
// Severity is declared ascending in agntcy/dir/security/v1/scan_report.proto,
// so a threshold is an ordinary comparison, and SEVERITY_UNSPECIFIED sorting
// below every real severity means an unscanned record fails a threshold
// rather than passing it.
MaxSeverity v1.Severity `` /* 132-byte string literal not displayed */
// Whether every scanner that reported considers the record safe.
IsSafe bool `protobuf:"varint,4,opt,name=is_safe,json=isSafe,proto3" json:"is_safe,omitempty"`
// How many findings were reported in total.
FindingCount uint32 `protobuf:"varint,5,opt,name=finding_count,json=findingCount,proto3" json:"finding_count,omitempty"`
// What each scanner found. A policy requiring a specific scanner should
// read this rather than the aggregate above.
Scanners []*ScannerResult `protobuf:"bytes,6,rep,name=scanners,proto3" json:"scanners,omitempty"`
// When the most recent scanner reported. Absent if none has.
ScannedAt *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=scanned_at,json=scannedAt,proto3,oneof" json:"scanned_at,omitempty"`
// contains filtered or unexported fields
}
ScanFacts is what the scanners found, aggregated and per scanner.
Individual findings are deliberately absent: a rule over rule IDs and remediation text is a rule over scanner output formats, which change without the record changing.
func (*ScanFacts) Descriptor
deprecated
func (*ScanFacts) GetFindingCount ¶
func (*ScanFacts) GetMaxSeverity ¶
func (*ScanFacts) GetScannedAt ¶
func (x *ScanFacts) GetScannedAt() *timestamppb.Timestamp
func (*ScanFacts) GetScanners ¶
func (x *ScanFacts) GetScanners() []*ScannerResult
func (*ScanFacts) GetSource ¶
func (x *ScanFacts) GetSource() FactSource
func (*ScanFacts) GetStatus ¶
func (x *ScanFacts) GetStatus() ScanStatus
func (*ScanFacts) ProtoMessage ¶
func (*ScanFacts) ProtoMessage()
func (*ScanFacts) ProtoReflect ¶
func (x *ScanFacts) ProtoReflect() protoreflect.Message
type ScanStatus ¶
type ScanStatus int32
ScanStatus is how far scanning a record got.
const ( ScanStatus_SCAN_STATUS_UNSPECIFIED ScanStatus = 0 // No scanner has reported on this record. ScanStatus_SCAN_STATUS_UNSCANNED ScanStatus = 1 // Every scanner that applies to this record reported. ScanStatus_SCAN_STATUS_COMPLETED ScanStatus = 2 // Some applicable scanners reported and others did not, so max_severity is // a floor rather than an answer. ScanStatus_SCAN_STATUS_PARTIAL ScanStatus = 3 // Scanning was attempted and could not complete. ScanStatus_SCAN_STATUS_FAILED ScanStatus = 4 )
func (ScanStatus) Descriptor ¶
func (ScanStatus) Descriptor() protoreflect.EnumDescriptor
func (ScanStatus) Enum ¶
func (x ScanStatus) Enum() *ScanStatus
func (ScanStatus) EnumDescriptor
deprecated
func (ScanStatus) EnumDescriptor() ([]byte, []int)
Deprecated: Use ScanStatus.Descriptor instead.
func (ScanStatus) Number ¶
func (x ScanStatus) Number() protoreflect.EnumNumber
func (ScanStatus) String ¶
func (x ScanStatus) String() string
func (ScanStatus) Type ¶
func (ScanStatus) Type() protoreflect.EnumType
type ScannerResult ¶
type ScannerResult struct {
// Which scanner reported.
ScannerType v1.ScannerType `` /* 135-byte string literal not displayed */
// How far this scanner got.
Status ScanStatus `protobuf:"varint,2,opt,name=status,proto3,enum=agntcy.dir.policy.v1.ScanStatus" json:"status,omitempty"`
// The highest severity this scanner found.
MaxSeverity v1.Severity `` /* 132-byte string literal not displayed */
// How many findings this scanner reported.
FindingCount uint32 `protobuf:"varint,4,opt,name=finding_count,json=findingCount,proto3" json:"finding_count,omitempty"`
// When this scanner reported. Absent if it has not.
ScannedAt *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=scanned_at,json=scannedAt,proto3,oneof" json:"scanned_at,omitempty"`
// contains filtered or unexported fields
}
ScannerResult is one scanner's contribution to a record's scan facts, so that a policy can require a particular scanner rather than trusting an aggregate it cannot see into.
func (*ScannerResult) Descriptor
deprecated
func (*ScannerResult) Descriptor() ([]byte, []int)
Deprecated: Use ScannerResult.ProtoReflect.Descriptor instead.
func (*ScannerResult) GetFindingCount ¶
func (x *ScannerResult) GetFindingCount() uint32
func (*ScannerResult) GetMaxSeverity ¶
func (x *ScannerResult) GetMaxSeverity() v1.Severity
func (*ScannerResult) GetScannedAt ¶
func (x *ScannerResult) GetScannedAt() *timestamppb.Timestamp
func (*ScannerResult) GetScannerType ¶
func (x *ScannerResult) GetScannerType() v1.ScannerType
func (*ScannerResult) GetStatus ¶
func (x *ScannerResult) GetStatus() ScanStatus
func (*ScannerResult) ProtoMessage ¶
func (*ScannerResult) ProtoMessage()
func (*ScannerResult) ProtoReflect ¶
func (x *ScannerResult) ProtoReflect() protoreflect.Message
func (*ScannerResult) Reset ¶
func (x *ScannerResult) Reset()
func (*ScannerResult) String ¶
func (x *ScannerResult) String() string
type SignatureFacts ¶
type SignatureFacts struct {
// What this node knows about the signature.
Status SignatureStatus `protobuf:"varint,1,opt,name=status,proto3,enum=agntcy.dir.policy.v1.SignatureStatus" json:"status,omitempty"`
// Whether this node verified the signature or took a peer's word for it.
Source FactSource `protobuf:"varint,2,opt,name=source,proto3,enum=agntcy.dir.policy.v1.FactSource" json:"source,omitempty"`
// The identity the signature was made with, as the verifier reports it
// (e.g. a Fulcio certificate's SAN). Absent until verified.
SignerIdentity *string `protobuf:"bytes,3,opt,name=signer_identity,json=signerIdentity,proto3,oneof" json:"signer_identity,omitempty"`
// The OIDC issuer that vouched for signer_identity. Absent until verified.
SignerIssuer *string `protobuf:"bytes,4,opt,name=signer_issuer,json=signerIssuer,proto3,oneof" json:"signer_issuer,omitempty"`
// When verification last ran. Absent if it never has.
VerifiedAt *timestamppb.Timestamp `protobuf:"bytes,5,opt,name=verified_at,json=verifiedAt,proto3,oneof" json:"verified_at,omitempty"`
// contains filtered or unexported fields
}
SignatureFacts is what this node knows about a record's signing.
The signature bytes, the certificate chain and the public key are deliberately absent. A policy decides over conclusions, not over material it would have to do cryptography on.
func (*SignatureFacts) Descriptor
deprecated
func (*SignatureFacts) Descriptor() ([]byte, []int)
Deprecated: Use SignatureFacts.ProtoReflect.Descriptor instead.
func (*SignatureFacts) GetSignerIdentity ¶
func (x *SignatureFacts) GetSignerIdentity() string
func (*SignatureFacts) GetSignerIssuer ¶
func (x *SignatureFacts) GetSignerIssuer() string
func (*SignatureFacts) GetSource ¶
func (x *SignatureFacts) GetSource() FactSource
func (*SignatureFacts) GetStatus ¶
func (x *SignatureFacts) GetStatus() SignatureStatus
func (*SignatureFacts) GetVerifiedAt ¶
func (x *SignatureFacts) GetVerifiedAt() *timestamppb.Timestamp
func (*SignatureFacts) ProtoMessage ¶
func (*SignatureFacts) ProtoMessage()
func (*SignatureFacts) ProtoReflect ¶
func (x *SignatureFacts) ProtoReflect() protoreflect.Message
func (*SignatureFacts) Reset ¶
func (x *SignatureFacts) Reset()
func (*SignatureFacts) String ¶
func (x *SignatureFacts) String() string
type SignatureStatus ¶
type SignatureStatus int32
SignatureStatus is what this node knows about a record's signature.
Deliberately keeps apart states the database currently collapses into one "unknown": a record with no signature at all, and a record with a signature nobody has verified yet, are different situations that warrant different rules.
const ( SignatureStatus_SIGNATURE_STATUS_UNSPECIFIED SignatureStatus = 0 // No signature is attached. SignatureStatus_SIGNATURE_STATUS_UNSIGNED SignatureStatus = 1 // A signature is attached but has not been verified. SignatureStatus_SIGNATURE_STATUS_UNVERIFIED SignatureStatus = 2 // A signature was verified and held. SignatureStatus_SIGNATURE_STATUS_VERIFIED SignatureStatus = 3 // A signature that verified before and does not now. SignatureStatus_SIGNATURE_STATUS_REVOKED SignatureStatus = 4 )
func (SignatureStatus) Descriptor ¶
func (SignatureStatus) Descriptor() protoreflect.EnumDescriptor
func (SignatureStatus) Enum ¶
func (x SignatureStatus) Enum() *SignatureStatus
func (SignatureStatus) EnumDescriptor
deprecated
func (SignatureStatus) EnumDescriptor() ([]byte, []int)
Deprecated: Use SignatureStatus.Descriptor instead.
func (SignatureStatus) Number ¶
func (x SignatureStatus) Number() protoreflect.EnumNumber
func (SignatureStatus) String ¶
func (x SignatureStatus) String() string
func (SignatureStatus) Type ¶
func (SignatureStatus) Type() protoreflect.EnumType
type UnimplementedPolicyAuditServiceServer ¶
type UnimplementedPolicyAuditServiceServer struct{}
UnimplementedPolicyAuditServiceServer should be embedded to have forward compatible implementations.
NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.
func (UnimplementedPolicyAuditServiceServer) GetRecord ¶
func (UnimplementedPolicyAuditServiceServer) GetRecord(context.Context, *GetRecordRequest) (*GetRecordResponse, error)
func (UnimplementedPolicyAuditServiceServer) ListExcludedRecords ¶
func (UnimplementedPolicyAuditServiceServer) ListExcludedRecords(*ListExcludedRecordsRequest, PolicyAuditService_ListExcludedRecordsServer) error
type UnsafePolicyAuditServiceServer ¶
type UnsafePolicyAuditServiceServer interface {
// contains filtered or unexported methods
}
UnsafePolicyAuditServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to PolicyAuditServiceServer will result in compilation errors.
type Verdict ¶
type Verdict struct {
// How far the evaluation got, and whether its result still counts.
Status VerdictStatus `protobuf:"varint,1,opt,name=status,proto3,enum=agntcy.dir.policy.v1.VerdictStatus" json:"status,omitempty"`
// Whether the record satisfies the policy's condition.
//
// Read this as "satisfies this condition", not as "this record is good".
// The field is neutral; which direction is safe depends on the operation
// deciding, and only one direction is safe per operation (see
// OPERATION_PRUNE).
Compliant bool `protobuf:"varint,2,opt,name=compliant,proto3" json:"compliant,omitempty"`
// Whether the record is compliant *and* the verdict was reached under the
// policy version currently in force.
//
// Derived here rather than left to the author on purpose. "Is this verdict
// current" is the fail-closed property the gate depends on, and exposing a
// raw version string for every policy to compare correctly guarantees that
// one of them eventually will not. Absence of a verdict, a superseded
// verdict and a non-compliant verdict all read false.
CompliantAndCurrent bool `protobuf:"varint,3,opt,name=compliant_and_current,json=compliantAndCurrent,proto3" json:"compliant_and_current,omitempty"`
// The policy version this verdict was reached under. Informational; use
// compliant_and_current to decide.
PolicyVersion string `protobuf:"bytes,4,opt,name=policy_version,json=policyVersion,proto3" json:"policy_version,omitempty"`
// Why the evaluator decided as it did, or why it failed. Useful to pass
// through to an error message; not a place to accumulate detail.
Reason string `protobuf:"bytes,5,opt,name=reason,proto3" json:"reason,omitempty"`
// When the verdict was reached. Absent when there is no verdict.
EvaluatedAt *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=evaluated_at,json=evaluatedAt,proto3,oneof" json:"evaluated_at,omitempty"`
// contains filtered or unexported fields
}
Verdict is one evaluation policy's conclusion about one record.
func (*Verdict) Descriptor
deprecated
func (*Verdict) GetCompliant ¶
func (*Verdict) GetCompliantAndCurrent ¶
func (*Verdict) GetEvaluatedAt ¶
func (x *Verdict) GetEvaluatedAt() *timestamppb.Timestamp
func (*Verdict) GetPolicyVersion ¶
func (*Verdict) GetStatus ¶
func (x *Verdict) GetStatus() VerdictStatus
func (*Verdict) ProtoMessage ¶
func (*Verdict) ProtoMessage()
func (*Verdict) ProtoReflect ¶
func (x *Verdict) ProtoReflect() protoreflect.Message
type VerdictStatus ¶
type VerdictStatus int32
VerdictStatus is how far an evaluation got, and whether its result still counts.
The current read gate treats all four non-EVALUATED cases alike and hides the record. Keeping them apart is most of the value of making the gate a policy: a policy can distinguish "nobody has looked at this yet" from "this was examined and failed" while still defaulting to the safe answer.
const ( VerdictStatus_VERDICT_STATUS_UNSPECIFIED VerdictStatus = 0 // The policy is configured but this record has no result under it yet. VerdictStatus_VERDICT_STATUS_UNEVALUATED VerdictStatus = 1 // The policy ran and reached a conclusion; see compliant. VerdictStatus_VERDICT_STATUS_EVALUATED VerdictStatus = 2 // The policy ran and could not decide, so the record is not compliant // under it. VerdictStatus_VERDICT_STATUS_FAILED VerdictStatus = 3 // A result exists, but under a policy version no longer in force. The // policy's content changed, so the conclusion is about a different rule. VerdictStatus_VERDICT_STATUS_SUPERSEDED VerdictStatus = 4 )
func (VerdictStatus) Descriptor ¶
func (VerdictStatus) Descriptor() protoreflect.EnumDescriptor
func (VerdictStatus) Enum ¶
func (x VerdictStatus) Enum() *VerdictStatus
func (VerdictStatus) EnumDescriptor
deprecated
func (VerdictStatus) EnumDescriptor() ([]byte, []int)
Deprecated: Use VerdictStatus.Descriptor instead.
func (VerdictStatus) Number ¶
func (x VerdictStatus) Number() protoreflect.EnumNumber
func (VerdictStatus) String ¶
func (x VerdictStatus) String() string
func (VerdictStatus) Type ¶
func (VerdictStatus) Type() protoreflect.EnumType