@opengeni/vaults-protonpass 0.0.0-stage → 3.2.2

package/LICENSE

@@ -0,0 +1,190 @@
+                                 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
+
+   Copyright 2026 Cloudgeni-ai
+
+   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.

package/README.md

@@ -1,3 +1,137 @@
-# Temporary Holding Version
+# `@opengeni/vaults-protonpass`
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The Proton Pass provider for Opengeni vaults. It implements `VaultProvider`
+from `@opengeni/vaults` by running the official Proton Pass CLI
+([`pass-cli`](https://protonpass.github.io/pass-cli/)) 2.4.2 under a
+personal access token (PAT) that the customer scopes to vaults or items.
+
+Load it only with a dynamic `import()` from the API or the worker
+(`test/import-guard.test.ts`).
+
+## The CLI is operator-installed
+
+This package does not download, bundle or redistribute `pass-cli`. The
+operator installs it on the API and worker hosts and points the adapter at it.
+Before each session the adapter checks that:
+
+- the binary is an absolute path (or `pass-cli` found on a fixed
+  `/usr/bin:/bin` PATH) and is not world-writable;
+- `pass-cli --version` reports exactly `PROTON_PASS_CLI_VERSION` (2.4.2), or
+  `expectedVersion`;
+- its SHA-256 matches `expectedSha256`, when given.
+
+## Usage
+
+```ts
+const { createProtonPassVaultProvider } = await import("@opengeni/vaults-protonpass");
+const provider = createProtonPassVaultProvider({
+  token, // "pst_…::…", decrypted from the connection's stored credential
+  binaryPath: "/opt/proton/pass-cli",
+  stateRoot: "/var/lib/opengeni/protonpass", // optional; default <tmpdir>/opengeni-protonpass
+});
+// … use it, then
+await provider.close(); // logs out and wipes the session directory
+```
+
+Other options: `expectedVersion`, `expectedSha256`, `commandTimeoutMs`
+(default 60 s), `maxStdoutBytes` (32 MB), `sessionMaxAgeMs` (105 minutes),
+`idleCloseMs` (15 minutes), `valueCacheMs` and `maxItemViewsPerList` (500).
+`operations` narrows the provider to the operations verified at setup and
+refuses the rest without running the CLI. `runner`, `hostEnv` and `now` exist
+for tests.
+
+Servers use `createProtonPassProviderPool({ binaryPath, … })` once per
+process. `pool.provider(token, { connectionId?, operations? })` returns a
+provider whose session is created on its first call. Sessions are scoped to
+the connection id and token: one connection reuses its logged-in CLI session,
+while different connections (even with the same token) and different tokens
+never share a session, state directory, key or cache. Without a connection id
+the provider gets a session of its own. A connection's new token replaces its
+idle old session. Sessions unused for 15 minutes (`poolIdleMs`) are logged
+out, wiped and forgotten. `maxSessions` (32) is a hard limit: the least
+recently used idle session makes room, and when every session is busy the
+call fails with `provider_rate_limited` (retry after
+`PROTON_PASS_POOL_BUSY_RETRY_MS`, 5 seconds). `pool.close()` logs them all
+out and refuses later calls.
+
+## How it runs the CLI
+
+- **No shell, bounded output.** Every command is spawned with an argument
+  list, a deadline, bounded stdout and stderr, and a process-group kill. At
+  most `PROTON_PASS_MAX_PROCESSES` (4) CLI processes run at once per process,
+  and commands for one connection are serialized. A finished process hands
+  its slot straight to the next waiting command, so the limit holds under
+  contention.
+- **Secrets never go on argv.** The PAT is passed only in the environment of
+  `pass-cli login`. Item values for create go in on stdin
+  (`item create … --from-template -`).
+- **Private, isolated state.** Each provider has its own `0700` state
+  directory (used as `HOME` and `PROTON_PASS_SESSION_DIR`), the `env` key
+  provider with a random per-instance `PROTON_PASS_ENCRYPTION_KEY`, telemetry
+  and update checks off, and a minimal environment (only proxy and CA
+  settings pass through). The directory is removed on `close()`, idle close
+  and process exit.
+- **Session lifecycle.** PAT sessions last about two hours, so the adapter
+  logs in again after 105 minutes. A "requires an authenticated client" reply
+  re-logs in and retries once. An invalidated session re-logs in and retries
+  reads only; a write whose outcome is unknown is never retried.
+- **Agent tokens.** For an agent PAT the CLI requires a reason on every
+  command; the adapter sends a short one built from the action and, when the
+  caller supplies it, the requesting authority. Agent tokens cannot list
+  item values in bulk, so listing views each item (at most 500 per list, else
+  `provider_inventory_incomplete`); each view is an audit event in Proton.
+  Bulk listings view only this share's items that have files, under the same
+  bound.
+- **Errors.** Failures map to `VaultProviderError` codes from the CLI's
+  `Reason:` lines and HTTP status. Raw stderr is never surfaced. A failed
+  write is definite only when it failed before sending (bad input, no
+  session, missing agent reason) or Proton refused that write itself: a
+  rejection status (400, 401, 403, 404, 409, 413, 422 or 429) or a known
+  rejection reason (permission, not found, stale revision, lock, quota,
+  invalid input). A 5xx, any other status, a server-failure or unrecognised
+  reason (`Timeout`, `InsertFailed`, …), a timeout or an error after the
+  request is `provider_outcome_unknown` and is never retried. The CLI prints
+  a decoded reason without its HTTP status, so a reason outside the
+  rejection list is treated as possibly applied. A failed login is
+  `provider_auth_invalid` only when Proton refused the token (400, 401, 403
+  or 422, or a permission or not-found reason, in the token-login context);
+  local, network, server and unrecognised failures are
+  `provider_unavailable` (429 is `provider_rate_limited`).
+
+## What it can do
+
+`PROTON_PASS_OPERATIONS` declares exactly this:
+
+| Operation | Supported | Notes |
+| --- | --- | --- |
+| List vaults | yes | `share list --only-vaults`; write access from the share role. Falls back to `vault list` (access unknown) when shares cannot be listed. |
+| List items, read values | yes | Values read live, cached per attempt; `forceRefresh` bypasses the cache. |
+| Read files | yes | Downloaded to a private directory, at most 256 KiB. |
+| Create | login, note, custom (`api_key`) | Including a TOTP seed on logins. A login takes only fields named `username`, `email` and `password` plus one TOTP; any other field is refused before running anything (use an `api_key` item). |
+| Update | **no** | The CLI's update takes values only as `--field` arguments and cannot change TOTP or time fields, so updates would put secrets on argv. Reported as `provider_unavailable` without running anything. |
+| Archive | trash (recoverable) | `item trash`. Permanent delete and restore are not exposed. |
+| Create vault, write files | no | |
+
+Writes to a share whose role is read-only are refused locally; Proton
+enforces the rest.
+
+The per-attempt value cache belongs to one provider instance (one token and
+session), so providers that share an attempt budget never see each other's
+values. Items with more than 50 fields or 20 websites (or a website over
+2,048 characters) make the listing `provider_inventory_incomplete` instead of
+being mirrored cut down.
+
+Field ids: `@note`, `login.username`, `login.email`, `login.password`,
+`login.totp`, `x:<name>` (extra fields), `s:<section>/<field>` (custom item
+sections), `ssh.*`, `wifi.*`, `card.*`, `identity.*` and `@file:<id>`, with
+`#n` on repeated names.
+
+## Testing
+
+`bun test` runs against `test/fake-pass-cli.ts`, a fake CLI that follows the
+2.4.2 source's arguments, JSON output and error lines. It covers the shared
+provider contract (read side), session lifecycle, agent reasons, error
+mapping, timeouts, output bounds, permissions and isolation.
+
+No live Proton account was used: the output shapes and error lines come from
+the CLI source and documentation, not from a live run.

package/dist/contract.d.ts

@@ -0,0 +1,6 @@
+/**
+ * The shared vault contracts this adapter implements, re-exported for the
+ * package's modules so every file names one source.
+ */
+export { VaultProviderError, type ProviderCallBudget, type ProviderCallOperation, type ProviderFieldMeta, type ProviderFieldValue, type ProviderItemMeta, type ProviderVault, type ProviderWriteField, type ProviderWriteItem, type VaultProvider, type VaultProviderAuthority, type VaultProviderCapabilities, type VaultProviderContext, type VaultProviderErrorCode, } from "@opengeni/vaults";
+export { VAULT_LIMITS, parseTotpInput, type SecretMaterial, type TotpParams, type VaultFieldKind, type VaultItemType, type VaultProviderOperations, } from "@opengeni/contracts";

package/dist/errors.d.ts

@@ -0,0 +1,57 @@
+import { VaultProviderError } from "./contract.js";
+import type { ProcessResult } from "./runner.js";
+/** The session can no longer be used; a fresh login is required. */
+export declare const SESSION_INVALIDATED: RegExp;
+/** Pre-flight: the CLI found no usable session before contacting the API. */
+export declare const NOT_AUTHENTICATED: RegExp;
+/** The Proton API error code name in stderr, if any (a closed enum, safe to report). */
+export declare function protonReason(stderr: string): string | null;
+export declare function protonStatus(stderr: string): number | null;
+/**
+ * Statuses with which Proton refuses a request before applying it: a bad or
+ * invalid request (400, 422), an unauthorised or forbidden one (401, 403), a
+ * missing target (404), a conflict (409), an oversized payload (413) or
+ * throttling (429). Any other status (500, 502, 503, 504 from Proton or a
+ * proxy, or anything unexpected) may follow an applied change.
+ */
+export declare const PROTON_DEFINITE_REJECTION_STATUSES: ReadonlySet<number>;
+/**
+ * `ProtonApiErrorCode` names (pass-cli 2.4.2 pass/src/error.rs) that describe
+ * a refusal of the request itself: permission, a missing or deleted target, a
+ * stale revision or key, a lock, a quota, or invalid input. Server-side
+ * failures that may follow a partial write (`Timeout`, `InsertFailed`,
+ * `SelectFailed`, `UploadFailure`, the `Provider*` family) and any name not
+ * listed here leave a mutation's outcome unknown.
+ */
+export declare const PROTON_DEFINITE_REJECTION_REASONS: ReadonlySet<string>;
+/**
+ * True when stderr shows Proton refused the request without applying it: a
+ * known rejection reason, or (when no reason was decoded) a rejection status.
+ */
+export declare function isDefiniteRejection(stderr: string): boolean;
+/**
+ * Maps a failed pass-cli run to a provider error. `subject` names the action in
+ * the message (for example "list items"); stderr content never leaves here
+ * except the closed Proton error-code name.
+ */
+export declare function mapProtonFailure(result: ProcessResult, subject: string): VaultProviderError;
+/**
+ * Whether a failed mutation is known not to have taken effect. Only a server
+ * rejection inside the mutation's own error context (`Error creating …`,
+ * `Error trashing item`) with a known rejection reason or status, or a
+ * pre-flight marker, counts. A server error (500, 502, 503, 504 or any other
+ * status or reason outside the rejection sets), a timeout, a signal, a
+ * cancelled call or an error after the request (for example the agent monitor
+ * event sent after a create) leaves the outcome unknown.
+ */
+export declare function isDefiniteMutationFailure(result: ProcessResult, mutationContext: RegExp): boolean;
+export declare function outcomeUnknown(subject: string): VaultProviderError;
+/**
+ * Maps a failed `pass-cli login`. Only Proton's own refusal of the token
+ * (a 400, 401, 403 or 422 answer, or a permission or not-found reason, in
+ * the token-login context) asks the customer for a new token. Local
+ * failures (key provider, disk, an unexpected CLI error), network trouble,
+ * throttling and server errors are `provider_unavailable` or
+ * `provider_rate_limited`; reconnecting would not help with them.
+ */
+export declare function loginFailure(result: ProcessResult): VaultProviderError;

package/dist/index.d.ts

@@ -0,0 +1,6 @@
+export { PROTON_PASS_MAX_ITEM_VIEWS_PER_LIST, PROTON_PASS_OPERATIONS, PROTON_PASS_VALUE_CACHE_MS, createProtonPassVaultProvider, protonPassCapabilities, type ProtonPassVaultProvider, type ProtonPassVaultProviderOptions, } from "./provider.js";
+export { PROTON_PASS_CLI_VERSION, PROTON_PASS_COMMAND_TIMEOUT_MS, PROTON_PASS_IDLE_CLOSE_MS, PROTON_PASS_MAX_PROCESSES, PROTON_PASS_SESSION_MAX_AGE_MS, type ProtonCliOptions, } from "./session.js";
+export { FILE_FIELD_PREFIX, LOGIN_FIELD_IDS, NOTE_FIELD_ID } from "./mapping.js";
+export { PROTON_PASS_POOL_BUSY_RETRY_MS, PROTON_PASS_POOL_IDLE_MS, PROTON_PASS_POOL_MAX_SESSIONS, createProtonPassProviderPool, type ProtonPassPoolProviderOptions, type ProtonPassProviderPool, type ProtonPassProviderPoolOptions, } from "./pool.js";
+export { restrictToOperations } from "./operations.js";
+export type { ProcessRequest, ProcessResult, ProcessRunner } from "./runner.js";