Merge pull request #21 from HumanAssisted/0.3.2

0.3.2

Author: Hendler

CHANGELOG.md

@@ -1,11 +1,33 @@
 # PLANNED
+
 - encrypt files at rest
 - refine schema usage
 - more getters and setters for documents recognized by schemas
 - WASM builds
 
+
+## 0.4.0
+- WASM
+
+## 0.3.4
+
+## 0.3.3
+ - upgrade pqcrypto https://github.com/rustpq/pqcrypto/issues/79
+
 # COMPLETED
 
+## 0.3.2
+ - [ ] add common clause to Apache 2.0
+ - [x] use a single file to handle file i/o for all storage types
+ - [x] use an ENV wrapper to prep for wasm
+ - [x] complete migration away from fs calls except for config, security, tests, cli 
+ - [x] create tests using custom schemas - verify this is working
+ - [] TEST init agent without needing configs in filesystem by checking that needed ENV variables are set
+ - [] separate public key location from private key location
+ - [] refactor API so easier to use from higher level libraries  - create agent, load agent, save document, create document, update document
+
+
+
 
 ## 0.3.1
 - upgraded many dependencies using 

Cargo.toml

@@ -29,6 +29,7 @@ include = [
     "CHANGELOG.md",
     "basic-schemas.png",
     "benches/sign_and_check_sig.rs",
+    "schemas/components/embedding/v1/embedding.schema.json",
 ]
 description = "JACS JSON AI Communication Standard"
 readme = "README.md"
@@ -43,34 +44,36 @@ build = "build.rs"
 
 [dependencies]
 base64 = "0.22.1"
-chrono = "0.4.39"
+chrono = "0.4.40"
 jsonschema = { version = "0.29", features = ["resolve-http", "resolve-file"] }
-log = "0.4.25"
-pem = "3.0.4"
+log = "0.4.27"
+pem = "3.0.5"
 rand = "0.9.0"
-rsa = { version= "0.9.7", features= ["sha2", "pem"]}
+rsa = { version= "0.9.8", features= ["sha2", "pem"]}
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
 signature = "2.2.0"
 url = "2.5.4"
 sha2 = "0.10.8"
 phf = { version = "0.11.3", features = ["macros"] }
-strum = "0.27.0"
+strum = "0.27.1"
 strum_macros = "0.27.0"
 secrecy = "0.10.3"
 aes-gcm = "0.10.3"
-clap = "4.5.29"
+clap = "4.5.35"
 regex = "1.11.1"
 mime_guess = "2.0.5"
-flate2 = "1.0.35"
+flate2 = "1.1.1"
 encoding_rs = "0.8.35"
 difference = "2.0.0"
 rpassword = "7.3.1"
 validator = "0.20.0"
-uuid = { version = "1.13.1", features = ["v4", "v7", "js"] }
-env_logger = "0.11.6"
+uuid = { version = "1.16.0", features = ["v4", "v7", "js"] }
+env_logger = "0.11.8"
 futures-util = "0.3.31"
-referencing = "0.29.0"
+referencing = "0.29.1"
+futures-executor = "0.3.31"
+# libp2p = "0.55.0"
 # [target.'cfg(target_os = "macos")'.dependencies]
 # pqcrypto-mldsa = { version = "0.1", default-features = false, features = ["serialization"] }
 
@@ -81,7 +84,7 @@ referencing = "0.29.0"
 [dev-dependencies]
 color-eyre = "0.6"
 criterion = "0.5.1"
-mdbook = "0.4.44"
+mdbook = "0.4.48"
 
 
 [lib]
@@ -94,10 +97,11 @@ pqcrypto-traits = "0.3.5"
 ring = "0.17.9"
 reqwest = {  version ="0.12.12", features = ["blocking", "json"] }
 walkdir = "2.5.0"
