uag-envsec 0.1.0__tar.gz

uag_envsec-0.1.0/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+
+All notable changes to `uag-envsec` are documented here.
+
+## [Unreleased]
+
+### Added
+
+- Standalone `uag-envsec` Python package and `uag_envsec` CLI.
+- Version-1 ciphertext envelopes, with versionless legacy ciphertext read as v0.
+- File encryption/decryption and ciphertext inspection APIs and CLI commands.
+- File and text migration between supported envelope versions.
+- Per-file rekeying with an explicit new key, preserving the source file.
+- Keyring support, secure key-file handling, and atomic private output writes.
+- API reference and automated test coverage for legacy compatibility and security
+  behavior.
+
+### Compatibility
+
+- New encryption writes v1 by default. Specify v0 when interoperating with older
+  `uag` releases.
+- Existing v0 data remains readable by this library.

uag_envsec-0.1.0/LICENSE

@@ -0,0 +1,203 @@
+Copyright 2026 Hirofumi Ukawa
+
+                                 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 shall 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 2026 Hirofumi Ukawa (awaku7)
+
+   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.

uag_envsec-0.1.0/MANIFEST.in

@@ -0,0 +1,2 @@
+include README.md CHANGELOG.md LICENSE
+recursive-include docs *.md

uag_envsec-0.1.0/PKG-INFO

