node-netlink 0.0.4 → 0.0.5

package/dist/lib/structures.d.ts

@@ -0,0 +1,171 @@
+import { type TAbi } from "ya-struct";
+declare const sockaddrNlDefinition: {
+    readonly type: "struct";
+    readonly packed: false;
+    readonly fixedAbi: {};
+    readonly fields: readonly [{
+        readonly name: "nl_family";
+        readonly definition: {
+            readonly type: "c-type";
+            readonly cType: "unsigned short";
+            readonly fixedAbi: {};
+        };
+    }, {
+        readonly name: "nl_pad";
+        readonly definition: {
+            readonly type: "c-type";
+            readonly cType: "unsigned short";
+            readonly fixedAbi: {};
+        };
+    }, {
+        readonly name: "nl_pid";
+        readonly definition: {
+            readonly type: "integer";
+            readonly sizeInBits: 32;
+            readonly signed: false;
+            readonly fixedAbi: {};
+        };
+    }, {
+        readonly name: "nl_groups";
+        readonly definition: {
+            readonly type: "integer";
+            readonly sizeInBits: 32;
+            readonly signed: false;
+            readonly fixedAbi: {};
+        };
+    }];
+};
+declare const nlmsghdrDefinition: {
+    readonly type: "struct";
+    readonly packed: false;
+    readonly fixedAbi: {};
+    readonly fields: readonly [{
+        readonly name: "nlmsg_len";
+        readonly definition: {
+            readonly type: "integer";
+            readonly sizeInBits: 32;
+            readonly signed: false;
+            readonly fixedAbi: {};
+        };
+    }, {
+        readonly name: "nlmsg_type";
+        readonly definition: {
+            readonly type: "integer";
+            readonly sizeInBits: 16;
+            readonly signed: false;
+            readonly fixedAbi: {};
+        };
+    }, {
+        readonly name: "nlmsg_flags";
+        readonly definition: {
+            readonly type: "integer";
+            readonly sizeInBits: 16;
+            readonly signed: false;
+            readonly fixedAbi: {};
+        };
+    }, {
+        readonly name: "nlmsg_seq";
+        readonly definition: {
+            readonly type: "integer";
+            readonly sizeInBits: 32;
+            readonly signed: false;
+            readonly fixedAbi: {};
+        };
+    }, {
+        readonly name: "nlmsg_pid";
+        readonly definition: {
+            readonly type: "integer";
+            readonly sizeInBits: 32;
+            readonly signed: false;
+            readonly fixedAbi: {};
+        };
+    }];
+};
+declare const nlmsgerrDefinition: {
+    readonly type: "struct";
+    readonly packed: false;
+    readonly fixedAbi: {};
+    readonly fields: readonly [{
+        readonly name: "error";
+        readonly definition: {
+            readonly type: "c-type";
+            readonly cType: "int";
+            readonly fixedAbi: {};
+        };
+    }, {
+        readonly name: "msg";
+        readonly definition: {
+            readonly type: "struct";
+            readonly packed: false;
+            readonly fixedAbi: {};
+            readonly fields: readonly [{
+                readonly name: "nlmsg_len";
+                readonly definition: {
+                    readonly type: "integer";
+                    readonly sizeInBits: 32;
+                    readonly signed: false;
+                    readonly fixedAbi: {};
+                };
+            }, {
+                readonly name: "nlmsg_type";
+                readonly definition: {
+                    readonly type: "integer";
+                    readonly sizeInBits: 16;
+                    readonly signed: false;
+                    readonly fixedAbi: {};
+                };
+            }, {
+                readonly name: "nlmsg_flags";
+                readonly definition: {
+                    readonly type: "integer";
+                    readonly sizeInBits: 16;
+                    readonly signed: false;
+                    readonly fixedAbi: {};
+                };
+            }, {
+                readonly name: "nlmsg_seq";
+                readonly definition: {
+                    readonly type: "integer";
+                    readonly sizeInBits: 32;
+                    readonly signed: false;
+                    readonly fixedAbi: {};
+                };
+            }, {
+                readonly name: "nlmsg_pid";
+                readonly definition: {
+                    readonly type: "integer";
+                    readonly sizeInBits: 32;
+                    readonly signed: false;
+                    readonly fixedAbi: {};
+                };
+            }];
+        };
+    }];
+};
+declare const createNetlinkStructuresFor: ({ abi }: {
+    abi: TAbi;
+}) => {
+    abi: TAbi;
+    sockaddrNl: any;
+    nlmsghdr: any;
+    nlmsgerr: any;
+};
+type TNetlinkStructures = ReturnType<typeof createNetlinkStructuresFor>;
+declare const hostStructures: {
+    abi: TAbi;
+    sockaddrNl: any;
+    nlmsghdr: any;
+    nlmsgerr: any;
+};
+/**
+ * Formats a struct sockaddr_nl, e.g. to bind() a netlink socket.
+ */
+declare const formatNetlinkAddress: ({ address, structures }: {
+    address: {
+        nl_pid: bigint;
+        nl_groups: bigint;
+    };
+    structures?: TNetlinkStructures;
+}) => any;
+export { sockaddrNlDefinition, nlmsghdrDefinition, nlmsgerrDefinition, createNetlinkStructuresFor, hostStructures, formatNetlinkAddress, };
+export type { TNetlinkStructures, };

