@push.rocks/smartsecret 1.1.0 → 1.2.0

package/readme.md

@@ -1,6 +1,6 @@
 # @push.rocks/smartsecret
 
-OS keychain-based secret storage with encrypted-file fallback for Node.js.
+OS-backed secret storage plus strict Linux kernel-keyring and envelope APIs for Node.js.
 
 ## Issue Reporting and Security
 
@@ -172,6 +172,53 @@ Key loading is an immutable per-instance snapshot. Replacing a credential file d
 
 The package never persists envelopes. The consumer owns durable envelope storage, compare-and-swap coordination during rewrap, and any metadata updates after recovery testing.
 
+## SmartSecret Kernel Store
+
+`SmartSecretKernelStore` is a separate, fail-closed API for small secrets in the Linux kernel keyring. It does not change the legacy `SmartSecret` backend selection or add a fallback to it. The store requires Node.js 25 on Linux x64 and starts only the package-owned static worker at `dist_rust/smartsecret-kernel_linux_amd64`. It never searches `PATH`, accepts an environment override, invokes a shell, probes Secret Service, or persists secret values to the filesystem.
+
+```typescript
+import { SmartSecretKernelStore } from '@push.rocks/smartsecret';
+
+const store = await SmartSecretKernelStore.create({
+  service: 'example.application',
+});
+
+try {
+  await store.setEntry('oidc-client-secret', new TextEncoder().encode('secret'));
+  const value = await store.getEntry('oidc-client-secret');
+  const deleted = await store.deleteEntry('oidc-client-secret');
+  value?.fill(0);
+} finally {
+  await store.close();
+}
+```
+
+Service and account strings must contain valid Unicode scalar values and encode to 1 through 1,024 UTF-8 bytes. Values may contain 0 through 1,024 bytes. The stored value is framed with a fixed version and exact length before publication. Existing service rings and entries are accepted only when their type, description, owner, and private permissions match the package contract.
+
+`setEntry()` copies its input before dispatch, and `getEntry()` returns a fresh byte array. The caller still owns its input and returned copies and should wipe them when no longer needed. JavaScript and operating-system buffers can retain additional copies, so this remains best-effort zeroization rather than guaranteed memory erasure.
+
+The store uses one persistent-user-owned service ring and stages unpublished objects in the process keyring. An inherited session link is preserved and revalidated, but it cannot override or conflict with the persistent root. Publication is verified before staging ownership is removed. Every operation also acquires a service-wide `NamedMutex`, which coordinates cooperating processes running as the same OS identity on the same machine.
+
+Kernel keyring permissions are an isolation boundary between OS identities, not between processes running under the same UID. Same-UID processes with access to the relevant keyrings may be able to read entries. Persistent keyrings can expire under kernel policy and are cleared by reboot. Applications must treat `null` as absence, not as evidence that a secret existed previously.
+
+Operation timeouts default to 5 seconds and may be set from 1 through 60,000 milliseconds. A timeout or abort covers queueing, mutex acquisition, and the worker request under one monotonic deadline. If a mutating request is interrupted after dispatch, or publication/release cannot be confirmed, the store rejects with a `SmartSecretKernelStoreError` whose code is `MUTATION_OUTCOME_UNKNOWN`, terminates the worker, and remains poisoned. Read-side worker integrity failures also poison and terminate the store. Always await `close()`; it waits for already-reserved operations and confirms worker termination.
+
+### DevIdP v1 keyutils migration
+
+The two `DevIdP` migration methods are intentionally narrow. They are available only on a store created with service `global.idp.devidp` and accept only accounts matching `v1:[a-f0-9]{64}`:
+
+```typescript
+const source = await store.readDevIdpV1Legacy(legacyAccount);
+if (source) {
+  // Parse the DevIdP envelope and durably verify every destination first.
+  await store.deleteDevIdpV1Legacy(source.receipt);
+}
+```
+
+`readDevIdpV1Legacy()` returns 1 through 16,384 opaque bytes plus a one-use, store-bound receipt. Deletion reacquires the same mutex and atomically rechecks the source serial, root membership, byte length, and SHA-256 digest inside one worker command. A replacement or changed value is not deleted and rejects with a `SmartSecretKernelStoreError` whose code is `SOURCE_CHANGED`. Linux keyutils does not provide compare-and-delete against an uncooperative writer that updates the same serial, so the legacy writer must be stopped or otherwise operationally quiescent before migration.
+
+This migration surface covers only a legacy record proven to have been written through the `@napi-rs/keyring` keyutils fallback. It does not probe or migrate Secret Service. If Secret Service could own the source, that source-specific migration must be implemented at its owning layer before treating a kernel-keyring miss as authoritative.
+
 ## API Reference
 
 ### `SmartSecret`
