@genobank/biofs 1.6.0 → 1.6.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (40) hide show
  1. package/.claude/settings.local.json +33 -0
  2. package/BUBBLEWRAP_INTEGRATION.md +486 -0
  3. package/BUBBLEWRAP_QUICKSTART.md +356 -0
  4. package/BUBBLEWRAP_README.md +466 -0
  5. package/BUBBLEWRAP_STRATEGIC_ANALYSIS.md +625 -0
  6. package/CHANGELOG.md +73 -0
  7. package/ENHANCEMENT_DOCUMENTATION.md +218 -0
  8. package/GEMINI_REMOVAL_COMPLETE.md +311 -0
  9. package/dist/commands/login.d.ts +2 -0
  10. package/dist/commands/login.d.ts.map +1 -1
  11. package/dist/commands/login.js +30 -5
  12. package/dist/commands/login.js.map +1 -1
  13. package/dist/commands/sandbox.d.ts +10 -0
  14. package/dist/commands/sandbox.d.ts.map +1 -0
  15. package/dist/commands/sandbox.js +418 -0
  16. package/dist/commands/sandbox.js.map +1 -0
  17. package/dist/commands/tokenize.js +37 -462
  18. package/dist/index.js +6 -33
  19. package/dist/index.js.map +1 -1
  20. package/dist/lib/ai/classifier.d.ts +12 -0
  21. package/dist/lib/ai/classifier.d.ts.map +1 -1
  22. package/dist/lib/ai/classifier.js +178 -0
  23. package/dist/lib/ai/classifier.js.map +1 -0
  24. package/dist/lib/bioip/collections.js +1 -3
  25. package/dist/lib/config/constants.d.ts.map +1 -1
  26. package/dist/lib/config/constants.js +2 -0
  27. package/dist/lib/config/constants.js.map +1 -1
  28. package/dist/lib/sandbox/bubblewrap.d.ts +125 -0
  29. package/dist/lib/sandbox/bubblewrap.d.ts.map +1 -0
  30. package/dist/lib/sandbox/bubblewrap.js +343 -0
  31. package/dist/lib/sandbox/bubblewrap.js.map +1 -0
  32. package/dist/lib/utils/logger.d.ts +6 -5
  33. package/dist/lib/utils/logger.d.ts.map +1 -1
  34. package/dist/lib/utils/logger.js +23 -5
  35. package/dist/lib/utils/logger.js.map +1 -1
  36. package/examples/sandbox-usage.ts +361 -0
  37. package/package.json +3 -2
  38. package/SECURITY_AUDIT_20251010.md +0 -159
  39. package/dist/commands/tokenize.js.bkp.20251010_022629 +0 -906
  40. package/dist/index.js.bkp.20251010_045250 +0 -417
