Two new kli utilities and a minor improvement to IPEX grant messages

.github/workflows/python-app-ci.yml

@@ -16,14 +16,27 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ macos-13, ubuntu-latest, windows-latest ]
+        os: [ macos-latest, ubuntu-latest, windows-latest ]
 
     steps:
-      - uses: actions/checkout@v3
-      - name: Set up Python 3.12.6
-        uses: actions/setup-python@v2
+      - uses: actions/checkout@v4
+      - name: Set up Python 3.12.6+
+        uses: actions/setup-python@v5
         with:
-          python-version: 3.12.6
+          python-version: '>=3.12.6'
+
+      - name: Install libsodium (macOS)
+        if: runner.os == 'macOS'
+        run: |
+          brew update
+          brew install libsodium
+
+      - name: Make libsodium discoverable
+        if: runner.os == 'macOS'
+        run: |
+          echo "DYLD_FALLBACK_LIBRARY_PATH=$(brew --prefix)/lib:/usr/local/lib:/usr/lib" >> "$GITHUB_ENV"
+          echo "DYLD_LIBRARY_PATH=$(brew --prefix)/lib" >> "$GITHUB_ENV"
+
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
@@ -50,10 +63,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-      - name: Set up Python 3.12.6
+      - name: Set up Python 3.12.6+
         uses: actions/setup-python@v2
         with:
-          python-version: 3.12.6
+          python-version: '>=3.12.6'
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
@@ -71,10 +84,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v3
-      - name: Set up Python 3.12.6
+      - name: Set up Python 3.12.6+
         uses: actions/setup-python@v2
         with:
-          python-version: 3.12.6
+          python-version: '>=3.12.6'
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
@@ -117,4 +130,4 @@ jobs:
           docker tag ${{ env.GITHUB_REPOSITORY_NAME }}/keripy-interop:${{ env.CACHE_KEY_INTEROP }} ghcr.io/${{ env.GITHUB_REPOSITORY_NAME }}/keripy-interop:latest
           docker push ghcr.io/${{ env.GITHUB_REPOSITORY_NAME }}/keripy-interop:latest
           mkdir -p ${GITHUB_WORKSPACE}/cache
-          touch ${GITHUB_WORKSPACE}/cache/${{ env.CACHE_KEY_INTEROP }}
+          touch ${GITHUB_WORKSPACE}/cache/${{ env.CACHE_KEY_INTEROP }}

setup.py

@@ -84,7 +84,7 @@
                         'multidict>=6.0.5',
                         'ordered-set>=4.1.0',
                         'hio>=0.6.19',
-                        'multicommand>=1.0.0',
+                        'multicommand==1.0.0',
                         'jsonschema>=4.21.1',
                         'falcon>=3.1.3',
                         'hjson>=3.1.0',

src/keri/app/cli/commands/delete.py

@@ -0,0 +1,74 @@
+# -*- encoding: utf-8 -*-
+"""
+KERI
+keri.kli.commands module
+
+"""
+import argparse
+
+from hio.base import doing
+
+from keri import help
+from keri.app.cli.common import existing
+from keri.db.dbing import dgKey, snKey
+
+logger = help.ogler.getLogger()
+
+parser = argparse.ArgumentParser(description='Remove an AID from the database')
+parser.set_defaults(handler=lambda args: handler(args),
+                    transferable=True)
+parser.add_argument('--name', '-n', help='keystore name and file location of KERI keystore', required=True)
+parser.add_argument('--base', '-b', help='additional optional prefix to file location of KERI keystore',
+                    required=False, default="")
+parser.add_argument('--prefix', help='qb64 identifier prefix to display', required=True)
+parser.add_argument('--passcode', '-p', help='21 character encryption passcode for keystore (is not saved)',
+                    dest="bran", default=None)  # passcode => bran
+
+
+def handler(args):
+    kever = DeleteDoer(name=args.name, base=args.base, bran=args.bran, prefix=args.prefix)
+    return [kever]
+
+
+class DeleteDoer(doing.Doer):
+
+    def __init__(self, name, base, bran, prefix, poll=False, verbose=False):
+        self.prefix = prefix
+        self.poll = poll
+        self.verbose = verbose
+        self.hby = existing.setupHby(name=name, base=base, bran=bran)
+        super(DeleteDoer, self).__init__()
+
+    def recur(self, tyme):
+        """ Command line status handler
+
+        """
+        preb = self.prefix.encode("utf-8")
+
+        if self.prefix not in self.hby.kevers:
+            print(f"Identifier prefix {self.prefix} is not known locally")
+            return True
+
+        count = 0
+        for _, fn, dig in self.hby.db.getFelItemPreIter(self.prefix):
+            dgkeys = (self.prefix, dig)
+            dgkey = dgKey(preb, dig)
+
+            self.hby.db.delEvt(dgkey)
+            self.hby.db.delWigs(dgkey)
+            self.hby.db.delSigs(dgkey)
+            self.hby.db.delDts(dgkey)
+            self.hby.db.wits.rem(keys=dgkeys)
+            self.hby.db.delKes(dgkey)
+            self.hby.db.delAes(dgkey)
+            self.hby.db.esrs.rem(dgkeys)
+            self.hby.db.fons.rem(dgkey)
+            count += 1
+
+        for sn in range(count):
+            self.hby.db.delKes(snKey(preb, sn))
+            self.hby.db.delFe(snKey(preb, sn))
+
+        self.hby.db.states.rem(keys=self.prefix)
+
+        return True

src/keri/app/cli/commands/vc/create.py

@@ -218,8 +218,6 @@ def createDo(self, tymth, tock=0.0, **kwa):
         dt = self.creder.attrib["dt"] if "dt" in self.creder.attrib else helping.nowIso8601()
         iserder = registry.issue(said=self.creder.said, dt=dt)
 
