keri 1.2.0.dev1__tar.gz → 1.2.0.dev2__tar.gz

{keri-1.2.0.dev1/src/keri.egg-info → keri-1.2.0.dev2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: keri
-Version: 1.2.0.dev1
+Version: 1.2.0.dev2
 Summary: Key Event Receipt Infrastructure
 Home-page: https://github.com/WebOfTrust/keripy
 Author: Samuel M. Smith

{keri-1.2.0.dev1 → keri-1.2.0.dev2}/setup.py

@@ -37,7 +37,7 @@ from os.path import splitext
 from setuptools import find_packages, setup
 setup(
     name='keri',
-    version='1.2.0-dev1',  # also change in src/keri/__init__.py
+    version='1.2.0-dev2',  # also change in src/keri/__init__.py
     license='Apache Software License 2.0',
     description='Key Event Receipt Infrastructure',
     long_description="KERI Decentralized Key Management Infrastructure",

keri-1.2.0.dev2/src/keri/__init__.py

@@ -0,0 +1,5 @@
+# -*- encoding: utf-8 -*-
+
+__version__ = '1.2.0-dev2'  # also change in setup.py
+
+

{keri-1.2.0.dev1 → keri-1.2.0.dev2}/src/keri/app/cli/commands/ipex/agree.py

@@ -7,7 +7,7 @@ import argparse
 
 from hio.base import doing
 
-from keri.core import coring
+from keri.core import signing
 
 parser = argparse.ArgumentParser(description='Reply to IPEX offer message acknowledged willingness to accept offered '
                                              'credential')
@@ -23,4 +23,4 @@ def nonce(tymth, tock=0.0):
     """
     _ = (yield tock)
 
-    print(coring.randomNonce())
+    print(signing.Salter().qb64)

{keri-1.2.0.dev1 → keri-1.2.0.dev2}/src/keri/app/cli/commands/ipex/apply.py

@@ -7,7 +7,7 @@ import argparse
 
 from hio.base import doing
 
-from keri.core import coring
+from keri.core import signing
 
 parser = argparse.ArgumentParser(description='Request a credential from another party by initiating an IPEX exchange')
 parser.set_defaults(handler=lambda args: handler(args))
@@ -22,4 +22,4 @@ def nonce(tymth, tock=0.0):
     """
     _ = (yield tock)
 
-    print(coring.randomNonce())
+    print(signing.Salter().qb64)

{keri-1.2.0.dev1 → keri-1.2.0.dev2}/src/keri/app/cli/commands/ipex/list.py

@@ -8,6 +8,7 @@ keri.kli.commands module
 import argparse
 import datetime
 import os
+import json
 import sys
 
 from hio import help
@@ -199,6 +200,12 @@ class ListDoer(doing.DoDoer):
         if response is not None:
             print(f"    Response: {responseType} ({response.qb64})")
 
+        if self.verbose:
+            bsad = json.dumps(sad, indent=2)
+            print("    Full Credential:")
+            for line in bsad.splitlines():
+                print(f"\t{line}")
+
     def apply(self, note, exn, pathed):
         pass
 

{keri-1.2.0.dev1 → keri-1.2.0.dev2}/src/keri/app/cli/commands/ipex/offer.py

@@ -7,7 +7,7 @@ import argparse
 
 from hio.base import doing
 
-from keri.core import coring
+from keri.core import signing
 
 parser = argparse.ArgumentParser(description='Reply to IPEX apply message or initiate an IPEX exchange with an offer'
                                              ' for a credential with certain characteristics')
@@ -23,4 +23,4 @@ def nonce(tymth, tock=0.0):
     """
     _ = (yield tock)
 
-    print(coring.randomNonce())
+    print(signing.Salter().qb64)

{keri-1.2.0.dev1 → keri-1.2.0.dev2}/src/keri/app/cli/commands/nonce.py

@@ -8,7 +8,7 @@ import argparse
 import pysodium
 from hio.base import doing
 
-from keri.core import coring
+from keri.core import signing
 
 parser = argparse.ArgumentParser(description='Print a new random nonce')
 parser.set_defaults(handler=lambda args: handler(args))
@@ -23,4 +23,4 @@ def nonce(tymth, tock=0.0):
     """
     _ = (yield tock)
 
-    print(coring.randomNonce())
+    print(signing.Salter().qb64)

keri-1.2.0.dev2/src/keri/app/cli/commands/watcher/__init__.py

@@ -0,0 +1,6 @@
+# -*- encoding: utf-8 -*-
+"""
+KERI
+keri.app.cli.commands.watcher Package
+"""
+

keri-1.2.0.dev2/src/keri/app/cli/commands/watcher/add.py

@@ -0,0 +1,132 @@
+# -*- encoding: utf-8 -*-
+"""
+KERI
+keri.kli.commands module
+
+"""
+import argparse
+
+from hio import help
+from hio.base import doing
+
+from keri.app import connecting, habbing, forwarding
+from keri.app.cli.common import existing
+from keri.core import eventing, serdering
+
+logger = help.ogler.getLogger()
+
+parser = argparse.ArgumentParser(description='Add AID or Alias to list of AIDs for a watcher to watch')
+parser.set_defaults(handler=lambda args: add(args),
+                    transferable=True)
+parser.add_argument('--name', '-n', help='keystore name and file location of KERI keystore', required=True)
+parser.add_argument('--alias', '-a', help='human readable alias for the identifier to whom the credential was issued',
+                    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='22 character encryption passcode for keystore (is not saved)',
+                    dest="bran", default=None)  # passcode => bran
+parser.add_argument("--watcher", '-w', help="the watcher AID or alias to add to", required=True)
+parser.add_argument("--watched", '-W', help="the watched AID or alias to add")
+
+
+def add(args):
+    """ Command line handler for adding an aid to a watcher's list of AIds to watch
+
+    Parameters:
+        args(Namespace): parsed command line arguments
+
+    """
+
+    ed = AddDoer(name=args.name,
+                 alias=args.alias,
+                 base=args.base,
+                 bran=args.bran,
+                 watcher=args.watcher,
+                 watched=args.watched)
+    return [ed]
+
+
+class AddDoer(doing.DoDoer):
+
+    def __init__(self, name, alias, base, bran, watcher, watched):
+        self.hby = existing.setupHby(name=name, base=base, bran=bran)
+        self.hab = self.hby.habByName(alias)
+        self.org = connecting.Organizer(hby=self.hby)
+
+        if watcher in self.hby.kevers:
+            wat = watcher
+        else:
+            wat = self.org.find("alias", watcher)
+            if len(wat) != 1:
+                raise ValueError(f"invalid recipient {watcher}")
+            wat = wat[0]['id']
+
+        if not wat:
+            raise ValueError(f"unknown watcher {watcher}")
+
+        if watched in self.hby.kevers:
+            watd = watched
+        else:
+            watd = self.org.find("alias", watched)
+            if len(watd) != 1:
+                raise ValueError(f"invalid recipient {watched}")
+            watd = watd[0]['id']
+
+        if not watd:
+            raise ValueError(f"unknown watched {watched}")
+
+        self.watcher = wat
+        self.watched = watd
+
+        self.oobi = None
+        for (key,), obr in self.hby.db.roobi.getItemIter():
+            if obr.cid == watd:
+                self.oobi = key
+
+        if not self.oobi:
+            raise ValueError(f"no valid oobi for watched {self.watched}")
+
+        doers = [doing.doify(self.addDo)]
+
+        super(AddDoer, self).__init__(doers=doers)
+
+    def addDo(self, tymth, tock=0.0):
+        """ Grant credential by creating /ipex/grant exn message
+
+        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)
+
+        if isinstance(self.hab, habbing.GroupHab):
+            raise ValueError("watchers for multisig AIDs not currently supported")
+
+        postman = forwarding.StreamPoster(hby=self.hby, hab=self.hab, recp=self.watcher, topic="reply")
+        for msg in self.hab.db.clonePreIter(pre=self.hab.pre):
+            serder = serdering.SerderKERI(raw=msg)
+            postman.send(serder=serder, attachment=msg[serder.size:])
+
+        data = dict(cid=self.hab.pre,
+                    wid=self.watched,
+                    oobi=self.oobi)
+
+        route = "/watcher/aid/add"
+        msg = self.hab.reply(route=route, data=data)
+        rpy = serdering.SerderKERI(raw=msg)
+        postman.send(serder=rpy, attachment=msg[rpy.size:])
+
+        doer = doing.DoDoer(doers=postman.deliver())
+        self.extend([doer])
+
+        while not doer.done:
+            yield self.tock
+
+        print(f"Request to add {self.watched} to watcher {self.watcher} submitted.")

{keri-1.2.0.dev1 → keri-1.2.0.dev2}/src/keri/app/cli/commands/witness/authenticate.py

@@ -35,7 +35,10 @@ parser.add_argument("--witness", '-w', help="the witness AID or alias to authent
 
 
 def auth(args):
-    """ Command line list credential registries handler
+    """ Command line handler for authenticating  against a witness by retrieving the secret or a TOTP
+
+    Parameters:
+        args(Namespace): parsed command line arguments
 
     """
 
@@ -65,7 +68,7 @@ class AuthDoer(doing.DoDoer):
         if not wit:
             raise ValueError(f"unknown witness {witness}")
 
-        self.witness = witness
+        self.witness = wit
         self.clienter = httping.Clienter()
         doers = [doing.doify(self.authDo), self.clienter]
 

{keri-1.2.0.dev1 → keri-1.2.0.dev2}/src/keri/app/habbing.py

@@ -2077,7 +2077,7 @@ class BaseHab:
         """
         while cues:  # iteratively process each cue in cues
             msgs = bytearray()
-            cue = cues.pull() #cues.popleft()
+            cue = cues.pull()  # cues.popleft()
             cueKin = cue["kin"]  # type or kind of cue
 
             if cueKin in ("receipt",):  # cue to receipt a received event from other pre

{keri-1.2.0.dev1 → keri-1.2.0.dev2}/src/keri/app/indirecting.py

@@ -40,6 +40,7 @@ def setupWitness(hby, alias="witness", mbx=None, aids=None, tcpPort=5631, httpPo
     Setup witness controller and doers
 
     """
+    host = "0.0.0.0"
     cues = decking.Deck()
     doers = []
 
@@ -87,7 +88,7 @@ def setupWitness(hby, alias="witness", mbx=None, aids=None, tcpPort=5631, httpPo
     receiptEnd = ReceiptEnd(hab=hab, inbound=cues, aids=aids)
     app.add_route("/receipts", receiptEnd)
 
-    server = createHttpServer(httpPort, app, keypath, certpath, cafilepath)
+    server = createHttpServer(host, httpPort, app, keypath, certpath, cafilepath)
     if not server.reopen():
         raise RuntimeError(f"cannot create http server on port {httpPort}")
     httpServerDoer = http.ServerDoer(server=server)
@@ -112,10 +113,11 @@ def setupWitness(hby, alias="witness", mbx=None, aids=None, tcpPort=5631, httpPo
     return doers
 
 
-def createHttpServer(port, app, keypath=None, certpath=None, cafilepath=None):
+def createHttpServer(host, port, app, keypath=None, certpath=None, cafilepath=None):
     """
     Create an HTTP or HTTPS server depending on whether TLS key material is present
     Parameters:
+        host(str)          : host to bind to for this server, or None for default of '0.0.0.0', all ifaces
         port (int)         : port to listen on for all HTTP(s) server instances
         app (falcon.App)   : application instance to pass to the http.Server instance
         keypath (string)   : the file path to the TLS private key
@@ -130,9 +132,9 @@ def createHttpServer(port, app, keypath=None, certpath=None, cafilepath=None):
                                 certpath=certpath,
                                 cafilepath=cafilepath,
                                 port=port)
-        server = http.Server(port=port, app=app, servant=servant)
+        server = http.Server(host=host, port=port, app=app, servant=servant)
     else:
-        server = http.Server(port=port, app=app)
+        server = http.Server(host=host, port=port, app=app)
     return server
 
 
@@ -246,7 +248,7 @@ class WitnessStart(doing.DoDoer):
 
         while True:
             while self.cues:
-                cue = self.cues.pull() # self.cues.popleft()
+                cue = self.cues.pull()  # self.cues.popleft()
                 cueKin = cue["kin"]
                 if cueKin == "stream":
                     self.queries.append(cue)

{keri-1.2.0.dev1 → keri-1.2.0.dev2}/src/keri/app/oobiing.py

@@ -13,18 +13,18 @@ from urllib.parse import urlparse
 import falcon
 from hio.base import doing
 from hio.help import decking
-from keri.core import coring
 
+from keri.core import coring
 from . import httping
-from .habbing import GroupHab
 from .. import help
 from .. import kering
-from ..app import forwarding, connecting
+from ..app import connecting
 from ..core import routing, eventing, parsing, scheming, serdering
 from ..db import basing
 from ..end import ending
 from ..end.ending import OOBI_RE, DOOBI_RE
 from ..help import helping
+from ..kering import Ilks, ValidationError, UnverifiedReplyError, ConfigurationError
 from ..peer import exchanging
 
 logger = help.ogler.getLogger()
@@ -276,7 +276,7 @@ class Oobiery:
 
     RetryDelay = 30
 
-    def __init__(self, hby, clienter=None, cues=None):
+    def __init__(self, hby, rvy=None, clienter=None, cues=None):
         """  DoDoer to handle the request and parsing of OOBIs
 
         Parameters:
@@ -286,8 +286,14 @@ class Oobiery:
         """
 
         self.hby = hby
+        self.rvy = rvy
+        if self.rvy is not None:
+            self.registerReplyRoutes(self.rvy.rtr)
+
         self.clienter = clienter or httping.Clienter()
         self.org = connecting.Organizer(hby=self.hby)
+
+        # Set up a local parser for returned events from OOBI queries.
         rtr = routing.Router()
         rvy = routing.Revery(db=self.hby.db, rtr=rtr)
         kvy = eventing.Kevery(db=self.hby.db, lax=True, local=False, rvy=rvy)
@@ -298,6 +304,89 @@ class Oobiery:
         self.clients = dict()
         self.doers = [self.clienter, doing.doify(self.scoobiDo)]
 
+    def registerReplyRoutes(self, router):
+        """ Register the routes for processing messages embedded in `rpy` event messages
+
+        The Oobiery handles rpy messages with the /introduce route by processing the contained oobi
+
+        Parameters:
+            router(Router): reply message router
+
+        """
+        router.addRoute("/introduce", self)
+
+    def processReply(self, *, serder, saider, route, cigars=None, tsgs=None, **kwargs):
+        """
+        Process one reply message for route = /introduce
+        with either attached nontrans receipt couples in cigars or attached trans
+        indexed sig groups in tsgs.
+        Assumes already validated saider, dater, and route from serder.ked
+
+        Parameters:
+            serder (SerderKERI): instance of reply msg (SAD)
+            saider (Saider): instance  from said in serder (SAD)
+            route (str): reply route
+            cigars (list): of Cigar instances that contain nontrans signing couple
+                          signature in .raw and public key in .verfer
+            tsgs (list): tuples (quadruples) of form
+                (prefixer, seqner, diger, [sigers]) where:
+                prefixer is pre of trans endorser
+                seqner is sequence number of trans endorser's est evt for keys for sigs
+                diger is digest of trans endorser's est evt for keys for sigs
+                [sigers] is list of indexed sigs from trans endorser's keys from est evt
+
+        OobiRecord:
+            date: str = date time of reply message of the introduction
+
+        Reply Message:
+        {
+          "v" : "KERI10JSON00011c_",
+          "t" : "rpy",
+          "d": "EZ-i0d8JZAoTNZH3ULaU6JR2nmwyvYAfSVPzhzS6b5CM",
+          "dt": "2020-08-22T17:50:12.988921+00:00",
+          "r" : "/introduce",
+          "a" :
+          {
+             "cid": "ENcOes8_t2C7tck4X4j61fSm0sWkLbZrEZffq7mSn8On",
+             "oobi":  "http://localhost:5632/oobi/ENcOes8_t2C7tck4X4j61fSm0sWkLbZrEZffq7mSn8On/witness",
+          }
+        }
+
+        """
+        if route != "/introduce":
+            raise ValidationError(f"Usupported route={route} in {Ilks.rpy} "
+                                  f"msg={serder.ked}.")
+
+        data = serder.ked['a']
+        dt = serder.ked["dt"]
+
+        for k in ("cid", "oobi"):
+            if k not in data:
+                raise ValidationError(f"Missing element={k} from attributes in"
+                                      f" {Ilks.rpy} msg={serder.ked}.")
+
+        cider = coring.Prefixer(qb64=data["cid"])  # raises error if unsupported code
+        cid = cider.qb64  # controller authorizing eid at role
+        aid = cid  # authorizing attribution id
+
+        oobi = data["oobi"]
+        url = urlparse(oobi)
+        if url.scheme not in ("http", "https"):
+            raise ValidationError(f"Invalid url scheme for introduced OOBI scheme={url.scheme}")
+
+        if self.rvy is None:
+            raise ConfigurationError("this oobiery is not configured to handle rpy introductions")
+
+        # Process BADA RUN but with no previous reply message, always process introductions
+        accepted = self.rvy.acceptReply(serder=serder, saider=saider, route=route,
+                                        aid=aid, osaider=None, cigars=cigars,
+                                        tsgs=tsgs)
+        if not accepted:
+            raise UnverifiedReplyError(f"Unverified introduciton reply. {serder.ked}")
+
+        obr = basing.OobiRecord(cid=cid, date=dt)
+        self.hby.db.oobis.put(keys=(oobi,), val=obr)
+
     def scoobiDo(self, tymth=None, tock=0.0):
         """
         Returns doifiable Doist compatibile generator method (doer dog) to process

{keri-1.2.0.dev1 → keri-1.2.0.dev2}/src/keri/core/__init__.py

@@ -4,9 +4,6 @@ KERI
 keri.core Package
 """
 
-#__all__ = ["coring", "eventing", "parsing", "scheming"]
-
-
 # Constants etc
 from .coring import (Tiers, )
 

{keri-1.2.0.dev1 → keri-1.2.0.dev2}/src/keri/core/coring.py

@@ -8,7 +8,7 @@ import json
 from typing import Union
 from collections import namedtuple, deque
 from collections.abc import Sequence, Mapping
-from dataclasses import dataclass, astuple
+from dataclasses import dataclass, astuple, asdict
 from base64 import urlsafe_b64encode as encodeB64
 from base64 import urlsafe_b64decode as decodeB64
 from fractions import Fraction
@@ -184,24 +184,21 @@ def loads(raw, size=None, kind=Serials.json):
     return ked
 
 
-# ToDo: nonces only need 128 bits of entropy. a Salt is enough
-# Just use Salter().qb64.
 # Deprecated
+# randomNonce() refactored to match Salter().qb64 and only used in coring to avoid circular dependencies
+# use Salter().qb64 in other places
 
 def randomNonce():
-    """ Generate a random ed25519 seed and encode as qb64
+    """ Generate a random 128 bits salt and encode as qb64
 
     Returns:
-        str: qb64 encoded ed25519 random seed
+        str: qb64 encoded 128 bits random salt
     """
-    preseed = pysodium.randombytes(pysodium.crypto_sign_SEEDBYTES)
-    seedqb64 = Matter(raw=preseed, code=MtrDex.Ed25519_Seed).qb64
+    preseed = pysodium.randombytes(pysodium.crypto_pwhash_SALTBYTES)
+    seedqb64 = Matter(raw=preseed, code=MtrDex.Salt_128).qb64
     return seedqb64
 
 
-
-
-
 # secret derivation security tier
 Tierage = namedtuple("Tierage", 'low med high')
 
@@ -906,6 +903,9 @@ class Matter:
         '9AAE': Sizage(hs=4, ss=4, fs=None, ls=2),
     }
 
+    Codes = asdict(MtrDex)  # map code name to code
+    Names = {val : key for key, val in Codes.items()} # invert map code to code name
+
 
 
     def __init__(self, raw=None, code=MtrDex.Ed25519N, soft='', rize=None,
@@ -1116,6 +1116,17 @@ class Matter:
         return self._code
 
 
+    @property
+    def name(self):
+        """
+        Returns:
+            name (str): code name for self.code. Used for annotation for
+            primitives like Matter
+
+        """
+        return self.Names[self.code]
+
+
     @property
     def hard(self):
         """
@@ -1700,6 +1711,10 @@ class Number(Matter):
 
     Methods:
     """
+    Codes = asdict(NumDex)  # map code name to code
+    Names = {val : key for key, val in Codes.items()} # invert map code to code name
+
+
 
     def __init__(self, raw=None, qb64b=None, qb64=None, qb2=None,
                  code=None, num=None, numh=None, **kwa):
@@ -4797,73 +4812,6 @@ class Tholder:
 
 
 
-class Streamer:
-    """
-    Streamer is CESR sniffable stream class
-
-
-    Has the following public properties:
-
-    Properties:
-
-
-    Methods:
-
-
-    Hidden:
-
-
-
-    """
-
-    def __init__(self, stream):
-        """Initialize instance
-
-
-        Parameters:
-            stream (bytes | bytearray): sniffable CESR stream
-
-
-        """
-        self._stream = bytes(stream)
-
-
-    @property
-    def stream(self):
-        """stream property getter
-        """
-        return self._stream
-
-    @property
-    def text(self):
-        """expanded stream as qb64 text
-        Returns:
-           stream (bytes): expanded text qb64 version of stream
-
-        """
-        return self._stream
-
-    @property
-    def binary(self):
-        """compacted stream as qb2 binary
-        Returns:
-           stream (bytes): compacted binary qb2 version of stream
-
-        """
-        return self._stream
-
-    @property
-    def texter(self):
-        """expanded stream as Texter instance
-        Returns:
-           texter (Texter): Texter primitive of stream suitable wrapping
-
-        """
-        return self._stream
-
-
-
-
 class Sadder:
     """
     Sadder is self addressed data (SAD) serializer-deserializer class