gea-program 0.61.0__tar.gz → 0.63.0__tar.gz

{gea_program-0.61.0 → gea_program-0.63.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gea-program
-Version: 0.61.0
+Version: 0.63.0
 Summary: GEA-Program: downhole gauge monitoring - canonical measurement records, quality rules, drift evaluation with a re-fit change log, well-test validation, alarm management, model cards, store-and-forward, monthly SLA measurement, FAT/SAT protocols and a dashboard, generated from live objects in the client's reporting outline.
 Author: Daniel T. Murphy
 License: MPL-2.0
@@ -683,13 +683,25 @@ catalogue well is added only from an entry that carries a downhole gauge
 series, with a well inside it and its gauge depth; a live seismic station
 whose feed has written nothing yet is listed as having no recording yet.
 
+### Trusted timestamps
+
+A signed dossier's time is the signing machine's clock. With a public
+time-stamping service named (RFC 3161: DigiCert, Sectigo or the site's
+own), each dossier also carries the authority's signed word that its
+signature existed at a given time - only the signature's SHA-256 is
+sent - and the dossier's own checker verifies it to a root the reader's
+computer trusts. `gea dossier --workspace C:\site --timestamp-url
+http://timestamp.digicert.com --timestamp on`; `gea help dossier`.
+
 ### Casing design and kick tolerance
 
 Each casing string's burst, collapse and tension ratings by API TR 5C3,
 from its size, weight and grade, against the loads the hole can put on it
 - gas to the surface held by the shoe, an emptied string, the buoyed
 weight with overpull - with the smallest safety factor and where, and the
-gas kick each open hole below a shoe can take and still be shut in. `gea
+gas kick each open hole below a shoe can take and still be shut in - the
+gas a real gas at the well's pressure and temperature, with a swabbed
+kick beside each. `gea
 casing --example`; declared on the **Casing & kick tolerance** tab, with
 `gea casing --workspace C:\site --well SWD-1 --strings ...`, or in the
 declarations sheet. `gea help casing`.

{gea_program-0.61.0 → gea_program-0.63.0}/README.md

@@ -644,13 +644,25 @@ catalogue well is added only from an entry that carries a downhole gauge
 series, with a well inside it and its gauge depth; a live seismic station
 whose feed has written nothing yet is listed as having no recording yet.
 
+### Trusted timestamps
+
+A signed dossier's time is the signing machine's clock. With a public
+time-stamping service named (RFC 3161: DigiCert, Sectigo or the site's
+own), each dossier also carries the authority's signed word that its
+signature existed at a given time - only the signature's SHA-256 is
+sent - and the dossier's own checker verifies it to a root the reader's
+computer trusts. `gea dossier --workspace C:\site --timestamp-url
+http://timestamp.digicert.com --timestamp on`; `gea help dossier`.
+
 ### Casing design and kick tolerance
 
 Each casing string's burst, collapse and tension ratings by API TR 5C3,
 from its size, weight and grade, against the loads the hole can put on it
 - gas to the surface held by the shoe, an emptied string, the buoyed
 weight with overpull - with the smallest safety factor and where, and the
-gas kick each open hole below a shoe can take and still be shut in. `gea
+gas kick each open hole below a shoe can take and still be shut in - the
+gas a real gas at the well's pressure and temperature, with a swabbed
+kick beside each. `gea
 casing --example`; declared on the **Casing & kick tolerance** tab, with
 `gea casing --workspace C:\site --well SWD-1 --strings ...`, or in the
 declarations sheet. `gea help casing`.

{gea_program-0.61.0 → gea_program-0.63.0}/gea/__init__.py

@@ -123,7 +123,7 @@ from .profile_catalog import (
     read_pangaea_txt,
 )
 
-__version__ = "0.61.0"
+__version__ = "0.63.0"
 __all__ = [
     "aging_rate", "rate_psi_yr", "accuracy_psi",
     "Sensor", "SimulatorConfig", "DownholeEngine",

{gea_program-0.61.0 → gea_program-0.63.0}/gea/__main__.py

@@ -596,6 +596,12 @@ def main(argv=None) -> int:
     p_dz.add_argument("--rotate-key", action="store_true", help="retire this site's signing key and start a new one, signed over by the old (give --reason)")
     p_dz.add_argument("--reason", type=str, default="", help="with --rotate-key: why the key is retired")
     p_dz.add_argument("--key-history", action="store_true", help="the site's keys, current and retired, and the rotations between them")
+    p_dz.add_argument("--timestamp-url", type=str, default=None, help="the RFC 3161 time-stamping service to use, e.g. http://timestamp.digicert.com ('none' to forget it)")
+    p_dz.add_argument("--timestamp", type=str, choices=["on", "off"], default=None, help="stamp every dossier as it is signed (on) or not (off)")
+    p_dz.add_argument("--timestamp-anchors", type=str, default=None, help="a PEM file with the service's root certificate, when this machine's store does not hold it ('none' to forget it)")
+    p_dz.add_argument("--timestamp-test", action="store_true", help="ask the service to stamp a random hash and check its reply (nothing is written)")
+    p_dz.add_argument("--stamp", type=str, default=None, help="stamp a dossier this site signed, by its id (gea dossier --list)")
+    p_dz.add_argument("--anchors", type=str, default="", help="with --verify: a PEM file of roots to trust for the timestamp, beside this machine's own")
     p_dz.add_argument("--actor", type=str, default="cli")
     p_dz.add_argument("--json", action="store_true")
 
@@ -653,7 +659,9 @@ def main(argv=None) -> int:
     p_cs.add_argument("--strings", type=str, default=None, help="shallowest shoe first: 'surface:13-3/8:54.5:J55:0-1500:17.5:9.0; intermediate:9-5/8:47:N80:0-7000:12.25:9.8' (what:od:lb_ft:grade:top-shoe:hole_in:mud_ppg[:wall_in])")
     for k_, h_ in (("td", "the well's TD below the deepest string, ft MD"), ("td-hole", "the hole below the deepest string, in"), ("td-mw", "the mud below the deepest string, ppg"),
                    ("pp", "a pore pressure for the well when the Pore pressure tab has none, ppg"), ("fg", "a fracture gradient for the well when the Pore pressure tab has none, ppg"),
-                   ("kick", "kick intensity above the mud, ppg (0.5)"), ("gas", "gas gradient, psi/ft (0.1)"), ("backup", "burst backup gradient outside, psi/ft (0.465)"),
+                   ("kick", "kick intensity above the mud, ppg (0.5)"), ("gas", "a fixed gas gradient, psi/ft, in place of the real gas ('none' for the real gas again)"),
+                   ("gas-sg", "the gas's specific gravity, air 1 (0.65)"), ("surface-temp", "the temperature at the surface, F (70)"),
+                   ("geothermal", "the geothermal gradient, F per 100 ft (1.5)"), ("backup", "burst backup gradient outside, psi/ft (0.465)"),
                    ("evacuation", "how far the string is emptied for collapse, 0 to 1 (1: to the shoe)"), ("df-burst", "burst design factor (1.1)"),
                    ("df-collapse", "collapse design factor (1.125)"), ("df-tension", "tension design factor (1.6)"), ("overpull", "overpull, klbf (100)"),
                    ("bha-od", "BHA outside diameter, in"), ("bha-length", "BHA length, ft"), ("dp-od", "drill pipe outside diameter, in")):
@@ -2505,11 +2513,40 @@ def main(argv=None) -> int:
             except WorkspaceError as e:
                 raise SystemExit(f"dossier: {e}")
         if a.verify:
-            r = _DZ.verify(a.verify, ws, a.sources)
+            if a.anchors and ws is None:
+                from . import dossier_verify as _DV, timestamp as _TSM
+                with open(a.anchors, "rb") as fh_:
+                    r = _DV.check(a.verify, a.sources, _TSM.ts_system_anchors() + _TSM.ts_pem_certs(fh_.read()))
+            else:
+                r = _DZ.verify(a.verify, ws, a.sources)
             print(_json.dumps(r, default=str) if a.json else _DZ.text(r))
             return 0 if r["status"] == "VALID" else 1
         if ws is None:
             raise SystemExit("dossier: give --workspace (or --verify FILE)")
+        if a.timestamp_url is not None or a.timestamp is not None or a.timestamp_anchors is not None:
+            try:
+                st_ = _DZ.set_timestamp(ws, a.actor, ("" if (a.timestamp_url or "").lower() == "none" else a.timestamp_url),
+                                        None if a.timestamp is None else a.timestamp == "on",
+                                        ("" if (a.timestamp_anchors or "").lower() == "none" else a.timestamp_anchors))
+            except ValueError as ex:
+                raise SystemExit(f"dossier: {ex}")
+            print(f"time-stamping service: {st_['url'] or 'none'}; every dossier stamped as it is signed: {'yes' if st_['enabled'] else 'no'}"
+                  + (f"; extra trusted roots: {st_['anchors']}" if st_["anchors"] else ""))
+            return 0
+        if a.timestamp_test or a.stamp:
+            from . import timestamp as _TSM
+            try:
+                if a.timestamp_test:
+                    t_ = _DZ.test_timestamp(ws)
+                    print(f"{t_['url']}: {t_['status']} - {t_['tsa']} stamped {t_['gen_time']}" + (f" (accuracy {t_['accuracy_s']:g} s)" if t_.get("accuracy_s") else ""))
+                    print(f"  the chain: {t_['chain_detail']}")
+                    return 0 if t_["status"] in ("TRUSTED", "VERIFIED") else 1
+                rec = _DZ.stamp(ws, a.actor, a.stamp)
+            except (KeyError, ValueError, OSError) as ex:
+                raise SystemExit(f"dossier: {ex.args[0] if ex.args else ex}")
+            print(f"stamped {rec['dossier_id']}: {rec['status']} - {rec['tsa']} at {rec['gen_time']} (signed {rec['signed_utc']} by this machine's clock)")
+            print(f"  the chain: {rec['chain']}")
+            return 0
         if a.key:
             k = _DZ.key_info(ws)
             print(f"Ed25519 {k['fingerprint']} (public key {k['public_key']}, made {k['created_utc']})" if k else "no signing key yet: the first dossier makes one")
@@ -2532,8 +2569,11 @@ def main(argv=None) -> int:
                 print("no key history yet")
             return 0
         if a.list:
+            st_ = _DZ.stamps(ws)
             for e in reversed(_DZ.ledger(ws)):
-                print(f"{e['utc']}  {e['dossier_id']}  {e['display']:<24} {e['n_files']:>4} files  {e['path']}")
+                t_ = st_.get(e["dossier_id"]) or {}
+                print(f"{e['utc']}  {e['dossier_id']}  {e['display']:<24} {e['n_files']:>4} files  {e['path']}"
+                      + (f"  [timestamp {t_['status']}" + (f" {t_['gen_time']}]" if t_.get("gen_time") else "]") if t_ else ""))
             return 0
         try:
             e = _DZ.build(ws, a.actor, __version__, a.well, a.include_sources)
@@ -2542,6 +2582,9 @@ def main(argv=None) -> int:
         print(f"signed {e['dossier_id']}: {e['display']}, {e['n_files']} file(s), {e['n_sources']} source record(s) {'embedded' if e['sources_embedded'] else 'by hash'}")
         print(f"  {os.path.join(ws.reports_dir, e['path'])}")
         print(f"  key fingerprint {e['fingerprint']}")
+        t_ = e.get("timestamp")
+        if t_:
+            print(f"  trusted timestamp: {t_['status']}" + (f" - {t_['tsa']} at {t_['gen_time']}" if t_.get("gen_time") else f" - {t_.get('reason', '')}"))
         return 0
     elif a.cmd == "collision":
         import json as _json
@@ -2625,7 +2668,8 @@ def main(argv=None) -> int:
             ws = Workspace(a.workspace) if a.workspace else None
             scene = "example" if (a.example or ws is None) else "workspace"
             keys_ = {"td": "td_md_ft", "td_hole": "td_hole_in", "td_mw": "td_mw_ppg", "pp": "pp_ppg", "fg": "fg_ppg", "kick": "kick_intensity_ppg",
-                     "gas": "gas_gradient_psi_ft", "backup": "backup_gradient_psi_ft", "evacuation": "evacuation", "df_burst": "df_burst",
+                     "gas": "gas_gradient_psi_ft", "gas_sg": "gas_sg", "surface_temp": "surface_temp_f", "geothermal": "geothermal_f_100ft",
+                     "backup": "backup_gradient_psi_ft", "evacuation": "evacuation", "df_burst": "df_burst",
                      "df_collapse": "df_collapse", "df_tension": "df_tension", "overpull": "overpull_klbf", "bha_od": "bha_od_in",
                      "bha_length": "bha_length_ft", "dp_od": "dp_od_in"}
             vals_ = {v: getattr(a, k) for k, v in keys_.items() if getattr(a, k) is not None}