node-ikev2 0.1.0

package/lib/src/proposal.d.ts

@@ -0,0 +1,90 @@
+import { Transform } from "./transform";
+import { securityProtocolId } from "./payload";
+/**
+ * Proposal Substructure
+                           1                   2                   3
+       0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      ! 0 (last) or 2 !   RESERVED (1)   !      Proposal Length       !
+      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      ! Proposal #    !  Protocol ID  !    SPI Size   !# of Transforms!
+      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      ~                        SPI (variable)                         ~
+      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      !                                                               !
+      ~                        <Transforms>                           ~
+      !                                                               !
+      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+                            Proposal Substructure
+
+    For an initial IKE_SA negotiation, this field MUST be zero; the SPI is \
+    obtained from the outer header. During subsequent negotiations, it is \
+    equal to the size, in octets, of the SPI of the corresponding protocol \
+    (8 for IKE, 4 for ESP and AH).
+ */
+/**
+ * IKEv2 Proposal
+ * @class
+ * @property {number} lastSubstructure - Last Substructure (1 bit)
+ * @property {number} length - 2 bytes
+ * @property {number} proposalNumber - 1 byte
+ * @property {securityProtocolId} protocolId - 1 byte
+ * @property {Buffer} spiSize - 1 bytes (SPI Size)
+ * @property {number} numTransforms - 1 byte (number of transforms)
+ * @property {Buffer} spi - variable length
+ * @property {Transform} transforms - variable length
+ */
+export declare class Proposal {
+    lastSubstructure: number;
+    length: number;
+    proposalNumber: number;
+    protocolId: securityProtocolId;
+    spiSize: number;
+    numTransforms: number;
+    spi: Buffer;
+    transforms: Transform[];
+    constructor(lastSubstructure: number, length: number, proposalNumber: number, protocolId: securityProtocolId, spiSize: number, numTransforms: number, spi: Buffer, transforms: Transform[]);
+    /**
+     * Parses a Proposal from a Buffer
+     * @param {Buffer} buffer
+     * @static
+     * @public
+     * @returns {Proposal}
+     */
+    static parse(buffer: Buffer): Proposal;
+    /**
+     * Serializes a Proposal from a JSON object
+     * @param {any} json
+     * @static
+     * @public
+     * @returns {Buffer}
+     */
+    static serializeJSON(json: Record<string, any>): Buffer;
+    /**
+     * Parses Transforms from a Buffer
+     * @param {Buffer} buffer
+     * @static
+     * @public
+     * @returns {Transform[]}
+     */
+    private static parseTransforms;
+    /**
+     * Serializes a Proposal to a Buffer
+     * @param proposal
+     * @public
+     * @returns {Buffer}
+     */
+    serialize(): Buffer;
+    /**
+     * Converts Proposal to JSON
+     * @public
+     * @returns {Record<string, any>} JSON object
+     */
+    toJSON(): Record<string, any>;
+    /**
+     * Returns a string representation of the proposal
+     * @public
+     * @returns {string}
+     */
+    toString(): string;
+}

package/lib/src/proposal.js

