feat (core): Activate in CLI & document new ?integrity=... generic UR…

…L query parameter
enola-dev · Jan 4, 2025 · fb8abcd · fb8abcd
1 parent 65a9bdd
commit fb8abcd
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 9 deletions.
diff --git a/docs/use/fetch/index.md b/docs/use/fetch/index.md
@@ -170,11 +170,29 @@ the Charset from the Media Type (if any) or any HTTP header like mechanisms.
 
 ### Integrity
 
-TODO We plan
-to support `?integrity=...`
-to verify resource integrity via a [cryptographic digest ("hash")])(https://docs.ipfs.tech/concepts/hashing/)
-using a [Multiformats's Multibase encoded Multihash](https://www.multiformats.io).
-This is similar e.g. to [HTML's Subresource Integrity (SRI)](https://developer.mozilla.org/en-US/docs/Web/Security/Subresource_Integrity).
+Add `?integrity=...` verifies resource integrity via a [cryptographic digest ("hash")])(https://docs.ipfs.tech/concepts/hashing/)
+using a [Multiformats's Multibase encoded Multihash](https://www.multiformats.io), this works for all schemes:
+(Similarly e.g. to [HTML's Subresource Integrity (SRI)](https://developer.mozilla.org/en-US/docs/Web/Security/Subresource_Integrity).)
+
+```bash cd ../.././..
+$ ./enola fetch "/tmp/hi.txt?integrity=z8VxiEEn4n7uuGrVQjeoH2KYypytUHttCubqN7rr65xSH3wjLDjHciXuTyTHkoRuJT1Njghj68RQdynADQt9vzLgyEs"
+...
+```
+
+or:
+
+```bash cd ../.././..
+$ ./enola fetch --http-scheme "https://www.vorburger.ch/hello.md?integrity=z8VttgvnrXN5ZzqAh8BLwyup7htUmSM9gbKR445teEECTwMRDQTireiWgWauLiZ4Xr5esrqbVFNbAuAM2XyZ4CTxU7N"
+...
+```
+
+In order to find the expected Multibase encoded Multihash,
+it's simplest to once use a wrong one, and then replace it with the correct one shown by the error message:
+
+```bash $? cd ../.././..
+$ ./enola fetch --http-scheme "https://www.vorburger.ch/hello.md?integrity=z8VsnXyGnRwJpnrQXB8KcLstvgFYGZ2f5BCm3DVndcNZ8NswtkCqsut69e7yd1FKNtettjgy669GNVt8VSTGxkAiJaB"
+...
+```
 
 <!-- TODO ?cache from OptionalCachingResourceProvider (current un-used) -->
 

diff --git a/java/dev/enola/cli/CommandWithResourceProvider.java b/java/dev/enola/cli/CommandWithResourceProvider.java
@@ -22,6 +22,7 @@
 
 import dev.enola.common.context.Context;
 import dev.enola.common.function.CheckedRunnable;
+import dev.enola.common.io.hashbrown.IntegrityValidatingDelegatingResource;
 import dev.enola.common.io.iri.URIs;
 import dev.enola.common.io.iri.namespace.NamespaceConverter;
 import dev.enola.common.io.iri.namespace.NamespaceConverterWithRepository;
@@ -106,7 +107,9 @@ public void run() throws Exception {
         }
         if (test) builder.add(new TestResource.Provider());
         if (classpath) builder.add(new ClasspathResource.Provider());
-        rp = new ResourceProviders(builder.build());
+
+        var original = new ResourceProviders(builder.build());
+        rp = new IntegrityValidatingDelegatingResource.Provider(original);
     }
 
     protected void setup(Context ctx) {

diff --git a/java/dev/enola/common/io/hashbrown/IntegrityValidatingDelegatingResource.java b/java/dev/enola/common/io/hashbrown/IntegrityValidatingDelegatingResource.java
@@ -93,7 +93,6 @@ private synchronized void validate() {
         var actualBytes = hashCode.asBytes();
         var actualHash = expectedHash.copy(actualBytes);
 
-        // TODO It would be useful if Multihash had an equalsTo() method to avoid byte array copy
         if (!expectedHash.equals(actualHash)) {
             throw new IntegrityViolationException(
                     "Expected " + expectedHash + " but got " + actualHash);

diff --git a/java/dev/enola/common/io/hashbrown/MultihashWithMultibase.java b/java/dev/enola/common/io/hashbrown/MultihashWithMultibase.java
@@ -67,8 +67,6 @@ public int hashCode() {
         return Objects.hash(multihash, multibase);
     }
 
-    // TODO equals & hashCode
-
     @Override
     public String toString() {
         return Multihashes.toString(multihash, multibase);