@@ -0,0 +1,256 @@
+Metadata-Version: 2.4
+Name: uag-envsec
+Version: 0.1.0
+Summary: Standalone encrypted environment-file and key-management helpers
+Author-email: Hirofumi Ukawa <hirofumi@ukawa.biz>
+License-Expression: Apache-2.0
+Classifier: Development Status :: 3 - Alpha
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Topic :: Security :: Cryptography
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: cryptography>=44.0.2
+Provides-Extra: keyring
+Requires-Dist: keyring>=25.0.0; extra == "keyring"
+Provides-Extra: test
+Requires-Dist: pytest>=8.0; extra == "test"
+Dynamic: license-file
+
+# uag-envsec
+
+Standalone Python library and CLI for encrypting environment files, managing the
+key used to protect them, and encrypting/decrypting text values.
+
+The package imports as `uag_envsec`; its distribution name is `uag-envsec`.
+It has no dependency on the `uagent` application. `cryptography` is required;
+`python-keyring` is optional and only needed when using an OS keyring backend.
+
+- [API reference](docs/API.md)
+- [Changelog](CHANGELOG.md)
+
+## Install
+
+```bash
+python -m pip install .
+```
+
+Install OS-keyring support when desired:
+
+```bash
+python -m pip install '.[keyring]'
+```
+
+For development and tests:
+
+```bash
+python -m pip install '.[test]'
+python -m pytest
+```
+
+## Python API
+
+```python
+from uag_envsec import decrypt_text, encrypt_text
+
+ciphertext = encrypt_text("API_TOKEN=example")
+plaintext = decrypt_text(ciphertext)
+```
+
+The default key is stored under `~/.uag/uag_envsec_key`, or in the OS keyring
+when the selected backend and platform allow it. An explicit `key_path` can be
+passed to `encrypt_text`, `decrypt_text`, `encrypt_file`, `decrypt_file`, and
+related functions. `encrypt_file()` writes `<source>.sec` by default; the
+plaintext source is retained and existing outputs are not overwritten.
+
+## CLI
+
+Encrypt a dotenv file to `<path>.sec`:
+
+```bash
+uag_envsec .env
+```
+
+Add or update a variable (the value is requested without echo if omitted):
+
+```bash
+uag_envsec add --file .env.sec --key API_TOKEN
+```
+
+Delete a variable:
+
+```bash
+uag_envsec delete --file .env.sec --key API_TOKEN
+```
+
+Use `--key-file PATH` to select an explicit file key. Existing output files are
+not overwritten unless `--force` is supplied. `add` and `delete` read either
+version and write version 1 by default; use `--format-version 0` when the
+result must remain readable by an older `uag` release.
+
+## Decrypt an encrypted file
+
+Decrypt to a file without printing plaintext to the terminal:
+
+```bash
+uag_envsec decrypt --file .env.sec
+```
+
+By default this creates `.env.sec.decrypted`; use `--output` to choose another
+path. The encrypted source is never replaced. An existing output is refused
+unless `--force` is given. On POSIX systems the plaintext output is created
+with owner-only permissions and written atomically.
+
+The library API provides the same operation:
+
+```python
+from uag_envsec import decrypt_file
+
+plain_path = decrypt_file(".env.sec")
+```
+
+`decrypt_file()` returns the output `Path`, keeps plaintext in memory until
+writing, and does not overwrite an existing destination by default.
+
+## Inspect an encrypted file
+
+Check the envelope version and verify that the ciphertext authenticates and can
+be decrypted, without printing plaintext or key material:
+
+```bash
+uag_envsec inspect --file .env.sec
+```
+
+The command reports the format version, ciphertext size, authentication result,
+and decryptability. The library API returns the same metadata as a dictionary:
+
+```python
+from uag_envsec import inspect_file
+
+metadata = inspect_file(".env.sec")
+```
+
+## Ciphertext format versions
+
+- **Version 0** is the historical unversioned Base64 ciphertext. Data with no
+  version marker is interpreted as version 0.
+- **Version 1** uses the `uag-envsec:v1:` prefix. The prefix is authenticated
+  as AES-GCM associated data, so removing or changing it causes decryption to
+  fail. This reserves an explicit envelope version for future format evolution.
+
+New encryption writes version 1 by default. Use version 0 explicitly when
+creating data for older `uag` releases, which only understand the historical
+unversioned format:
+
+```python
+ciphertext = encrypt_text(value, format_version=0)
+```
+
+```bash
+uag_envsec .env --format-version 0
+```
+
+This library reads both formats. Unknown or malformed version markers are
+rejected rather than guessed as legacy data.
+
+## Migrate an existing encrypted file
+
+Use the `migrate` command to decrypt an existing ciphertext in memory and
+re-encrypt it using another supported envelope version. By default it upgrades
+the file to version 1 and writes a new sibling file such as `.env.sec.v1`; the
+source is never overwritten:
+
+```bash
+uag_envsec migrate --file .env.sec --to 1
+```
+
+Choose another destination with `--output`. `--force` permits replacing that
+destination, but never replaces the source file.
+
+The same operation is available through the library API:
+
+```python
+from uag_envsec import migrate_file, migrate_text
+
+versioned_text = migrate_text(ciphertext, target_version=1)
+versioned_path = migrate_file(".env.sec", target_version=1)
+```
+
+`migrate_text()` returns encrypted text and does not write a plaintext
+intermediate file. `migrate_file()` writes atomically, preserves the source,
+and by default names the output `<source>.v<target-version>`. If a file is
+already in the requested format and no output path is specified, it validates
+the ciphertext and returns the source path without creating another file.
+
+## Rekey an encrypted file
+
+`rekey` decrypts a file in memory and encrypts it under a different key. The
+new key file is explicit and is created if it does not exist. By default the
+source remains untouched and the output is `<source>.rekeyed`:
+
+```bash
+uag_envsec rekey --file .env.sec --old-key-file ~/.uag/uag_envsec_key --new-key-file ~/.uag/envsec-next.key
+```
+
+If `--old-key-file` is omitted, the configured default key backend is used.
+The output uses version 1 by default; pass `--format-version 0` for older `uag`
+compatibility. `--force` only replaces the output; it never replaces the source.
+Keep the new key file safe. Rekeying one file does not change the library's
+configured default key or automatically rotate other `.env.sec` files.
+
+The library provides both text and file APIs:
+
+```python
+from uag_envsec import rekey_file, rekey_text
+
+rotated = rekey_text(
+    ciphertext,
+    old_key_path="old.key",
+    new_key_path="new.key",
+)
+rotated_path = rekey_file(
+    ".env.sec",
+    old_key_path="old.key",
+    new_key_path="new.key",
+)
+```
+
+`rekey_text()` requires the new key to exist and never writes plaintext to
+disk. `rekey_file()` also requires an existing new key; the CLI creates it
+before calling the API.
+
+## Key backend settings
+
+- `UAGENT_ENVSEC_KEY_BACKEND`: `auto`, `file`, or `keyring` (`os` is accepted
+  as an alias for `keyring`). Linux defaults to `file`; other platforms default
+  to `auto`.
+- `UAGENT_KEYRING_TIMEOUT`: maximum wait for an OS keyring operation in
+  seconds (default `3`, clamped to `0.1`–`30`).
+
+In `auto` mode, keyring support is used when available; if the optional package
+or a keyring backend is absent, the library uses the key file. Keyring access
+errors and timeouts fail closed rather than silently switching key sources
+while a request may still complete. The library never installs optional
+dependencies implicitly. Select `keyring` explicitly to require an installed,
+functional `python-keyring` backend.
+
+File-backed keys, including explicit key paths, are created with owner-only
+permissions on POSIX systems; existing key files with broader permissions are
+restricted before use. The default key path rejects symlinks.
+Encrypted CLI outputs are written through unique, owner-only temporary files
+and replaced atomically. `save_key(overwrite=True)` replaces the active master
+key but does not re-encrypt existing `.env.sec` files; retain the old key or
+migrate the encrypted data before replacing it.
+
+## Compatibility
+
+This extraction preserves the existing `uag_envsec` Python import name, CLI
+command, default key filename, keyring service/account, key-derivation labels,
+and version-0 AES-GCM ciphertext format used by the `uag` application. Existing
+keys and `.env.sec` files remain usable with the same key source.
+
+## License
+
+Apache-2.0. See [LICENSE](LICENSE).