node-ikev2 0.1.3 → 0.2.1

package/lib/src/configuration-attribute.d.ts

@@ -0,0 +1,302 @@
+/**
+ * Configuration Attribute Types
+ *
+ * See: https://datatracker.ietf.org/doc/html/rfc7296#section-3.15.1
+ *
+ *    Attribute Type           Value  Multi-Valued  Length
+ *    ------------------------------------------------------------
+ *    INTERNAL_IP4_ADDRESS     1      YES*          0 or 4 octets
+ *    INTERNAL_IP4_NETMASK     2      NO            0 or 4 octets
+ *    INTERNAL_IP4_DNS         3      YES           0 or 4 octets
+ *    INTERNAL_IP4_NBNS        4      YES           0 or 4 octets
+ *    INTERNAL_IP4_DHCP        6      YES           0 or 4 octets
+ *    APPLICATION_VERSION      7      NO            0 or more
+ *    INTERNAL_IP6_ADDRESS     8      YES*          0 or 17 octets
+ *    INTERNAL_IP6_DNS         10     YES           0 or 16 octets
+ *    INTERNAL_IP6_DHCP        12     YES           0 or 16 octets
+ *    INTERNAL_IP4_SUBNET      13     YES           0 or 8 octets
+ *    SUPPORTED_ATTRIBUTES     14     NO            Multiple of 2
+ *    INTERNAL_IP6_SUBNET      15     YES           17 octets
+ *
+ * See: https://www.iana.org/assignments/ikev2-parameters/ikev2-parameters.xhtml#ikev2-parameters-20
+ *
+ * Value 	Attribute Type 	Multi-Valued 	Length 	Reference
+ * 0	Reserved			[RFC7296]
+ * 1	INTERNAL_IP4_ADDRESS	YES*	0 or 4 octets	[RFC7296]
+ * 2	INTERNAL_IP4_NETMASK	NO	0 or 4 octets	[RFC7296]
+ * 3	INTERNAL_IP4_DNS	YES	0 or 4 octets	[RFC7296]
+ * 4	INTERNAL_IP4_NBNS	YES	0 or 4 octets	[RFC7296]
+ * 5	Reserved			[RFC7296]
+ * 6	INTERNAL_IP4_DHCP	YES	0 or 4 octets	[RFC7296]
+ * 7	APPLICATION_VERSION	NO	0 or more	[RFC7296]
+ * 8	INTERNAL_IP6_ADDRESS	YES*	0 or 17 octets	[RFC7296]
+ * 9	Reserved			[RFC7296]
+ * 10	INTERNAL_IP6_DNS	YES	0 or 16 octets	[RFC7296]
+ * 11	Reserved			[RFC7296]
+ * 12	INTERNAL_IP6_DHCP	YES	0 or 16 octets	[RFC7296]
+ * 13	INTERNAL_IP4_SUBNET	YES	0 or 8 octets	[RFC7296]
+ * 14	SUPPORTED_ATTRIBUTES	NO	Multiple of 2	[RFC7296]
+ * 15	INTERNAL_IP6_SUBNET	YES	17 octets	[RFC7296]
+ * 16	MIP6_HOME_PREFIX	YES	0 or 21 octets	[RFC5026]
+ * 17	INTERNAL_IP6_LINK	NO	8 or more	[RFC5739]
+ * 18	INTERNAL_IP6_PREFIX	YES	17 octets	[RFC5739]
+ * 19	HOME_AGENT_ADDRESS	NO	16 or 20	[http://www.3gpp.org/ftp/Specs/html-info/24302.htm][John_Meredith]
+ * 20	P_CSCF_IP4_ADDRESS	YES	0 or 4 octets	[RFC7651]
+ * 21	P_CSCF_IP6_ADDRESS	YES	0 or 16 octets	[RFC7651]
+ * 22	FTT_KAT	NO	2 octets	[TS 24.302 12.6.0]
+ * 23	EXTERNAL_SOURCE_IP4_NAT_INFO	NO	0 or 6	[TS 29.139][Kimmo_Kymalainen]
+ * 24	TIMEOUT_PERIOD_FOR_LIVENESS_CHECK	NO	0 or 4 octets	[TS 24.302 13.4.0][Frederic_Firmin]
+ * 25	INTERNAL_DNS_DOMAIN	YES	0 or more	[RFC8598]
+ * 26	INTERNAL_DNSSEC_TA	YES	0 or more	[RFC8598]
+ * 27	ENCDNS_IP4	YES	0 or more	[RFC9464]
+ * 28	ENCDNS_IP6	YES	0 or more	[RFC9464]
+ * 29	ENCDNS_DIGEST_INFO	YES	0 or more	[RFC9464]
+ * 30-16383	Unassigned
+ * 16384-32767	Reserved for Private Use			[RFC7296]
+ */
+export declare enum configurationAttributeType {
+    INTERNAL_IP4_ADDRESS = 1,
+    INTERNAL_IP4_NETMASK = 2,
+    INTERNAL_IP4_DNS = 3,
+    INTERNAL_IP4_NBNS = 4,
+    INTERNAL_IP4_DHCP = 6,
+    APPLICATION_VERSION = 7,
+    INTERNAL_IP6_ADDRESS = 8,
+    INTERNAL_IP6_DNS = 10,
+    INTERNAL_IP6_DHCP = 12,
+    INTERNAL_IP4_SUBNET = 13,
+    SUPPORTED_ATTRIBUTES = 14,
+    INTERNAL_IP6_SUBNET = 15,
+    MIP6_HOME_PREFIX = 16,
+    INTERNAL_IP6_LINK = 17,
+    INTERNAL_IP6_PREFIX = 18,
+    HOME_AGENT_ADDRESS = 19,
+    P_CSCF_IP4_ADDRESS = 20,
+    P_CSCF_IP6_ADDRESS = 21,
+    FTT_KAT = 22,
+    EXTERNAL_SOURCE_IP4_NAT_INFO = 23,
+    TIMEOUT_PERIOD_FOR_LIVENESS_CHECK = 24,
+    INTERNAL_DNS_DOMAIN = 25,
+    INTERNAL_DNSSEC_TA = 26,
+    ENCDNS_IP4 = 27,
+    ENCDNS_IP6 = 28,
+    ENCDNS_DIGEST_INFO = 29
+}
+/**
+ * Configuration Attributes
+ *
+ *    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
+ *   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+ *   |R|         Attribute Type      |            Length             |
+ *   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+ *   |                                                               |
+ *   ~                             Value                             ~
+ *   |                                                               |
+ *   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
+ *
+ *                 Figure 23: Configuration Attribute Format
+ *
+ * See: https://datatracker.ietf.org/doc/html/rfc7296#section-3.15.1
+ *
+ * As used in the PayloadCP
+ *
+ */
+export declare class ConfigurationAttribute {
+    type: configurationAttributeType;
+    value: Buffer;
+    constructor(type: configurationAttributeType, value: Buffer);
+    /**
+     * Parses a ConfigurationAttribute from a Buffer
+     * @param {Buffer} buffer
+     * @static
+     * @public
+     * @returns {ConfigurationAttribute}
+     */
+    static parse(buffer: Buffer): ConfigurationAttribute;
+    /**
+     * Serializes a Configuration Attribute from a JSON object
+     * @param {any} json
+     * @static
+     * @public
+     * @returns {Buffer}
+     */
+    static serializeJSON(json: Record<string, any>): Buffer;
+    /**
+     * Serializes a Configuration Attribute to a Buffer
+     * @public
+     * @returns {Buffer}
+     */
+    serialize(): Buffer;
+    /**
+     * Parses Configuration Attributes from a Buffer
+     * @param {Buffer} buffer
+     * @static
+     * @public
+     * @returns {ConfigurationAttribute[]}
+     */
+    static parseConfigurationAttributes(buffer: Buffer): ConfigurationAttribute[];
+    /**
+     * Converts Configuration Attribute to JSON
+     * @public
+     * @returns {Record<string, any>} JSON object
+     */
+    toJSON(): Record<string, any>;
+    /**
+     * Returns a string representation of the configuration attribute
+     * @public
+     * @returns {string}
+     */
+    toString(): string;
+}
+export declare class INTERNAL_IP4_ADDRESS extends ConfigurationAttribute {
+    address: Buffer;
+    constructor(address: Buffer);
+    static parse(buffer: Buffer): INTERNAL_IP4_ADDRESS;
+    static serializeJSON(json: Record<string, any>): Buffer;
+    toJSON(): Record<string, any>;
+    toString(): string;
+}
+export declare class INTERNAL_IP4_NETMASK extends ConfigurationAttribute {
+    netmask: Buffer;
+    constructor(netmask: Buffer);
+    static parse(buffer: Buffer): INTERNAL_IP4_NETMASK;
+    static serializeJSON(json: Record<string, any>): Buffer;
+    toJSON(): Record<string, any>;
+    toString(): string;
+}
+export declare class INTERNAL_IP4_DNS extends ConfigurationAttribute {
+    dns: Buffer;
+    constructor(dns: Buffer);
+    static parse(buffer: Buffer): INTERNAL_IP4_DNS;
+    static serializeJSON(json: Record<string, any>): Buffer;
+    toJSON(): Record<string, any>;
+    toString(): string;
+}
+export declare class INTERNAL_IP4_NBNS extends ConfigurationAttribute {
+    nbns: Buffer;
+    constructor(nbns: Buffer);
+    static parse(buffer: Buffer): INTERNAL_IP4_NBNS;
+    static serializeJSON(json: Record<string, any>): Buffer;
+    toJSON(): Record<string, any>;
+    toString(): string;
+}
+export declare class INTERNAL_IP4_DHCP extends ConfigurationAttribute {
+    dhcp: Buffer;
+    constructor(dhcp: Buffer);
+    static parse(buffer: Buffer): INTERNAL_IP4_DHCP;
+    static serializeJSON(json: Record<string, any>): Buffer;
+    toJSON(): Record<string, any>;
+    toString(): string;
+}
+export declare class APPLICATION_VERSION extends ConfigurationAttribute {
+    versionString: string;
+    constructor(versionString: string);
+    static parse(buffer: Buffer): APPLICATION_VERSION;
+    static serializeJSON(json: Record<string, any>): Buffer;
+    toJSON(): Record<string, any>;
+    toString(): string;
+}
+export declare class INTERNAL_IP6_ADDRESS extends ConfigurationAttribute {
+    address: Buffer;
+    prefixLength: number;
+    constructor(address: Buffer, prefixLength: number);
+    static parse(buffer: Buffer): INTERNAL_IP6_ADDRESS;
+    static serializeJSON(json: Record<string, any>): Buffer;
+    toJSON(): Record<string, any>;
+    toString(): string;
+}
+export declare class INTERNAL_IP6_DNS extends ConfigurationAttribute {
+    dns: Buffer;
+    constructor(dns: Buffer);
+    static parse(buffer: Buffer): INTERNAL_IP6_DNS;
+    static serializeJSON(json: Record<string, any>): Buffer;
+    toJSON(): Record<string, any>;
+    toString(): string;
+}
+export declare class INTERNAL_IP6_DHCP extends ConfigurationAttribute {
+    dhcp: Buffer;
+    constructor(dhcp: Buffer);
+    static parse(buffer: Buffer): INTERNAL_IP6_DHCP;
+    static serializeJSON(json: Record<string, any>): Buffer;
+    toJSON(): Record<string, any>;
+    toString(): string;
+}
+export declare class INTERNAL_IP4_SUBNET extends ConfigurationAttribute {
+    address: Buffer;
+    netmask: Buffer;
+    constructor(address: Buffer, netmask: Buffer);
+    static parse(buffer: Buffer): INTERNAL_IP4_SUBNET;
+    static serializeJSON(json: Record<string, any>): Buffer;
+    toJSON(): Record<string, any>;
+    toString(): string;
+}
+export declare class SUPPORTED_ATTRIBUTES extends ConfigurationAttribute {
+    values: configurationAttributeType[];
+    constructor(values: configurationAttributeType[]);
+    static parse(buffer: Buffer): SUPPORTED_ATTRIBUTES;
+    static serializeJSON(json: Record<string, any>): Buffer;
+    toJSON(): Record<string, any>;
+    toString(): string;
+}
+export declare class INTERNAL_IP6_SUBNET extends ConfigurationAttribute {
+    address: Buffer;
+    prefixLength: number;
+    constructor(address: Buffer, prefixLength: number);
+    static parse(buffer: Buffer): INTERNAL_IP6_SUBNET;
+    static serializeJSON(json: Record<string, any>): Buffer;
+    toJSON(): Record<string, any>;
+    toString(): string;
+}
+export declare class P_CSCF_IP4_ADDRESS extends ConfigurationAttribute {
+    address: Buffer;
+    constructor(address: Buffer);
+    static parse(buffer: Buffer): P_CSCF_IP4_ADDRESS;
+    static serializeJSON(json: Record<string, any>): Buffer;
+    toJSON(): Record<string, any>;
+    toString(): string;
+}
+export declare class P_CSCF_IP6_ADDRESS extends ConfigurationAttribute {
+    address: Buffer;
+    constructor(address: Buffer);
+    static parse(buffer: Buffer): P_CSCF_IP6_ADDRESS;
+    static serializeJSON(json: Record<string, any>): Buffer;
+    toJSON(): Record<string, any>;
+    toString(): string;
+}
+export declare class CPAttributes {
+    INTERNAL_IP4_ADDRESS: INTERNAL_IP4_ADDRESS[];
+    INTERNAL_IP4_NETMASK: INTERNAL_IP4_NETMASK | undefined;
+    INTERNAL_IP4_DNS: INTERNAL_IP4_DNS[];
+    INTERNAL_IP4_NBNS: INTERNAL_IP4_NBNS[];
+    INTERNAL_IP4_DHCP: INTERNAL_IP4_DHCP[];
+    APPLICATION_VERSION: APPLICATION_VERSION | undefined;
+    INTERNAL_IP6_ADDRESS: INTERNAL_IP6_ADDRESS[];
+    INTERNAL_IP6_DNS: INTERNAL_IP6_DNS[];
+    INTERNAL_IP6_DHCP: INTERNAL_IP6_DHCP[];
+    INTERNAL_IP4_SUBNET: INTERNAL_IP4_SUBNET[];
+    SUPPORTED_ATTRIBUTES: SUPPORTED_ATTRIBUTES | undefined;
+    INTERNAL_IP6_SUBNET: INTERNAL_IP6_SUBNET[];
+    P_CSCF_IP4_ADDRESS: P_CSCF_IP4_ADDRESS[];
+    P_CSCF_IP6_ADDRESS: P_CSCF_IP6_ADDRESS[];
+    OtherAttributes: ConfigurationAttribute[];
+    constructor();
+    static parse(buffer: Buffer): CPAttributes;
+    /**
+     * Serializes the configuration attributes to a buffer
+     * @public
+     * @returns {Buffer}
+     */
+    serialize(): Buffer;
+    /**
+     * Converts Configuration Attribute to JSON
+     * @public
+     * @returns {Record<string, any>}
+     */
+    toJSON(): Record<string, any>;
+    /**
+     * Returns a string representation of the configuration attributes
+     * @public
+     * @returns {string}
+     */
+    toString(): string;
+}