@@ -218,6 +265,27 @@ SmartSecretKeyring.create(config: ISmartSecretKeyringConfig): Promise<SmartSecre
 
 All keyring failures are `SmartSecretKeyringError` instances with a stable `TSmartSecretKeyringErrorCode`. Their message, JSON representation, Node.js inspection output, and stack contain only the code and fixed package boilerplate. Filesystem and SmartCrypto causes are not retained.
 
+### `SmartSecretKernelStore`
+
+Create kernel stores through the asynchronous factory. The constructor is not public.
+
+```typescript
+SmartSecretKernelStore.create(
+  options: ISmartSecretKernelStoreOptions,
+): Promise<SmartSecretKernelStore>
+```
+
+| Method | Signature | Description |
+| --- | --- | --- |
+| `getEntry` | `(account: string, options?) => Promise<Uint8Array \| null>` | Read a copied raw value or return `null` when absent |
+| `setEntry` | `(account: string, value: Uint8Array, options?) => Promise<void>` | Create or replace one framed entry |
+| `deleteEntry` | `(account: string, options?) => Promise<boolean>` | Delete an entry and report whether it existed |
+| `readDevIdpV1Legacy` | `(account: string, options?) => Promise<IDevIdpV1LegacyRead \| null>` | Read one verified, opaque keyutils legacy value |
+| `deleteDevIdpV1Legacy` | `(receipt, options?) => Promise<'deleted' \| 'alreadyAbsent'>` | Revalidate and consume one legacy receipt |
+| `close` | `() => Promise<void>` | Wait for reserved operations and confirm worker termination |
+
+Operation options contain optional `timeoutMs` and `signal: AbortSignal` properties. Failures are code-only `SmartSecretKernelStoreError` instances. Stable codes distinguish invalid input, unsupported runtime, unavailable kernel/worker/mutex resources, root conflicts, corrupt entries, changed migration sources, pre-dispatch aborts/timeouts, unknown mutation outcomes, poisoned/closed lifecycle state, and worker integrity failures. Secret values and underlying causes are never retained on these errors.
+
 ### Types
 
 ```typescript
@@ -283,6 +351,8 @@ Both paths can be influenced by providing a custom `vaultPath` in the constructo
 
 This repository contains open-source code licensed under the MIT License. A copy of the license can be found in the repository license file.
 
+The packaged Linux kernel worker contains statically linked third-party Rust components. Their copyright and license notices are reproduced in [third-party-notices.md](./third-party-notices.md).
+
 **Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
 
 ### Trademarks

package/third-party-notices.md

@@ -0,0 +1,177 @@
+# Third-Party Notices
+
+The `smartsecret-kernel_linux_amd64` executable distributed with this package is
+statically linked. The following notices cover its third-party Rust components
+and the compile-time components recorded by its reproducible Cargo lockfile.
+
+## Component Inventory
+
+The package uses the MIT option where a component is offered under
+`MIT OR Apache-2.0`, and the MIT option where `memchr` is offered under
+`MIT OR Unlicense`.
+
+| Component | Version | Selected license |
+| --- | --- | --- |
+| base64 | 0.22.1 | MIT |
+| bitflags | 1.3.2 | MIT |
+| block-buffer | 0.10.4 | MIT |
+| cfg-if | 1.0.4 | MIT |
+| cpufeatures | 0.2.17 | MIT |
+| crypto-common | 0.1.7 | MIT |
+| digest | 0.10.7 | MIT |
+| errno | 0.3.14 | MIT |
+| generic-array | 0.14.7 | MIT |
+| itoa | 1.0.18 | MIT |
+| keyutils | 0.4.0 | BSD-3-Clause |
+| keyutils-raw | 0.4.0 | BSD-3-Clause |
+| libc | 0.2.189 | MIT |
+| log | 0.4.33 | MIT |
+| memchr | 2.8.3 | MIT |
+| proc-macro2 | 1.0.107 | MIT |
+| quote | 1.0.47 | MIT |
+| serde | 1.0.229 | MIT |
+| serde_core | 1.0.229 | MIT |
+| serde_derive | 1.0.229 | MIT |
+| serde_json | 1.0.151 | MIT |
+| sha2 | 0.10.9 | MIT |
+| syn | 3.0.3 | MIT |
+| typenum | 1.20.1 | MIT |
+| unicode-ident | 1.0.24 | MIT AND Unicode-3.0 |
+| uninit | 0.3.0 | MIT |
+| version_check | 0.9.5 | MIT |
+| windows-link | 0.2.1 | MIT |
+| windows-sys | 0.61.2 | MIT |
+| zeroize | 1.9.0 | MIT |
+| zmij | 1.0.23 | MIT |
+
+The `windows-*` components are target-inactive for the distributed Linux
+worker. `proc-macro2`, `quote`, `serde_derive`, `syn`, and `unicode-ident` are
+compile-time components. They are listed conservatively so this notice covers
+the complete locked Rust dependency graph.
+
+## MIT Copyright Notices
+
+Copyright (c) 2015 Alice Maz (`base64`)
+
+Copyright (c) 2014 The Rust Project Developers (`bitflags`, `log`)
+
+Copyright (c) 2018-2019 The RustCrypto Project Developers (`block-buffer`)
+
+Copyright (c) 2014 Alex Crichton (`cfg-if`)
+
+Copyright (c) 2020-2025 The RustCrypto Project Developers (`cpufeatures`)
+
+Copyright (c) 2021 RustCrypto Developers (`crypto-common`)
+
+Copyright (c) 2017 Artyom Pavlov (`digest`)
+
+Copyright (c) 2014 Chris Wong (`errno`)
+
+Copyright (c) 2015 Bartłomiej Kamiński (`generic-array`)
+
+Copyright (c) The Rust Project Developers (`libc`)
+
+Copyright (c) 2015 Andrew Gallant (`memchr`)
+
+Copyright (c) 2006-2009 Graydon Hoare (`sha2`)
+
+Copyright (c) 2009-2013 Mozilla Foundation (`sha2`)
+
+Copyright (c) 2016 Artyom Pavlov (`sha2`)
+
+Copyright (c) 2014 Paho Lurie-Gregg (`typenum`)
+
+Copyright (c) 2019 Daniel Henry-Mantilla (`uninit`)
+
+Copyright (c) 2017-2018 Sergio Benitez (`version_check`)
+
+Copyright (c) 2018-2026 The RustCrypto Project Developers (`zeroize`)
+
+The remaining MIT-licensed components in the inventory publish the license
+text below without an additional copyright line in their crate license file.
+
+### MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+## BSD-3-Clause Notice for keyutils and keyutils-raw
+
+Copyright (c) 2018, Ben Boeckel
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice,
+   this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+3. Neither the name of this project nor the names of its contributors may be
+   used to endorse or promote products derived from this software without
+   specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+## Unicode License V3 for unicode-ident
+
+COPYRIGHT AND PERMISSION NOTICE
+
+Copyright © 1991-2023 Unicode, Inc.
+
+NOTICE TO USER: Carefully read the following legal agreement. BY DOWNLOADING,
+INSTALLING, COPYING OR OTHERWISE USING DATA FILES, AND/OR SOFTWARE, YOU
+UNEQUIVOCALLY ACCEPT, AND AGREE TO BE BOUND BY, ALL OF THE TERMS AND CONDITIONS
+OF THIS AGREEMENT. IF YOU DO NOT AGREE, DO NOT DOWNLOAD, INSTALL, COPY,
+DISTRIBUTE OR USE THE DATA FILES OR SOFTWARE.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+data files and any associated documentation (the "Data Files") or software and
+any associated documentation (the "Software") to deal in the Data Files or
+Software without restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, and/or sell copies of the Data Files
+or Software, and to permit persons to whom the Data Files or Software are
+furnished to do so, provided that either (a) this copyright and permission
+notice appear with all copies of the Data Files or Software, or (b) this
+copyright and permission notice appear in associated Documentation.
+
+THE DATA FILES AND SOFTWARE ARE PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF THIRD
+PARTY RIGHTS.
+
+IN NO EVENT SHALL THE COPYRIGHT HOLDER OR HOLDERS INCLUDED IN THIS NOTICE BE
+LIABLE FOR ANY CLAIM, OR ANY SPECIAL INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY
+DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
+CONNECTION WITH THE USE OR PERFORMANCE OF THE DATA FILES OR SOFTWARE.
+
+Except as contained in this notice, the name of a copyright holder shall not be
+used in advertising or otherwise to promote the sale, use or other dealings in
+these Data Files or Software without prior written authorization of the
+copyright holder.

package/ts/00_commitinfo_data.ts

@@ -3,6 +3,6 @@
  */
 export const commitinfo = {
   name: '@push.rocks/smartsecret',
-  version: '1.1.0',
-  description: 'OS keychain-based secret storage with encrypted-file fallback for Node.js.'
+  version: '1.2.0',
+  description: 'OS-backed secret storage plus strict Linux kernel-keyring and envelope APIs for Node.js.'
 }

package/ts/index.ts

@@ -13,3 +13,9 @@ export type {
   ISmartSecretEnvelopeV1,
   TSmartSecretKeyringProfile,
 } from './smartsecret.keyring.protocol.js';
+export * from './smartsecret.kernelstore.js';
+export { SmartSecretKernelStoreError } from './smartsecret.kernel.error.js';
+export type {
+  ISmartSecretKernelStoreErrorJson,
+  TSmartSecretKernelStoreErrorCode,
+} from './smartsecret.kernel.error.js';

package/ts/smartsecret.kernel.error.ts

@@ -0,0 +1,78 @@
+export type TSmartSecretKernelStoreErrorCode =
+  | 'ENTRY_CORRUPT'
+  | 'INVALID_ARGUMENT'
+  | 'KERNEL_UNAVAILABLE'
+  | 'MUTATION_OUTCOME_UNKNOWN'
+  | 'MUTEX_FAILED'
+  | 'OPERATION_ABORTED'
+  | 'OPERATION_TIMEOUT'
+  | 'RECEIPT_INVALID'
+  | 'ROOT_CONFLICT'
+  | 'SOURCE_CHANGED'
+  | 'STORE_CLOSED'
+  | 'STORE_POISONED'
+  | 'UNSUPPORTED_RUNTIME'
+  | 'WORKER_INTEGRITY_FAILED'
+  | 'WORKER_UNAVAILABLE';
+
+export interface ISmartSecretKernelStoreErrorJson {
+  name: 'SmartSecretKernelStoreError';
+  code: TSmartSecretKernelStoreErrorCode;
+  message: string;
+}
+
+const inspectSymbol = Symbol.for('nodejs.util.inspect.custom');
+const errorCodes = new Set<TSmartSecretKernelStoreErrorCode>([
+  'ENTRY_CORRUPT',
+  'INVALID_ARGUMENT',
+  'KERNEL_UNAVAILABLE',
+  'MUTATION_OUTCOME_UNKNOWN',
+  'MUTEX_FAILED',
+  'OPERATION_ABORTED',
+  'OPERATION_TIMEOUT',
+  'RECEIPT_INVALID',
+  'ROOT_CONFLICT',
+  'SOURCE_CHANGED',
+  'STORE_CLOSED',
+  'STORE_POISONED',
+  'UNSUPPORTED_RUNTIME',
+  'WORKER_INTEGRITY_FAILED',
+  'WORKER_UNAVAILABLE',
+]);
+
+/** A code-only error that intentionally retains no operation values or causes. */
+export class SmartSecretKernelStoreError extends Error {
+  public readonly code: TSmartSecretKernelStoreErrorCode;
+  public readonly cause: undefined;
+
+  constructor(codeArg: TSmartSecretKernelStoreErrorCode) {
+    const code = errorCodes.has(codeArg) ? codeArg : 'INVALID_ARGUMENT';
+    const message = `SmartSecret kernel store operation failed (${code}).`;
+    super(message);
+    this.name = 'SmartSecretKernelStoreError';
+    this.code = code;
+    this.stack = `${this.name}: ${message}`;
+    Object.defineProperty(this, 'cause', {
+      configurable: false,
+      enumerable: false,
+      value: undefined,
+      writable: false,
+    });
+  }
+
+  public toJSON(): ISmartSecretKernelStoreErrorJson {
+    return {
+      name: 'SmartSecretKernelStoreError',
+      code: this.code,
+      message: this.message,
+    };
+  }
+
+  public [inspectSymbol](): ISmartSecretKernelStoreErrorJson {
+    return this.toJSON();
+  }
+}
+
+export const createSmartSecretKernelStoreError = (
+  codeArg: TSmartSecretKernelStoreErrorCode,
+): SmartSecretKernelStoreError => new SmartSecretKernelStoreError(codeArg);