bx-mac 0.4.0 → 0.5.0

package/README.md

@@ -28,7 +28,7 @@ bx ~/work/my-project ~/work/shared-lib
 - ⚙️ Keeps VSCode, extensions, shell, Node.js, and other tooling fully functional
 - 🔍 Generates sandbox rules dynamically based on your actual `$HOME` contents
 - 📝 Supports `.bxignore` files (searched recursively) to hide secrets like `.env` files within a project
-- 📂 Supports `~/.bxallow` to grant access to shared utility directories
+- 📂 Supports `rw:` and `ro:` prefixes in `~/.bxignore` to grant read-write or read-only access to extra directories
 - 🗂️ Supports multiple working directories in a single sandbox
 
 ## 🚫 What it doesn't do
@@ -100,30 +100,29 @@ bx --verbose ~/work/my-project
 
 ## 📝 Configuration
 
-bx uses three optional config files — one entry per line, `#` for comments. Project `.bxignore` files are discovered recursively.
-
-### `~/.bxallow`
-
-Allow extra directories beyond the working directory. Paths relative to `$HOME`.
-
-```gitignore
-# Shared shell scripts and utilities
-work/bin
-shared/libs
-```
+bx uses two optional config files — one entry per line, `#` for comments. Project `.bxignore` files are discovered recursively.
 
 ### `~/.bxignore`
 
-Block additional dotdirs or files in your home. Paths relative to `$HOME`.
+Unified sandbox rules for your home directory. Paths relative to `$HOME`. Each line is either a deny rule (no prefix) or an access grant (`rw:` / `ro:` prefix, case-insensitive).
 
 ```gitignore
+# Block additional sensitive paths (no prefix = deny)
 .aws
 .azure
 .kube
 .config/gcloud
+
+# Allow read-write access to extra directories
+rw:work/bin
+rw:shared/libs
+
+# Allow read-only access (can read but not modify)
+ro:reference/docs
+ro:shared/toolchain
 ```
 
-These are blocked **in addition** to the built-in protected list:
+Deny rules are applied **in addition** to the built-in protected list:
 
 > 🔒 `.Trash` `.ssh` `.gnupg` `.docker` `.zsh_sessions` `.cargo` `.gradle` `.gem`
 
@@ -155,10 +154,11 @@ bx generates a macOS sandbox profile at launch time:
 
 1. **Scan** `$HOME` for non-hidden directories
 2. **Block** each one individually with `(deny file* (subpath ...))`
-3. **Skip** all working directories, `~/Library`, dotfiles, and `~/.bxallow` paths
+3. **Skip** all working directories, `~/Library`, dotfiles, and `rw:`/`ro:` paths from `~/.bxignore`
 4. **Descend** into parent directories of allowed paths to block only siblings (because SBPL deny rules always override allow rules)
-5. **Append** deny rules for protected dotdirs, `~/.bxignore`, and `.bxignore` files found recursively in each working directory
-6. **Write** the profile to `/tmp`, launch the app via `sandbox-exec`, clean up on exit
+5. **Append** deny rules for protected dotdirs, plain entries in `~/.bxignore`, and `.bxignore` files found recursively in each working directory
+6. **Apply** `(deny file-write*)` rules for `ro:` directories (read allowed, write blocked)
+7. **Write** the profile to `/tmp`, launch the app via `sandbox-exec`, clean up on exit
 
 ### Why not a simple deny-all + allow?
 

package/dist/bx.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-const __VERSION__ = "0.4.0";
+const __VERSION__ = "0.5.0";
 import { accessSync, constants, cpSync, existsSync, globSync, mkdirSync, readFileSync, readdirSync, rmSync, statSync, writeFileSync } from "node:fs";
 import { dirname, join, resolve } from "node:path";
 import { spawn } from "node:child_process";
@@ -147,15 +147,39 @@ function collectIgnoreFilesRecursive(dir, ignored) {
 	}
 }
 /**
-* Parse ~/.bxallow and return a set of all allowed directories.
+* Parse ~/.bxignore for RW:/RO: prefixed lines and return allowed directories.
+* Lines without prefix are ignored here (handled by collectIgnoredPaths).
+* Also checks for deprecated ~/.bxallow and migrates its entries.
 */
