wireguard-config-parse 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 ricco020
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,45 @@
+# wireguard-config-parse
+
+Parse a **WireGuard `.conf`** file into a plain object: one `[Interface]` and any
+number of `[Peer]` sections. Zero dependencies, comment-safe. Ports become numbers
+and comma-separated fields (`Address`, `DNS`, `AllowedIPs`) become arrays.
+
+```js
+const parse = require('wireguard-config-parse');
+
+parse(`[Interface]
+PrivateKey = <key>
+Address = 10.0.0.1/24
+ListenPort = 51820
+
+[Peer]
+PublicKey = <key>
+AllowedIPs = 0.0.0.0/0, ::/0
+Endpoint = 203.0.113.5:51820
+PersistentKeepalive = 25`);
+// {
+//   interface: { PrivateKey:'<key>', Address:['10.0.0.1/24'], ListenPort:51820 },
+//   peers: [ { PublicKey:'<key>', AllowedIPs:['0.0.0.0/0','::/0'],
+//             Endpoint:'203.0.113.5:51820', PersistentKeepalive:25 } ]
+// }
+```
+
+## Behaviour
+
+- Lines starting with `#` or `;`, and inline ` #` comments, are ignored.
+- `ListenPort`, `PersistentKeepalive`, `MTU`, `FwMark` are coerced to numbers.
+- `Address`, `DNS`, `AllowedIPs` are split into arrays on commas.
+- Unknown sections are ignored; a missing `[Interface]` yields `interface: null`.
+
+**Honest note:** this parses structure and values only. It does not validate that
+keys are cryptographically valid or that the config actually connects.
+
+## Notes
+
+Maintained by the team behind [VPNSmith](https://www.vpnsmith.com), a self-hosted
+VPN resource. For plain-English guides on WireGuard and running your own VPN, see
+[vpnsmith.com](https://www.vpnsmith.com).
+
+## License
+
+MIT

package/index.js

@@ -0,0 +1,58 @@
+'use strict';
+
+/**
+ * wireguard-config-parse
+ * Parse a WireGuard .conf file into a plain object: one [Interface] and any
+ * number of [Peer] sections. No dependencies, no network. Comment-safe.
+ * It parses structure and values; it does not validate keys cryptographically.
+ */
+
+// Keys whose values are comma-separated lists in WireGuard configs.
+var LIST_KEYS = { Address: true, DNS: true, AllowedIPs: true };
+
+function coerce(key, value) {
+  if (key === 'ListenPort' || key === 'PersistentKeepalive' || key === 'MTU' || key === 'FwMark') {
+    var n = parseInt(value, 10);
+    return isNaN(n) ? value : n;
+  }
+  if (LIST_KEYS[key]) {
+    return value.split(',').map(function (s) { return s.trim(); }).filter(Boolean);
+  }
+  return value;
+}
+
+/**
+ * @param {string} text contents of a WireGuard .conf file
+ * @returns {{interface: (object|null), peers: object[]}}
+ */
+function parse(text) {
+  if (typeof text !== 'string') { throw new TypeError('config must be a string'); }
+  var iface = null;
+  var peers = [];
+  var current = null; // reference to the section object being filled
+  var lines = text.split(/\r?\n/);
+  for (var i = 0; i < lines.length; i++) {
+    var line = lines[i].trim();
+    if (line === '' || line.charAt(0) === '#' || line.charAt(0) === ';') { continue; }
+    var section = line.match(/^\[(.+?)\]$/);
+    if (section) {
+      var name = section[1].toLowerCase();
+      if (name === 'interface') { iface = {}; current = iface; }
+      else if (name === 'peer') { var p = {}; peers.push(p); current = p; }
+      else { current = null; } // unknown section: ignore its keys
+      continue;
+    }
+    var eq = line.indexOf('=');
+    if (eq === -1 || current === null) { continue; }
+    var key = line.slice(0, eq).trim();
+    var value = line.slice(eq + 1).trim();
+    // strip inline comment
+    var hash = value.indexOf(' #');
+    if (hash !== -1) { value = value.slice(0, hash).trim(); }
+    current[key] = coerce(key, value);
+  }
+  return { interface: iface, peers: peers };
+}
+
+module.exports = parse;
+module.exports.parse = parse;

package/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "wireguard-config-parse",
+  "version": "1.0.0",
+  "description": "Parse a WireGuard .conf file into a plain object (Interface + Peers). Zero dependencies, comment-safe, coerces ports to numbers and lists to arrays.",
+  "main": "index.js",
+  "type": "commonjs",
+  "scripts": { "test": "node test.js" },
+  "keywords": ["wireguard", "config", "parser", "vpn", "wg", "conf", "self-hosted"],
+  "homepage": "https://www.vpnsmith.com",
+  "author": "ricco020",
+  "license": "MIT",
+  "engines": { "node": ">=12" },
+  "files": ["index.js", "README.md", "LICENSE"]
+}