common.h

Go to the documentation of this file.

/*
 *  OpenVPN -- An application to securely tunnel IP networks
 *             over a single UDP port, with support for SSL/TLS-based
 *             session authentication and key exchange,
 *             packet encryption, packet authentication, and
 *             packet compression.
 *
 *  Copyright (C) 2002-2025 OpenVPN Inc <sales@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/>.
 */
 
#ifndef COMMON_H
#define COMMON_H
 
#include <stdint.h>
 
/*
 * Statistics counters and associated printf format.
 */
typedef uint64_t counter_type;
#define counter_format "%" PRIu64
 
/*
 * Time intervals
 */
typedef int interval_t;
 
/*
 * Used as an upper bound for timeouts.
 */
#define BIG_TIMEOUT (60 * 60 * 24 * 7) /* one week (in seconds) */
 
/*
 * Printf formats for special types
 */
#ifdef _WIN64
#define ptr_format "0x%016" PRIx64
#else
#define ptr_format "0x%08lx"
#endif
#define fragment_header_format "0x%08x"
 
/* these are used to cast the arguments
 * and MUST match the formats above */
#ifdef _WIN64
typedef unsigned long long ptr_type;
#else
typedef unsigned long ptr_type;
#endif
 
/* the --client-config-dir default file */
#define CCD_DEFAULT "DEFAULT"
 
/*
 * This parameter controls the TLS channel buffer size and the
 * maximum size of a single TLS message (cleartext).
 * This parameter must be >= PUSH_BUNDLE_SIZE
 */
#define TLS_CHANNEL_BUF_SIZE 2048
 
/* TLS control buffer minimum size
 *
 * A control frame might have IPv6 header (40 byte),
 * UDP (8 byte), opcode (1), session id (8),
 * ACK array with 4 ACKs in non-ACK_V1 packets (25 bytes)
 * tls-crypt(56) or tls-auth(up to 72). To allow secure
 * renegotiation (dynamic tls-crypt), we set this minimum
 * to 154, which only allows 16 byte of payload and should
 * be considered an absolute minimum and not a good value to
 * set
 */
#define TLS_CHANNEL_MTU_MIN 154
 
/*
 * This parameter controls the maximum size of a bundle
 * of pushed options.
 */
#define PUSH_BUNDLE_SIZE 1024
 
/*
 * In how many seconds does client re-send PUSH_REQUEST if we haven't yet received a reply
 */
#define PUSH_REQUEST_INTERVAL 5
 
/*
 * Script security warning
 */
#define SCRIPT_SECURITY_WARNING \
    "WARNING: External program may not be called unless '--script-security 2' or higher is enabled. See --help text or man page for detailed info."
 
#endif /* ifndef COMMON_H */