-function parseAllowedDirs(home, workDirs) {
+function parseHomeConfig(home, workDirs) {
 	const allowed = new Set(workDirs);
-	for (const line of parseLines(join(home, ".bxallow"))) {
-		const absolute = resolve(home, line);
-		if (existsSync(absolute) && statSync(absolute).isDirectory()) allowed.add(absolute);
+	const readOnly = /* @__PURE__ */ new Set();
+	const bxallowPath = join(home, ".bxallow");
+	if (existsSync(bxallowPath)) {
+		console.error("sandbox: WARNING — ~/.bxallow is deprecated. Move entries to ~/.bxignore with RW: prefix.");
+		for (const line of parseLines(bxallowPath)) {
+			const absolute = resolve(home, line);
+			if (existsSync(absolute) && statSync(absolute).isDirectory()) allowed.add(absolute);
+		}
+	}
+	for (const line of parseLines(join(home, ".bxignore"))) {
+		let prefix = "";
+		let path = line;
+		const match = line.match(/^(RW|RO):(.+)$/i);
+		if (match) {
+			prefix = match[1].toUpperCase();
+			path = match[2].trim();
+		}
+		if (!prefix) continue;
+		const absolute = resolve(home, path);
+		if (!existsSync(absolute) || !statSync(absolute).isDirectory()) continue;
+		if (prefix === "RW") allowed.add(absolute);
+		else readOnly.add(absolute);
 	}
-	return allowed;
+	return {
+		allowed,
+		readOnly
+	};
 }
 /**
 * Recursively collect directories to block under parentDir.
@@ -180,22 +204,27 @@ function collectBlockedDirs(parentDir, home, scriptDir, allowedDirs) {
 }
 /**
 * Collect paths to deny from .bxignore files and built-in protected dotdirs.
-* Searches ~/.bxignore and recursively through all workdirs.
+* Searches ~/.bxignore (skipping RW:/RO: lines) and recursively through all workdirs.
 */
 function collectIgnoredPaths(home, workDirs) {
 	const ignored = PROTECTED_DOTDIRS.map((d) => join(home, d));
-	applyIgnoreFile(join(home, ".bxignore"), home, ignored);
+	const globalIgnore = join(home, ".bxignore");
+	if (existsSync(globalIgnore)) {
+		const denyLines = parseLines(globalIgnore).filter((l) => !l.match(/^(RW|RO):/i));
+		for (const line of denyLines) for (const match of globSync(line, { cwd: home })) ignored.push(resolve(home, match));
+	}
 	for (const workDir of workDirs) collectIgnoreFilesRecursive(workDir, ignored);
 	return ignored;
 }
 /**
 * Generate the SBPL sandbox profile string.
 */
-function generateProfile(workDirs, blockedDirs, ignoredPaths) {
+function generateProfile(workDirs, blockedDirs, ignoredPaths, readOnlyDirs = []) {
 	const denyRules = blockedDirs.map((dir) => `  (subpath "${dir}")`).join("\n");
 	const ignoredRules = ignoredPaths.length > 0 ? `\n; Hidden paths from .bxignore\n(deny file*\n${ignoredPaths.map((p) => {
 		return existsSync(p) && statSync(p).isDirectory() ? `  (subpath "${p}")` : `  (literal "${p}")`;
 	}).join("\n")}\n)\n` : "";
+	const readOnlyRules = readOnlyDirs.length > 0 ? `\n; Read-only directories\n(deny file-write*\n${readOnlyDirs.map((dir) => `  (subpath "${dir}")`).join("\n")}\n)\n` : "";
 	return `; Auto-generated sandbox profile
 ; Working directories: ${workDirs.join(", ")}
 
@@ -206,7 +235,7 @@ function generateProfile(workDirs, blockedDirs, ignoredPaths) {
 (deny file*
 ${denyRules}
 )
-${ignoredRules}
+${ignoredRules}${readOnlyRules}
 `;
 }
 //#endregion
@@ -282,8 +311,10 @@ Options:
   -h, --help           show this help
 
 Configuration:
-  ~/.bxallow           extra allowed directories (one per line)
-  ~/.bxignore          extra blocked paths in $HOME (one per line)
+  ~/.bxignore          sandbox rules (one per line):
+                         path         block access (deny)
+                         rw:path      allow read-write access
+                         ro:path      allow read-only access
   <workdir>/.bxignore  blocked paths in project (supports globs, searched recursively)
 
 https://github.com/holtwick/bx-mac`);
@@ -297,11 +328,13 @@ const HOME = process.env.HOME;
 const WORK_DIRS = workArgs.map((a) => resolve(a));
 checkWorkDirs(WORK_DIRS, HOME);
 if (mode === "code" && profileSandbox) setupVSCodeProfile(HOME);
-const blockedDirs = collectBlockedDirs(HOME, HOME, __dirname, parseAllowedDirs(HOME, WORK_DIRS));
+const { allowed, readOnly } = parseHomeConfig(HOME, WORK_DIRS);
+const blockedDirs = collectBlockedDirs(HOME, HOME, __dirname, new Set([...allowed, ...readOnly]));
 const ignoredPaths = collectIgnoredPaths(HOME, WORK_DIRS);
 const extraIgnored = ignoredPaths.length - PROTECTED_DOTDIRS.length;
 if (extraIgnored > 0) console.error(`sandbox: .bxignore hides ${extraIgnored} extra path(s)`);
-const profile = generateProfile(WORK_DIRS, blockedDirs, ignoredPaths);
+if (readOnly.size > 0) console.error(`sandbox: ${readOnly.size} read-only director${readOnly.size === 1 ? "y" : "ies"}`);
+const profile = generateProfile(WORK_DIRS, blockedDirs, ignoredPaths, [...readOnly]);
 const profilePath = join("/tmp", `bx-${process.pid}.sb`);
 writeFileSync(profilePath, profile);
 const dirLabel = WORK_DIRS.length === 1 ? WORK_DIRS[0] : `${WORK_DIRS.length} directories`;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "bx-mac",
-  "version": "0.4.0",
+  "version": "0.5.0",
   "description": "Launch apps in a macOS sandbox — only the project directory is accessible",
   "type": "module",
   "bin": {