gemstone-utils 0.4.0__tar.gz

gemstone_utils-0.4.0/LICENSE

@@ -0,0 +1,373 @@
+Mozilla Public License Version 2.0
+==================================
+
+1. Definitions
+--------------
+
+1.1. "Contributor"
+    means each individual or legal entity that creates, contributes to
+    the creation of, or owns Covered Software.
+
+1.2. "Contributor Version"
+    means the combination of the Contributions of others (if any) used
+    by a Contributor and that particular Contributor's Contribution.
+
+1.3. "Contribution"
+    means Covered Software of a particular Contributor.
+
+1.4. "Covered Software"
+    means Source Code Form to which the initial Contributor has attached
+    the notice in Exhibit A, the Executable Form of such Source Code
+    Form, and Modifications of such Source Code Form, in each case
+    including portions thereof.
+
+1.5. "Incompatible With Secondary Licenses"
+    means
+
+    (a) that the initial Contributor has attached the notice described
+        in Exhibit B to the Covered Software; or
+
+    (b) that the Covered Software was made available under the terms of
+        version 1.1 or earlier of the License, but not also under the
+        terms of a Secondary License.
+
+1.6. "Executable Form"
+    means any form of the work other than Source Code Form.
+
+1.7. "Larger Work"
+    means a work that combines Covered Software with other material, in
+    a separate file or files, that is not Covered Software.
+
+1.8. "License"
+    means this document.
+
+1.9. "Licensable"
+    means having the right to grant, to the maximum extent possible,
+    whether at the time of the initial grant or subsequently, any and
+    all of the rights conveyed by this License.
+
+1.10. "Modifications"
+    means any of the following:
+
+    (a) any file in Source Code Form that results from an addition to,
+        deletion from, or modification of the contents of Covered
+        Software; or
+
+    (b) any new file in Source Code Form that contains any Covered
+        Software.
+
+1.11. "Patent Claims" of a Contributor
+    means any patent claim(s), including without limitation, method,
+    process, and apparatus claims, in any patent Licensable by such
+    Contributor that would be infringed, but for the grant of the
+    License, by the making, using, selling, offering for sale, having
+    made, import, or transfer of either its Contributions or its
+    Contributor Version.
+
+1.12. "Secondary License"
+    means either the GNU General Public License, Version 2.0, the GNU
+    Lesser General Public License, Version 2.1, the GNU Affero General
+    Public License, Version 3.0, or any later versions of those
+    licenses.
+
+1.13. "Source Code Form"
+    means the form of the work preferred for making modifications.
+
+1.14. "You" (or "Your")
+    means an individual or a legal entity exercising rights under this
+    License. For legal entities, "You" includes any entity that
+    controls, is controlled by, or is under common control with You. For
+    purposes of this definition, "control" means (a) the power, direct
+    or indirect, to cause the direction or management of such entity,
+    whether by contract or otherwise, or (b) ownership of more than
+    fifty percent (50%) of the outstanding shares or beneficial
+    ownership of such entity.
+
+2. License Grants and Conditions
+--------------------------------
+
+2.1. Grants
+
+Each Contributor hereby grants You a world-wide, royalty-free,
+non-exclusive license:
+
+(a) under intellectual property rights (other than patent or trademark)
+    Licensable by such Contributor to use, reproduce, make available,
+    modify, display, perform, distribute, and otherwise exploit its
+    Contributions, either on an unmodified basis, with Modifications, or
+    as part of a Larger Work; and
+
+(b) under Patent Claims of such Contributor to make, use, sell, offer
+    for sale, have made, import, and otherwise transfer either its
+    Contributions or its Contributor Version.
+
+2.2. Effective Date
+
+The licenses granted in Section 2.1 with respect to any Contribution
+become effective for each Contribution on the date the Contributor first
+distributes such Contribution.
+
+2.3. Limitations on Grant Scope
+
+The licenses granted in this Section 2 are the only rights granted under
+this License. No additional rights or licenses will be implied from the
+distribution or licensing of Covered Software under this License.
+Notwithstanding Section 2.1(b) above, no patent license is granted by a
+Contributor:
+
+(a) for any code that a Contributor has removed from Covered Software;
+    or
+
+(b) for infringements caused by: (i) Your and any other third party's
+    modifications of Covered Software, or (ii) the combination of its
+    Contributions with other software (except as part of its Contributor
+    Version); or
+
+(c) under Patent Claims infringed by Covered Software in the absence of
+    its Contributions.
+
+This License does not grant any rights in the trademarks, service marks,
+or logos of any Contributor (except as may be necessary to comply with
+the notice requirements in Section 3.4).
+
+2.4. Subsequent Licenses
+
+No Contributor makes additional grants as a result of Your choice to
+distribute the Covered Software under a subsequent version of this
+License (see Section 10.2) or under the terms of a Secondary License (if
+permitted under the terms of Section 3.3).
+
+2.5. Representation
+
+Each Contributor represents that the Contributor believes its
+Contributions are its original creation(s) or it has sufficient rights
+to grant the rights to its Contributions conveyed by this License.
+
+2.6. Fair Use
+
+This License is not intended to limit any rights You have under
+applicable copyright doctrines of fair use, fair dealing, or other
+equivalents.
+
+2.7. Conditions
+
+Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted
+in Section 2.1.
+
+3. Responsibilities
+-------------------
+
+3.1. Distribution of Source Form
+
+All distribution of Covered Software in Source Code Form, including any
+Modifications that You create or to which You contribute, must be under
+the terms of this License. You must inform recipients that the Source
+Code Form of the Covered Software is governed by the terms of this
+License, and how they can obtain a copy of this License. You may not
+attempt to alter or restrict the recipients' rights in the Source Code
+Form.
+
+3.2. Distribution of Executable Form
+
+If You distribute Covered Software in Executable Form then:
+
+(a) such Covered Software must also be made available in Source Code
+    Form, as described in Section 3.1, and You must inform recipients of
+    the Executable Form how they can obtain a copy of such Source Code
+    Form by reasonable means in a timely manner, at a charge no more
+    than the cost of distribution to the recipient; and
+
+(b) You may distribute such Executable Form under the terms of this
+    License, or sublicense it under different terms, provided that the
+    license for the Executable Form does not attempt to limit or alter
+    the recipients' rights in the Source Code Form under this License.
+
+3.3. Distribution of a Larger Work
+
+You may create and distribute a Larger Work under terms of Your choice,
+provided that You also comply with the requirements of this License for
+the Covered Software. If the Larger Work is a combination of Covered
+Software with a work governed by one or more Secondary Licenses, and the
+Covered Software is not Incompatible With Secondary Licenses, this
+License permits You to additionally distribute such Covered Software
+under the terms of such Secondary License(s), so that the recipient of
+the Larger Work may, at their option, further distribute the Covered
+Software under the terms of either this License or such Secondary
+License(s).
+
+3.4. Notices
+
+You may not remove or alter the substance of any license notices
+(including copyright notices, patent notices, disclaimers of warranty,
+or limitations of liability) contained within the Source Code Form of
+the Covered Software, except that You may alter any license notices to
+the extent required to remedy known factual inaccuracies.
+
+3.5. Application of Additional Terms
+
+You may choose to offer, and to charge a fee for, warranty, support,
+indemnity or liability obligations to one or more recipients of Covered
+Software. However, You may do so only on Your own behalf, and not on
+behalf of any Contributor. You must make it absolutely clear that any
+such warranty, support, indemnity, or liability obligation is offered by
+You alone, and You hereby agree to indemnify every Contributor for any
+liability incurred by such Contributor as a result of warranty, support,
+indemnity or liability terms You offer. You may include additional
+disclaimers of warranty and limitations of liability specific to any
+jurisdiction.
+
+4. Inability to Comply Due to Statute or Regulation
+---------------------------------------------------
+
+If it is impossible for You to comply with any of the terms of this
+License with respect to some or all of the Covered Software due to
+statute, judicial order, or regulation then You must: (a) comply with
+the terms of this License to the maximum extent possible; and (b)
+describe the limitations and the code they affect. Such description must
+be placed in a text file included with all distributions of the Covered
+Software under this License. Except to the extent prohibited by statute
+or regulation, such description must be sufficiently detailed for a
+recipient of ordinary skill to be able to understand it.
+
+5. Termination
+--------------
+
+5.1. The rights granted under this License will terminate automatically
+if You fail to comply with any of its terms. However, if You become
+compliant, then the rights granted under this License from a particular
+Contributor are reinstated (a) provisionally, unless and until such
+Contributor explicitly and finally terminates Your grants, and (b) on an
+ongoing basis, if such Contributor fails to notify You of the
+non-compliance by some reasonable means prior to 60 days after You have
+come back into compliance. Moreover, Your grants from a particular
+Contributor are reinstated on an ongoing basis if such Contributor
+notifies You of the non-compliance by some reasonable means, this is the
+first time You have received notice of non-compliance with this License
+from such Contributor, and You become compliant prior to 30 days after
+Your receipt of the notice.
+
+5.2. If You initiate litigation against any entity by asserting a patent
+infringement claim (excluding declaratory judgment actions,
+counter-claims, and cross-claims) alleging that a Contributor Version
+directly or indirectly infringes any patent, then the rights granted to
+You by any and all Contributors for the Covered Software under Section
+2.1 of this License shall terminate.
+
+5.3. In the event of termination under Sections 5.1 or 5.2 above, all
+end user license agreements (excluding distributors and resellers) which
+have been validly granted by You or Your distributors under this License
+prior to termination shall survive termination.
+
+************************************************************************
+*                                                                      *
+*  6. Disclaimer of Warranty                                           *
+*  -------------------------                                           *
+*                                                                      *
+*  Covered Software is provided under this License on an "as is"       *
+*  basis, without warranty of any kind, either expressed, implied, or  *
+*  statutory, including, without limitation, warranties that the       *
+*  Covered Software is free of defects, merchantable, fit for a        *
+*  particular purpose or non-infringing. The entire risk as to the     *
+*  quality and performance of the Covered Software is with You.        *
+*  Should any Covered Software prove defective in any respect, You     *
+*  (not any Contributor) assume the cost of any necessary servicing,   *
+*  repair, or correction. This disclaimer of warranty constitutes an   *
+*  essential part of this License. No use of any Covered Software is   *
+*  authorized under this License except under this disclaimer.         *
+*                                                                      *
+************************************************************************
+
+************************************************************************
+*                                                                      *
+*  7. Limitation of Liability                                          *
+*  --------------------------                                          *
+*                                                                      *
+*  Under no circumstances and under no legal theory, whether tort      *
+*  (including negligence), contract, or otherwise, shall any           *
+*  Contributor, or anyone who distributes Covered Software as          *
+*  permitted above, be liable to You for any direct, indirect,         *
+*  special, incidental, or consequential damages of any character      *
+*  including, without limitation, damages for lost profits, loss of    *
+*  goodwill, work stoppage, computer failure or malfunction, or any    *
+*  and all other commercial damages or losses, even if such party      *
+*  shall have been informed of the possibility of such damages. This   *
+*  limitation of liability shall not apply to liability for death or   *
+*  personal injury resulting from such party's negligence to the       *
+*  extent applicable law prohibits such limitation. Some               *
+*  jurisdictions do not allow the exclusion or limitation of           *
+*  incidental or consequential damages, so this exclusion and          *
+*  limitation may not apply to You.                                    *
+*                                                                      *
+************************************************************************
+
+8. Litigation
+-------------
+
+Any litigation relating to this License may be brought only in the
+courts of a jurisdiction where the defendant maintains its principal
+place of business and such litigation shall be governed by laws of that
+jurisdiction, without reference to its conflict-of-law provisions.
+Nothing in this Section shall prevent a party's ability to bring
+cross-claims or counter-claims.
+
+9. Miscellaneous
+----------------
+
+This License represents the complete agreement concerning the subject
+matter hereof. If any provision of this License is held to be
+unenforceable, such provision shall be reformed only to the extent
+necessary to make it enforceable. Any law or regulation which provides
+that the language of a contract shall be construed against the drafter
+shall not be used to construe this License against a Contributor.
+
+10. Versions of the License
+---------------------------
+
+10.1. New Versions
+
+Mozilla Foundation is the license steward. Except as provided in Section
+10.3, no one other than the license steward has the right to modify or
+publish new versions of this License. Each version will be given a
+distinguishing version number.
+
+10.2. Effect of New Versions
+
+You may distribute the Covered Software under the terms of the version
+of the License under which You originally received the Covered Software,
+or under the terms of any subsequent version published by the license
+steward.
+
+10.3. Modified Versions
+
+If you create software not governed by this License, and you want to
+create a new license for such software, you may create and use a
+modified version of this License if you rename the license and remove
+any references to the name of the license steward (except to note that
+such modified license differs from this License).
+
+10.4. Distributing Source Code Form that is Incompatible With Secondary
+Licenses
+
+If You choose to distribute Source Code Form that is Incompatible With
+Secondary Licenses under the terms of this version of the License, the
+notice described in Exhibit B of this License must be attached.
+
+Exhibit A - Source Code Form License Notice
+-------------------------------------------
+
+  This Source Code Form is subject to the terms of the Mozilla Public
+  License, v. 2.0. If a copy of the MPL was not distributed with this
+  file, You can obtain one at https://mozilla.org/MPL/2.0/.
+
+If it is not possible or desirable to put the notice in a particular
+file, then You may include the notice in a location (such as a LICENSE
+file in a relevant directory) where a recipient would be likely to look
+for such a notice.
+
+You may add additional accurate notices of copyright ownership.
+
+Exhibit B - "Incompatible With Secondary Licenses" Notice
+---------------------------------------------------------
+
+  This Source Code Form is "Incompatible With Secondary Licenses", as
+  defined by the Mozilla Public License, v. 2.0.

