node-lxc 1.0.0

package/LICENSE

@@ -0,0 +1,201 @@
+                                 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
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2026 ProjectSource V.O.F.
+
+   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

@@ -0,0 +1,328 @@
+# node-lxc
+
+> Node.js native bindings for [LXC](https://linuxcontainers.org/lxc/) (Linux Containers) — a complete, production-ready wrapper around `liblxc` built with N-API.
+
+[![npm version](https://img.shields.io/npm/v/node-lxc.svg)](https://www.npmjs.com/package/node-lxc)
+[![license](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE)
+[![Node.js ≥ 12](https://img.shields.io/badge/node-%3E%3D12-brightgreen.svg)](https://nodejs.org)
+[![Platform: Linux](https://img.shields.io/badge/platform-linux-blue.svg)](https://linuxcontainers.org)
+
+## Features
+
+- **Full lifecycle control** — create, start, stop, reboot, shutdown, destroy
+- **Async-first** — all blocking operations return `Promise`s backed by a libuv thread pool
+- **Interactive console** — non-blocking console sessions with `EventEmitter` interface
+- **Rich configuration API** — get, set, clear, and bulk-read container configuration
+- **Snapshot support** — create, list, restore, and destroy snapshots
+- **CRIU integration** — checkpoint, restore, and live-migrate containers
+- **Mount injection** — bind-mount paths into running containers without restart
+- **Resource metrics** — async cgroup stat reads (memory, CPU, block I/O)
+- **Network management** — attach/detach interfaces, query IPs and interfaces
+- **Device hotplug** — add/remove device nodes into running containers
+- **Seccomp support** — retrieve seccomp notification file descriptors
+- **Memory-safe** — no leaks; all heap buffers freed, all async captures by value
+- **TypeScript** — full type declarations included
+
+## Prerequisites
+
+| Requirement | Version |
+|---|---|
+| Node.js | ≥ 12.17 |
+| LXC | ≥ 4.0 |
+| liblxc-dev | (same as LXC) |
+| g++ | ≥ 7 |
+
+Install LXC on Debian/Ubuntu:
+
+```sh
+sudo apt install lxc lxc-dev
+```
+
+Verify your kernel supports LXC features:
+
+```sh
+lxc-checkconfig
+```
+
+## Installation
+
+```sh
+npm install node-lxc
+```
+
+The package ships a pre-built binary for `x86_64-linux-gnu`. No compilation step is required for this platform.
+
+## Quick Start
+
+```typescript
+import { Container, GetVersion } from "node-lxc";
+
+console.log("LXC", GetVersion()); // e.g. "5.0.2"
+
+// Create and start a container
+const c = new Container("my-container");
+
+await c.create({
+    template: "download",
+    argv: ["--dist", "ubuntu", "--release", "jammy", "--arch", "amd64"],
+});
+
+c.setConfigItem("lxc.net.0.type", "veth");
+c.setConfigItem("lxc.net.0.link", "lxcbr0");
+c.setConfigItem("lxc.net.0.flags", "up");
+
+await c.start();
+console.log(c.state);   // "RUNNING"
+console.log(c.initPID); // e.g. 12345
+
+// Run a command and get the exit code
+const code = await c.exec({ argv: ["/bin/sh", "-c", "echo hello"] });
+console.log(code); // 0
+
+await c.shutdown(30);
+await c.destroy();
+```
+
+## API
+
+### Global functions
+
+```typescript
+import {
+    GetVersion,               // → string
+    GetGlobalConfigItem,      // (key: string) → string
+    ListAllContainers,        // (lxcpath?: string) → string[]
+    ListAllDefinedContainers, // (lxcpath?: string) → string[]
+    ListAllActiveContainers,  // (lxcpath?: string) → string[]
+    ConfigItemIsSupported,    // (key: string) → boolean
+    HasApiExtension,          // (extension: string) → boolean
+    GetWaitStates,            // () → string[]
+} from "node-lxc";
+```
+
+### Container constructor
+
+```typescript
+const c = new Container(name: string, configPath?: string, alt_file?: string);
+```
+
+| Parameter | Description |
+|---|---|
+| `name` | Container name |
+| `configPath` | LXC container directory (defaults to `lxc.lxcpath`) |
+| `alt_file` | Alternate configuration file path |
+
+### Lifecycle
+
+```typescript
+await c.create({ template?, argv?, bdevtype?, bdev_specs?, flags? });
+await c.start(useinit?, argv?);
+await c.stop();
+await c.reboot(timeout?);          // → Promise<boolean>
+await c.shutdown(timeout?);        // → Promise<boolean>
+await c.freeze();
+await c.unfreeze();
+await c.destroy({ include_snapshots?, force? });
+await c.clone(options);            // → Promise<Container>
+```
+
+### State and introspection
+
+```typescript
+c.name                   // string
+c.defined                // boolean
+c.running                // boolean
+c.state                  // ContainerState ("RUNNING" | "STOPPED" | ...)
+c.initPID                // number (-1 if not running)
+c.error                  // { num: number, string: string | null }
+c.daemonize              // boolean (get/set)
+c.configPath             // string (get/set)
+c.configFileName         // string
+c.mayControl()           // → boolean
+await c.initPIDFd()      // → number (pidfd)
+await c.devptsFd()       // → number
+```
+
+### Configuration
+
+```typescript
+c.getConfigItem(key)              // → string | null
+c.setConfigItem(key, value)
+c.clearConfigItem(key)
+c.clearConfig()
+c.getRunningConfigItem(key)       // → string | null (live, running container)
+c.getKeys(prefix?)                // → string[]
+c.getConfigItems(prefix?)         // → Record<string, string | null>
+await c.loadConfig(alt_file)
+await c.save(alt_file)
+```
+
+### Execution and console
+
+```typescript
+// Run a command; returns its exit code
+await c.exec({ argv: string[], ...lxc_attach_options })  // → number
+
+// Open a shell; returns the shell's exit code
+await c.attach(options?)                                  // → number
+
+// Non-blocking async console session (EventEmitter)
+const session = await c.consoleAsync(ttynum?)  // → ConsoleSession
+session.on("data", (chunk: Buffer) => { ... });
+session.on("close", () => { ... });
+session.write(data);
+session.resize(cols, rows);
+session.close();
+
+// Blocking console (connects current stdio)
+await c.console(ttynum, [stdinfd, stdoutfd, stderrfd], escape);
+
+// Raw TTY allocation
+const [ttyfd, ptxfd] = await c.consoleGetFds(ttynum?);
+```
+
+### Resource metrics
+
+```typescript
+const stats: ContainerStats = await c.stats();
+// {
+//   "memory.usage_in_bytes":             string | null,
+//   "memory.limit_in_bytes":             string | null,
+//   "memory.memsw.usage_in_bytes":       string | null,
+//   "cpuacct.usage":                     string | null,
+//   "cpu.stat":                          string | null,
+//   "blkio.throttle.io_service_bytes":   string | null,
+// }
+```
+
+### Network
+
+```typescript
+await c.getInterfaces()                              // → string[]
+await c.getIPs(iface, "inet")                        // → string[] (IPv4)
+await c.getIPs(iface, "inet6", scope)                // → string[] (IPv6)
+await c.attachInterface(dev, dst_dev?)
+await c.detachInterface(dev, dst_dev?)
+```
+
+### Devices and cgroups
+
+```typescript
+await c.addDeviceNode(src_path, dest_path?)
+await c.removeDeviceNode(src_path, dest_path?)
+c.getCGroupItem(subsys)              // → string | undefined
+c.setCGroupItem(subsys, value)
+```
+
+### Snapshots
+
+```typescript
+await c.snapshot(commentfile)                      // → number (snap index)
+await c.snapshotList()                             // → lxc_snapshot[]
+await c.snapshotRestore(snapname, newname?)
+await c.snapshotDestroy(snapname)
+await c.snapshotDestroy(true)                      // destroy all
+```
+
+### Mount injection (running container)
+
+```typescript
+await c.mount(source, target, filesystemtype, mountflags, mnt)
+await c.umount(source, mountflags, mnt)
+```
+
+### CRIU checkpoint / restore / migrate
+
+```typescript
+await c.checkpoint(directory, stop?, verbose?)
+await c.restore(directory, verbose?)
+await c.migrate(cmd: LXC_MIGRATE, options?)
+```
+
+### Seccomp
+
+```typescript
+await c.seccompNotifyFd()        // → number
+await c.seccompNotifyFdActive()  // → number
+```
+
+### Console ring buffer
+
+```typescript
+await c.consoleLog({ clear?, read?, read_max? })  // → string
+```
+
+## Examples
+
+The `examples/` directory contains runnable scripts for common use cases:
+
+| Script | Description |
+|---|---|
+| `examples/create/` | Create a container from a template |
+| `examples/start/` | Start a container |
+| `examples/execute/` | Run a command in a container |
+| `examples/attach/` | Open a shell in a container |
+| `examples/console_async/` | Non-blocking console session |
+| `examples/clone/` | Clone a container |
+| `examples/checkpoint/` | CRIU checkpoint/restore |
+| `examples/concurrent_create/` | Concurrent container creation |
+| `examples/stats/` | Read cgroup resource metrics |
+| `examples/images/` | Browse available LXC images |
+
+Run any example with ts-node:
+
+```sh
+npm run example:create
+npm run example:execute
+npm run example:console_async
+```
+
+## Building from Source
+
+```sh
+# Install system dependencies (Debian/Ubuntu)
+sudo apt install g++ lxc lxc-dev
+
+# Install npm dependencies
+npm install
+
+# Configure and build the native addon
+node-gyp configure
+node-gyp build
+
+# Compile TypeScript
+npx tsc --build
+```
+
+## Testing
+
+```sh
+npm test
+```
+
+The test suite uses Node.js's built-in `node:test` runner. Tests that require root access (container create/start/stop/destroy) are automatically skipped unless the process is running as root.
+
+To run the full integration test suite:
+
+```sh
+sudo npm test
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on [GitHub](https://github.com/SourceRegistry/node-lxc).
+
+Please ensure:
+- New C++ code uses `std::unique_ptr<char[]>` for heap buffers
+- Async lambda captures use by-value (`[this, var]` not `[this, &var]`)
+- All public API changes include TypeScript type updates and JSDoc
+
+## License
+
+[Apache 2.0](LICENSE) © 2026 [ProjectSource V.O.F.](https://projectsource.nl)
+
+## See Also
+
+- [LXC API documentation](https://linuxcontainers.org/lxc/apidoc/structlxc__container.html)
+- [LXC C header (GitHub)](https://github.com/lxc/lxc/blob/main/src/lxc/lxccontainer.h)
+- [Linux Containers](https://linuxcontainers.org)

package/examples/attach/index.ts

@@ -0,0 +1,29 @@
+import {Container} from "../../lib";
+
+const name = "test-ct"
+
+/**
+ * In this example, a container is created and the calling process stdio is attached.
+ */
+async function main() {
+    const c = new Container(name);
+    if (!c.defined) {
+        console.log("Container creating...");
+        await c.create({
+            template: "download",
+            argv: ["--dist", "ubuntu", "--release", "lunar", "--arch", "amd64"]
+        });
+        console.log("Created");
+    }
+    if (!c.running) {
+        await c.start();
+    }
+    console.log(`Attaching to container '${name}'`)
+    await c.attach({
+        stdio: [process.stdin.fd, process.stdout.fd, process.stderr.fd],
+    });
+    console.warn(`Destroying '${name}'`)
+    await c.destroy({force: true});
+}
+
+main().catch(console.error);

package/examples/attach-streams/index.ts

@@ -0,0 +1,34 @@
+import {Container} from "../../lib";
+import {openSync} from "node:fs";
+
+const name = "test-ct"
+
+/**
+ * In this example, a container is created and the calling process stdio is attached.
+ */
+async function main() {
+    const c = new Container(name);
+    if (!c.defined) {
+        console.log("Container creating...");
+        await c.create({
+            template: "download",
+            argv: ["--dist", "ubuntu", "--release", "lunar", "--arch", "amd64"]
+        });
+        console.log("Created");
+    }
+    if (!c.running) {
+        await c.start();
+    }
+    console.log(`Attaching to container '${name}'`);
+
+    const stdoutFd = openSync("examples/attach-streams/stdout", "w+"); //TODO: Check if this works
+    const stderrFd = openSync("examples/attach-streams/stderr", "w+"); //TODO: Check if this works
+
+
+    await c.attach({stdio: [process.stdin.fd, stdoutFd, stderrFd]});  //TODO: Check if this works
+
+    console.warn(`Destroying '${name}'`)
+    await c.destroy({force: true});
+}
+
+main().catch(console.error);

package/examples/checkpoint/index.ts

@@ -0,0 +1,34 @@
+import {Container, LXC_LOGLEVEL} from "../../lib";
+import {readdir} from "node:fs/promises";
+
+const name = "test-ct"
+const checkpointDir = `/tmp/${name}`
+
+/**
+ * In this example, a container is created and the calling process stdio is attached.
+ */
+async function main() {
+    const c = new Container(name);
+
+    c.setConfigItem("lxc.log.file", `./${name}/.log`);
+    c.setConfigItem("lxc.log.level", LXC_LOGLEVEL.TRACE);
+
+    if (!c.defined) {
+        console.log("Container creating...");
+        await c.create({
+            template: "download",
+            argv: ["--dist", "ubuntu", "--release", "lunar", "--arch", "amd64"]
+        });
+        console.log("Created");
+    }
+    if (!c.running) {
+        await c.start();
+    }
+    console.log(`Creating lcone for container '${name}' in directory '${checkpointDir}'`);
+    await c.checkpoint(checkpointDir, true, true); //TODO
+
+    console.table(await readdir(checkpointDir));
+
+}
+
+main().catch(console.error);

package/examples/clone/index.ts

@@ -0,0 +1,34 @@
+import {Container, LXC_LOGLEVEL} from "../../lib";
+
+const name = "test-ct"
+
+/**
+ * In this example, a container is created and the calling process stdio is attached.
+ */
+async function main() {
+    const c = new Container(name);
+
+    c.setConfigItem("lxc.log.file", `./${name}/.log`);
+    c.setConfigItem("lxc.log.level", LXC_LOGLEVEL.TRACE);
+
+    if (!c.defined) {
+        console.log("Container creating...");
+        await c.create({
+            template: "download",
+            argv: ["--dist", "ubuntu", "--release", "lunar", "--arch", "amd64"]
+        });
+        console.log("Created");
+    }
+    if (c.running) {
+        console.warn("Container needs to be stopped to create a clone")
+        console.log("Container shutting down...");
+        await c.shutdown();
+        console.log("Done");
+
+    }
+    console.log("Creating clone...")
+    await c.clone({newname: name + "2"});
+    console.log("Done");
+}
+
+main().catch(console.error);