ovpn_dco_win.h

Go to the documentation of this file.

/*
 *  ovpn-dco-win OpenVPN protocol accelerator for Windows
 *
 *  Copyright (C) 2020-2025 OpenVPN Inc <sales@openvpn.net>
 *
 *  Author:     Lev Stipakov <lev@openvpn.net>
 *
 *  This program is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License version 2
 *  as published by the Free Software Foundation.
 *
 *  This program is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License along
 *  with this program; if not, see <https://www.gnu.org/licenses/>.
 *
 *  This particular file (uapi.h) is also licensed using the MIT license (see COPYRIGHT.MIT).
 */
 
#pragma once
#ifndef _KERNEL_MODE
#include <winsock2.h>
#endif
#include <ws2def.h>
#include <ws2ipdef.h>
 
typedef enum {
        OVPN_PROTO_UDP,
        OVPN_PROTO_TCP
} OVPN_PROTO;
 
typedef struct _OVPN_NEW_PEER {
        union {
                SOCKADDR_IN Addr4;
                SOCKADDR_IN6 Addr6;
        } Local;
 
        union {
                SOCKADDR_IN Addr4;
                SOCKADDR_IN6 Addr6;
        } Remote;
 
        OVPN_PROTO Proto;
} OVPN_NEW_PEER, * POVPN_NEW_PEER;
 
typedef struct _OVPN_MP_NEW_PEER {
    union {
        SOCKADDR_IN Addr4;
        SOCKADDR_IN6 Addr6;
    } Local;
 
    union {
        SOCKADDR_IN Addr4;
        SOCKADDR_IN6 Addr6;
    } Remote;
 
    IN_ADDR VpnAddr4;
    IN6_ADDR VpnAddr6;
 
    int PeerId;
} OVPN_MP_NEW_PEER, * POVPN_MP_NEW_PEER;
 
typedef struct _OVPN_STATS {
        LONG LostInControlPackets;
        LONG LostOutControlPackets;
 
        LONG LostInDataPackets;
        LONG LostOutDataPackets;
 
        LONG ReceivedDataPackets;
        LONG ReceivedControlPackets;
 
        LONG SentControlPackets;
        LONG SentDataPackets;
 
        LONG64 TransportBytesSent;
        LONG64 TransportBytesReceived;
 
        LONG64 TunBytesSent;
        LONG64 TunBytesReceived;
} OVPN_STATS, * POVPN_STATS;
 
typedef struct _OVPN_PEER_STATS {
    int PeerId;
    LONG64 LinkRxBytes;
    LONG64 LinkTxBytes;
    LONG64 VpnRxBytes;
    LONG64 VpnTxBytes;
} OVPN_PEER_STATS, * POVPN_PEER_STATS;
 
typedef enum _OVPN_KEY_SLOT {
        OVPN_KEY_SLOT_PRIMARY,
        OVPN_KEY_SLOT_SECONDARY
} OVPN_KEY_SLOT;
 
typedef enum _OVPN_CIPHER_ALG {
        OVPN_CIPHER_ALG_NONE,
        OVPN_CIPHER_ALG_AES_GCM,
        OVPN_CIPHER_ALG_CHACHA20_POLY1305
} OVPN_CIPHER_ALG;
 
typedef struct _OVPN_KEY_DIRECTION
{
        unsigned char Key[32];
        unsigned char KeyLen; // 16/24/32 -> AES-128-GCM/AES-192-GCM/AES-256-GCM
        unsigned char NonceTail[8];
} OVPN_KEY_DIRECTION;
 
typedef struct _OVPN_CRYPTO_DATA {
        OVPN_KEY_DIRECTION Encrypt;
        OVPN_KEY_DIRECTION Decrypt;
        OVPN_KEY_SLOT KeySlot;
        OVPN_CIPHER_ALG CipherAlg;
        unsigned char KeyId;
        int PeerId;
} OVPN_CRYPTO_DATA, * POVPN_CRYPTO_DATA;
 
#define CRYPTO_OPTIONS_EPOCH (1<<1)
 
typedef struct _OVPN_CRYPTO_DATA_V2 {
    OVPN_CRYPTO_DATA V1;
    UINT32 CryptoOptions;
} OVPN_CRYPTO_DATA_V2, * POVPN_CRYPTO_DATA_V2;
 
typedef struct _OVPN_MP_SET_PEER {
    int PeerId;
    LONG KeepaliveInterval;
    LONG KeepaliveTimeout;
    LONG MSS;
} OVPN_MP_SET_PEER, * POVPN_MP_SET_PEER;
 
typedef struct _OVPN_SET_PEER {
    LONG KeepaliveInterval;
    LONG KeepaliveTimeout;
    LONG MSS;
} OVPN_SET_PEER, * POVPN_SET_PEER;
 
typedef struct _OVPN_VERSION {
    LONG Major;
    LONG Minor;
    LONG Patch;
} OVPN_VERSION, * POVPN_VERSION;
 
typedef enum {
    OVPN_MODE_P2P,
    OVPN_MODE_MP
} OVPN_MODE;
 
typedef struct _OVPN_SET_MODE {
    OVPN_MODE Mode;
} OVPN_SET_MODE, * POVPN_SET_MODE;
 
typedef struct _OVPN_MP_START_VPN {
    union {
        SOCKADDR_IN Addr4;
        SOCKADDR_IN6 Addr6;
    } ListenAddress;
    int IPv6Only;
} OVPN_MP_START_VPN, * POVPN_MP_START_VPN;
 