-object_store = { version ="0.11.2", features = ["serde","serde_json", "aws", "http"] }
+object_store = { version ="0.12.0", features = ["serde","serde_json", "aws", "http"] }
 
  [target.'cfg(target_arch = "wasm32")'.dependencies]
  wasm-bindgen = "0.2.100"
+ web-sys = { version = "0.3", features = ["Storage", "Window"] }
 
 [[bin]]
 name = "jacs"

LICENSE

@@ -1,5 +1,28 @@
+“Commons Clause” License Condition v1.0
 
-            Copyright 2024 Human Assisted Intelligence, LLC
+Software: JACS
+License: Apache 2.0
+Licensor: Human Assisted Intelligence, LLC
+Link: https://commonsclause.com/  
+
+The Software is provided to you by the Licensor under the License, 
+as defined below, subject to the following condition.
+
+Without limiting other conditions in the License, the grant of rights 
+under the License will not include, and the License does not grant 
+to you, the right to Sell the Software.
+
+For purposes of the foregoing, “Sell” means practicing any or all of 
+the rights granted to you under the License to provide to third parties, 
+for a fee or other consideration (including without limitation fees for 
+hosting or consulting/ support services related to the Software), 
+a product or service whose value derives, entirely or substantially, 
+from the functionality of the Software. Any license notice or attribution 
+required by the License must also include this Commons Clause License
+ Condition notice.
+
+
+            Copyright 2024, 2025 Human Assisted Intelligence, LLC
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

README.md

@@ -4,7 +4,7 @@ Welcome to JACS (JSON Agent Communication Standard), a verifiable document forma
 
 JACS documents enable more trusted data sharing between AI agents and Human UIs.
 
-** NOTE: Current version 0.3.0 *ALPHA* .
+** NOTE: Current version 0.3.2 *ALPHA* .
 
 JACS is a JSON document format for creating secure, verifiable documents that AI agents, ML pipelines, SaaS services, and UIs can exchange and process. The goal of JACS is to ensure that these documents remain unchanged (immutable), produce the same verification result every time (idempotent), and can be used flexibly by software.
 
@@ -14,6 +14,8 @@ JACS also provides standardization for agreement between agents. While each docu
 
 Use JACS as is, embed in other projects or libraries, commercial or otherwise.
 