package/dist/lib/structures.js

@@ -0,0 +1,88 @@
+import { define, /*type TAbi */} from "ya-struct";
+import { hostAbi } from "po6";
+import { AF_NETLINK } from "./constants.js";
+
+// struct sockaddr_nl from <linux/netlink.h>
+const sockaddrNlDefinition = {
+  type: "struct",
+  packed: false,
+  fixedAbi: {},
+  fields: [
+    { name: "nl_family", definition: { type: "c-type", cType: "unsigned short", fixedAbi: {} } },
+    { name: "nl_pad", definition: { type: "c-type", cType: "unsigned short", fixedAbi: {} } },
+    { name: "nl_pid", definition: { type: "integer", sizeInBits: 32, signed: false, fixedAbi: {} } },
+    { name: "nl_groups", definition: { type: "integer", sizeInBits: 32, signed: false, fixedAbi: {} } },
+  ],
+} /*as const*/;
+
+// struct nlmsghdr from <linux/netlink.h>
+const nlmsghdrDefinition = {
+  type: "struct",
+  packed: false,
+  fixedAbi: {},
+  fields: [
+    { name: "nlmsg_len", definition: { type: "integer", sizeInBits: 32, signed: false, fixedAbi: {} } },
+    { name: "nlmsg_type", definition: { type: "integer", sizeInBits: 16, signed: false, fixedAbi: {} } },
+    { name: "nlmsg_flags", definition: { type: "integer", sizeInBits: 16, signed: false, fixedAbi: {} } },
+    { name: "nlmsg_seq", definition: { type: "integer", sizeInBits: 32, signed: false, fixedAbi: {} } },
+    { name: "nlmsg_pid", definition: { type: "integer", sizeInBits: 32, signed: false, fixedAbi: {} } },
+  ],
+} /*as const*/;
+
+// struct nlmsgerr from <linux/netlink.h>, the payload of NLMSG_ERROR
+const nlmsgerrDefinition = {
+  type: "struct",
+  packed: false,
+  fixedAbi: {},
+  fields: [
+    { name: "error", definition: { type: "c-type", cType: "int", fixedAbi: {} } },
+    { name: "msg", definition: nlmsghdrDefinition },
+  ],
+} /*as const*/;
+
+const sockaddrNl = define({ definition: sockaddrNlDefinition });
+const nlmsghdr = define({ definition: nlmsghdrDefinition });
+const nlmsgerr = define({ definition: nlmsgerrDefinition });
+
+const createNetlinkStructuresFor = ({ abi }/*: { abi: TAbi }*/) => {
+  return {
+    abi,
+    sockaddrNl: sockaddrNl.parser({ abi }),
+    nlmsghdr: nlmsghdr.parser({ abi }),
+    nlmsgerr: nlmsgerr.parser({ abi }),
+  };
+};
+
+/*type TNetlinkStructures = ReturnType<typeof createNetlinkStructuresFor>;*/
+
+const hostStructures = createNetlinkStructuresFor({ abi: hostAbi });
+
+/**
+ * Formats a struct sockaddr_nl, e.g. to bind() a netlink socket.
+ */
+const formatNetlinkAddress = ({ address, structures = hostStructures }/*: {
+  address: { nl_pid: bigint, nl_groups: bigint },
+  structures?: TNetlinkStructures,
+}*/) => {
+  return structures.sockaddrNl.format({
+    value: {
+      nl_family: AF_NETLINK,
+      nl_pad: 0n,
+      ...address,
+    },
+  });
+};
+
+export {
+  sockaddrNlDefinition,
+  nlmsghdrDefinition,
+  nlmsgerrDefinition,
+
+  createNetlinkStructuresFor,
+  hostStructures,
+  formatNetlinkAddress,
+};
+
+/*export type {
+  TNetlinkStructures,
+};*/