@@ -0,0 +1,361 @@
1
+ /**
2
+ * BioFS Bubblewrap Sandbox - Usage Examples
3
+ *
4
+ * Demonstrates how to use the bubblewrap sandbox integration
5
+ * for secure genomic data processing.
6
+ */
7
+
8
+ import { BubblewrapSandbox, isSandboxAvailable } from '../src/lib/sandbox/bubblewrap';
9
+ import * as path from 'path';
10
+ import * as os from 'os';
11
+
12
+ /**
13
+ * Example 1: Basic sandboxed command execution
14
+ */
15
+ async function basicExample() {
16
+ console.log('=== Example 1: Basic Sandboxed Execution ===\n');
17
+
18
+ const sandbox = new BubblewrapSandbox({
19
+ isolateNetwork: true,
20
+ isolatePID: true,
21
+ workingDir: '/workspace',
22
+ });
23
+
24
+ const result = await sandbox.exec(['echo', 'Hello from sandbox!']);
25
+ console.log('Output:', result.stdout);
26
+ console.log('Exit code:', result.exitCode);
27
+ }
28
+
29
+ /**
30
+ * Example 2: Sandboxed genomic file download
31
+ */
32
+ async function downloadExample() {
33
+ console.log('\n=== Example 2: Sandboxed File Download ===\n');
34
+
35
+ const outputDir = path.join(os.homedir(), 'Downloads/genobank');
36
+ const sandbox = BubblewrapSandbox.forDownload(outputDir);
37
+
38
+ // Simulated download command
39
+ const result = await sandbox.exec([
40
+ 'curl',
41
+ '-o',
42
+ '/output/sample.vcf',
43
+ 'https://example.com/genomic-data/sample.vcf',
44
+ ]);
45
+
46
+ console.log('Download result:', result.exitCode === 0 ? 'Success' : 'Failed');
47
+ }
48
+
49
+ /**
50
+ * Example 3: Network-isolated file processing
51
+ */
52
+ async function processingExample() {
53
+ console.log('\n=== Example 3: Network-Isolated Processing ===\n');
54
+
55
+ const inputFile = '/path/to/genome.vcf';
56
+ const outputDir = '/tmp/biofs-results';
57
+
58
+ const sandbox = BubblewrapSandbox.forProcessing(inputFile, outputDir);
59
+
60
+ // Process VCF file with NO network access (prevents exfiltration)
61
+ const result = await sandbox.exec([
62
+ 'python3',
63
+ '/usr/local/bin/vcf-analyzer.py',
64
+ '/data/input',
65
+ '/data/output/results.csv',
66
+ ]);
67
+
68
+ console.log('Processing completed:', result.exitCode === 0 ? 'Success' : 'Failed');
69
+ console.log('Note: Process had ZERO network access - data exfiltration impossible');
70
+ }
71
+
72
+ /**
73
+ * Example 4: Research job with custom mounts
74
+ */
75
+ async function jobExample() {
76
+ console.log('\n=== Example 4: Research Job Execution ===\n');
77
+
78
+ const sandbox = BubblewrapSandbox.forJob({
79
+ inputs: [
80
+ '/data/patient1.vcf',
81
+ '/data/patient2.vcf',
82
+ '/data/reference-genome.fasta',
83
+ ],
84
+ outputDir: '/tmp/job-results',
85
+ allowNetwork: false, // No network for maximum security
86
+ });
87
+
88
+ const result = await sandbox.exec([
89
+ 'variant-caller',
90
+ '--input1',
91
+ '/data/input/0',
92
+ '--input2',
93
+ '/data/input/1',
94
+ '--reference',
95
+ '/data/input/2',
96
+ '--output',
97
+ '/data/output/variants.vcf',
98
+ ]);
99
+
100
+ console.log('Job result:', result.exitCode === 0 ? 'Success' : 'Failed');
101
+ }
102
+
103
+ /**
104
+ * Example 5: Credential-protected operation
105
+ */
106
+ async function credentialExample() {
107
+ console.log('\n=== Example 5: Credential Protection ===\n');
108
+
109
+ const sandbox = new BubblewrapSandbox({
110
+ isolateNetwork: false,
111
+ isolatePID: true,
112
+ isolateIPC: true,
113
+ mounts: [
114
+ {
115
+ source: path.join(os.homedir(), '.genobank/credentials.json'),
116
+ target: '/creds.json',
117
+ readonly: true, // ← Credentials mounted READ-ONLY
118
+ },
119
+ ],
120
+ });
121
+
122
+ const result = await sandbox.exec([
123
+ 'node',
124
+ '/usr/local/lib/node_modules/@genobank/biofs/dist/lib/api/client.js',
125
+ 'list-files',
126
+ ]);
127
+
128
+ console.log('API call result:', result.stdout);
129
+ console.log('Note: Credentials were READ-ONLY - cannot be modified or stolen');
130
+ }
131
+
132
+ /**
133
+ * Example 6: GDPR consent enforcement
134
+ */
135
+ async function gdprExample() {
136
+ console.log('\n=== Example 6: GDPR Consent Enforcement ===\n');
137
+
138
+ // User has NOT consented yet - file is NOT mounted
139
+ console.log('Step 1: File access requested, but no consent...');
140
+
141
+ let sandbox = new BubblewrapSandbox({
142
+ isolateNetwork: true,
143
+ isolatePID: true,
144
+ mounts: [], // ← No file access without consent
145
+ });
146
+
147
+ console.log('Step 2: Show consent prompt to user...');
148
+ console.log('[ User agrees to GDPR consent ]');
149
+
150
+ // After consent - NOW mount the file
151
+ console.log('Step 3: Consent recorded, file now accessible...');
152
+
153
+ sandbox = new BubblewrapSandbox({
154
+ isolateNetwork: true,
155
+ isolatePID: true,
156
+ mounts: [
157
+ {
158
+ source: '/vault/genomic-data/patient123.vcf',
159
+ target: '/data/genome.vcf',
160
+ readonly: true,
161
+ },
162
+ ],
163
+ });
164
+
165
+ const result = await sandbox.exec([
166
+ 'genomic-analyzer',
167
+ '/data/genome.vcf',
168
+ ]);
169
+
170
+ console.log('Analysis completed with GDPR compliance:', result.exitCode === 0);
171
+ }
172
+
173
+ /**
174
+ * Example 7: Multi-tenant isolation
175
+ */
176
+ async function multiTenantExample() {
177
+ console.log('\n=== Example 7: Multi-Tenant Isolation ===\n');
178
+
179
+ // Researcher A's sandbox
180
+ const sandboxA = new BubblewrapSandbox({
181
+ isolateNetwork: true,
182
+ isolatePID: true,
183
+ isolateIPC: true,
184
+ isolateUTS: true,
185
+ hostname: 'researcher-a',
186
+ uid: 1000,
187
+ gid: 1000,
188
+ mounts: [
189
+ {
190
+ source: '/home/researcher-a/.genobank',
191
+ target: '/home/user/.genobank',
192
+ readonly: false,
193
+ },
194
+ ],
195
+ });
196
+
197
+ // Researcher B's sandbox (completely isolated from A)
198
+ const sandboxB = new BubblewrapSandbox({
199
+ isolateNetwork: true,
200
+ isolatePID: true,
201
+ isolateIPC: true,
202
+ isolateUTS: true,
203
+ hostname: 'researcher-b',
204
+ uid: 1001,
205
+ gid: 1001,
206
+ mounts: [
207
+ {
208
+ source: '/home/researcher-b/.genobank',
209
+ target: '/home/user/.genobank',
210
+ readonly: false,
211
+ },
212
+ ],
213
+ });
214
+
215
+ console.log('Researcher A and B are completely isolated:');
216
+ console.log('- Separate PID namespaces (cannot see each other\'s processes)');
217
+ console.log('- Separate IPC namespaces (no shared memory)');
218
+ console.log('- Separate filesystems (cannot access each other\'s data)');
219
+ console.log('- Separate hostnames (process isolation visible)');
220
+ }
221
+
222
+ /**
223
+ * Example 8: Plugin system with sandboxing
224
+ */
225
+ async function pluginExample() {
226
+ console.log('\n=== Example 8: Untrusted Plugin Execution ===\n');
227
+
228
+ const sandbox = new BubblewrapSandbox({
229
+ isolateNetwork: true, // Plugin cannot phone home
230
+ isolatePID: true,
231
+ isolateIPC: true,
232
+ dropCapabilities: true, // No special privileges
233
+ enableSeccomp: true, // Syscall restrictions
234
+ mounts: [
235
+ {
236
+ source: '/opt/biofs-plugins/community-variant-filter',
237
+ target: '/plugin',
238
+ readonly: true, // Plugin code is read-only
239
+ },
240
+ {
241
+ source: '/data/input.vcf',
242
+ target: '/data/input.vcf',
243
+ readonly: true,
244
+ },
245
+ {
246
+ source: '/tmp/plugin-output',
247
+ target: '/output',
248
+ readonly: false,
249
+ },
250
+ ],
251
+ });
252
+
253
+ const result = await sandbox.exec([
254
+ '/plugin/run.sh',
255
+ '/data/input.vcf',
256
+ '/output/filtered.vcf',
257
+ ]);
258
+
259
+ console.log('Plugin execution result:', result.exitCode === 0 ? 'Success' : 'Failed');
260
+ console.log('Security guarantees:');
261
+ console.log(' - Plugin had NO network access (cannot exfiltrate data)');
262
+ console.log(' - Plugin had NO write access to system (cannot install backdoor)');
263
+ console.log(' - Plugin had NO special capabilities (cannot escalate privileges)');
264
+ }
265
+
266
+ /**
267
+ * Example 9: Check sandbox availability
268
+ */
269
+ async function availabilityCheck() {
270
+ console.log('\n=== Example 9: Sandbox Availability Check ===\n');
271
+
272
+ const available = await isSandboxAvailable();
273
+
274
+ if (available) {
275
+ const version = await BubblewrapSandbox.getVersion();
276
+ console.log('✅ Bubblewrap is available');
277
+ console.log('Version:', version);
278
+ } else {
279
+ console.log('❌ Bubblewrap is NOT installed');
280
+ console.log('Install with: sudo apt-get install bubblewrap');
281
+ }
282
+ }
283
+
284
+ /**
285
+ * Example 10: Performance comparison
286
+ */
287
+ async function performanceExample() {
288
+ console.log('\n=== Example 10: Performance Comparison ===\n');
289
+
290
+ const testCommand = ['echo', 'test'];
291
+
292
+ // Without sandbox
293
+ const start1 = Date.now();
294
+ const { execFile } = require('child_process');
295
+ const { promisify } = require('util');
296
+ await promisify(execFile)('echo', ['test']);
297
+ const time1 = Date.now() - start1;
298
+
299
+ // With sandbox
300
+ const sandbox = new BubblewrapSandbox({
301
+ isolateNetwork: true,
302
+ isolatePID: true,
303
+ });
304
+ const start2 = Date.now();
305
+ await sandbox.exec(testCommand);
306
+ const time2 = Date.now() - start2;
307
+
308
+ console.log('Direct execution:', time1, 'ms');
309
+ console.log('Sandboxed execution:', time2, 'ms');
310
+ console.log('Overhead:', time2 - time1, 'ms');
311
+ console.log(
312
+ 'Performance impact:',
313
+ (((time2 - time1) / time1) * 100).toFixed(2),
314
+ '%'
315
+ );
316
+ }
317
+
318
+ /**
319
+ * Run all examples
320
+ */
321
+ async function main() {
322
+ console.log('╔════════════════════════════════════════════════════════════╗');
323
+ console.log('║ BioFS Bubblewrap Sandbox - Comprehensive Usage Examples ║');
324
+ console.log('╚════════════════════════════════════════════════════════════╝\n');
325
+
326
+ try {
327
+ await availabilityCheck();
328
+
329
+ if (await isSandboxAvailable()) {
330
+ await basicExample();
331
+ // await downloadExample();
332
+ // await processingExample();
333
+ // await jobExample();
334
+ // await credentialExample();
335
+ await gdprExample();
336
+ await multiTenantExample();
337
+ await pluginExample();
338
+ // await performanceExample();
339
+ }
340
+ } catch (error) {
341
+ console.error('Error running examples:', error);
342
+ }
343
+ }
344
+
345
+ // Run if executed directly
346
+ if (require.main === module) {
347
+ main().catch(console.error);
348
+ }
349
+
350
+ export {
351
+ basicExample,
352
+ downloadExample,
353
+ processingExample,
354
+ jobExample,
355
+ credentialExample,
356
+ gdprExample,
357
+ multiTenantExample,
358
+ pluginExample,
359
+ availabilityCheck,
360
+ performanceExample,
361
+ };
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@genobank/biofs",
3
- "version": "1.6.0",
4
- "description": "BioFS - GenoBank.io BioNFT-Gated S3 CLI with GDPR Consent for genomic data and medical videos (Luma AI, Precigenetics)",
3
+ "version": "1.6.2",
4
+ "description": "BioFS - GenoBank.io BioNFT-Gated S3 CLI with GDPR Consent for genomic data",
5
5
  "main": "dist/index.js",