@@ -0,0 +1,200 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Proposal = void 0;
+const transform_1 = require("./transform");
+const payload_1 = require("./payload");
+/**
+ * Proposal Substructure
+                           1                   2                   3
+       0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      ! 0 (last) or 2 !   RESERVED (1)   !      Proposal Length       !
+      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      ! Proposal #    !  Protocol ID  !    SPI Size   !# of Transforms!
+      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      ~                        SPI (variable)                         ~
+      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+      !                                                               !
+      ~                        <Transforms>                           ~
+      !                                                               !
+      +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+                            Proposal Substructure
+
+    For an initial IKE_SA negotiation, this field MUST be zero; the SPI is \
+    obtained from the outer header. During subsequent negotiations, it is \
+    equal to the size, in octets, of the SPI of the corresponding protocol \
+    (8 for IKE, 4 for ESP and AH).
+ */
+/**
+ * IKEv2 Proposal
+ * @class
+ * @property {number} lastSubstructure - Last Substructure (1 bit)
+ * @property {number} length - 2 bytes
+ * @property {number} proposalNumber - 1 byte
+ * @property {securityProtocolId} protocolId - 1 byte
+ * @property {Buffer} spiSize - 1 bytes (SPI Size)
+ * @property {number} numTransforms - 1 byte (number of transforms)
+ * @property {Buffer} spi - variable length
+ * @property {Transform} transforms - variable length
+ */
+class Proposal {
+    constructor(lastSubstructure, length, proposalNumber, protocolId, spiSize, numTransforms, spi, transforms) {
+        this.lastSubstructure = lastSubstructure;
+        this.length = length;
+        this.proposalNumber = proposalNumber;
+        this.protocolId = protocolId;
+        this.spiSize = spiSize;
+        this.numTransforms = numTransforms;
+        this.spi = spi;
+        this.transforms = transforms;
+        if (transforms.length === 0) {
+            throw new Error("Transforms length cannot be 0");
+        }
+    }
+    /**
+     * Parses a Proposal from a Buffer
+     * @param {Buffer} buffer
+     * @static
+     * @public
+     * @returns {Proposal}
+     */
+    static parse(buffer) {
+        try {
+            const lastSubstructure = buffer.readUInt8(0); // First octet
+            const length = buffer.readUInt16BE(2);
+            const proposalNumber = buffer.readUInt8(4);
+            const protocolId = buffer.readUInt8(5);
+            const spiSize = buffer.readUInt8(6);
+            const numTransforms = buffer.readUInt8(7);
+            const spi = Buffer.alloc(spiSize);
+            if (spiSize > 0) {
+                buffer.copy(spi, 0, 8, 8 + spiSize);
+            }
+            const transforms = this.parseTransforms(buffer.subarray(8 + spiSize, length));
+            return new Proposal(lastSubstructure, length, proposalNumber, protocolId, spiSize, numTransforms, spi, transforms);
+        }
+        catch (error) {
+            throw new Error(`Failed to parse proposal from buffer ${buffer.toString("hex")}: ${error}`);
+        }
+    }
+    /**
+     * Serializes a Proposal from a JSON object
+     * @param {any} json
+     * @static
+     * @public
+     * @returns {Buffer}
+     */
+    static serializeJSON(json) {
+        const lastSubstructure = json.lastSubstructure;
+        const length = json.length;
+        const proposalNumber = json.proposalNumber;
+        const protocolId = json.protocolId;
+        const spiSize = json.spiSize;
+        const numTransforms = json.numTransforms;
+        let spi = Buffer.alloc(spiSize);
+        if (spiSize > 0 && json.spi) {
+            spi = Buffer.from(json.spi, "hex");
+        }
+        const transformsBuffer = json.transforms.map((transform) => transform_1.Transform.serializeJSON(transform));
+        const totalLength = 8 +
+            spiSize +
+            transformsBuffer.reduce((acc, buf) => acc + buf.length, 0);
+        const buffer = Buffer.alloc(totalLength);
+        buffer.writeUInt8(lastSubstructure, 0);
+        buffer.writeUInt8(0, 1);
+        buffer.writeUInt16BE(length, 2);
+        buffer.writeUInt8(proposalNumber, 4);
+        buffer.writeUInt8(protocolId, 5);
+        buffer.writeUInt8(spiSize, 6);
+        buffer.writeUInt8(numTransforms, 7);
+        if (spiSize > 0) {
+            spi.copy(buffer, 8);
+        }
+        // Copy transforms directly into buffer instead of using Buffer.concat
+        let offset = 8 + spiSize;
+        for (const transformBuffer of transformsBuffer) {
+            transformBuffer.copy(buffer, offset);
+            offset += transformBuffer.length;
+        }
+        return buffer;
+    }
+    /**
+     * Parses Transforms from a Buffer
+     * @param {Buffer} buffer
+     * @static
+     * @public
+     * @returns {Transform[]}
+     */
+    static parseTransforms(buffer) {
+        const transforms = [];
+        let offset = 0;
+        while (offset < buffer.length) {
+            const transformLength = buffer.readUInt16BE(offset + 2);
+            const transformBuffer = buffer.subarray(offset, offset + transformLength);
+            const transform = transform_1.Transform.parse(transformBuffer);
+            transforms.push(transform);
+            offset += transformLength;
+        }
+        return transforms;
+    }
+    /**
+     * Serializes a Proposal to a Buffer
+     * @param proposal
+     * @public
+     * @returns {Buffer}
+     */
+    serialize() {
+        // Encode deep transforms first
+        const transforms = this.transforms.map((transform) => transform.serialize());
+        const transformsBuffer = Buffer.concat(transforms);
+        // Fix the length
+        this.length = 8 + this.spiSize + transformsBuffer.length;
+        // Fix the numTransforms
+        this.numTransforms = this.transforms.length;
+        const buffer = Buffer.alloc(this.length);
+        buffer.writeUInt8(this.lastSubstructure, 0);
+        buffer.writeUInt8(0, 1);
+        buffer.writeUInt16BE(this.length, 2);
+        buffer.writeUInt8(this.proposalNumber, 4);
+        buffer.writeUInt8(this.protocolId, 5);
+        buffer.writeUInt8(this.spiSize, 6);
+        buffer.writeUInt8(this.numTransforms, 7);
+        if (this.spiSize > 0) {
+            this.spi.copy(buffer, 8, 0, this.spiSize);
+        }
+        transformsBuffer.copy(buffer, 8 + this.spiSize);
+        return buffer;
+    }
+    /**
+     * Converts Proposal to JSON
+     * @public
+     * @returns {Record<string, any>} JSON object
+     */
+    toJSON() {
+        var _a, _b;
+        return {
+            lastSubstructure: this.lastSubstructure,
+            length: this.length,
+            proposalNumber: this.proposalNumber,
+            protocolId: this.protocolId,
+            spiSize: this.spiSize,
+            numTransforms: this.numTransforms,
+            spi: (_b = (_a = this.spi) === null || _a === void 0 ? void 0 : _a.toString("hex")) !== null && _b !== void 0 ? _b : "",
+            transforms: this.transforms.map((transform) => transform.toJSON()),
+        };
+    }
+    /**
+     * Returns a string representation of the proposal
+     * @public
+     * @returns {string}
+     */
+    toString() {
+        const prettyJson = this.toJSON();
+        prettyJson.lastSubstructure =
+            this.lastSubstructure === 0 ? "None (0)" : "Proposal (2)";
+        prettyJson.protocolId = `${payload_1.securityProtocolId[prettyJson.protocolId]} (${prettyJson.protocolId})`;
+        prettyJson.transforms = this.transforms.map((transform) => JSON.parse(transform.toString()));
+        return JSON.stringify(prettyJson, null, 2);
+    }
+}
+exports.Proposal = Proposal;