gemstone_utils-0.4.0/MANIFEST.in

@@ -0,0 +1,3 @@
+include README.md
+include LICENSE
+recursive-include gemstone_utils *.py

gemstone_utils-0.4.0/PKG-INFO

@@ -0,0 +1,278 @@
+Metadata-Version: 2.4
+Name: gemstone_utils
+Version: 0.4.0
+Summary: Crypto utilities, encrypted SQLAlchemy fields, and experimental secret resolvers.
+Author: Clinton Bunch
+Project-URL: Homepage, https://github.com/gemstone-software-dev/gemstone_utils
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: cryptography>=41.0
+Requires-Dist: sqlalchemy>=2.0
+Requires-Dist: uuid6>=2024.7.1; python_version < "3.14"
+Provides-Extra: azure
+Requires-Dist: azure-identity>=1.14; extra == "azure"
+Requires-Dist: azure-keyvault-secrets>=4.7; extra == "azure"
+Provides-Extra: dev
+Requires-Dist: pytest>=7.0; extra == "dev"
+Dynamic: license-file
+
+# gemstone_utils
+
+**gemstone_utils** provides a small, stable core of cryptographic helpers, transparent AES‑GCM encrypted SQLAlchemy fields, and a minimal experimental secrets resolver suitable for Pydantic’s `BeforeValidator`. It is designed for applications that need reversible secret storage with minimal plaintext exposure and predictable operational behavior.
+
+The package is licensed under the **MPL‑2.0**, allowing use in both open‑source and proprietary projects while keeping modifications to this library itself open.
+
+## Documentation
+
+| Topic | Guide |
+|--------|--------|
+| SQLAlchemy `EncryptedString`, init order, rotation | [docs/sqlalchemy.md](docs/sqlalchemy.md) |
+| Persisted keys (`key_storage`), two-level wire semantics, bootstrap | [docs/key-storage.md](docs/key-storage.md) |
+| Experimental `resolve_secret` and backends | [docs/secrets-resolver.md](docs/secrets-resolver.md) |
+| Curated public API (stable vs experimental) | [docs/api.md](docs/api.md) |
+
+Breaking changes and migration (including UUID key ids): [RELEASE_NOTES.md](RELEASE_NOTES.md). A data-migration outline for key ids: [scripts/migrate_key_ids.py](scripts/migrate_key_ids.py).
+
+---
+
+## Features
+
+### 🔐 Cryptography core
+- Registered symmetric algorithms (`SYM_ALG_REGISTRY`, `SUPPORTED_SYM_ALGS`) with **`encrypt_alg` / `decrypt_alg`** (optional per‑algorithm params; encrypt returns **`(ciphertext, updated_params)`**)
+- **`recommended_data_alg()`** / **`RECOMMENDED_DATA_ALG`** — library default field algorithm id (avoids hardcoding in apps)
+- **`generate_key_by_alg(alg)`** for DEK-sized random bytes from the registry
+- PBKDF2‑HMAC‑SHA256 key derivation (no extra dependencies)
+- URL‑safe base64 encoding helpers
+- Minimal, dependency‑light design
+
+### 🧩 Encrypted fields
+- `$A256GCM$<uuid>$base64(json)$base64(blob)` encrypted‑field format (segment 2 is a **canonical UUID** string, typically UUIDv7 from `gemstone_utils.key_id.new_key_id()`)
+- `KeyContext` (`keyid` as `str`, `key`, `alg`) in `gemstone_utils.types`
+- `encrypt_string()` and `decrypt_string()` helpers in `gemstone_utils.encrypted_fields`
+
+### 🗄️ SQLAlchemy integration
+- `EncryptedString` TypeDecorator
+- Transparent encryption on write
+- Lazy decryption on read via `LazySecret`
+- Prevents accidental double‑encryption
+- `EncryptedString.set_current_keyctx()` for the active write key
+- `EncryptedString.set_keyctx_resolver()` to map `keyid` from stored ciphertext to a `KeyContext` on read
+
+### 🔐 Key management (`key_mgmt`)
+- **`derive_kek(passphrase, params)`** plus a pluggable **`register_kdf`** registry; params JSON is the source of truth for which algorithm runs.
+- **`recommended_kdf_params()`** — library default for *new* KDF rows (today: PBKDF2‑HMAC‑SHA256 with strong iteration count and random salt).
+- **`gemstone_utils.key_mgmt.kdf`** — documented contract (`RecommendedKdfParamsFn`, `HasKdfRegistryName`) and per‑algorithm modules (e.g. **`kdf.pbkdf2`**: `NAME`, `pbkdf2_params`, `recommended_pbkdf2_params`) when you pin a specific algorithm instead of the default.
+
+### 🔑 SQL key storage (`sqlalchemy.key_storage`)
+- Tables `gemstone_key_kdf` (KEK slot: persisted KDF JSON, **`canary_wrapped`**, optional **`app_reencrypt_pending`**, timestamps) and `gemstone_key_record` (**DEKs only**: wrapped keys in the same five‑part wire format as encrypted columns, plus **`data_alg`**, **`is_active`**, **`created_at`**, **`updated_at`**). Primary keys are **UUID strings** (`String(36)` until v0.9.0; see release notes).
+- The KEK **canary** lives on the **`gemstone_key_kdf`** row (`canary_wrapped`), not in `gemstone_key_record`. The **segment** `keyid` inside each wrapped DEK wire string is the KEK slot id (row in `gemstone_key_kdf`). The **segment** in **application** `EncryptedString` ciphertext is the **DEK** id (`gemstone_key_record.key_id`).
+- Bootstrap with **`new_kdf_params()`** (alias of **`recommended_kdf_params`**) or your own params dict; **`salt` must always be stored** in JSON for PBKDF2 rows. Use **`set_kdf_params`**, **`set_kek_canary`**, then **`put_keyrecord`** for the DEK.
+- **`put_keyrecord()`** inserts DEK rows only (validates **`data_alg`**, maintains a single active DEK when **`is_active=True`**, sets timestamps).
+- `make_keyctx_resolver()` wires `EncryptedString.set_keyctx_resolver()` to `get_session()` + persisted rows + `derive_kek` / unwrap; **`KeyContext.alg`** comes from the row’s **`data_alg`** (field algorithm), not the wrap algorithm inside `wrapped`.
+- `rewrap_key_records()` performs `rotate_kek`‑style batch re‑wrap inside a transaction you open with `with session.begin(): ...` and bumps **`updated_at`** on touched rows.
+
+Back up `gemstone_key_kdf` with the same care as `gemstone_key_record`: salt and iteration counts are required to recover KEKs from the vault passphrase.
+
+### 🧪 Experimental secret resolver
+Suitable for Pydantic `BeforeValidator`:
+
+Supports:
+- `env:` — environment variables (cached + scrubbed)
+- `file:` — read from filesystem
+- `secret:` — systemd / container secret directories
+- pluggable backend (`azexp:`) enabled by explicitly importing the plugin module
+- `$A256GCM$keyid$base64(json)$base64(blob)` encrypted values (requires `secrets_resolver.set_keyctx_resolver`)
+
+Not intended to be the final vault/meta‑manager.
+
+---
+
+## Installation
+
+```
+pip install gemstone_utils
+```
+
+With Azure Key Vault support:
+
+```
+pip install 'gemstone_utils[azure]'
+```
+
+For running tests in a checkout:
+
+```
+pip install 'gemstone_utils[dev]'
+```
+
+Or from a source tarball:
+
+```
+pip install gemstone_utils-0.4.0.tar.gz
+```
+
+---
+
+## Quick Start
+
+### 1. Derive a data key and wire `EncryptedString`
+
+```python
+from gemstone_utils.key_mgmt import derive_kek, recommended_kdf_params
+from gemstone_utils.key_mgmt.kdf.pbkdf2 import pbkdf2_params
+from gemstone_utils.types import KeyContext
+from gemstone_utils.sqlalchemy.encrypted_type import EncryptedString
+from gemstone_utils.experimental.secrets_resolver import resolve_secret
+
+passphrase = resolve_secret("env:APP_DK_PASSPHRASE")
+salt = resolve_secret("env:APP_DK_SALT").encode("utf-8")
+
+dk = derive_kek(passphrase, pbkdf2_params(salt))
+# or: derive_kek(passphrase, recommended_kdf_params(salt))
+from gemstone_utils.key_id import new_key_id
+
+kid = new_key_id()
+ctx = KeyContext(keyid=kid, key=dk)
+
+EncryptedString.set_current_keyctx(ctx)
+
+def resolve_enc_keyctx(keyid: str) -> KeyContext:
+    if keyid != ctx.keyid:
+        raise ValueError(f"unknown keyid {keyid}")
+    return ctx
+
+EncryptedString.set_keyctx_resolver(resolve_enc_keyctx)
+```
+
+`set_current_keyctx` is used for new writes. `set_keyctx_resolver` is used on read to choose the correct `KeyContext` for each row’s embedded `keyid` (needed for rotation and multiple keys).
+
+### 1b. Optional: persisted keys + `EncryptedString` resolver
+
+```python
+import gemstone_utils.sqlalchemy.key_storage  # registers ORM tables on GemstoneDB
+from gemstone_utils.crypto import generate_key_by_alg, recommended_data_alg
+from gemstone_utils.db import get_session, init_db
+from gemstone_utils.key_id import new_key_id
+from gemstone_utils.key_mgmt import derive_kek, init as key_mgmt_init, make_kek_check_record
+from gemstone_utils.sqlalchemy.encrypted_type import EncryptedString
+from gemstone_utils.sqlalchemy.key_storage import (
+    keyrecord_to_wire,
+    make_keyctx_resolver,
+    new_kdf_params,
+    put_keyrecord,
+    set_kdf_params,
+    set_kek_canary,
+    wire_wrap,
+)
+from gemstone_utils.types import KeyContext
+
+init_db("sqlite:///./app.db")
+key_mgmt_init("vault_passphrase", b"constant-canary-bytes", env_allowed=True)
+
+passphrase = "human vault passphrase"
+kdf = new_kdf_params()
+kek = derive_kek(passphrase, kdf)
+kek_id = new_key_id()
+dek_id = new_key_id()
+dek_material = generate_key_by_alg(recommended_data_alg())
+dek = KeyContext(keyid=dek_id, key=dek_material)
+
+with get_session() as session:
+    with session.begin():
+        set_kdf_params(session, kek_id, kdf)
+        set_kek_canary(
+            session,
+            kek_id,
+            keyrecord_to_wire(make_kek_check_record(kek), kek_id),
+        )
+        put_keyrecord(
+            session,
+            key_id=dek_id,
+            wrapped=wire_wrap(kek_id, kek, dek.key),
+            is_active=True,
+        )
+
+EncryptedString.set_current_keyctx(dek)
+EncryptedString.set_keyctx_resolver(
+    make_keyctx_resolver(load_passphrase=lambda: passphrase)
+)
+```
+
+KEK rotation (new passphrase or new KEK under the same KDF row) uses `rewrap_key_records` inside `with session.begin():` — see `gemstone_utils.sqlalchemy.key_storage`.
+
+### 2. Use encrypted fields in SQLAlchemy models
+
+```python
+from sqlalchemy import Column, Integer
+from gemstone_utils.sqlalchemy.encrypted_type import EncryptedString
+
+class OAuthToken(Base):
+    __tablename__ = "oauth_tokens"
+
+    id = Column(Integer, primary_key=True)
+    refresh_token = Column(EncryptedString, nullable=False)
+```
+
+### 3. Use the experimental secrets resolver with Pydantic
+
+```python
+from pydantic import BaseModel, field_validator
+from gemstone_utils.experimental.secrets_resolver import resolve_secret
+
+class Config(BaseModel):
+    api_token: str
+
+    @field_validator("api_token", mode="before")
+    @classmethod
+    def load_secret(cls, v):
+        return resolve_secret(v)
+```
+
+Config example:
+
+```
+api_token = "secret:my_api_token"
+```
+
+---
+
+## Secret Resolver Backends
+
+### `env:VAR`
+Reads from environment, caches, and scrubs the variable.
+
+### `file:/path/to/file`
+Reads a file once and caches it.
+
+### `secret:name`
+Searches:
+- `$CREDENTIALS_DIRECTORY/name`
+- `/run/secrets/name`
+- `/var/run/secrets/name`
+
+### `azexp:https://vault.vault.azure.net/secrets/name`
+Fetches from Azure Key Vault. Enabled by importing
+`gemstone_utils.experimental.azexp_backend` (or calling its `enable()`).
+Install `gemstone_utils[azure]` and authenticate with `DefaultAzureCredential`.
+Use `azexp_backend.set_azexp_credential(...)` to override credentials.
+
+### Encrypted field values (`$A256GCM$…`)
+Values use the wire form `$A256GCM$<uuid>$<base64(json)>$<base64(blob)>` where `<uuid>` is a canonical UUID string (segment 2). URL-safe base64 of a JSON object for per-algorithm parameters (currently `{}` for `A256GCM`), then URL-safe base64 of the ciphertext blob. Automatically decrypted using `secrets_resolver.set_keyctx_resolver` (separate from `EncryptedString.set_keyctx_resolver`).
+
+---
+
+## Experimental Components
+
+The following modules are intentionally minimal and **will not** be part of the future vault/meta‑manager:
+
+- `gemstone_utils.experimental.secrets_resolver`
+
+They exist to support early projects (GemstoneOps, Thaum, WebexCalling bridge) without constraining the design of the full resolver.
+
+---
+
+## License
+
+This project is licensed under the **Mozilla Public License 2.0 (MPL‑2.0)**.  
+You may use it in proprietary applications, but modifications to this library itself must be published under the MPL.