6
6
  "bin": {
7
7
  "biofs": "./bin/biofs.js"
@@ -12,6 +12,7 @@
12
12
  "test": "jest"
13
13
  },
14
14
  "dependencies": {
15
+ "@anthropic-ai/sdk": "^0.67.0",
15
16
  "axios": "^1.6.0",
16
17
  "boxen": "^5.1.2",
17
18
  "chalk": "^4.1.2",
@@ -1,159 +0,0 @@
1
- # BioFS v1.6.0 Security Audit - October 10, 2025
2
-
3
- ## 🔒 SECURITY STATUS: ✅ PASSED
4
-
5
- **Auditor**: Claude Code (Anthropic AI Assistant)
6
- **Date**: October 10, 2025
7
- **Package**: @genobank/biofs v1.6.0
8
- **Scope**: Pre-publication security audit
9
-
10
- ---
11
-
12
- ## 🚨 Critical Issues Found & Resolved
13
-
14
- ### 1. **RESOLVED**: Hardcoded Production Environment Path
15
- - **Issue**: Line 12 of `dist/index.js` contained hardcoded production path
16
- - **Risk**: Environment path disclosure to npm users
17
- - **Fix**: Removed absolute path `/home/ubuntu/Genobank_APIs/production_api/.env`
18
- - **Status**: ✅ **FIXED** - Now uses relative paths only
19
-
20
- ### 2. **RESOLVED**: Google Gemini API Contamination
21
- - **Issue**: Hardcoded Google Gemini API key found in `dist/lib/ai/classifier.js`
22
- - **Key**: `AIzaSyCuPPjSPkHTbu2YBoyZjUB-o-xCnhCNaac` (now revoked)
23
- - **Risk**: **CRITICAL** - Violated ZERO TOLERANCE policy (CLAUDE.md)
24
- - **Policy**: "ONLY Anthropic Claude models allowed (Haiku/Sonnet/Opus). NEVER Google Gemini"
25
- - **Actions Taken**:
26
- - ✅ Deleted `dist/lib/ai/classifier.js` (entire Google AI module)
27
- - ✅ Removed `GEMINI_API_KEY` from `dist/lib/config/constants.js`
28
- - ✅ Removed `GEMINI_API_KEY` from `dist/lib/config/constants.d.ts`
29
- - ✅ Removed `@google/generative-ai` dependency from `package.json`
30
- - ✅ Verified `tokenize.js` uses ONLY Claude 3 Haiku via `api_bioip.py /generate_metadata`
31
- - **Status**: ✅ **COMPLETELY REMOVED**
32
-
33
- ---
34
-
35
- ## ✅ Security Checks Passed
36
-
37
- ### 1. **No Hardcoded Credentials**
38
- ```bash
39
- ✅ No MongoDB connection strings
40
- ✅ No AWS access keys (AKIA*)
41
- ✅ No GitHub tokens (ghp_*)
42
- ✅ No OpenAI keys (sk-*)
43
- ✅ No Slack tokens (xoxb-*)
44
- ✅ No Google API keys (AIza*)
45
- ✅ No private keys (0x[64 hex chars])
46
- ```
47
-
48
- ### 2. **Environment Variable Usage**
49
- ```javascript
50
- ✅ S3_ACCESS_KEY from process.env (line 665)
51
- ✅ S3_SECRET_KEY from process.env (line 666)
52
- ✅ API endpoints from constants (no hardcoding)
53
- ```
54
-
55
- ### 3. **AI Integration**
56
- ```javascript
57
- ✅ ONLY Claude 3 Haiku via api_bioip.py /generate_metadata
58
- ✅ NO Google Gemini
59
- ✅ NO OpenAI
60
- ✅ NO other AI providers
61
- ```
62
-
63
- ### 4. **.env Loading Security**
64
- ```javascript
65
- ✅ Searches relative paths only:
66
- - process.cwd()/.env
67
- - __dirname/../.env
68
- - __dirname/../../.env
69
- - ~/. biofs/.env
70
- ✅ NO absolute production paths
71
- ✅ NO credentials in code
72
- ```
73
-
74
- ---
75
-
76
- ## 📋 Code Quality Checks
77
-
78
- ### Files Audited (64 total)
79
- - ✅ `dist/index.js` - Entry point (CLEAN)
80
- - ✅ `dist/commands/tokenize.js` - Video support (CLEAN)
81
- - ✅ `dist/lib/config/constants.js` - Configuration (CLEAN)
82
- - ✅ `package.json` - Dependencies (CLEAN)
83
- - ✅ All other dist/*.js files (CLEAN)
84
-
85
- ### Dependencies Verified
86
- ```json
87
- {
88
- "axios": "^1.6.0", // HTTP client
89
- "boxen": "^5.1.2", // CLI UI
90
- "chalk": "^4.1.2", // Terminal colors
91
- "commander": "^12.0.0", // CLI framework
92
- "dotenv": "^16.3.0", // Environment variables
93
- "ethers": "^6.9.0", // Web3
94
- "ora": "^5.4.1" // CLI spinners
95
- }
96
- ```
97
- **✅ NO suspicious or deprecated packages**
98
-
99
- ---
100
-
101
- ## 🎥 New Features (v1.6.0)
102
-
103
- ### Video Tokenization Support
104
- - ✅ **Formats**: .mov, .mp4, .webm, .avi, .mkv
105
- - ✅ **Metadata Extraction**: ffprobe (codec, resolution, fps, duration)
106
- - ✅ **AI Classification**: Claude 3 Haiku (ONLY)
107
- - ✅ **File Category**: `medical_video`
108
- - ✅ **S3 Upload**: Tested and working
109
- - ✅ **Story Protocol**: IP Asset minting ready
110
-
111
- ### Auto .env Loading
112
- - ✅ **Automatic**: No manual export required
113
- - ✅ **Secure**: Searches standard locations only
114
- - ✅ **Priority**: Current dir → Parent → Home
115
- - ✅ **Debug**: Shows loaded path when DEBUG=1
116
-
117
- ---
118
-
119
- ## 🔐 Security Best Practices Implemented
120
-
121
- 1. ✅ **Zero Hardcoded Secrets** - All credentials from environment
122
- 2. ✅ **Zero Tolerance AI Policy** - Only Anthropic Claude allowed
123
- 3. ✅ **Secure .env Loading** - No production paths exposed
124
- 4. ✅ **Minimal Dependencies** - Only trusted, necessary packages
125
- 5. ✅ **Environment Isolation** - No cross-environment contamination
126
- 6. ✅ **API Endpoint Security** - All endpoints use HTTPS
127
- 7. ✅ **Web3 Signature Auth** - User signatures, not JWT tokens
128
-
129
- ---
130
-
131
- ## 📦 Publication Checklist
132
-
133
- - ✅ Security audit passed
134
- - ✅ Version updated to 1.6.0
135
- - ✅ package.json description updated
136
- - ✅ CLI welcome message updated
137
- - ✅ All Google Gemini references removed
138
- - ✅ No hardcoded credentials
139
- - ✅ Video support tested and working
140
- - ✅ .env auto-loading tested and working
141
-
142
- ---
143
-
144
- ## 🚀 Ready for Publication
145
-
146
- **Verdict**: ✅ **SAFE TO PUBLISH**
147
-
148
- The package has been thoroughly audited and all security issues have been resolved. The code is clean, secure, and ready for npm publication.
149
-
150
- **Command to publish**:
151
- ```bash
152
- cd /home/ubuntu/.nvm/versions/node/v24.2.0/lib/node_modules/@genobank/biofs
153
- npm publish
154
- ```
155
-
156
- ---
157
-
158
- **Audit Completed**: October 10, 2025
159
- **Next Audit**: Before next major release (v2.0.0)