-        #vcid = iserder.ked["i"]
-        #rseq = coring.Seqner(snh=iserder.ked["s"])
         rseal = eventing.SealEvent(iserder.pre, iserder.snh, iserder.said)
         rseal = dict(i=rseal.i, s=rseal.s, d=rseal.d)
 

src/keri/app/cli/commands/vc/schema/__init__.py

@@ -0,0 +1,6 @@
+# -*- encoding: utf-8 -*-
+"""
+KERI
+keri.kli.commands.vc.schema module
+
+"""

src/keri/app/cli/commands/vc/schema/import.py

@@ -0,0 +1,85 @@
+# -*- encoding: utf-8 -*-
+"""
+KERI
+keri.kli.commands.vc.schema module
+
+"""
+import argparse
+import json
+
+from hio.base import doing
+
+from keri import help, kering
+from keri.app.cli.common import existing
+from keri.core import scheming
+
+logger = help.ogler.getLogger()
+
+parser = argparse.ArgumentParser(description='Import ACDC JSON schema file into the schema database')
+parser.set_defaults(handler=lambda args: import_schema(args))
+parser.add_argument('--name', '-n', help='keystore name and file location of KERI keystore', required=True)
+parser.add_argument('--base', '-b', help='additional optional prefix to file location of KERI keystore',
+                    required=False, default="")
+parser.add_argument('--passcode', '-p', help='21 character encryption passcode for keystore (is not saved)',
+                    dest="bran", default=None)  # passcode => bran
+parser.add_argument('--schema', '-s', help='path to ACDC JSON schema file to import', required=True)
+
+
+def import_schema(args):
+    """ Command line handler for importing ACDC JSON schema files
+
+    """
+    idoer = ImportDoer(name=args.name,
+                    base=args.base,
+                    bran=args.bran,
+                    schema=args.schema)
+    return [idoer]
+
+
+class ImportDoer(doing.DoDoer):
+
+    def __init__(self, name, base, bran, schema):
+        self.schemaPath = schema
+        self.hby = existing.setupHby(name=name, base=base, bran=bran)
+
+        doers = [doing.doify(self.importDo)]
+
+        super(ImportDoer, self).__init__(doers=doers)
+
+    def importDo(self, tymth, tock=0.0, **kwa):
+        """ Import ACDC JSON schema file into the schema database
+
+        Parameters:
+            tymth (function): injected function wrapper closure returned by .tymen() of
+                Tymist instance. Calling tymth() returns associated Tymist .tyme.
+            tock (float): injected initial tock value
+
+        Returns:  doifiable Doist compatible generator method
+
+        """
+        # enter context
+        self.wind(tymth)
+        self.tock = tock
+        _ = (yield self.tock)
+
+        try:
+            # Read the schema file
+            with open(self.schemaPath, 'rb') as f:
+                raw = f.read()
+
+            # Create Schemer instance which validates the schema
+            schemer = scheming.Schemer(raw=raw)
+
+            # Store the schema in the database
+            self.hby.db.schema.pin(keys=(schemer.said,), val=schemer)
+
+            print(f"Schema successfully imported with SAID: {schemer.said}")
+
+        except FileNotFoundError:
+            raise kering.ConfigurationError(f"Schema file not found: {self.schemaPath}")
+        except json.JSONDecodeError as e:
+            raise kering.ConfigurationError(f"Invalid JSON in schema file: {e}")
+        except kering.ValidationError as e:
+            raise kering.ConfigurationError(f"Schema validation failed: {e}")
+        except Exception as e:
+            raise kering.ConfigurationError(f"Error importing schema: {e}")

src/keri/vc/protocoling.py

@@ -219,14 +219,15 @@ def ipexAgreeExn(hab, message, offer):
     return exn, ims
 
 
-def ipexGrantExn(hab, recp, message, acdc, iss=None, anc=None, agree=None, dt=None):
+def ipexGrantExn(hab, recp, message, acdc, reg=None, iss=None, anc=None, agree=None, dt=None):
     """ Disclose an ACDC
 
     Parameters:
         hab(Hab): identifier environment for issuer of credential
         recp (str) qb64 AID of recipient of GRANT message
         message(str): Human readable message regarding the credential disclosure
         acdc (bytes): CESR stream of serialized ACDC with attachments
+        reg (bytes): serialized TEL registry event
         iss (bytes): serialized TEL issuance event
         anc (bytes): serialized anchoring event in the KEL, either ixn or rot
         agree (Serder): optional IPEX exn agree message that this grant is response to.
@@ -246,6 +247,9 @@ def ipexGrantExn(hab, recp, message, acdc, iss=None, anc=None, agree=None, dt=No
         acdc=acdc,
     )
 
+    if reg is not None:
+        embeds['reg'] = reg
+
     if iss is not None:
         embeds['iss'] = iss
 

src/keri/vdr/credentialing.py

@@ -561,6 +561,7 @@ def issue(self, creder, iserder, anc):
         if not isinstance(hab, GroupHab):  # not a multisig group
             seqner = coring.Seqner(sn=hab.kever.sner.num)
             saider = coring.Saider(qb64=hab.kever.serder.said)
+            # Key is credential SAID and TEL event SAID
             registry.anchorMsg(pre=vcid, regd=iserder.said, seqner=seqner, saider=saider)
 
             print("Waiting for TEL event witness receipts")

src/keri/vdr/viring.py

@@ -17,7 +17,6 @@
 from ..app import signing
 from ..core import coring, serdering, indexing, counting
 from ..db import dbing, basing
-from ..db.dbing import snKey
 from ..vdr import eventing
 from .. import help