package/lib/src/selector.d.ts

@@ -0,0 +1,80 @@
+/**
+ * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+   |   TS Type     |IP Protocol ID*|       Selector Length         |
+   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+   |           Start Port*         |           End Port*           |
+   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+   |                                                               |
+   ~                         Starting Address*                     ~
+   |                                                               |
+   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+   |                                                               |
+   ~                         Ending Address*                       ~
+   |                                                               |
+   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+
+                        Traffic Selector
+*/
+/**
+ * Traffic Selector Type
+ */
+export declare enum TrafficSelectorType {
+    TS_IPV4_ADDR_RANGE = 7,
+    TS_IPV6_ADDR_RANGE = 8
+}
+/**
+ * Traffic Selector
+ * @class
+ * @property {number} type - 1 byte
+ * @property {number} protocolId - 1 byte
+ * @property {number} length - 2 bytes
+ * @property {number} startPort - 2 bytes
+ * @property {number} endPort - 2 bytes
+ * @property {Buffer} startAddress - 4 bytes
+ * @property {Buffer} endAddress - 4 bytes
+ */
+export declare class TrafficSelector {
+    type: number;
+    protocolId: number;
+    length: number;
+    startPort: number;
+    endPort: number;
+    startAddress: Buffer;
+    endAddress: Buffer;
+    constructor(type: number, protocolId: number, length: number, startPort: number, endPort: number, startAddress: Buffer, endAddress: Buffer);
+    /**
+     * Parses a Traffic Selector from a buffer
+     * @param buffer The buffer to parse from.
+     * @static
+     * @public
+     * @returns {TrafficSelector}
+     */
+    static parse(buffer: Buffer): TrafficSelector;
+    /**
+     * Serializes a JSON representation of the Traffic Selector to a buffer
+     * @param json The JSON object to serialize.
+     * @public
+     * @static
+     * @returns {Buffer}
+     */
+    static serializeJSON(json: Record<string, any>): Buffer;
+    /**
+     * Serializes a Traffic Selector to a buffer
+     * @public
+     * @returns {Buffer}
+     */
+    serialize(): Buffer;
+    /**
+     * Returns the Traffic Selector as a JSON object
+     * @public
+     * @returns {Record<string, any>}
+     */
+    toJSON(): Record<string, any>;
+    /**
+     * Returns a string representation of the Traffic Selector
+     * @public
+     * @returns {string}
+     */
+    toString(): string;
+}

package/lib/src/selector.js

