encrypted-keyring 0.1.0__py3-none-any.whl

encrypted_keyring-0.1.0.dist-info/METADATA

@@ -0,0 +1,587 @@
+Metadata-Version: 2.4
+Name: encrypted-keyring
+Version: 0.1.0
+Summary: Encrypted file-based keyring storage with a small command line interface.
+License:                                  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.
+        
+Keywords: keyring,encrypted,cryptography,passwords,cli
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Security :: Cryptography
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: cryptography
+Provides-Extra: dev
+Requires-Dist: build; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: twine; extra == "dev"
+Dynamic: license-file
+
+# keyring
+
+[![Python 3.10+](https://img.shields.io/badge/python-3.10%2B-blue)](https://www.python.org/)
+[![Status Alpha](https://img.shields.io/badge/status-alpha-orange)](#)
+[![Tests](https://img.shields.io/badge/tests-pytest-success)](#tests)
+[![Distribution](https://img.shields.io/badge/pypi-encrypted--keyring-blueviolet)](https://pypi.org/project/encrypted-keyring/)
+
+Python-Paket für verschlüsselte Keyring-Dateien mit kleiner CLI und installierbarem Konsolenbefehl.
+
+Das Projekt wird auf PyPI als `encrypted-keyring` veröffentlicht. Der Python-Import bleibt `keyring`.
+
+## Status
+
+Der aktuelle Stand des Repos ist:
+
+- als Python-Paket importierbar
+- als CLI über `python3 -m keyring` nutzbar
+- als installierter Befehl `encrypted-keyring` verfügbar
+- über `shell-alias.sh` zusätzlich als `keyring` aliasierbar
+- mit automatisierten Tests unter `tests/` abgesichert
+- auf PyPI vorbereitet über [pyproject.toml](pyproject.toml)
+
+Kurz gesagt: Die Grundlage für eine veröffentlichte, installierbare Python-Bibliothek ist vorhanden, der Code ist als kleines Werkzeug direkt verwendbar, und die wichtigsten Pfade sind dokumentiert und getestet.
+
+## Was das Paket macht
+
+Dieses Repository stellt eine einfache, dateibasierte Geheimnisverwaltung bereit:
+
+- Ein `Keyring`-Objekt zum Speichern, Lesen, Aktualisieren und Löschen von Einträgen
+- Eine Kryptoschicht für die Ableitung von Schlüsseln und die Verschlüsselung der gespeicherten Daten
+- Eine kleine Kommandozeilenanwendung für direkte Nutzung ohne eigenes Skript
+- Eine Paketkonfiguration über `pyproject.toml`, damit das Projekt als echtes Python-Paket gebaut und veröffentlicht werden kann
+
+Die Daten werden lokal in einer Datei gespeichert, verschlüsselt abgelegt und mit einem Master-Passwort geöffnet.
+
+## Paket- und Importnamen
+
+Wichtig ist die Unterscheidung zwischen Distribution und Import:
+
+- PyPI-Name / Distribution: `encrypted-keyring`
+- Python-Import: `keyring`
+- Installierter CLI-Befehl: `encrypted-keyring`
+- Optionaler Shell-Alias aus diesem Repo: `keyring`
+
+Das ist absichtlich so gewählt, weil der Name `keyring` auf PyPI bereits stark belegt ist.
+
+## Voraussetzungen
+
+Das Projekt benötigt:
+
+- Python 3.10 oder neuer
+- `cryptography` zur Schlüsselableitung und Verschlüsselung
+
+Die Laufzeitabhängigkeit ist in [pyproject.toml](pyproject.toml) beschrieben. Zusätzlich liegt [requirements.txt](requirements.txt) als einfache manuelle Liste im Repo.
+
+## Installation
+
+### Aus dem Repository für Entwicklung
+
+Für eine lokale Entwicklungsumgebung:
+
+```bash
+python3 -m venv .venv
+source .venv/bin/activate
+pip install -e '.[dev]'
+```
+
+Das installiert:
+
+- das Paket im Editable-Modus
+- die Laufzeitabhängigkeit `cryptography`
+- die Entwicklungswerkzeuge aus dem `dev`-Extra
+
+### Als reguläre Installation
+
+Wenn das Paket später von PyPI installiert wird:
+
+```bash
+pip install encrypted-keyring
+```
+
+## Schnellstart
+
+Ein einfaches Beispiel für die Nutzung als Modul:
+
+```python
+from pathlib import Path
+
+from keyring import Keyring
+
+ring = Keyring(path=Path("keyring.dat"), password="mein-master-passwort")
+ring.put(
+    "github",
+    user="alice",
+    password="geheim",
+    description="Privates Konto",
+)
+
+print(ring.names())
+print(ring.get("github"))
+```
+
+Ausgabe und Verhalten hängen natürlich von deinem Inhalt ab, aber der typische Ablauf ist:
+
+1. Keyring-Datei öffnen oder anlegen
+2. Eintrag speichern
+3. Eintrag wieder lesen
+4. Einträge bei Bedarf löschen
+
+## Nutzung als Modul
+
+`keyring` exportiert die zentrale Klasse `Keyring` direkt auf Paket-Ebene:
+
+```python
+from keyring import Keyring
+```
+
+### API-Übersicht
+
+- `Keyring(path, password)` öffnet oder erstellt eine Keyring-Datei
+- `names()` liefert eine Liste aller gespeicherten Eintragsnamen
+- `get(name)` liest einen Eintrag als `dict` oder gibt `None` zurück
+- `put(name, user=None, password=None, description=None, overwrite=False)` speichert einen Eintrag
+- `delete(name)` entfernt einen Eintrag
+
+### Typisches Muster
+
+```python
+from pathlib import Path
+
+from keyring import Keyring
+
+ring = Keyring(path=Path("keyring.dat"), password="master")
+
+if "github" not in ring.names():
+    ring.put(
+        "github",
+        user="alice",
+        password="geheim",
+        description="Privates Konto",
+    )
+
+entry = ring.get("github")
+if entry is not None:
+    print(entry["user"])
+    print(entry["password"])
+    print(entry["description"])
+```
+
+### Verhalten von `put`
+
+Beim Speichern eines neuen Eintrags:
+
+- wird ein zufälliger interner Schlüssel erzeugt
+- werden `user`, `password` und `description` jeweils separat verschlüsselt
+- wird der interne Schlüssel selbst mit dem Master-Passwort verschlüsselt und separat abgelegt
+
+Das bedeutet: Der eigentliche Inhalt eines Eintrags ist nicht direkt mit demselben Schlüssel wie die Datei selbst verschlüsselt.
+
+## Kleine Anwendung
+
+Die CLI ist für direkte Benutzung gedacht und arbeitet mit derselben Keyring-Datei wie das Modul.
+
+Der Einstieg läuft über:
+
+```bash
+python3 -m keyring --help
+```
+
+Standardmäßig verwendet die CLI die Datei `keyring.dat` im aktuellen Arbeitsverzeichnis.
+
+### Globale Optionen
+
+- `-f`, `--file`: Pfad zur Keyring-Datei
+- `-p`, `--password`: Master-Passwort für die Datei
+
+Wenn `--password` fehlt, wird es interaktiv abgefragt.
+
+### Befehle
+
+#### `list`
+
+Listet alle gespeicherten Einträge auf.
+
+```bash
+python3 -m keyring -p "mein-master-passwort" list
+```
+
+#### `show`
+
+Zeigt einen einzelnen Eintrag an.
+
+```bash
+python3 -m keyring -p "mein-master-passwort" show github
+```
+
+#### `add`
+
+Legt einen Eintrag an oder ersetzt ihn mit `--overwrite`.
+
+```bash
+python3 -m keyring -p "mein-master-passwort" add github --user "alice" --entry-password "geheim" --description "Privates Konto"
+```
+
+Wenn der Eintrag bereits existiert und nicht überschrieben werden soll, bricht die CLI mit einer Fehlermeldung ab.
+
+#### `delete`
+
+Löscht einen gespeicherten Eintrag.
+
+```bash
+python3 -m keyring -p "mein-master-passwort" delete github
+```
+
+### Beispielablauf
+
+```bash
+python3 -m keyring -p "master" add demo --user alice --entry-password secret --description test
+python3 -m keyring -p "master" list
+python3 -m keyring -p "master" show demo
+python3 -m keyring -p "master" delete demo
+```
+
+## Shell-Alias
+
+Wenn du den installierten CLI-Befehl lieber als `keyring` aufrufen möchtest, kannst du das beiliegende Alias-Snippet laden:
+
+```bash
+source ./shell-alias.sh
+```
+
+Die Datei [shell-alias.sh](shell-alias.sh) enthält:
+
+```bash
+alias keyring='encrypted-keyring'
+```
+
+Hinweis:
+
+- Das ist ein Shell-Alias, kein Python-Import.
+- Der Alias betrifft nur deine aktuelle Shell-Sitzung, solange du ihn nicht dauerhaft in deiner Shell-Startdatei einträgst.
+- In einer dauerhaften Konfiguration kannst du denselben Alias zum Beispiel in `~/.bashrc` oder `~/.zshrc` hinterlegen.
+
+## Tests
+
+Für das Projekt existiert eine `pytest`-Suite unter [tests/](tests):
+
+- [tests/test_crypto.py](tests/test_crypto.py)
+- [tests/test_keyring.py](tests/test_keyring.py)
+- [tests/test_cli.py](tests/test_cli.py)
+
+Die Tests decken ab:
+
+- Verschlüsselung und Entschlüsselung mit `str`- und `bytes`-Passwörtern
+- Erzeugen zufälliger Eintrags-Schlüssel
+- Speichern, Laden, Löschen und Auflisten von Einträgen
+- CLI-Verhalten über den `main()`-Einstiegspunkt
+
+Zusätzlich sind folgende Szenarien abgedeckt:
+
+- Erzeugen und erneutes Laden einer leeren Keyring-Datei
+- Fehlverhalten bei falschem Master-Passwort
+- `get()` und `delete()` bei nicht vorhandenen Einträgen
+- Überschreiben und Nicht-Überschreiben bestehender Einträge
+- CLI-Fehlerfälle für `show`, `add` ohne `--overwrite` und `delete`
+- CLI-Hilfe über `--help`
+
+### Tests ausführen
+
+```bash
+python3 -m pytest -q
+```
+
+Falls dein System-Python extern verwaltet ist, empfiehlt sich ein virtuelles Umfeld:
+
+```bash
+python3 -m venv .venv
+source .venv/bin/activate
+pip install -e '.[dev]'
+python3 -m pytest -q
+```
+
+## Packaging und Veröffentlichung
+
+Die Paketdefinition liegt vollständig in [pyproject.toml](pyproject.toml).
+
+Wichtige Punkte daraus:
+
+- Build-Backend: `setuptools`
+- Distribution-Name: `encrypted-keyring`
+- Konsolenbefehl: `encrypted-keyring`
+- Python-Version: `>=3.10`
+- Laufzeitabhängigkeit: `cryptography`
+- Entwicklungsabhängigkeiten: `build`, `pytest`, `twine`
+
+### Lokales Builden
+
+```bash
+python3 -m build
+```
+
+Das erzeugt typischerweise:
+
+- ein Source Distribution Archiv
+- ein Wheel
+
+### Veröffentlichungsprüfung
+
+Vor einem Upload ist ein Trockenlauf sinnvoll:
+
+```bash
+python3 -m twine check dist/*
+```
+
+### Upload auf PyPI
+
+Wenn du veröffentlichen willst:
+
+```bash
+python3 -m twine upload dist/*
+```
+
+## Datenformat und Verhalten
+
+- Die Keyring-Datei wird verschlüsselt gespeichert.
+- Beim Schreiben wird eine temporäre Datei verwendet und anschließend atomar ersetzt.
+- Nach dem Schreiben wird die Datei mit Berechtigung `600` versehen, damit nur der Besitzer lesen und schreiben kann.
+- Die interne Struktur trennt die eigentlichen Eintragsdaten von den verschlüsselten Eintrags-Schlüsseln.
+- Die Kryptoschicht akzeptiert Passwortwerte als `str` oder als `bytes`.
+- Zufällige Eintrags-Schlüssel werden intern als Bytes erzeugt und verschlüsselt abgelegt.
+- Die Datei `keyring.dat` ist eine Laufzeitdatei und gehört nicht ins Git-Repository.
+
+## Projektstruktur
+
+- `keyring/__init__.py` - Paket-Exports für `Keyring` und `Crypto`
+- `keyring/__main__.py` - CLI-Einstiegspunkt
+- `keyring/crypto.py` - Schlüsselableitung, Verschlüsselung und Entschlüsselung
+- `keyring/keyring.py` - Laden, Speichern und Verwalten der Keyring-Daten
+- `pyproject.toml` - Build-, Packaging- und Test-Konfiguration
+- `requirements.txt` - manuelle Liste der Laufzeitabhängigkeiten
+- `shell-alias.sh` - Shell-Alias für den CLI-Befehl
+- `tests/` - automatisierte Tests
+
+## Veröffentlichung und Nutzung
+
+Ein typischer Ablauf für die Weiterentwicklung ist:
+
+1. Code ändern
+2. Tests ergänzen oder anpassen
+3. `python3 -m pytest -q` ausführen
+4. `python3 -m build` ausführen
+5. `python3 -m twine check dist/*` prüfen
+6. Paket auf PyPI hochladen
+
+## Hinweise
+
+- Der Python-Import bleibt `keyring`, auch wenn die Distribution `encrypted-keyring` heißt.
+- Die CLI ist separat installierbar und kann über den Shell-Alias bequem auf `keyring` gelegt werden.
+- Wenn du neue Funktionen ergänzt, sollten dazu passende Tests und eine kurze Dokumentation dazukommen.

encrypted_keyring-0.1.0.dist-info/RECORD

@@ -0,0 +1,10 @@
+encrypted_keyring-0.1.0.dist-info/licenses/LICENSE,sha256=HrhfyXIkWY2tGFK11kg7vPCqhgh5DcxleloqdhrpyMY,11558
+keyring/__init__.py,sha256=0Fd1mEg1Yz9ZAhIQvsmNSg_BrOhh4y38XVEOssNYv7o,128
+keyring/__main__.py,sha256=MzUm-roViseCqD6wlqhcojkkguVf8uMfDYPzvZYuljs,4283
+keyring/crypto.py,sha256=BO4iLbkeK4xWPUmcQspUnKIxK_vuOVnGEtx2DDLVu0A,1099
+keyring/keyring.py,sha256=QgBpbYh_iPASdF8XQxW-ki3WV9t4IYK9z9mq5zlwwXk,4021
+encrypted_keyring-0.1.0.dist-info/METADATA,sha256=zHZoUGsPVa4xOlrFYRdpLu4ixKaaUfeaQoPxjG0tJJQ,24368
+encrypted_keyring-0.1.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+encrypted_keyring-0.1.0.dist-info/entry_points.txt,sha256=4BW9tURqO41GSWn4SdMYP8VTW0NwDdOI3SkHujTIXkQ,60
+encrypted_keyring-0.1.0.dist-info/top_level.txt,sha256=ohh1dke28_NdSNkZ6nkVSwIKkLJTOwIfEwnXKva3pkg,8
+encrypted_keyring-0.1.0.dist-info/RECORD,,

encrypted_keyring-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

encrypted_keyring-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+encrypted-keyring = keyring.__main__:main

encrypted_keyring-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,201 @@
+                                 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.

encrypted_keyring-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+keyring

keyring/__init__.py

@@ -0,0 +1,6 @@
+"""Verschlüsseltes Keyring-Paket."""
+
+from .crypto import Crypto
+from .keyring import Keyring
+
+__all__ = ["Crypto", "Keyring"]

keyring/__main__.py

@@ -0,0 +1,156 @@
+from __future__ import annotations
+
+import argparse
+from getpass import getpass
+import sys
+from pathlib import Path
+
+from .keyring import Keyring
+
+
+DEFAULT_KEYRING_FILE = Path("keyring.dat")
+
+
+def build_parser() -> argparse.ArgumentParser:
+    parser = argparse.ArgumentParser(
+        prog="keyring",
+        description="Kleine CLI für den verschlüsselten Keyring.",
+    )
+    parser.add_argument(
+        "-f",
+        "--file",
+        type=Path,
+        default=DEFAULT_KEYRING_FILE,
+        help=f"Pfad zur Keyring-Datei (Standard: {DEFAULT_KEYRING_FILE})",
+    )
+    parser.add_argument(
+        "-p",
+        "--password",
+        help="Master-Passwort für die Keyring-Datei. Wenn es fehlt, wird es abgefragt.",
+    )
+
+    subparsers = parser.add_subparsers(dest="command", required=True)
+
+    subparsers.add_parser("list", help="Alle Einträge auflisten")
+
+    show_parser = subparsers.add_parser("show", help="Einen Eintrag anzeigen")
+    show_parser.add_argument("name")
+
+    add_parser = subparsers.add_parser("add", help="Einen Eintrag anlegen oder ersetzen")
+    add_parser.add_argument("name")
+    add_parser.add_argument("--user")
+    add_parser.add_argument("--entry-password", dest="entry_password")
+    add_parser.add_argument("--description")
+    add_parser.add_argument("--overwrite", action="store_true", help="Vorhandenen Eintrag überschreiben")
+
+    delete_parser = subparsers.add_parser("delete", help="Einen Eintrag löschen")
+    delete_parser.add_argument("name")
+
+    return parser
+
+
+def resolve_master_password(provided: str | None) -> str:
+    if provided is not None:
+        return provided
+    return getpass("Master-Passwort: ")
+
+
+def resolve_entry_password(provided: str | None) -> str:
+    if provided is not None:
+        return provided
+    return getpass("Eintrags-Passwort: ")
+
+
+def open_keyring(path: Path, password: str) -> Keyring:
+    return Keyring(path=path, password=password)
+
+
+def handle_list(keyring: Keyring) -> int:
+    names = keyring.names()
+    if not names:
+        print("Keine Einträge vorhanden.")
+        return 0
+
+    for name in names:
+        print(name)
+    return 0
+
+
+def handle_show(keyring: Keyring, name: str) -> int:
+    data = keyring.get(name)
+    if data is None:
+        print(f"Eintrag '{name}' wurde nicht gefunden.", file=sys.stderr)
+        return 1
+
+    print(f"Name: {name}")
+    print(f"Benutzer: {data.get('user', '')}")
+    print(f"Passwort: {data.get('password', '')}")
+    print(f"Beschreibung: {data.get('description', '')}")
+    return 0
+
+
+def handle_add(
+    keyring: Keyring,
+    name: str,
+    user: str | None,
+    entry_password: str | None,
+    description: str | None,
+    overwrite: bool,
+) -> int:
+    if keyring.get(name) is not None and not overwrite:
+        print(f"Eintrag '{name}' existiert bereits. Nutze --overwrite.", file=sys.stderr)
+        return 1
+
+    keyring.put(
+        name,
+        user=user,
+        password=resolve_entry_password(entry_password),
+        description=description,
+        overwrite=overwrite,
+    )
+    print(f"Eintrag '{name}' gespeichert.")
+    return 0
+
+
+def handle_delete(keyring: Keyring, name: str) -> int:
+    if keyring.get(name) is None:
+        print(f"Eintrag '{name}' wurde nicht gefunden.", file=sys.stderr)
+        return 1
+
+    keyring.delete(name)
+    print(f"Eintrag '{name}' gelöscht.")
+    return 0
+
+
+def main(argv: list[str] | None = None) -> int:
+    parser = build_parser()
+    args = parser.parse_args(argv)
+
+    try:
+        keyring = open_keyring(args.file, resolve_master_password(args.password))
+
+        if args.command == "list":
+            return handle_list(keyring)
+        if args.command == "show":
+            return handle_show(keyring, args.name)
+        if args.command == "add":
+            return handle_add(
+                keyring,
+                args.name,
+                args.user,
+                args.entry_password,
+                args.description,
+                args.overwrite,
+            )
+        if args.command == "delete":
+            return handle_delete(keyring, args.name)
+
+        parser.error("Unbekannter Befehl.")
+        return 2
+    except Exception as exc:
+        print(str(exc), file=sys.stderr)
+        return 1
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

keyring/crypto.py

@@ -0,0 +1,33 @@
+import os, base64
+from cryptography.fernet import Fernet
+from cryptography.hazmat.primitives.kdf.pbkdf2 import PBKDF2HMAC
+from cryptography.hazmat.primitives import hashes
+
+
+class Crypto:
+    
+    def __init__(self) -> None:
+        pass
+    
+    def _key(self, password: bytes | str, salt: bytes) -> bytes:
+        if isinstance(password, str):
+            password = password.encode('utf-8')
+        kdf = PBKDF2HMAC(
+            algorithm=hashes.SHA256(),
+            length=32,
+            salt=salt,
+            iterations=480_000,
+        )
+        return base64.urlsafe_b64encode(kdf.derive(password))
+
+    def encrypt(self, password: bytes | str, data: bytes) -> bytes:
+        salt = os.urandom(16)
+        token = Fernet(self._key(password, salt)).encrypt(data)
+        return salt + token 
+
+    def decrypt(self, password: bytes | str, blob: bytes) -> bytes:
+        salt, token = blob[:16], blob[16:]
+        return Fernet(self._key(password, salt)).decrypt(token)
+
+    def create_password(self, size: int = 16) -> bytes:
+        return os.urandom(size)

keyring/keyring.py

@@ -0,0 +1,93 @@
+from pathlib import Path
+from .crypto import Crypto
+import pickle
+import os
+
+class Keyring:
+    
+    crypto: Crypto = Crypto()
+    
+    def __init__(self, path: Path, password: str) -> None:
+        self._data: dict = dict()
+        self._path: Path = path
+        self._password: str = password
+        if not self._path.exists():
+            self.create()
+        self.load()
+        
+    def create(self) -> None:
+        self._data['_keys'] = {}
+        self.save()
+    
+    def load(self) -> None:
+        try:
+            with open(file=self._path.as_posix(), mode='rb') as input_file:
+                data_blob: bytes = input_file.read()
+            data: bytes = self.crypto.decrypt(password=self._password, blob=data_blob)
+            self._data: dict = pickle.loads(data)
+        except Exception as e:
+            raise Exception('KeyRing Datei konnte nicht geladen werden') from e
+        
+    def save(self) -> None:
+        data: bytes = pickle.dumps(self._data)
+        data_blob: bytes = self.crypto.encrypt(password=self._password, data=data)
+        tmp_file: Path = Path(f'{self._path.as_posix()}.tmp')
+        try:
+            with open(file=tmp_file.as_posix(), mode='wb') as output_file:
+                output_file.write(data_blob)
+                output_file.flush()
+                os.fsync(output_file.fileno())
+            os.replace(tmp_file.as_posix(), self._path.as_posix())
+            os.chmod(self._path.as_posix(), 0o600)
+        except Exception as e:
+            tmp_file.unlink(missing_ok=True)
+            raise Exception('Keyringfile konnte nicht geschrieben werden') from e
+    
+    def get(self, name: str) -> dict | None:
+        if name not in ['_keys',]:
+            if name in self._data:
+                ring_password: bytes = self.crypto.decrypt(password=self._password, blob=self._data['_keys'][name])
+                temp: dict = dict()
+                for k in self._data[name]:
+                    temp[k] = self.crypto.decrypt(password=ring_password, blob=self._data[name][k]).decode(encoding='utf-8')
+                return temp
+        return None
+    
+    def put(self, name: str, user: str | None = None, password: str | None = None, description: str | None = None, overwrite: bool = False) -> None:
+        if name not in ['_keys',]:
+            data: dict = dict()
+            if name in self._data and overwrite == True:
+                current: dict = self.get(name=name)
+                data: dict = {
+                    'user': user if user is not None else current['user'],
+                    'password': password if password is not None else current['password'],
+                    'description': description if description is not None else current['description']
+                }
+            if name not in self._data:
+                data: dict = {
+                    'user': user if user is not None else str(),
+                    'password': password if password is not None else str(),
+                    'description': description if description is not None else str()
+                }
+            if len(data) > 0:
+                ring_password: bytes = self.crypto.create_password()
+                for k in data:
+                    data[k] = self.crypto.encrypt(password=ring_password, data=data[k].encode(encoding='utf-8'))
+          
+                self._data[name] = data
+                self._data['_keys'][name] = self.crypto.encrypt(password=self._password, data=ring_password)
+                self.save()
+    
+    def delete(self, name: str) -> None:
+        if name not in ['_keys',]:
+            if name in self._data:
+                self._data.pop(name)
+                self._data['_keys'].pop(name)
+                self.save()
+                
+    def names(self) -> list[str]:
+        result: list = list()
+        for k in self._data:
+            if k not in ['_keys',]:
+                result.append(str(k))
+        return result