@landstrip/landstrip-api 0.18.43 → 0.19.0

package/README.md

@@ -1,64 +1,49 @@
-# landstrip
+# @landstrip/landstrip-api
 
-`landstrip` runs commands in an OS-level sandbox using Landlock on Linux,
-Seatbelt on macOS, and AppContainer or restricted users on Windows.
+Node.js wrapper, native binaries, and TypeScript types for the Landstrip sandbox.
+Requires Node.js 18 or newer; binaries are provided for Linux, macOS, and Windows
+on x64 and arm64.
 
-## Install
+## Install and run
 
 ```sh
 npm install --save-dev @landstrip/landstrip-api
 npx landstrip run -p policy.json -- cargo test
 ```
 
-The npm package installs a Node.js wrapper and a native binary for the current
-platform.
+See the [quick start](../../README.md#quick-start) for an example policy and
+[landstrip(1)](../landstrip/man/man1/landstrip.1) for CLI options, policy rules,
+and platform limits.
 
-## Usage
+## Node.js API
 
-```sh
-landstrip run -p policy.json -- cargo test
-landstrip policy validate -p policy.json
-landstrip policy resolve -p policy.json
-landstrip doctor
-```
-
-Run `landstrip --help` or see [landstrip(1)](../landstrip/man/man1/landstrip.1) for the full
-command reference.
-
-## Agent extensions
+```js
+const { execFileSync } = require('node:child_process');
+const { binaryPath } = require('@landstrip/landstrip-api');
 
-| Integration | Package                | Documentation                                                        |
-| ----------- | ---------------------- | -------------------------------------------------------------------- |
-| OpenCode    | `opencode-landstrip`   | [OpenCode](packages/opencode-landstrip/README.md)                    |
-| Pi          | `pi-landstrip`         | [Pi](packages/pi-landstrip/README.md)                                |
+execFileSync(binaryPath(), ['run', '-p', 'policy.json', '--', 'cargo', 'test'], {
+  stdio: 'inherit',
+});
+```
 
-## Policy
+`binaryPath()` returns the installed native binary's path and throws if the
+platform is unsupported or its binary package is missing. `packageName()` returns
+the platform's binary package name. Both accept optional `platform` and `arch`
+arguments, defaulting to the current process.
 
-```json
-{
-  "filesystem": {
-    "allowWrite": ["."],
-    "denyWrite": ["**/.env", "**/*.pem"],
-    "denyRead": ["~/.ssh"],
-    "allowRead": ["~/.ssh/config"]
-  },
-  "network": {
-    "allowNetwork": false,
-    "allowLocalBinding": false
-  }
-}
-```
+The package exports [`LandstripTrap` and `LandstripControlResponse`](lib/index.d.ts)
+for structured events and Linux broker replies. Runtime traps and approval
+queries are Linux-only; macOS's `--trap` reports setup and launch failures.
+Descriptor lifetimes and the reply protocol are covered in the manual.
 
-Pass policies with `-p, --policy <FILE>`. Later policies merge over earlier
-ones. Platform behavior and limits are documented in the manual.
+Integration helpers are exported through [`/shared`](lib/shared.d.ts) and
+[`/proxy`](lib/proxy.d.ts).
 
 ## Development
 
-```sh
-make ci
-```
+Run `make ci` from the repository root.
 
-## Licensing
+## License
 
-`@landstrip/landstrip-api` is licensed under the Apache 2.0 license. See
-[LICENSE](LICENSE) for more information.
+[Apache-2.0](LICENSE). The bundled native binary is
+[LGPL-3.0-or-later](../landstrip/LICENSE).

package/lib/index.d.ts

@@ -10,7 +10,7 @@ export type LandstripMechanism =
 /**
  * `query` holds the syscall until the launcher answers with a
  * {@link LandstripControlResponse}; `info` is terminal. Queries need a socket on
- * `--trap-fd`, and only the Linux broker raises them.
+ * `--trap`, and only the Linux broker raises them.
  */
 export type LandstripTrapState = 'query' | 'info';
 
@@ -83,6 +83,7 @@ export type LandstripPolicyErrorCode =
   | 'POLICY_PARSE_FAILED'
   | 'POLICY_IO_FAILED'
   | 'POLICY_UNRESTRICTED_READ'
+  | 'POLICY_DENY_READ_ALWAYS_UNSUPPORTED'
   | 'POLICY_TCP_BIND_UNSUPPORTED'
   | 'POLICY_UNIX_SOCKET_UNSUPPORTED'
   | 'POLICY_UNIX_SOCKET_PATH'
@@ -118,7 +119,7 @@ export type LandstripInternalTrap =
 
 /**
  * One landstrip event. Failure and completed-denial events are written to
- * stderr; pending Linux query events are written only to `--trap-fd`.
+ * stderr; pending Linux query events are written only to `--trap`.
  */
 export type LandstripTrap =
   | LandstripFilesystemTrap

package/lib/proxy.js

@@ -4,6 +4,7 @@
 const { lookup } = require('node:dns/promises');
 const { Agent, createServer: createHttpServer, request: requestHttp } = require('node:http');
 const { connect, isIP } = require('node:net');
+const { pipeline } = require('node:stream');
 
 const { canonicalizeHost } = require('./shared');
 
@@ -262,7 +263,9 @@ function startFilterProxy(options) {
         upstreamResponse.statusMessage,
         stripHopByHopHeaders(upstreamResponse.headers),
       );
-      upstreamResponse.pipe(clientResponse);
+      pipeline(upstreamResponse, clientResponse, (error) => {
+        if (error) upstreamRequest.destroy();
+      });
     });
     upstreamRequest.once('error', () => {
       if (!clientResponse.headersSent) {
@@ -272,8 +275,12 @@ function startFilterProxy(options) {
       }
     });
     clientRequest.once('aborted', () => upstreamRequest.destroy());
+    clientRequest.once('error', () => upstreamRequest.destroy());
+    clientResponse.once('error', () => upstreamRequest.destroy());
     clientResponse.once('close', () => {
-      if (!clientResponse.writableEnded) upstreamRequest.destroy();
+      clientRequest.unpipe(upstreamRequest);
+      upstreamRequest.destroy();
+      agent.destroy();
     });
     clientRequest.pipe(upstreamRequest);
   }

