macwarden 1.0.1 → 1.1.1

package/schemas/output/watch-event.schema.json

@@ -0,0 +1,232 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://github.com/ZilverZtream/macwarden/blob/main/schemas/output/watch-event.schema.json",
+  "title": "macwarden watch --json event line",
+  "description": "Normative source: SPEC.md, Output and Commands > 8. watch. With --json, watch prints one of these objects per line while it runs, then its final document (watch.schema.json, the only line with a \"command\" field) as the last line.",
+  "oneOf": [
+    {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "schema",
+        "event",
+        "time",
+        "method",
+        "rootKeyId",
+        "credential",
+        "label"
+      ],
+      "properties": {
+        "schema": {
+          "const": 1
+        },
+        "time": {
+          "type": "string",
+          "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
+        },
+        "event": {
+          "enum": [
+            "call",
+            "error"
+          ]
+        },
+        "method": {
+          "type": "string"
+        },
+        "rootKeyId": {
+          "oneOf": [
+            {
+              "$ref": "#/$defs/rootKeyId"
+            },
+            {
+              "const": "none"
+            }
+          ]
+        },
+        "credential": {
+          "type": "string",
+          "pattern": "^id:([0-9a-f]{16}|none|undecodable)$"
+        },
+        "label": {
+          "type": [
+            "string",
+            "null"
+          ]
+        }
+      }
+    },
+    {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "schema",
+        "event",
+        "time",
+        "method",
+        "rootKeyId",
+        "credential",
+        "label",
+        "denied"
+      ],
+      "properties": {
+        "schema": {
+          "const": 1
+        },
+        "time": {
+          "type": "string",
+          "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
+        },
+        "event": {
+          "const": "canary"
+        },
+        "method": {
+          "type": "string"
+        },
+        "rootKeyId": {
+          "oneOf": [
+            {
+              "$ref": "#/$defs/rootKeyId"
+            },
+            {
+              "const": "none"
+            }
+          ]
+        },
+        "credential": {
+          "type": "string",
+          "pattern": "^id:([0-9a-f]{16}|none|undecodable)$"
+        },
+        "label": {
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "denied": {
+          "const": true
+        },
+        "repeats": {
+          "type": "integer",
+          "minimum": 1
+        }
+      }
+    },
+    {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "schema",
+        "event",
+        "time",
+        "status",
+        "canaries",
+        "readOnly"
+      ],
+      "properties": {
+        "schema": {
+          "const": 1
+        },
+        "time": {
+          "type": "string",
+          "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
+        },
+        "event": {
+          "const": "status"
+        },
+        "status": {
+          "enum": [
+            "registered",
+            "reconnecting"
+          ]
+        },
+        "canaries": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "readOnly": {
+          "const": true
+        }
+      }
+    },
+    {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "schema",
+        "event",
+        "time",
+        "status",
+        "dropped"
+      ],
+      "properties": {
+        "schema": {
+          "const": 1
+        },
+        "time": {
+          "type": "string",
+          "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
+        },
+        "event": {
+          "const": "status"
+        },
+        "status": {
+          "const": "output-dropped"
+        },
+        "dropped": {
+          "type": "integer",
+          "minimum": 1
+        }
+      }
+    },
+    {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "schema",
+        "event",
+        "time",
+        "status",
+        "rootKeyId",
+        "label"
+      ],
+      "properties": {
+        "schema": {
+          "const": 1
+        },
+        "time": {
+          "type": "string",
+          "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
+        },
+        "event": {
+          "const": "status"
+        },
+        "status": {
+          "const": "alert-failed"
+        },
+        "rootKeyId": {
+          "oneOf": [
+            {
+              "$ref": "#/$defs/rootKeyId"
+            },
+            {
+              "const": "none"
+            }
+          ]
+        },
+        "label": {
+          "type": [
+            "string",
+            "null"
+          ]
+        }
+      }
+    }
+  ],
+  "$defs": {
+    "rootKeyId": {
+      "type": "string",
+      "pattern": "^(0|[1-9][0-9]{0,19})$",
+      "description": "uint64 as a canonical decimal string (range up to 18446744073709551615 is enforced by the decoder)."
+    }
+  }
+}

package/schemas/output/watch.schema.json

