//! Generated by `trust-tasks-codegen` — do not edit by hand.
//!
//! Spec slug: `audit/list`. Version: `0.1`.
#[allow(unused_imports)]
use serde::{Deserialize, Serialize};
/// Error types.
pub mod error {
/// Error from a `TryFrom` or `FromStr` implementation.
pub struct ConversionError(::std::borrow::Cow<'static, str>);
impl ::std::error::Error for ConversionError {}
impl ::std::fmt::Display for ConversionError {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> Result<(), ::std::fmt::Error> {
::std::fmt::Display::fmt(&self.0, f)
}
}
impl ::std::fmt::Debug for ConversionError {
fn fmt(&self, f: &mut ::std::fmt::Formatter<'_>) -> Result<(), ::std::fmt::Error> {
::std::fmt::Debug::fmt(&self.0, f)
}
}
impl From<&'static str> for ConversionError {
fn from(value: &'static str) -> Self {
Self(value.into())
}
}
impl From<String> for ConversionError {
fn from(value: String) -> Self {
Self(value.into())
}
}
}
///One entry in an append-only audit log. Only eventId/recordedAt/action are universal; every other field is populated by maintainers that track it. `prevHash`/`entryHash` are present on hash-chained logs (see audit/verify) and absent otherwise. Principal DIDs are plaintext and MAY be absent when a right-to-be-forgotten redaction has nulled them after the fact.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "AuditEnvelope",
/// "description": "One entry in an append-only audit log. Only eventId/recordedAt/action are universal; every other field is populated by maintainers that track it. `prevHash`/`entryHash` are present on hash-chained logs (see audit/verify) and absent otherwise. Principal DIDs are plaintext and MAY be absent when a right-to-be-forgotten redaction has nulled them after the fact.",
/// "type": "object",
/// "required": [
/// "action",
/// "eventId",
/// "recordedAt"
/// ],
/// "properties": {
/// "action": {
/// "description": "The operation this entry records — a maintainer-defined action name (e.g. `member.removed`, `policy.activated`). The discriminator for `detail`.",
/// "type": "string",
/// "minLength": 1
/// },
/// "actor": {
/// "description": "DID of the principal that performed the action. `null` when a right-to-be-forgotten redaction has removed the plaintext; a maintainer that keeps a keyed hash of the actor for correlation carries it in `ext`, not here.",
/// "type": [
/// "string",
/// "null"
/// ]
/// },
/// "contextId": {
/// "description": "Trust context the event occurred in, for a maintainer that partitions its log per context.",
/// "type": "string",
/// "minLength": 1
/// },
/// "detail": {
/// "description": "Event-specific payload, keyed by `action`. Opaque to the framework; a consumer that does not recognise the action treats it as an unstructured record.",
/// "type": "object",
/// "additionalProperties": true
/// },
/// "entryHash": {
/// "description": "Hash-chain commitment over this entry's immutable content. The next entry's `prevHash` points here.",
/// "type": "string"
/// },
/// "eventId": {
/// "description": "Stable identifier for this event. Also the tie-breaker component of a cursor's position key.",
/// "type": "string",
/// "minLength": 1
/// },
/// "ext": {
/// "$ref": "#/definitions/Ext"
/// },
/// "outcome": {
/// "description": "How the operation resolved. Typically `success` or `denied`; a maintainer MAY use others. Absent for events that have no pass/fail sense.",
/// "type": "string"
/// },
/// "prevHash": {
/// "description": "Hash-chain link: the `entryHash` of the immediately-preceding entry. Present only on chained logs; its integrity is what audit/verify checks.",
/// "type": "string"
/// },
/// "recordedAt": {
/// "description": "Wall-clock time the entry was written. The primary ordering key.",
/// "type": "string",
/// "format": "date-time"
/// },
/// "schemaVersion": {
/// "description": "Envelope-shape version at the maintainer, for consumers that need to reason about wire-shape evolution.",
/// "type": "integer",
/// "minimum": 0.0
/// },
/// "target": {
/// "description": "DID of the principal the action acted upon, when the event has one. `null`/absent for events whose target is the maintainer itself. Same redaction semantics as `actor`.",
/// "type": [
/// "string",
/// "null"
/// ]
/// }
/// },
/// "additionalProperties": false,
/// "$anchor": "auditEnvelope"
///}
/// ```
/// </details>
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
pub struct AuditEnvelope {
///The operation this entry records — a maintainer-defined action name (e.g. `member.removed`, `policy.activated`). The discriminator for `detail`.
pub action: AuditEnvelopeAction,
///DID of the principal that performed the action. `null` when a right-to-be-forgotten redaction has removed the plaintext; a maintainer that keeps a keyed hash of the actor for correlation carries it in `ext`, not here.
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub actor: ::std::option::Option<::std::string::String>,
///Trust context the event occurred in, for a maintainer that partitions its log per context.
#[serde(
rename = "contextId",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub context_id: ::std::option::Option<AuditEnvelopeContextId>,
///Event-specific payload, keyed by `action`. Opaque to the framework; a consumer that does not recognise the action treats it as an unstructured record.
#[serde(default, skip_serializing_if = "::serde_json::Map::is_empty")]
pub detail: ::serde_json::Map<::std::string::String, ::serde_json::Value>,
///Hash-chain commitment over this entry's immutable content. The next entry's `prevHash` points here.
#[serde(
rename = "entryHash",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub entry_hash: ::std::option::Option<::std::string::String>,
///Stable identifier for this event. Also the tie-breaker component of a cursor's position key.
#[serde(rename = "eventId")]
pub event_id: AuditEnvelopeEventId,
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub ext: ::std::option::Option<Ext>,
///How the operation resolved. Typically `success` or `denied`; a maintainer MAY use others. Absent for events that have no pass/fail sense.
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub outcome: ::std::option::Option<::std::string::String>,
///Hash-chain link: the `entryHash` of the immediately-preceding entry. Present only on chained logs; its integrity is what audit/verify checks.
#[serde(
rename = "prevHash",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub prev_hash: ::std::option::Option<::std::string::String>,
///Wall-clock time the entry was written. The primary ordering key.
#[serde(rename = "recordedAt")]
pub recorded_at: ::chrono::DateTime<::chrono::offset::Utc>,
///Envelope-shape version at the maintainer, for consumers that need to reason about wire-shape evolution.
#[serde(
rename = "schemaVersion",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub schema_version: ::std::option::Option<u64>,
///DID of the principal the action acted upon, when the event has one. `null`/absent for events whose target is the maintainer itself. Same redaction semantics as `actor`.
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub target: ::std::option::Option<::std::string::String>,
}
///The operation this entry records — a maintainer-defined action name (e.g. `member.removed`, `policy.activated`). The discriminator for `detail`.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "The operation this entry records — a maintainer-defined action name (e.g. `member.removed`, `policy.activated`). The discriminator for `detail`.",
/// "type": "string",
/// "minLength": 1
///}
/// ```
/// </details>
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct AuditEnvelopeAction(::std::string::String);
impl ::std::ops::Deref for AuditEnvelopeAction {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<AuditEnvelopeAction> for ::std::string::String {
fn from(value: AuditEnvelopeAction) -> Self {
value.0
}
}
impl ::std::str::FromStr for AuditEnvelopeAction {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
if value.chars().count() < 1usize {
return Err("shorter than 1 characters".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for AuditEnvelopeAction {
type Error = self::error::ConversionError;
fn try_from(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<&::std::string::String> for AuditEnvelopeAction {
type Error = self::error::ConversionError;
fn try_from(
value: &::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<::std::string::String> for AuditEnvelopeAction {
type Error = self::error::ConversionError;
fn try_from(
value: ::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl<'de> ::serde::Deserialize<'de> for AuditEnvelopeAction {
fn deserialize<D>(deserializer: D) -> ::std::result::Result<Self, D::Error>
where
D: ::serde::Deserializer<'de>,
{
::std::string::String::deserialize(deserializer)?
.parse()
.map_err(|e: self::error::ConversionError| {
<D::Error as ::serde::de::Error>::custom(e.to_string())
})
}
}
///Trust context the event occurred in, for a maintainer that partitions its log per context.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Trust context the event occurred in, for a maintainer that partitions its log per context.",
/// "type": "string",
/// "minLength": 1
///}
/// ```
/// </details>
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct AuditEnvelopeContextId(::std::string::String);
impl ::std::ops::Deref for AuditEnvelopeContextId {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<AuditEnvelopeContextId> for ::std::string::String {
fn from(value: AuditEnvelopeContextId) -> Self {
value.0
}
}
impl ::std::str::FromStr for AuditEnvelopeContextId {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
if value.chars().count() < 1usize {
return Err("shorter than 1 characters".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for AuditEnvelopeContextId {
type Error = self::error::ConversionError;
fn try_from(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<&::std::string::String> for AuditEnvelopeContextId {
type Error = self::error::ConversionError;
fn try_from(
value: &::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<::std::string::String> for AuditEnvelopeContextId {
type Error = self::error::ConversionError;
fn try_from(
value: ::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl<'de> ::serde::Deserialize<'de> for AuditEnvelopeContextId {
fn deserialize<D>(deserializer: D) -> ::std::result::Result<Self, D::Error>
where
D: ::serde::Deserializer<'de>,
{
::std::string::String::deserialize(deserializer)?
.parse()
.map_err(|e: self::error::ConversionError| {
<D::Error as ::serde::de::Error>::custom(e.to_string())
})
}
}
///Stable identifier for this event. Also the tie-breaker component of a cursor's position key.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Stable identifier for this event. Also the tie-breaker component of a cursor's position key.",
/// "type": "string",
/// "minLength": 1
///}
/// ```
/// </details>
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct AuditEnvelopeEventId(::std::string::String);
impl ::std::ops::Deref for AuditEnvelopeEventId {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<AuditEnvelopeEventId> for ::std::string::String {
fn from(value: AuditEnvelopeEventId) -> Self {
value.0
}
}
impl ::std::str::FromStr for AuditEnvelopeEventId {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
if value.chars().count() < 1usize {
return Err("shorter than 1 characters".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for AuditEnvelopeEventId {
type Error = self::error::ConversionError;
fn try_from(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<&::std::string::String> for AuditEnvelopeEventId {
type Error = self::error::ConversionError;
fn try_from(
value: &::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<::std::string::String> for AuditEnvelopeEventId {
type Error = self::error::ConversionError;
fn try_from(
value: ::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl<'de> ::serde::Deserialize<'de> for AuditEnvelopeEventId {
fn deserialize<D>(deserializer: D) -> ::std::result::Result<Self, D::Error>
where
D: ::serde::Deserializer<'de>,
{
::std::string::String::deserialize(deserializer)?
.parse()
.map_err(|e: self::error::ConversionError| {
<D::Error as ::serde::de::Error>::custom(e.to_string())
})
}
}
///Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "Ext",
/// "description": "Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.",
/// "type": "object",
/// "minProperties": 1,
/// "additionalProperties": true,
/// "propertyNames": {
/// "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
/// }
///}
/// ```
/// </details>
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(transparent)]
pub struct Ext(pub ::std::collections::HashMap<ExtKey, ::serde_json::Value>);
impl ::std::ops::Deref for Ext {
type Target = ::std::collections::HashMap<ExtKey, ::serde_json::Value>;
fn deref(&self) -> &::std::collections::HashMap<ExtKey, ::serde_json::Value> {
&self.0
}
}
impl ::std::convert::From<Ext> for ::std::collections::HashMap<ExtKey, ::serde_json::Value> {
fn from(value: Ext) -> Self {
value.0
}
}
impl ::std::convert::From<::std::collections::HashMap<ExtKey, ::serde_json::Value>> for Ext {
fn from(value: ::std::collections::HashMap<ExtKey, ::serde_json::Value>) -> Self {
Self(value)
}
}
///`ExtKey`
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "type": "string",
/// "pattern": "^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$"
///}
/// ```
/// </details>
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct ExtKey(::std::string::String);
impl ::std::ops::Deref for ExtKey {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<ExtKey> for ::std::string::String {
fn from(value: ExtKey) -> Self {
value.0
}
}
impl ::std::str::FromStr for ExtKey {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
static PATTERN: ::std::sync::LazyLock<::regress::Regex> =
::std::sync::LazyLock::new(|| {
::regress::Regex::new("^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$").unwrap()
});
if PATTERN.find(value).is_none() {
return Err("doesn't match pattern \"^[a-z][a-z0-9-]*(\\.[a-z0-9-]+)+$\"".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for ExtKey {
type Error = self::error::ConversionError;
fn try_from(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<&::std::string::String> for ExtKey {
type Error = self::error::ConversionError;
fn try_from(
value: &::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<::std::string::String> for ExtKey {
type Error = self::error::ConversionError;
fn try_from(
value: ::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl<'de> ::serde::Deserialize<'de> for ExtKey {
fn deserialize<D>(deserializer: D) -> ::std::result::Result<Self, D::Error>
where
D: ::serde::Deserializer<'de>,
{
::std::string::String::deserialize(deserializer)?
.parse()
.map_err(|e: self::error::ConversionError| {
<D::Error as ::serde::de::Error>::custom(e.to_string())
})
}
}
///`Payload`
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "$id": "https://trusttasks.org/spec/audit/list/0.1",
/// "title": "Payload",
/// "type": "object",
/// "properties": {
/// "action": {
/// "description": "Return only entries whose `action` equals this value.",
/// "type": "string",
/// "minLength": 1
/// },
/// "actor": {
/// "description": "Return only entries whose `actor` DID equals this value. Matches on the plaintext; redacted entries are not returned by an actor filter.",
/// "type": "string",
/// "minLength": 1
/// },
/// "contextId": {
/// "description": "Return only entries in this trust context.",
/// "type": "string",
/// "minLength": 1
/// },
/// "cursor": {
/// "description": "Opaque continuation token from a previous response's `cursor`. Encodes the position to resume from; a maintainer SHOULD sign it so it cannot be forged to skip entries. Treated as invalid (see errorCodes) if it fails to verify — e.g. minted before an audit-key rotation. A consumer that supplies a `cursor` MUST NOT also change the filters, which are bound into the cursor's position.",
/// "type": "string"
/// },
/// "ext": {
/// "$ref": "#/definitions/Ext"
/// },
/// "from": {
/// "description": "Return only entries recorded at or after this time.",
/// "type": "string",
/// "format": "date-time"
/// },
/// "outcome": {
/// "description": "Return only entries whose `outcome` equals this value.",
/// "type": "string",
/// "minLength": 1
/// },
/// "pageSize": {
/// "description": "Maximum entries to return in this page.",
/// "type": "integer",
/// "maximum": 1000.0,
/// "minimum": 1.0
/// },
/// "to": {
/// "description": "Return only entries recorded strictly before this time.",
/// "type": "string",
/// "format": "date-time"
/// }
/// },
/// "additionalProperties": false
///}
/// ```
/// </details>
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
pub struct Payload {
///Return only entries whose `action` equals this value.
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub action: ::std::option::Option<PayloadAction>,
///Return only entries whose `actor` DID equals this value. Matches on the plaintext; redacted entries are not returned by an actor filter.
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub actor: ::std::option::Option<PayloadActor>,
///Return only entries in this trust context.
#[serde(
rename = "contextId",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub context_id: ::std::option::Option<PayloadContextId>,
///Opaque continuation token from a previous response's `cursor`. Encodes the position to resume from; a maintainer SHOULD sign it so it cannot be forged to skip entries. Treated as invalid (see errorCodes) if it fails to verify — e.g. minted before an audit-key rotation. A consumer that supplies a `cursor` MUST NOT also change the filters, which are bound into the cursor's position.
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub cursor: ::std::option::Option<::std::string::String>,
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub ext: ::std::option::Option<Ext>,
///Return only entries recorded at or after this time.
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub from: ::std::option::Option<::chrono::DateTime<::chrono::offset::Utc>>,
///Return only entries whose `outcome` equals this value.
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub outcome: ::std::option::Option<PayloadOutcome>,
///Maximum entries to return in this page.
#[serde(
rename = "pageSize",
default,
skip_serializing_if = "::std::option::Option::is_none"
)]
pub page_size: ::std::option::Option<::std::num::NonZeroU64>,
///Return only entries recorded strictly before this time.
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub to: ::std::option::Option<::chrono::DateTime<::chrono::offset::Utc>>,
}
impl ::std::default::Default for Payload {
fn default() -> Self {
Self {
action: Default::default(),
actor: Default::default(),
context_id: Default::default(),
cursor: Default::default(),
ext: Default::default(),
from: Default::default(),
outcome: Default::default(),
page_size: Default::default(),
to: Default::default(),
}
}
}
///Return only entries whose `action` equals this value.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Return only entries whose `action` equals this value.",
/// "type": "string",
/// "minLength": 1
///}
/// ```
/// </details>
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct PayloadAction(::std::string::String);
impl ::std::ops::Deref for PayloadAction {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<PayloadAction> for ::std::string::String {
fn from(value: PayloadAction) -> Self {
value.0
}
}
impl ::std::str::FromStr for PayloadAction {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
if value.chars().count() < 1usize {
return Err("shorter than 1 characters".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for PayloadAction {
type Error = self::error::ConversionError;
fn try_from(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<&::std::string::String> for PayloadAction {
type Error = self::error::ConversionError;
fn try_from(
value: &::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<::std::string::String> for PayloadAction {
type Error = self::error::ConversionError;
fn try_from(
value: ::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl<'de> ::serde::Deserialize<'de> for PayloadAction {
fn deserialize<D>(deserializer: D) -> ::std::result::Result<Self, D::Error>
where
D: ::serde::Deserializer<'de>,
{
::std::string::String::deserialize(deserializer)?
.parse()
.map_err(|e: self::error::ConversionError| {
<D::Error as ::serde::de::Error>::custom(e.to_string())
})
}
}
///Return only entries whose `actor` DID equals this value. Matches on the plaintext; redacted entries are not returned by an actor filter.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Return only entries whose `actor` DID equals this value. Matches on the plaintext; redacted entries are not returned by an actor filter.",
/// "type": "string",
/// "minLength": 1
///}
/// ```
/// </details>
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct PayloadActor(::std::string::String);
impl ::std::ops::Deref for PayloadActor {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<PayloadActor> for ::std::string::String {
fn from(value: PayloadActor) -> Self {
value.0
}
}
impl ::std::str::FromStr for PayloadActor {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
if value.chars().count() < 1usize {
return Err("shorter than 1 characters".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for PayloadActor {
type Error = self::error::ConversionError;
fn try_from(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<&::std::string::String> for PayloadActor {
type Error = self::error::ConversionError;
fn try_from(
value: &::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<::std::string::String> for PayloadActor {
type Error = self::error::ConversionError;
fn try_from(
value: ::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl<'de> ::serde::Deserialize<'de> for PayloadActor {
fn deserialize<D>(deserializer: D) -> ::std::result::Result<Self, D::Error>
where
D: ::serde::Deserializer<'de>,
{
::std::string::String::deserialize(deserializer)?
.parse()
.map_err(|e: self::error::ConversionError| {
<D::Error as ::serde::de::Error>::custom(e.to_string())
})
}
}
///Return only entries in this trust context.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Return only entries in this trust context.",
/// "type": "string",
/// "minLength": 1
///}
/// ```
/// </details>
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct PayloadContextId(::std::string::String);
impl ::std::ops::Deref for PayloadContextId {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<PayloadContextId> for ::std::string::String {
fn from(value: PayloadContextId) -> Self {
value.0
}
}
impl ::std::str::FromStr for PayloadContextId {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
if value.chars().count() < 1usize {
return Err("shorter than 1 characters".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for PayloadContextId {
type Error = self::error::ConversionError;
fn try_from(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<&::std::string::String> for PayloadContextId {
type Error = self::error::ConversionError;
fn try_from(
value: &::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<::std::string::String> for PayloadContextId {
type Error = self::error::ConversionError;
fn try_from(
value: ::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl<'de> ::serde::Deserialize<'de> for PayloadContextId {
fn deserialize<D>(deserializer: D) -> ::std::result::Result<Self, D::Error>
where
D: ::serde::Deserializer<'de>,
{
::std::string::String::deserialize(deserializer)?
.parse()
.map_err(|e: self::error::ConversionError| {
<D::Error as ::serde::de::Error>::custom(e.to_string())
})
}
}
///Return only entries whose `outcome` equals this value.
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "description": "Return only entries whose `outcome` equals this value.",
/// "type": "string",
/// "minLength": 1
///}
/// ```
/// </details>
#[derive(::serde::Serialize, Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd)]
#[serde(transparent)]
pub struct PayloadOutcome(::std::string::String);
impl ::std::ops::Deref for PayloadOutcome {
type Target = ::std::string::String;
fn deref(&self) -> &::std::string::String {
&self.0
}
}
impl ::std::convert::From<PayloadOutcome> for ::std::string::String {
fn from(value: PayloadOutcome) -> Self {
value.0
}
}
impl ::std::str::FromStr for PayloadOutcome {
type Err = self::error::ConversionError;
fn from_str(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
if value.chars().count() < 1usize {
return Err("shorter than 1 characters".into());
}
Ok(Self(value.to_string()))
}
}
impl ::std::convert::TryFrom<&str> for PayloadOutcome {
type Error = self::error::ConversionError;
fn try_from(value: &str) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<&::std::string::String> for PayloadOutcome {
type Error = self::error::ConversionError;
fn try_from(
value: &::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl ::std::convert::TryFrom<::std::string::String> for PayloadOutcome {
type Error = self::error::ConversionError;
fn try_from(
value: ::std::string::String,
) -> ::std::result::Result<Self, self::error::ConversionError> {
value.parse()
}
}
impl<'de> ::serde::Deserialize<'de> for PayloadOutcome {
fn deserialize<D>(deserializer: D) -> ::std::result::Result<Self, D::Error>
where
D: ::serde::Deserializer<'de>,
{
::std::string::String::deserialize(deserializer)?
.parse()
.map_err(|e: self::error::ConversionError| {
<D::Error as ::serde::de::Error>::custom(e.to_string())
})
}
}
///`Response`
///
/// <details><summary>JSON schema</summary>
///
/// ```json
///{
/// "title": "Response",
/// "type": "object",
/// "required": [
/// "entries",
/// "truncated"
/// ],
/// "properties": {
/// "cursor": {
/// "description": "Opaque continuation token for the next page. Present iff `truncated` is true.",
/// "type": "string"
/// },
/// "entries": {
/// "description": "The matching audit entries, newest first.",
/// "type": "array",
/// "items": {
/// "$ref": "#/definitions/AuditEnvelope"
/// }
/// },
/// "ext": {
/// "$ref": "#/definitions/Ext"
/// },
/// "truncated": {
/// "description": "True when more entries match beyond this page — `cursor` is then present to fetch them.",
/// "type": "boolean"
/// }
/// },
/// "additionalProperties": false,
/// "$anchor": "response"
///}
/// ```
/// </details>
#[derive(::serde::Deserialize, ::serde::Serialize, Clone, Debug)]
#[serde(deny_unknown_fields)]
pub struct Response {
///Opaque continuation token for the next page. Present iff `truncated` is true.
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub cursor: ::std::option::Option<::std::string::String>,
///The matching audit entries, newest first.
pub entries: ::std::vec::Vec<AuditEnvelope>,
#[serde(default, skip_serializing_if = "::std::option::Option::is_none")]
pub ext: ::std::option::Option<Ext>,
///True when more entries match beyond this page — `cursor` is then present to fetch them.
pub truncated: bool,
}
impl crate::Payload for Payload {
const TYPE_URI: &'static str = "https://trusttasks.org/spec/audit/list/0.1";
const IS_RECIPIENT_REQUIRED: bool = true;
}
impl crate::Payload for Response {
const TYPE_URI: &'static str = "https://trusttasks.org/spec/audit/list/0.1#response";
const IS_RECIPIENT_REQUIRED: bool = true;
}
#[cfg(feature = "validate")]
impl crate::validate::ValidatedPayload for Payload {
const SCHEMA_JSON: &'static str = "{\n \"$defs\": {\n \"AuditEnvelope\": {\n \"$anchor\": \"auditEnvelope\",\n \"additionalProperties\": false,\n \"description\": \"One entry in an append-only audit log. Only eventId/recordedAt/action are universal; every other field is populated by maintainers that track it. `prevHash`/`entryHash` are present on hash-chained logs (see audit/verify) and absent otherwise. Principal DIDs are plaintext and MAY be absent when a right-to-be-forgotten redaction has nulled them after the fact.\",\n \"properties\": {\n \"action\": {\n \"description\": \"The operation this entry records — a maintainer-defined action name (e.g. `member.removed`, `policy.activated`). The discriminator for `detail`.\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"actor\": {\n \"description\": \"DID of the principal that performed the action. `null` when a right-to-be-forgotten redaction has removed the plaintext; a maintainer that keeps a keyed hash of the actor for correlation carries it in `ext`, not here.\",\n \"type\": [\n \"string\",\n \"null\"\n ]\n },\n \"contextId\": {\n \"description\": \"Trust context the event occurred in, for a maintainer that partitions its log per context.\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"detail\": {\n \"additionalProperties\": true,\n \"description\": \"Event-specific payload, keyed by `action`. Opaque to the framework; a consumer that does not recognise the action treats it as an unstructured record.\",\n \"type\": \"object\"\n },\n \"entryHash\": {\n \"description\": \"Hash-chain commitment over this entry's immutable content. The next entry's `prevHash` points here.\",\n \"type\": \"string\"\n },\n \"eventId\": {\n \"description\": \"Stable identifier for this event. Also the tie-breaker component of a cursor's position key.\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"ext\": {\n \"$ref\": \"#/$defs/Ext\"\n },\n \"outcome\": {\n \"description\": \"How the operation resolved. Typically `success` or `denied`; a maintainer MAY use others. Absent for events that have no pass/fail sense.\",\n \"type\": \"string\"\n },\n \"prevHash\": {\n \"description\": \"Hash-chain link: the `entryHash` of the immediately-preceding entry. Present only on chained logs; its integrity is what audit/verify checks.\",\n \"type\": \"string\"\n },\n \"recordedAt\": {\n \"description\": \"Wall-clock time the entry was written. The primary ordering key.\",\n \"format\": \"date-time\",\n \"type\": \"string\"\n },\n \"schemaVersion\": {\n \"description\": \"Envelope-shape version at the maintainer, for consumers that need to reason about wire-shape evolution.\",\n \"minimum\": 0,\n \"type\": \"integer\"\n },\n \"target\": {\n \"description\": \"DID of the principal the action acted upon, when the event has one. `null`/absent for events whose target is the maintainer itself. Same redaction semantics as `actor`.\",\n \"type\": [\n \"string\",\n \"null\"\n ]\n }\n },\n \"required\": [\n \"eventId\",\n \"recordedAt\",\n \"action\"\n ],\n \"title\": \"AuditEnvelope\",\n \"type\": \"object\"\n },\n \"Ext\": {\n \"additionalProperties\": true,\n \"description\": \"Vendor-namespaced extension object per SPEC.md §4.5.1. Each immediate key MUST be a reverse-DNS namespace; structure under each namespace is opaque to the framework.\",\n \"minProperties\": 1,\n \"propertyNames\": {\n \"pattern\": \"^[a-z][a-z0-9-]*(\\\\.[a-z0-9-]+)+$\"\n },\n \"title\": \"Ext\",\n \"type\": \"object\"\n },\n \"Response\": {\n \"$anchor\": \"response\",\n \"additionalProperties\": false,\n \"properties\": {\n \"cursor\": {\n \"description\": \"Opaque continuation token for the next page. Present iff `truncated` is true.\",\n \"type\": \"string\"\n },\n \"entries\": {\n \"description\": \"The matching audit entries, newest first.\",\n \"items\": {\n \"$ref\": \"#/$defs/AuditEnvelope\"\n },\n \"type\": \"array\"\n },\n \"ext\": {\n \"$ref\": \"#/$defs/Ext\"\n },\n \"truncated\": {\n \"description\": \"True when more entries match beyond this page — `cursor` is then present to fetch them.\",\n \"type\": \"boolean\"\n }\n },\n \"required\": [\n \"entries\",\n \"truncated\"\n ],\n \"title\": \"Audit List — response payload\",\n \"type\": \"object\"\n }\n },\n \"$id\": \"https://trusttasks.org/spec/audit/list/0.1\",\n \"$schema\": \"https://json-schema.org/draft/2020-12/schema\",\n \"additionalProperties\": false,\n \"properties\": {\n \"action\": {\n \"description\": \"Return only entries whose `action` equals this value.\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"actor\": {\n \"description\": \"Return only entries whose `actor` DID equals this value. Matches on the plaintext; redacted entries are not returned by an actor filter.\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"contextId\": {\n \"description\": \"Return only entries in this trust context.\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"cursor\": {\n \"description\": \"Opaque continuation token from a previous response's `cursor`. Encodes the position to resume from; a maintainer SHOULD sign it so it cannot be forged to skip entries. Treated as invalid (see errorCodes) if it fails to verify — e.g. minted before an audit-key rotation. A consumer that supplies a `cursor` MUST NOT also change the filters, which are bound into the cursor's position.\",\n \"type\": \"string\"\n },\n \"ext\": {\n \"$ref\": \"#/$defs/Ext\"\n },\n \"from\": {\n \"description\": \"Return only entries recorded at or after this time.\",\n \"format\": \"date-time\",\n \"type\": \"string\"\n },\n \"outcome\": {\n \"description\": \"Return only entries whose `outcome` equals this value.\",\n \"minLength\": 1,\n \"type\": \"string\"\n },\n \"pageSize\": {\n \"description\": \"Maximum entries to return in this page.\",\n \"maximum\": 1000,\n \"minimum\": 1,\n \"type\": \"integer\"\n },\n \"to\": {\n \"description\": \"Return only entries recorded strictly before this time.\",\n \"format\": \"date-time\",\n \"type\": \"string\"\n }\n },\n \"title\": \"Audit List — payload\",\n \"type\": \"object\"\n}\n";
}
#[cfg(test)]
mod conformance {
//! Round-trip tests harvested from the spec's `spec.md`,
//! plus a `rejects_invalid_examples` test for any fixtures
//! in `payload.invalid-examples.json` (validate feature).
/// Each fixture in `payload.invalid-examples.json` MUST be
/// rejected by at least one of: serde deserialization, or
/// JSON-Schema validation under the `validate` feature. The
/// fixture file documents the producer-side bug class that
/// each payload exemplifies; this generated test pins it.
#[cfg(feature = "validate")]
#[test]
fn rejects_invalid_examples() {
use crate::validate::ValidatedPayload;
let fixtures: &[(&str, &str)] = &[
(
"Unknown top-level member is rejected (additionalProperties: false).",
"{\n \"__notARealMember__\": true,\n \"action\": \"member.removed\"\n}",
),
(
"`pageSize` is capped at 1000.",
"{\n \"pageSize\": 5000\n}",
),
("`pageSize` must be at least 1.", "{\n \"pageSize\": 0\n}"),
(
"`from` must be a date-time.",
"{\n \"from\": \"yesterday\"\n}",
),
];
for (i, (note, raw)) in fixtures.iter().enumerate() {
let value: serde_json::Value = match serde_json::from_str(raw) {
Ok(v) => v,
Err(_) => continue,
};
let serde_ok = serde_json::from_value::<super::Payload>(value.clone()).is_ok();
let schema_ok = super::Payload::validate_value(&value).is_ok();
assert!(
!(serde_ok && schema_ok),
"invalid-example #{} ({:?}) was accepted by both serde and JSON Schema; \
the fixture's stated failure class is no longer caught:\n{}",
i + 1,
note,
raw
);
}
}
}