package/lib/shared.js

@@ -68,22 +68,22 @@ function sessionScopeFor(filePath, baseDirectory) {
 }
 
 function canonicalizeHost(host) {
+  if (/[\s\p{Cc}/\\@?#]/u.test(host)) return null;
+
   const bracketed = host.startsWith('[');
   if (bracketed !== host.endsWith(']')) return null;
-
-  // A trailing dot ("pastebin.com.") is the same host to DNS but would slip
-  // past a literal deny entry; strip a single trailing dot and reject the rest.
-  const value = bracketed ? host.slice(1, -1) : host.replace(/\.$/, '');
-  if (!value || value.endsWith('.')) return null;
+  const value = bracketed ? host.slice(1, -1) : host;
 
   if (ipaddr.isValid(value)) {
     if (bracketed && ipaddr.parse(value).kind() !== 'ipv6') return null;
     return ipaddr.process(value).toString();
   }
-  if (bracketed) return null;
+  if (bracketed || /[:%]/.test(value)) return null;
 
-  const ascii = domainToASCII(value);
-  if (!ascii) return null;
+  // A trailing dot ("pastebin.com.") is the same host to DNS but would slip
+  // past a literal deny entry; strip a single trailing dot and reject the rest.
+  const ascii = domainToASCII(value).replace(/\.$/, '');
+  if (!ascii || ascii.endsWith('.')) return null;
 
   try {
     const parsed = new URL(`http://${ascii}/`);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@landstrip/landstrip-api",
-  "version": "0.18.43",
+  "version": "0.19.0",
   "description": "Sandbox runner using Landlock, Seatbelt, and AppContainer",
   "license": "Apache-2.0",
   "homepage": "https://github.com/landstrip/landstrip#readme",
@@ -40,12 +40,12 @@
     "ipaddr.js": "^2.5.0"
   },
   "optionalDependencies": {
-    "@landstrip/landstrip-darwin-arm64": "0.18.43",
-    "@landstrip/landstrip-darwin-x64": "0.18.43",
-    "@landstrip/landstrip-linux-x64": "0.18.43",
-    "@landstrip/landstrip-linux-arm64": "0.18.43",
-    "@landstrip/landstrip-win32-x64": "0.18.43",
-    "@landstrip/landstrip-win32-arm64": "0.18.43"
+    "@landstrip/landstrip-darwin-arm64": "0.19.0",
+    "@landstrip/landstrip-darwin-x64": "0.19.0",
+    "@landstrip/landstrip-linux-x64": "0.19.0",
+    "@landstrip/landstrip-linux-arm64": "0.19.0",
+    "@landstrip/landstrip-win32-x64": "0.19.0",
+    "@landstrip/landstrip-win32-arm64": "0.19.0"
   },
   "publishConfig": {
     "access": "public"