@@ -0,0 +1,404 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://github.com/ZilverZtream/macwarden/blob/main/schemas/output/watch.schema.json",
+  "title": "macwarden watch --json final document",
+  "description": "Normative source: SPEC.md, Commands > 8. watch. The last line of watch --json; the event lines before it follow watch-event.schema.json.",
+  "type": "object",
+  "additionalProperties": false,
+  "required": [
+    "schema",
+    "command",
+    "ok",
+    "warnings",
+    "result",
+    "error"
+  ],
+  "properties": {
+    "schema": {
+      "const": 1
+    },
+    "command": {
+      "const": "watch"
+    },
+    "ok": {
+      "type": "boolean"
+    },
+    "warnings": {
+      "type": "array",
+      "items": {
+        "$ref": "#/$defs/warning"
+      }
+    },
+    "result": {
+      "oneOf": [
+        {
+          "type": "null"
+        },
+        {
+          "$ref": "#/$defs/result"
+        },
+        {
+          "$ref": "#/$defs/help"
+        }
+      ]
+    },
+    "error": {
+      "oneOf": [
+        {
+          "type": "null"
+        },
+        {
+          "$ref": "#/$defs/error"
+        }
+      ]
+    }
+  },
+  "allOf": [
+    {
+      "if": {
+        "properties": {
+          "ok": {
+            "const": true
+          }
+        },
+        "required": [
+          "ok"
+        ]
+      },
+      "then": {
+        "properties": {
+          "result": {
+            "oneOf": [
+              {
+                "$ref": "#/$defs/result"
+              },
+              {
+                "$ref": "#/$defs/help"
+              }
+            ]
+          },
+          "error": {
+            "type": "null"
+          }
+        }
+      },
+      "else": {
+        "properties": {
+          "result": {
+            "type": "null"
+          },
+          "error": {
+            "$ref": "#/$defs/error"
+          }
+        }
+      }
+    }
+  ],
+  "$defs": {
+    "error": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "code",
+        "step",
+        "message"
+      ],
+      "properties": {
+        "code": {
+          "type": "integer",
+          "minimum": 1,
+          "maximum": 8
+        },
+        "step": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "minLength": 1
+        },
+        "message": {
+          "type": "string",
+          "minLength": 1
+        }
+      }
+    },
+    "warning": {
+      "oneOf": [
+        {
+          "type": "string",
+          "minLength": 1
+        },
+        {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "code",
+            "message"
+          ],
+          "properties": {
+            "code": {
+              "type": "string",
+              "minLength": 1
+            },
+            "message": {
+              "type": "string"
+            }
+          }
+        }
+      ]
+    },
+    "rootKeyId": {
+      "type": "string",
+      "pattern": "^(0|[1-9][0-9]{0,19})$",
+      "description": "uint64 as a canonical decimal string (range up to 18446744073709551615 is enforced by the decoder)."
+    },
+    "grade": {
+      "enum": [
+        "ADMIN",
+        "SPEND",
+        "OPERATE",
+        "RECEIVE",
+        "READ",
+        "UNASSESSED"
+      ]
+    },
+    "registryEntry": {
+      "type": "object",
+      "required": [
+        "nodePubkey",
+        "label",
+        "rootKeyId",
+        "permissions",
+        "caveats",
+        "grade",
+        "fingerprint",
+        "outPath",
+        "createdAt",
+        "verified",
+        "status",
+        "revokedAt",
+        "revokeEvidence",
+        "replaces",
+        "replacedBy"
+      ],
+      "additionalProperties": false,
+      "properties": {
+        "nodePubkey": {
+          "type": "string",
+          "pattern": "^0[23][0-9a-fA-F]{64}$"
+        },
+        "label": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "pattern": "^[A-Za-z][A-Za-z0-9._-]{0,63}$"
+        },
+        "rootKeyId": {
+          "type": "string",
+          "pattern": "^(0|[1-9][0-9]*)$"
+        },
+        "permissions": {
+          "type": "array",
+          "items": {
+            "type": "string"
+          }
+        },
+        "caveats": {
+          "type": "array",
+          "items": {
+            "type": "object"
+          }
+        },
+        "grade": {
+          "enum": [
+            "ADMIN",
+            "SPEND",
+            "OPERATE",
+            "RECEIVE",
+            "READ",
+            "UNASSESSED"
+          ]
+        },
+        "fingerprint": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "pattern": "^fp:[0-9a-f]{16}$"
+        },
+        "outPath": {
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "createdAt": {
+          "type": "string"
+        },
+        "verified": {
+          "type": "boolean"
+        },
+        "status": {
+          "enum": [
+            "active",
+            "revoked"
+          ]
+        },
+        "revokedAt": {
+          "type": [
+            "string",
+            "null"
+          ]
+        },
+        "revokeEvidence": {
+          "enum": [
+            "rejected",
+            "by-id-only",
+            null
+          ]
+        },
+        "replaces": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "pattern": "^(0|[1-9][0-9]*)$"
+        },
+        "replacedBy": {
+          "type": [
+            "string",
+            "null"
+          ],
+          "pattern": "^(0|[1-9][0-9]*)$"
+        }
+      },
+      "allOf": [
+        {
+          "if": {
+            "properties": {
+              "fingerprint": {
+                "type": "null"
+              }
+            }
+          },
+          "then": {
+            "properties": {
+              "verified": {
+                "const": false
+              },
+              "outPath": {
+                "type": "null"
+              }
+            }
+          }
+        }
+      ]
+    },
+    "help": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "usage"
+      ],
+      "properties": {
+        "usage": {
+          "type": "array",
+          "minItems": 1,
+          "items": {
+            "type": "string",
+            "pattern": "^macwarden watch "
+          }
+        }
+      }
+    },
+    "result": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "node",
+        "startedAt",
+        "endedAt",
+        "calls",
+        "errors",
+        "credentials",
+        "canaryAlerts",
+        "canaryUses",
+        "alertFailures",
+        "reconnects",
+        "canaries",
+        "droppedUsageRecords",
+        "evictedUsageRecords",
+        "droppedAttributions",
+        "droppedEvents",
+        "usageFile"
+      ],
+      "properties": {
+        "node": {
+          "type": "string",
+          "pattern": "^0[23][0-9a-fA-F]{64}$"
+        },
+        "startedAt": {
+          "type": "string",
+          "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
+        },
+        "endedAt": {
+          "type": "string",
+          "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}\\.\\d{3}Z$"
+        },
+        "calls": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "errors": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "credentials": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "canaryAlerts": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "canaryUses": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "alertFailures": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "reconnects": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "canaries": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "droppedUsageRecords": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "evictedUsageRecords": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "droppedAttributions": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "droppedEvents": {
+          "type": "integer",
+          "minimum": 0
+        },
+        "usageFile": {
+          "type": "string",
+          "minLength": 1
+        }
+      }
+    }
+  }
+}