harar 0.2.0__tar.gz

harar-0.2.0/.gitignore

@@ -0,0 +1,9 @@
+/.target/
+/.tmp/
+/js/.tmp/
+/js/node_modules/
+/vendor/
+/composer.lock
+/dist/
+/ruby/*.gem
+__pycache__/

harar-0.2.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

harar-0.2.0/PKG-INFO

@@ -0,0 +1,30 @@
+Metadata-Version: 2.4
+Name: harar
+Version: 0.2.0
+Summary: harar's client: from harar import vault. Where each secret may go, and the secret itself for one host only.
+Project-URL: Homepage, https://harar.addis.gg
+Project-URL: Source, https://github.com/addiscorp/harar
+License-Expression: Apache-2.0
+License-File: LICENSE
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+
+# harar
+
+harar's client for Python.
+
+```python
+from harar import vault
+
+v = vault(socket="/run/harar.sock")
+v.hosts("prod/shop/STRIPE_KEY")                   # where it may go: ['api.stripe.com']
+v.send("prod/shop/STRIPE_KEY", "api.stripe.com")  # the key, for that host only
+```
+
+harar decides every send and records the host, and this client holds
+nothing. It speaks to a per-user agent (`harar agent`, where `harar hosts
+allow <secret> <host>` sets the hosts) or a primary (where a role's `send`
+permission does). A refusal, or a harar that cannot be reached, raises
+`harar.HararError` naming why.
+
+harar itself: https://github.com/addiscorp/harar

harar-0.2.0/README.md

@@ -0,0 +1,19 @@
+# harar
+
+harar's client for Python.
+
+```python
+from harar import vault
+
+v = vault(socket="/run/harar.sock")
+v.hosts("prod/shop/STRIPE_KEY")                   # where it may go: ['api.stripe.com']
+v.send("prod/shop/STRIPE_KEY", "api.stripe.com")  # the key, for that host only
+```
+
+harar decides every send and records the host, and this client holds
+nothing. It speaks to a per-user agent (`harar agent`, where `harar hosts
+allow <secret> <host>` sets the hosts) or a primary (where a role's `send`
+permission does). A refusal, or a harar that cannot be reached, raises
+`harar.HararError` naming why.
+
+harar itself: https://github.com/addiscorp/harar

harar-0.2.0/pyproject.toml

@@ -0,0 +1,21 @@
+[build-system]
+requires = ["hatchling==1.27.0"]
+build-backend = "hatchling.build"
+
+[project]
+name = "harar"
+# harar's release version (scripts/version.sh); scripts/check-clients.sh holds it there.
+version = "0.2.0"
+description = "harar's client: from harar import vault. Where each secret may go, and the secret itself for one host only."
+readme = "README.md"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+requires-python = ">=3.9"
+dependencies = []
+
+[project.urls]
+Homepage = "https://harar.addis.gg"
+Source = "https://github.com/addiscorp/harar"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/harar"]

harar-0.2.0/src/harar/__init__.py

@@ -0,0 +1,91 @@
+"""harar's client for Python:
+
+    from harar import vault
+    v = vault(socket="/run/harar.sock")
+    v.hosts("prod/shop/STRIPE_KEY")                    # ['api.stripe.com']
+    v.send("prod/shop/STRIPE_KEY", "api.stripe.com")   # the key, for that host only
+
+One JSON request on harar's local socket, the write side closed, one JSON
+answer: the protocol the per-user agent and a primary both speak. harar
+decides every send, and records the host; this client holds nothing.
+"""
+
+import json
+import socket as _socket
+
+__all__ = ["HararError", "Vault", "vault"]
+
+# harar's answers are small; anything longer is refused.
+MAX_ANSWER = 1024 * 1024
+# How long harar has to answer (a per-user agent may be asking for Touch ID).
+TIMEOUT_S = 60
+
+
+class HararError(Exception):
+    """harar refused, or could not be asked; the message names why."""
+
+
+def _ask(path, request, what):
+    """One request to harar, and its answer if it says ok; otherwise why not."""
+    try:
+        with _socket.socket(_socket.AF_UNIX, _socket.SOCK_STREAM) as conn:
+            conn.settimeout(TIMEOUT_S)
+            conn.connect(path)
+            conn.sendall(json.dumps(request).encode("utf-8"))
+            conn.shutdown(_socket.SHUT_WR)
+            chunks, size = [], 0
+            while True:
+                chunk = conn.recv(65536)
+                if not chunk:
+                    break
+                size += len(chunk)
+                if size > MAX_ANSWER:
+                    raise HararError("harar sent too long an answer")
+                chunks.append(chunk)
+    except _socket.timeout:
+        raise HararError(f"harar did not answer in {TIMEOUT_S} s") from None
+    except OSError as e:
+        raise HararError(f"harar at {path}: {e.strerror or e}") from None
+    try:
+        answer = json.loads(b"".join(chunks).decode("utf-8"))
+    except ValueError:
+        raise HararError(f"harar at {path} did not answer with JSON") from None
+    if not isinstance(answer, dict):
+        raise HararError(f"harar at {path} did not answer with an object")
+    if answer.get("ok") is True:
+        return answer
+    error = answer.get("error")
+    raise HararError(f"harar refused {what}: {error if isinstance(error, str) else 'no answer'}")
+
+
+class Vault:
+    """A vault on harar's socket: where each secret may go, and the secret
+    itself for one host only."""
+
+    def __init__(self, socket):
+        if not isinstance(socket, str) or not socket.startswith("/"):
+            raise ValueError("vault(socket=...): the socket is an absolute path")
+        self._socket = socket
+
+    def hosts(self, secret):
+        """The host patterns `secret` may go to: an exact name, or
+        `*.example.com` for any name under it (never the name itself)."""
+        hosts = _ask(self._socket, {"op": "hosts", "key": secret}, secret).get("hosts")
+        if not isinstance(hosts, list) or not all(isinstance(h, str) for h in hosts):
+            raise HararError(f"harar sent no hosts for {secret}")
+        return hosts
+
+    def send(self, secret, host):
+        """`secret`'s value, for a request to `host` only. harar decides, and
+        records the host."""
+        value = _ask(
+            self._socket, {"op": "send", "key": secret, "host": host}, f"{secret} to {host}"
+        ).get("value")
+        if not isinstance(value, str):
+            raise HararError(f"harar refused {secret} to {host}: no value")
+        return value
+
+
+def vault(socket):
+    """harar at `socket`: a per-user agent or a primary."""
+    return Vault(socket)

harar-0.2.0/tests/test_vault.py

@@ -0,0 +1,102 @@
+# The client against a stand-in harar on a unix socket: the requests it
+# sends are the ones harar's `hosts` and `send` take (the harar crate's
+# PrimaryRequest::Hosts { key } and Send { key, host }, tag "op"), and every
+# way harar can say no is an error naming why. The same cases as js/test.
+import json
+import os
+import socket
+import tempfile
+import threading
+import unittest
+
+from harar import HararError, vault
+
+
+class Harar:
+    """A stand-in harar answering each request with reply(request)."""
+
+    def __init__(self, reply):
+        self.dir = tempfile.TemporaryDirectory(prefix="harar-py-")
+        self.socket = os.path.join(self.dir.name, "h.sock")
+        self.requests = []
+        self.server = socket.socket(socket.AF_UNIX, socket.SOCK_STREAM)
+        self.server.bind(self.socket)
+        self.server.listen()
+        self.reply = reply
+        threading.Thread(target=self._serve, daemon=True).start()
+
+    def _serve(self):
+        while True:
+            try:
+                conn, _ = self.server.accept()
+            except OSError:
+                return
+            with conn:
+                body = b""
+                while chunk := conn.recv(65536):
+                    body += chunk
+                request = json.loads(body)
+                self.requests.append(request)
+                try:
+                    conn.sendall(self.reply(request).encode("utf-8"))
+                except OSError:
+                    pass  # the client stopped reading: too long an answer
+
+    def __enter__(self):
+        return self
+
+    def __exit__(self, *_):
+        self.server.close()
+        self.dir.cleanup()
+
+
+def stripe(r):
+    if r["op"] == "hosts":
+        return json.dumps({"ok": True, "hosts": ["api.stripe.com", "*.stripe.com"]})
+    if r["op"] == "send" and r["host"] == "api.stripe.com":
+        return json.dumps({"ok": True, "value": "sk_live_real"})
+    return json.dumps({"ok": False, "error": "not_allowed"})
+
+
+class VaultTest(unittest.TestCase):
+    def test_hosts_and_send_ask_harar_exactly_and_a_send_is_for_one_host(self):
+        with Harar(stripe) as h:
+            v = vault(socket=h.socket)
+            self.assertEqual(v.hosts("prod/shop/STRIPE_KEY"), ["api.stripe.com", "*.stripe.com"])
+            self.assertEqual(v.send("prod/shop/STRIPE_KEY", "api.stripe.com"), "sk_live_real")
+            with self.assertRaisesRegex(
+                HararError, r"harar refused prod/shop/STRIPE_KEY to evil\.example\.com: not_allowed"
+            ):
+                v.send("prod/shop/STRIPE_KEY", "evil.example.com")
+            self.assertEqual(
+                h.requests,
+                [
+                    {"op": "hosts", "key": "prod/shop/STRIPE_KEY"},
+                    {"op": "send", "key": "prod/shop/STRIPE_KEY", "host": "api.stripe.com"},
+                    {"op": "send", "key": "prod/shop/STRIPE_KEY", "host": "evil.example.com"},
+                ],
+            )
+
+    def test_every_way_harar_can_fail_is_an_error_naming_why(self):
+        for answer, why in [
+            ("not json", r"did not answer with JSON"),
+            ("null", r"did not answer with an object"),
+            ("[1]", r"did not answer with an object"),
+            (json.dumps({"ok": True}), r"no value|no hosts"),
+            (json.dumps({"ok": False, "error": "locked"}), r"harar refused .*: locked"),
+            ("x" * (1024 * 1024 + 1), r"too long an answer"),
+        ]:
+            with self.subTest(answer=answer[:20]), Harar(lambda _: answer) as h:
+                v = vault(socket=h.socket)
+                with self.assertRaisesRegex(HararError, why):
+                    v.send("a/b", "x.example.com")
+                with self.assertRaisesRegex(HararError, why):
+                    v.hosts("a/b")
+        with self.assertRaisesRegex(HararError, r"harar at /nonexistent/h\.sock"):
+            vault(socket="/nonexistent/h.sock").hosts("a/b")
+        with self.assertRaisesRegex(ValueError, r"absolute path"):
+            vault(socket="relative.sock")
+
+
+if __name__ == "__main__":
+    unittest.main()