+ Please note that the [license][./LICENSE] is *modified* Apache 2.0, with the [Common Clause](https://commonsclause.com/) preamble. In simple terms, unless you are competing with HAI.AI, you can create commercial products with JACS. 
+
 ## Basic use cases
 
   1. version json documents and test against a schema

benches/sign_and_check_sig.rs

@@ -6,27 +6,32 @@ use jacs::agent::Agent;
 use log::debug;
 
 use jacs::agent::DOCUMENT_AGENT_SIGNATURE_FIELDNAME;
+use jacs::storage::jenv::set_env_var;
 use rand::Rng;
 use std::env;
 
 static BENCH_SAMPLE_SIZE: usize = 100;
 
 fn set_enc_to_ring() {
-    env::set_var(
+    set_env_var(
         "JACS_AGENT_PRIVATE_KEY_FILENAME",
         "test-ring-Ed25519-private.pem",
-    );
-    env::set_var(
+    )
+    .expect("Failed to set private key filename");
+    set_env_var(
         "JACS_AGENT_PUBLIC_KEY_FILENAME",
         "test-ring-Ed25519-public.pem",
-    );
-    env::set_var("JACS_AGENT_KEY_ALGORITHM", "ring-Ed25519");
+    )
+    .expect("Failed to set public key filename");
+    set_env_var("JACS_AGENT_KEY_ALGORITHM", "ring-Ed25519").expect("Failed to set key algorithm");
 }
 
 fn set_enc_to_pq() {
-    env::set_var("JACS_AGENT_PRIVATE_KEY_FILENAME", "test-pq-private.pem");
-    env::set_var("JACS_AGENT_PUBLIC_KEY_FILENAME", "test-pq-public.pem");
-    env::set_var("JACS_AGENT_KEY_ALGORITHM", "pq-dilithium");
+    set_env_var("JACS_AGENT_PRIVATE_KEY_FILENAME", "test-pq-private.pem")
+        .expect("Failed to set private key filename");
+    set_env_var("JACS_AGENT_PUBLIC_KEY_FILENAME", "test-pq-public.pem")
+        .expect("Failed to set public key filename");
+    set_env_var("JACS_AGENT_KEY_ALGORITHM", "pq-dilithium").expect("Failed to set key algorithm");
 }
 
 fn load_test_agent_one() -> Agent {

docs/schema/jacs-properties-jacs_default_storage.md

@@ -0,0 +1,25 @@
+# Untitled string in Config Schema
+
+```txt
+https://hai.ai/schemas/jacs.config.schema.json#/properties/jacs_default_storage
+```
+
+default storage to use
+
+| Abstract            | Extensible | Status         | Identifiable            | Custom Properties | Additional Properties | Access Restrictions | Defined In                                                                                |
+| :------------------ | :--------- | :------------- | :---------------------- | :---------------- | :-------------------- | :------------------ | :---------------------------------------------------------------------------------------- |
+| Can be instantiated | No         | Unknown status | Unknown identifiability | Forbidden         | Allowed               | none                | [jacs.config.schema.json\*](../../schemas/jacs.config.schema.json "open original schema") |
+
+## jacs\_default\_storage Type
+
+`string`
+
+## jacs\_default\_storage Constraints
+
+**enum**: the value of this property must be equal to one of the following values:
+
+| Value   | Explanation |
+| :------ | :---------- |
+| `"fs"`  |             |
+| `"aws"` |             |
+| `"hai"` |             |

docs/schema/jacs.md

@@ -29,6 +29,7 @@ Jacs Configuration File
 | [jacs\_header\_schema\_version](#jacs_header_schema_version)            | `string` | Optional | cannot be null | [Config](jacs-properties-jacs_header_schema_version.md "https://hai.ai/schemas/jacs.config.schema.json#/properties/jacs_header_schema_version")           |
 | [jacs\_signature\_schema\_version](#jacs_signature_schema_version)      | `string` | Optional | cannot be null | [Config](jacs-properties-jacs_signature_schema_version.md "https://hai.ai/schemas/jacs.config.schema.json#/properties/jacs_signature_schema_version")     |
 | [jacs\_private\_key\_password](#jacs_private_key_password)              | `string` | Optional | cannot be null | [Config](jacs-properties-jacs_private_key_password.md "https://hai.ai/schemas/jacs.config.schema.json#/properties/jacs_private_key_password")             |
+| [jacs\_default\_storage](#jacs_default_storage)                         | `string` | Required | cannot be null | [Config](jacs-properties-jacs_default_storage.md "https://hai.ai/schemas/jacs.config.schema.json#/properties/jacs_default_storage")                       |
 
 ## jacs\_use\_filesystem
 
@@ -237,3 +238,31 @@ encryption password. Do not use in production and instead only keep in ENV with
 ### jacs\_private\_key\_password Type
 
 `string`
+
+## jacs\_default\_storage
+
+default storage to use
+
+`jacs_default_storage`
+
+*   is required
+
+*   Type: `string`
+
+*   cannot be null
+
+*   defined in: [Config](jacs-properties-jacs_default_storage.md "https://hai.ai/schemas/jacs.config.schema.json#/properties/jacs_default_storage")
+
+### jacs\_default\_storage Type
+
+`string`
+
+### jacs\_default\_storage Constraints
+
+**enum**: the value of this property must be equal to one of the following values:
+
+| Value   | Explanation |
+| :------ | :---------- |
+| `"fs"`  |             |
+| `"aws"` |             |
+| `"hai"` |             |

examples/documents/002a2ed6-2eec-4325-9072-a8612b3ae697:470ba1a2-8d91-4066-b9f5-2ba91b83122a

@@ -0,0 +1,46 @@
+{
+  "$schema": "https://hai.ai/schemas/header/v1/header.schema.json",
+  "description": "We should embed an xml document here",
+  "jacsFiles": [
+    {
+      "embed": false,
+      "mimetype": "text/xml",
+      "path": "raw/plants.xml",
+      "sha256": "8615f88410eeafb38e2c386ed9dbae8fadf3d4d0e50a8dc43c4287246f104311"
+    },
+    {
+      "embed": false,
+      "mimetype": "text/xml",
+      "path": "raw/breakfast.xml",
+      "sha256": "71ae785d2f68d8b818da97171013033a5bfc632b6cad7d286e8e1907e023d0dd"
+    }
+  ],
+  "jacsId": "002a2ed6-2eec-4325-9072-a8612b3ae697",
+  "jacsLevel": "raw",
+  "jacsOriginalDate": "2025-02-17T23:58:00.976546+00:00",
+  "jacsOriginalVersion": "470ba1a2-8d91-4066-b9f5-2ba91b83122a",
+  "jacsSha256": "91590db6b2debaa3d459b02c51778538ba6078c7a99ff2ef882f078104eaa794",
+  "jacsSignature": {
+    "agentID": "ddf35096-d212-4ca9-a299-feda597d5525",
+    "agentVersion": "b57d480f-b8d4-46e7-9d7c-942f2b132717",
+    "date": "2025-02-17T23:58:01.332675+00:00",
+    "fields": [
+      "$schema",
+      "description",
+      "jacsFiles",
+      "jacsId",
+      "jacsLevel",
+      "jacsOriginalDate",
+      "jacsOriginalVersion",
+      "jacsType",
+      "jacsVersion",
+      "jacsVersionDate"
+    ],
+    "publicKeyHash": "2c9cc6361e2003173df86b9c267b3891193319da7fe7c6f42cb0fbe5b30d7c0d",
+    "signature": "E4tGYMCPNM/ii01CUC+hywJzza694O20ODFW3NAYx7OaPJlTsFVyJ56i7NTY/hFotYqLm68zAmpGTL/vhlXhlelMHOVVsJa03+oXGj71a6scwBQdaEMasAMNsAKsEEQn27J6yux7CNtAI7jJtAcOoAc5OhOgLeXBArN2Uq9L7ahYzW5EsvQmIKMPNHx5EdFdOCol1kpYcYexe3JuzhkITAGk/hGAbKyAc6qyFHesKb4SsH4xHJJjWAJFr4UIc1Ege+TOCamRFD0npKuSc+hPcgUn/RFBZFfW7dlLcFbD+VlIc//mLGMlt0I07LCFIxkj/4JjbxEUGIo8XT1lDoCa/xWGzBb4wAhkrjkHfv7aMIrHSVgTqE5Kch7esDudx5e+N4bYX7f3vaOXlu2InpKw0j6KD2UZGYXdmr4KOBipyulH9dWyx/TYbGFbaNC1f+/83hei9kEPsH6BgIdCiax5CHo3n8Gs2rr5yqMDbs+YbEfcMYyQQtF1Ee4Gr1wAO6XEXU1cdlA9Tm6Fh4nFg3uuLgN1E3mSOZZGTdBA1i4mVzBE9Dum4MuGCnm4Xb4cuFTxhD8K5PRv1PPuGa3qsq8u/vTZTDLnH1WwquGHXhv7TX+yed1jQBiRKAoLhavEhVHGCdZTEILlubxvgPLPMK6kULavPEusWePydUJbzolam/Y=",
+    "signingAlgorithm": "RSA-PSS"
+  },
+  "jacsType": "header",
+  "jacsVersion": "470ba1a2-8d91-4066-b9f5-2ba91b83122a",
+  "jacsVersionDate": "2025-02-17T23:58:00.976546+00:00"
+}

examples/documents/10246cd3-5824-4b31-8340-224f22b801d6:ddcd1726-582b-4bce-ab7f-74d42ccb3273

@@ -0,0 +1,46 @@
+{
+  "$schema": "https://hai.ai/schemas/header/v1/header.schema.json",
+  "description": "We should embed an xml document here",
+  "jacsFiles": [
+    {
+      "embed": false,
+      "mimetype": "text/xml",
+      "path": "raw/plants.xml",
+      "sha256": "8615f88410eeafb38e2c386ed9dbae8fadf3d4d0e50a8dc43c4287246f104311"
+    },
+    {
+      "embed": false,
+      "mimetype": "text/xml",
+      "path": "raw/breakfast.xml",
+      "sha256": "71ae785d2f68d8b818da97171013033a5bfc632b6cad7d286e8e1907e023d0dd"
+    }
+  ],
+  "jacsId": "10246cd3-5824-4b31-8340-224f22b801d6",
+  "jacsLevel": "raw",
+  "jacsOriginalDate": "2025-02-17T10:28:03.504197+00:00",
+  "jacsOriginalVersion": "ddcd1726-582b-4bce-ab7f-74d42ccb3273",
+  "jacsSha256": "6f30af9349d5063a61e3b3ae0c78ffcfc8bc2ee55a282268b87ef3bcf8ddd6b3",
+  "jacsSignature": {
+    "agentID": "ddf35096-d212-4ca9-a299-feda597d5525",
+    "agentVersion": "b57d480f-b8d4-46e7-9d7c-942f2b132717",
+    "date": "2025-02-17T10:28:03.868565+00:00",
+    "fields": [
+      "$schema",
+      "description",
+      "jacsFiles",
+      "jacsId",
+      "jacsLevel",
+      "jacsOriginalDate",
+      "jacsOriginalVersion",
+      "jacsType",
+      "jacsVersion",
+      "jacsVersionDate"
+    ],
+    "publicKeyHash": "2c9cc6361e2003173df86b9c267b3891193319da7fe7c6f42cb0fbe5b30d7c0d",
+    "signature": "fYlqwrHCSt+5AhPqKa+tybqNY7Rhv5hrDv+tnQ24prMzQAFHZ7vIutgxeWoTDt4vC0KQm4euhLnEzSAXYEBBR4DpkCcFCzehocriX7nf0xiPWLpaOwnvNPBI+Xr2x9NQ1su6f0wJWD32KMFqQI/mwYi56OzdjU9ZXZ2yAk5HueScD551VnE1/+sGsTPeGX+eilSRZC4RV+BywkUiBIW6sVFSTcbHxvPaMoJUjX3Jf892wBPk4bKBsFbKJJ0JwzoOqQyeAYdM88viqv6P4wYeGMDDHMkjM+ThRSURaL0QoSuWpccfwZTBi+hRyth3O8KTcSKTJiXr4Ey/mrzjxLv9aLcA4iUGNEvI2dRM96id7y3b8CdVA9e7/KCu1upSI2N7/lT/D9sSG2NC6/RpW3lS4MbNrtiyFxBDO78/9+eQ9oSN0AskUacwSiPaKiJUTZmQrnGonmjSPqzGGDM6f7FVoF4nfdr3kjr8p/3C6RZwobYfre3UBfnyZLKoixn/zCCzd1nXJinnr4Xp8wW0v1gDAeM3m2PCDVU++CKeCuD0M3fDheLt2kOlp/BrGbFZXsSBHgNDkORlbuUqpvoFH62lri/nGpU54C0pfTOOQ8ECZh0pCWlz4Z5vhsvZ8N/+SjkBk6XwxSHKahbuWby0ayeYsYYJNgAb2sqH3KiEXGaa8Fc=",
+    "signingAlgorithm": "RSA-PSS"
+  },
+  "jacsType": "header",
+  "jacsVersion": "ddcd1726-582b-4bce-ab7f-74d42ccb3273",
+  "jacsVersionDate": "2025-02-17T10:28:03.504197+00:00"
+}