node-ikev2 0.1.0

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.
package/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
package/README.md ADDED
@@ -0,0 +1,86 @@
1
+ ## IKEv2 Parser
2
+
3
+ A TypeScript parser for Internet Key Exchange Version 2 (IKEv2) protocol, designed to parse, manipulate, and serialize IKEv2 packets based on [RFC 7296](https://datatracker.ietf.org/doc/html/rfc7296). This parser breaks down IKEv2 messages into modular components, including headers, payloads, transforms, and proposals, for detailed inspection and modification.
4
+
5
+ ### Features
6
+
7
+ • Parsing of IKEv2 Packets: Parse incoming IKEv2 packets into a readable structure like JSON.
8
+
9
+ • Modular Architecture: Separate classes for headers, payloads, transforms, and proposals for ease of use and extension.
10
+
11
+ • Serialization: Convert structured IKEv2 data back into its original binary format for transmission.
12
+
13
+ ### Project Structure
14
+
15
+ • **Header**: Manages parsing and serialization of the IKEv2 header.
16
+
17
+ • **Payload**: Represents individual IKEv2 payloads. Different types of payloads (e.g., SA, KE, AUTH) are represented by dedicated classes, enabling specific parsing logic for each type.
18
+
19
+ • **Transform & Proposal**: Contains structures for handling proposals and transforms within the IKEv2 SA payload, supporting complex configurations and transformations.
20
+
21
+ • **Message**: The main class to parse and serialize IKEv2 messages, which combines the header and payloads.
22
+
23
+ ### Installation
24
+
25
+ ```sh
26
+ npm install node-ikev2
27
+ ```
28
+
29
+ ### Usage
30
+
31
+ Import the necessary classes and use the parser to handle IKEv2 packets. Here's a quick example:
32
+
33
+ ```ts
34
+ import { Message } from "node-ikev2";
35
+
36
+ // Example hex string representing an IKEv2 packet
37
+ const packetHex = "800e0080...";
38
+ const packetBuffer = Buffer.from(packetHex, "hex");
39
+
40
+ // Parsing the packet
41
+ const message = Message.parse(packetBuffer);
42
+
43
+ // Inspecting the parsed message
44
+ console.log("Parsed Message:", message.toJSON());
45
+
46
+ // Modifying a payload (if necessary)
47
+ message.header.version = 2; // Modify as needed
48
+
49
+ // Serializing the message back to binary format
50
+ const serialized = message.serialize();
51
+ console.log("Serialized Packet (hex):", serialized.toString("hex"));
52
+ ```
53
+
54
+ ### Testing
55
+
56
+ Tests are written using Jest. To run tests:
57
+
58
+ ```sh
59
+ npm test
60
+ ```
61
+
62
+ ### Building, Development and Testing
63
+
64
+ Clone this repository, then...
65
+
66
+ ```sh
67
+ npm install
68
+ npm run build-and-test
69
+ ```
70
+
71
+ Tests cover various cases, including parsing and serialization, to ensure reliability and stability.
72
+
73
+ ### Sample IKEv2 Wireshark Pcap
74
+
75
+ You can check the IKEv2 messages and their content in this Pcap sample from Wireshark:
76
+
77
+ [Sample IKEv2 Wireshark Pcap](./pcap/capture.pcapng)
78
+
79
+ ### Contributing
80
+
81
+ Contributions are welcome! To contribute:
82
+
83
+ 1. Fork the repository.
84
+ 2. Create a new branch for your feature or bugfix.
85
+ 3. Write tests for any new functionality.
86
+ 4. Open a pull request with a clear description of changes.
@@ -0,0 +1,67 @@
1
+ /**
2
+ * 1 2 3
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
4
+ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
5
+ !A! Attribute Type ! AF=0 Attribute Length !
6
+ !F! ! AF=1 Attribute Value !
7
+ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
8
+ ! AF=0 Attribute Value !
9
+ ! AF=1 Not Transmitted !
10
+ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
11
+ Data Attributes
12
+ */
13
+ export declare enum attributeType {
14
+ KeyLength = 14
15
+ }
16
+ /**
17
+ * Attribute class
18
+ * @class
19
+ * @param {number} format - 1 bit:
20
+ * @param {number} type - 15 bits
21
+ * @param {Buffer} value - n bytes
22
+ * @param {number} length - 2 bytes if AF=1
23
+ */
24
+ export declare class Attribute {
25
+ format: number;
26
+ type: attributeType;
27
+ value: Buffer;
28
+ length: number;
29
+ constructor(format: number, // 0=TLV (Type/Length/Value), 1=TV (Type/Value)
30
+ type: attributeType, value: Buffer, length?: number);
31
+ /**
32
+ * Parses an attribute from a buffer
33
+ * @param buffer The buffer to parse from.
34
+ * @static
35
+ * @public
36
+ * @returns {Attribute}
37
+ */
38
+ static parse(buffer: Buffer): Attribute;
39
+ /**
40
+ * Serializes JSON attribute to buffer
41
+ * @public
42
+ * @static
43
+ * @param json object
44
+ * @returns {Buffer}
45
+ */
46
+ static serializeJSON(json: Record<string, any>): Buffer;
47
+ /**
48
+ * Serializes the attribute to a buffer
49
+ * @public
50
+ * @returns {Buffer}
51
+ */
52
+ serialize(): Buffer;
53
+ /**
54
+ * Convert object to JSON
55
+ * @method
56
+ * @public
57
+ * @returns {Record<string, any>} JSON object
58
+ */
59
+ toJSON(): Record<string, any>;
60
+ /**
61
+ * Returns a string representation of the attribute
62
+ * @method
63
+ * @public
64
+ * @returns {void}
65
+ */
66
+ toString(): string;
67
+ }
@@ -0,0 +1,161 @@
1
+ "use strict";
2
+ /**
3
+ * 1 2 3
4
+ 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
5
+ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
6
+ !A! Attribute Type ! AF=0 Attribute Length !
7
+ !F! ! AF=1 Attribute Value !
8
+ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
9
+ ! AF=0 Attribute Value !
10
+ ! AF=1 Not Transmitted !
11
+ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
12
+ Data Attributes
13
+ */
14
+ Object.defineProperty(exports, "__esModule", { value: true });
15
+ exports.Attribute = exports.attributeType = void 0;
16
+ var attributeType;
17
+ (function (attributeType) {
18
+ attributeType[attributeType["KeyLength"] = 14] = "KeyLength";
19
+ })(attributeType || (exports.attributeType = attributeType = {}));
20
+ /**
21
+ * Attribute class
22
+ * @class
23
+ * @param {number} format - 1 bit:
24
+ * @param {number} type - 15 bits
25
+ * @param {Buffer} value - n bytes
26
+ * @param {number} length - 2 bytes if AF=1
27
+ */
28
+ class Attribute {
29
+ constructor(format, // 0=TLV (Type/Length/Value), 1=TV (Type/Value)
30
+ type, value, length = 0) {
31
+ this.format = format;
32
+ this.type = type;
33
+ this.value = value;
34
+ this.length = length;
35
+ }
36
+ /**
37
+ * Parses an attribute from a buffer
38
+ * @param buffer The buffer to parse from.
39
+ * @static
40
+ * @public
41
+ * @returns {Attribute}
42
+ */
43
+ static parse(buffer) {
44
+ if (!Buffer.isBuffer(buffer)) {
45
+ throw new Error("Input must be a Buffer");
46
+ }
47
+ if (buffer.length < 4) {
48
+ throw new Error("Buffer too short for attribute header (minimum 4 bytes)");
49
+ }
50
+ try {
51
+ const format = buffer.readUInt8(0) >> 7;
52
+ const type = buffer.readUInt16BE(0) & 0x7fff;
53
+ if (format === 0) {
54
+ // TLV format: Type(2) + Length(2) + Value(n)
55
+ const length = buffer.readUInt16BE(2);
56
+ if (buffer.length < 4 + length) {
57
+ throw new Error(`Buffer too short for TLV attribute value. Expected ${4 + length} bytes, got ${buffer.length}`);
58
+ }
59
+ const value = buffer.subarray(4, 4 + length);
60
+ return new Attribute(format, type, value, length);
61
+ }
62
+ else {
63
+ // TV format: Type(2) + Value(n)
64
+ const value = buffer.subarray(2, 4); // Fixed 2 bytes for TV
65
+ return new Attribute(format, type, value);
66
+ }
67
+ }
68
+ catch (error) {
69
+ if (error instanceof Error) {
70
+ throw new Error(`Failed to parse attribute: ${error.message}`);
71
+ }
72
+ throw new Error("Failed to parse attribute: Unknown error");
73
+ }
74
+ }
75
+ /**
76
+ * Serializes JSON attribute to buffer
77
+ * @public
78
+ * @static
79
+ * @param json object
80
+ * @returns {Buffer}
81
+ */
82
+ static serializeJSON(json) {
83
+ const format = json.format;
84
+ const type = json.type;
85
+ const length = json.length;
86
+ const value = Buffer.from(json.value, "hex");
87
+ const attribute = new Attribute(format, type, value, length);
88
+ return attribute.serialize();
89
+ }
90
+ /**
91
+ * Serializes the attribute to a buffer
92
+ * @public
93
+ * @returns {Buffer}
94
+ */
95
+ serialize() {
96
+ if (this.format === 0) {
97
+ // TLV format: Type(2) + Length(2) + Value(n)
98
+ const buffer = Buffer.alloc(4 + this.length);
99
+ // Write format (1 bit) and type (15 bits) as a 16-bit value
100
+ buffer.writeUInt16BE((this.format << 15) | this.type, 0);
101
+ // Write the length for TLV (Type-Length-Value) format
102
+ buffer.writeUInt16BE(this.length, 2);
103
+ // Copy the value into the buffer starting at byte 4
104
+ this.value.copy(buffer, 4);
105
+ return buffer;
106
+ }
107
+ else {
108
+ // TV format: Type(2) + Value(n)
109
+ const buffer = Buffer.alloc(4);
110
+ // Write format (1 bit) and type (15 bits) as a 16-bit value
111
+ buffer.writeUInt16BE((this.format << 15) | this.type, 0);
112
+ // Copy the value starting at byte 2
113
+ this.value.copy(buffer, 2);
114
+ return buffer;
115
+ }
116
+ }
117
+ /**
118
+ * Convert object to JSON
119
+ * @method
120
+ * @public
121
+ * @returns {Record<string, any>} JSON object
122
+ */
123
+ toJSON() {
124
+ var _a;
125
+ return {
126
+ format: this.format,
127
+ type: this.type,
128
+ length: (_a = this.length) !== null && _a !== void 0 ? _a : 0,
129
+ value: this.value.toString("hex"),
130
+ };
131
+ }
132
+ /**
133
+ * Returns a string representation of the attribute
134
+ * @method
135
+ * @public
136
+ * @returns {void}
137
+ */
138
+ toString() {
139
+ const prettyJson = this.toJSON();
140
+ if (prettyJson.format === 1) {
141
+ prettyJson.format = `TV (Type/Value) (${prettyJson.format})`;
142
+ prettyJson.length = undefined; // not applicable for TV format
143
+ if (this.value.length === 2) {
144
+ prettyJson.valueUint = this.value.readUInt16BE(0); // assuming 2 bytes for TV value
145
+ }
146
+ }
147
+ else {
148
+ prettyJson.format = `TLV (Type/Length/Value) (${prettyJson.format})`;
149
+ }
150
+ switch (prettyJson.type) {
151
+ case 14:
152
+ prettyJson.type = `Key Length (${prettyJson.type})`;
153
+ break;
154
+ default:
155
+ break;
156
+ }
157
+ // it is just a representation of the value in this case, it is not the actual length
158
+ return JSON.stringify(prettyJson, null, 2);
159
+ }
160
+ }
161
+ exports.Attribute = Attribute;
@@ -0,0 +1,102 @@
1
+ import { payloadType } from "./payload";
2
+ /**
3
+ * IKEv2 Message Header
4
+ * 1 2 3
5
+ 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
6
+ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
7
+ ! IKE_SA Initiator's SPI !
8
+ ! (8 Octets) !
9
+ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
10
+ ! IKE_SA Responder's SPI !
11
+ ! (8 Octets) !
12
+ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
13
+ ! Next Payload(1)! MjVer ! MnVer ! Exchange Type(1) ! Flags(1) !
14
+ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
15
+ ! Message ID (4 Octets) !
16
+ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
17
+ ! Length (4 Octets) !
18
+ +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
19
+
20
+ RFC 4306: IKE Header Format
21
+ */
22
+ /**
23
+ * IKEv2 Exchange Types: \
24
+ * IKE_SA_INIT = 34 \
25
+ * IKE_AUTH = 35 \
26
+ * CREATE_CHILD_SA = 36 \
27
+ * INFORMATIONAL = 37
28
+ */
29
+ export declare enum exchangeType {
30
+ IKE_SA_INIT = 34,
31
+ IKE_AUTH = 35,
32
+ CREATE_CHILD_SA = 36,
33
+ INFORMATIONAL = 37
34
+ }
35
+ /**
36
+ * IKEv2 Message Header
37
+ * @class
38
+ * @property {Buffer} initiatorSPI - 8 bytes
39
+ * @property {Buffer} responderSPI - 8 bytes
40
+ * @property {payloadType} nextPayload - 1 byte
41
+ * @property {number} majorVersion - 4 bits
42
+ * @property {number} minorVersion - 4 bits
43
+ * @property {exchangeType} exchangeType - 1 byte
44
+ * @property {boolean} isInitiator - 1 bit (flags)
45
+ * @property {boolean} canUseHigherVersion - 1 bit (flags)
46
+ * @property {boolean} isResponse - 1 bit (flags)
47
+ * @property {number} messageID - 4 bytes
48
+ * @property {number} length - 4 bytes
49
+ */
50
+ export declare class Header {
51
+ initiatorSPI: Buffer;
52
+ responderSPI: Buffer;
53
+ nextPayload: payloadType;
54
+ majorVersion: number;
55
+ minorVersion: number;
56
+ exchangeType: exchangeType;
57
+ isInitiator: boolean;
58
+ canUseHigherVersion: boolean;
59
+ isResponse: boolean;
60
+ messageID: number;
61
+ length: number;
62
+ static headerLength: number;
63
+ constructor(initiatorSPI: Buffer, responderSPI: Buffer, nextPayload: payloadType, majorVersion: number, minorVersion: number, exchangeType: exchangeType, isInitiator: boolean, canUseHigherVersion: boolean, isResponse: boolean, messageID: number, length?: number);
64
+ /**
65
+ * Parses IKEv2 message header
66
+ * @param buffer
67
+ * @public
68
+ * @static
69
+ * @returns {Header}
70
+ */
71
+ static parse(buffer: Buffer): Header;
72
+ /**
73
+ * Serializes JSON to IKEv2 message header
74
+ * @param json object
75
+ * @public
76
+ * @static
77
+ * @returns {Buffer}
78
+ */
79
+ static serializeJSON(json: Record<string, any>): Buffer;
80
+ /**
81
+ * Serializes IKEv2 message header
82
+ * @public
83
+ * @returns {Buffer}
84
+ */
85
+ serialize(): Buffer;
86
+ isRequest(): boolean;
87
+ isResponder(): boolean;
88
+ /**
89
+ * Convert object to JSON
90
+ * @method
91
+ * @public
92
+ * @returns {Record<string, any>} JSON object
93
+ */
94
+ toJSON(): Record<string, any>;
95
+ /**
96
+ * Returns a string representation of the header
97
+ * @method
98
+ * @public
99
+ * @returns {void}
100
+ */
101
+ toString(): string;
102
+ }