typedef enum {
    OVPN_CMD_DEL_PEER,
    OVPN_CMD_SWAP_KEYS,
    OVPN_CMD_FLOAT_PEER
} OVPN_NOTIFY_CMD;
 
typedef enum {
    OVPN_DEL_PEER_REASON_TEARDOWN,
    OVPN_DEL_PEER_REASON_USERSPACE,
    OVPN_DEL_PEER_REASON_EXPIRED,
    OVPN_DEL_PEER_REASON_TRANSPORT_ERROR,
    OVPN_DEL_PEER_REASON_TRANSPORT_DISCONNECT
} OVPN_DEL_PEER_REASON;
 
typedef struct _OVPN_NOTIFY_EVENT {
    OVPN_NOTIFY_CMD Cmd;
    int PeerId;
    OVPN_DEL_PEER_REASON DelPeerReason;
    struct sockaddr_storage FloatAddress;
} OVPN_NOTIFY_EVENT, * POVPN_NOTIFY_EVENT;
 
typedef struct _OVPN_MP_DEL_PEER {
    int PeerId;
} OVPN_MP_DEL_PEER, * POVPN_MP_DEL_PEER;
 
typedef struct _OVPN_MP_SWAP_KEYS {
    int PeerId;
} OVPN_MP_SWAP_KEYS, * POVPN_MP_SWAP_KEYS;
 
typedef struct _OVPN_MP_IROUTE {
    union {
        IN_ADDR Addr4;
        IN6_ADDR Addr6;
    } Addr;
    int Netbits;
    int PeerId;
    int IPv6;
} OVPN_MP_IROUTE, * POVPN_MP_IROUTE;
 
typedef struct _OVPN_GET_PEER_STATS {
    int PeerId; // -1 for all peers stats
} OVPN_GET_PEER_STATS, * POVPN_GET_PEER_STATS;
 
#define OVPN_IOCTL_NEW_PEER     CTL_CODE(FILE_DEVICE_UNKNOWN, 1, METHOD_BUFFERED, FILE_ANY_ACCESS)
#define OVPN_IOCTL_GET_STATS    CTL_CODE(FILE_DEVICE_UNKNOWN, 2, METHOD_BUFFERED, FILE_ANY_ACCESS)
#define OVPN_IOCTL_NEW_KEY      CTL_CODE(FILE_DEVICE_UNKNOWN, 3, METHOD_BUFFERED, FILE_ANY_ACCESS)
#define OVPN_IOCTL_SWAP_KEYS    CTL_CODE(FILE_DEVICE_UNKNOWN, 4, METHOD_BUFFERED, FILE_ANY_ACCESS)
#define OVPN_IOCTL_SET_PEER     CTL_CODE(FILE_DEVICE_UNKNOWN, 5, METHOD_BUFFERED, FILE_ANY_ACCESS)
#define OVPN_IOCTL_START_VPN    CTL_CODE(FILE_DEVICE_UNKNOWN, 6, METHOD_BUFFERED, FILE_ANY_ACCESS)
#define OVPN_IOCTL_DEL_PEER     CTL_CODE(FILE_DEVICE_UNKNOWN, 7, METHOD_BUFFERED, FILE_ANY_ACCESS)
#define OVPN_IOCTL_GET_VERSION  CTL_CODE(FILE_DEVICE_UNKNOWN, 8, METHOD_BUFFERED, FILE_ANY_ACCESS)
#define OVPN_IOCTL_NEW_KEY_V2   CTL_CODE(FILE_DEVICE_UNKNOWN, 9, METHOD_BUFFERED, FILE_ANY_ACCESS)
#define OVPN_IOCTL_SET_MODE     CTL_CODE(FILE_DEVICE_UNKNOWN, 10, METHOD_BUFFERED, FILE_ANY_ACCESS)
 
#define OVPN_IOCTL_MP_START_VPN   CTL_CODE(FILE_DEVICE_UNKNOWN, 11, METHOD_BUFFERED, FILE_ANY_ACCESS)
#define OVPN_IOCTL_MP_NEW_PEER    CTL_CODE(FILE_DEVICE_UNKNOWN, 12, METHOD_BUFFERED, FILE_ANY_ACCESS)
#define OVPN_IOCTL_MP_SET_PEER    CTL_CODE(FILE_DEVICE_UNKNOWN, 13, METHOD_BUFFERED, FILE_ANY_ACCESS)
 
#define OVPN_IOCTL_NOTIFY_EVENT   CTL_CODE(FILE_DEVICE_UNKNOWN, 14, METHOD_BUFFERED, FILE_ANY_ACCESS)
 
#define OVPN_IOCTL_MP_DEL_PEER    CTL_CODE(FILE_DEVICE_UNKNOWN, 15, METHOD_BUFFERED, FILE_ANY_ACCESS)
#define OVPN_IOCTL_MP_SWAP_KEYS   CTL_CODE(FILE_DEVICE_UNKNOWN, 16, METHOD_BUFFERED, FILE_ANY_ACCESS)
 
#define OVPN_IOCTL_MP_ADD_IROUTE CTL_CODE(FILE_DEVICE_UNKNOWN, 17, METHOD_BUFFERED, FILE_ANY_ACCESS)
#define OVPN_IOCTL_MP_DEL_IROUTE CTL_CODE(FILE_DEVICE_UNKNOWN, 18, METHOD_BUFFERED, FILE_ANY_ACCESS)
 
#define OVPN_IOCTL_GET_PEER_STATS CTL_CODE(FILE_DEVICE_UNKNOWN, 19, METHOD_BUFFERED, FILE_ANY_ACCESS)