@@ -0,0 +1,132 @@
+"use strict";
+/**
+ * 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
+   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+   |   TS Type     |IP Protocol ID*|       Selector Length         |
+   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+   |           Start Port*         |           End Port*           |
+   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+   |                                                               |
+   ~                         Starting Address*                     ~
+   |                                                               |
+   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+   |                                                               |
+   ~                         Ending Address*                       ~
+   |                                                               |
+   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+
+                        Traffic Selector
+*/
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.TrafficSelector = exports.TrafficSelectorType = void 0;
+/**
+ * Traffic Selector Type
+ */
+var TrafficSelectorType;
+(function (TrafficSelectorType) {
+    TrafficSelectorType[TrafficSelectorType["TS_IPV4_ADDR_RANGE"] = 7] = "TS_IPV4_ADDR_RANGE";
+    TrafficSelectorType[TrafficSelectorType["TS_IPV6_ADDR_RANGE"] = 8] = "TS_IPV6_ADDR_RANGE";
+})(TrafficSelectorType || (exports.TrafficSelectorType = TrafficSelectorType = {}));
+/**
+ * Traffic Selector
+ * @class
+ * @property {number} type - 1 byte
+ * @property {number} protocolId - 1 byte
+ * @property {number} length - 2 bytes
+ * @property {number} startPort - 2 bytes
+ * @property {number} endPort - 2 bytes
+ * @property {Buffer} startAddress - 4 bytes
+ * @property {Buffer} endAddress - 4 bytes
+ */
+class TrafficSelector {
+    constructor(type, protocolId, length, startPort, endPort, startAddress, endAddress) {
+        this.type = type;
+        this.protocolId = protocolId;
+        this.length = length;
+        this.startPort = startPort;
+        this.endPort = endPort;
+        this.startAddress = startAddress;
+        this.endAddress = endAddress;
+    }
+    /**
+     * Parses a Traffic Selector from a buffer
+     * @param buffer The buffer to parse from.
+     * @static
+     * @public
+     * @returns {TrafficSelector}
+     */
+    static parse(buffer) {
+        try {
+            const type = buffer.readUInt8(0);
+            const protocolId = buffer.readUInt8(1);
+            const length = buffer.readUInt16BE(2);
+            const startPort = buffer.readUInt16BE(4);
+            const endPort = buffer.readUInt16BE(6);
+            const startAddress = buffer.subarray(8, 12);
+            const endAddress = buffer.subarray(12, 16);
+            return new TrafficSelector(type, protocolId, length, startPort, endPort, startAddress, endAddress);
+        }
+        catch (error) {
+            throw new Error("Failed to parse traffic selector");
+        }
+    }
+    /**
+     * Serializes a JSON representation of the Traffic Selector to a buffer
+     * @param json The JSON object to serialize.
+     * @public
+     * @static
+     * @returns {Buffer}
+     */
+    static serializeJSON(json) {
+        const buffer = Buffer.alloc(16);
+        buffer.writeUInt8(json.type, 0);
+        buffer.writeUInt8(json.protocolId, 1);
+        buffer.writeUInt16BE(json.length, 2);
+        buffer.writeUInt16BE(json.startPort, 4);
+        buffer.writeUInt16BE(json.endPort, 6);
+        Buffer.from(json.startAddress, "hex").copy(buffer, 8);
+        Buffer.from(json.endAddress, "hex").copy(buffer, 12);
+        return buffer;
+    }
+    /**
+     * Serializes a Traffic Selector to a buffer
+     * @public
+     * @returns {Buffer}
+     */
+    serialize() {
+        const buffer = Buffer.alloc(16);
+        buffer.writeUInt8(this.type, 0);
+        buffer.writeUInt8(this.protocolId, 1);
+        buffer.writeUInt16BE(this.length, 2);
+        buffer.writeUInt16BE(this.startPort, 4);
+        buffer.writeUInt16BE(this.endPort, 6);
+        this.startAddress.copy(buffer, 8);
+        this.endAddress.copy(buffer, 12);
+        return buffer;
+    }
+    /**
+     * Returns the Traffic Selector as a JSON object
+     * @public
+     * @returns {Record<string, any>}
+     */
+    toJSON() {
+        return {
+            type: this.type,
+            protocolId: this.protocolId,
+            length: this.length,
+            startPort: this.startPort,
+            endPort: this.endPort,
+            startAddress: this.startAddress.toString("hex"),
+            endAddress: this.endAddress.toString("hex"),
+        };
+    }
+    /**
+     * Returns a string representation of the Traffic Selector
+     * @public
+     * @returns {string}
+     */
+    toString() {
+        return JSON.stringify(this.toJSON(), null, 2);
+    }
+}
+exports.TrafficSelector = TrafficSelector;