package/package.json

@@ -1,26 +1,52 @@
 {
+  "version": "0.0.5",
   "name": "node-netlink",
   "type": "module",
-  "version": "0.0.4",
-  "description": "netlink bindings for node.js",
-  "main": "lib/index.js",
-  "scripts": {
-    "test": "c8 --reporter lcov --reporter html --reporter text mocha",
-    "eslint": "eslint ."
+  "description": "The netlink protocol for Node.js on Linux, on top of sockets you own",
+  "files": [
+    "dist"
+  ],
+  "main": "dist/lib/index.js",
+  "scripts": {},
+  "devDependencies": {
+    "@eslint/js": "^10.0.1",
+    "@k13engineering/eslint-rules": "^0.0.6",
+    "@k13engineering/releasetool": "^0.0.5",
+    "@k13engineering/uv-poll": "^0.0.6",
+    "@types/mocha": "^10.0.10",
+    "@types/node": "^25.6.0",
+    "buffer2address": "^0.1.1",
+    "c8": "^11.0.0",
+    "deno-node": "^0.0.12",
+    "mocha": "^12.0.2",
+    "npm-check-updates": "^20.0.2",
+    "syscall-napi": "^0.2.2",
+    "typescript": "^6.0.3"
   },
   "dependencies": {
-    "po6-socket": "^0.0.3",
-    "ya-struct": "^0.0.4"
+    "po6": "^0.1.0",
+    "ya-struct": "^0.0.17"
   },
-  "devDependencies": {
-    "c8": "^7.10.0",
-    "eslint": "^7.32.0",
-    "mocha": "^9.1.3"
+  "publishConfig": {
+    "access": "public"
   },
   "repository": {
     "type": "git",
     "url": "git+https://github.com/k13-engineering/node-netlink.git"
   },
+  "keywords": [
+    "netlink",
+    "linux",
+    "socket",
+    "rtnetlink",
+    "typescript"
+  ],
+  "os": [
+    "linux"
+  ],
+  "engines": {
+    "node": ">=24"
+  },
   "author": "Simon Kadisch",
   "license": "LGPL 2.1",
   "bugs": {

package/.eslintrc

@@ -1,90 +0,0 @@
-{
-  "parserOptions": {
-    "ecmaVersion": 2021,
-    "sourceType": "module",
-    "requireConfigFile": false
-  },
-  "env": {
-    "node": true,
-    "es2020": true
-  },
-  "rules": {
-    "global-require": "off",
-    "quote-props": ["warn", "consistent-as-needed"],
-    "quotes": ["error", "double", { "allowTemplateLiterals": true }],
-    "no-plusplus": "error",
-    "no-nested-ternary": "error",
-    "no-multiple-empty-lines": "error",
-    "no-inline-comments": "error",
-    "no-lonely-if": "error",
-    "no-array-constructor": "error",
-    "no-delete-var": "error",
-    "no-param-reassign": "error",
-    "no-return-assign": "error",
-    "no-import-assign": "error",
-    "no-multi-assign": "error",
-    "keyword-spacing": "error",
-    "max-len": [ "warn", { "code": 140 } ],
-    "max-params": ["error", 4],
-    "max-statements": ["error", 15],
-    "no-loss-of-precision": "error",
-    "no-unreachable-loop": "error",
-    "require-atomic-updates": "error",
-    "complexity": ["error", 4],
-    "max-statements-per-line": ["error", { "max": 1 }],
-    "no-tabs": "error",
-    "no-underscore-dangle": "error",
-    "no-negated-condition": "error",
-    "no-use-before-define": "error",
-    "no-shadow": "error",
-    "no-labels": "error",
-    "no-throw-literal": "error",
-    "default-case": "error",
-    "default-case-last": "error",
-    "no-caller": "error",
-    "no-eval": "error",
-    "no-implied-eval": "error",
-    "no-new": "error",
-    "no-new-func": "error",
-    "no-new-object": "error",
-    "no-new-wrappers": "error",
-    "no-useless-concat": "error",
-    "no-unused-vars": ["error", {"ignoreRestSiblings": true}],
-    "array-bracket-newline": ["error", "consistent"],
-    "func-names": ["error", "never"],
-    "func-style": ["error", "expression", { "allowArrowFunctions": true }],
-    "max-depth": ["error", 4],
-    "arrow-parens": "error",
-    "no-confusing-arrow": "error",
-    "prefer-const": "error",
-    "rest-spread-spacing": ["error", "never"],
-    "template-curly-spacing": ["error", "never"],
-    "prefer-rest-params": "error",
-    "prefer-spread": "error",
-    "prefer-template": "error",
-    "object-shorthand": ["error", "properties"],
-    "no-var": "error",
-    "no-useless-computed-key": "error",
-    "array-callback-return": "error",
-    "consistent-return": "error",
-    "dot-notation": "error",
-    "eqeqeq": "error",
-    "no-eq-null": "error",
-    "no-implicit-coercion": "error",
-    "no-multi-spaces": "error",
-    "no-proto": "error",
-    "yoda": "error",
-    "indent": ["error", 2],
-    "object-curly-spacing": [ "error", "always" ],
-    "object-curly-newline": ["error", { "consistent": true, "multiline": true }],
-    "space-before-blocks": "error",
-    "space-before-function-paren": [ "error", "always" ],
-    "spaced-comment": "error",
-    "no-whitespace-before-property": "error",
-    "brace-style": ["error", "1tbs", { "allowSingleLine": false }],
-    "eol-last": ["error", "always"],
-    "func-call-spacing": ["error", "never"],
-    "semi": ["error", "always"]
-  },
-  "extends": "eslint:recommended"
-}

package/lib/error.js

@@ -1,50 +0,0 @@
-const knownErrors = {
-  EPERM: {
-    code: 1,
-    message: "Operation not permitted",
-  },
-  ENOENT: {
-    code: 2,
-    message: "No such file or directory",
-  },
-  EAGAIN: {
-    code: 11,
-    message: "Resource temporarily unavailable",
-  },
-  EEXIST: {
-    code: 17,
-    message: "File already exists",
-  },
-  ENODEV: {
-    code: 19,
-    message: "No such device",
-  },
-  EINVAL: {
-    code: 22,
-    message: "Invalid argument",
-  },
-  ENOTSUP: {
-    code: 48,
-    message: "Operation not supported",
-  },
-};
-
-const createFromErrorCode = ({ errorCode, message }) => {
-  const knownErrorKey = Object.keys(knownErrors).find((key) => {
-    return knownErrors[key].code === errorCode;
-  });
-
-  if (knownErrorKey) {
-    const knownError = knownErrors[knownErrorKey];
-    const errorObject = new Error(`${message ? `${message}: ` : ""}${knownError.message}`);
-    errorObject.code = knownError.code;
-    errorObject.errno = errorCode;
-    return errorObject;
-  } else {
-    return new Error(`${message ? `${message}: ` : ""}unknown error code ${errorCode}`);
-  }
-};
-
-export default {
-  createFromErrorCode,
-};