tinc/src/solaris/device.c

/*
    device.c -- Interaction with Solaris tun device
    Copyright (C) 2001-2005 Ivo Timmermans,
                  2002-2010 OpenVPN Technologies, Inc. <sales@openvpn.net>
                  2001-2017 Guus Sliepen <guus@tinc-vpn.org>

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.

    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, write to the Free Software Foundation, Inc.,
    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
*/


#include "../system.h"

#include <sys/stropts.h>
#include <sys/sockio.h>
#include <stropts.h>

#include "../conf.h"
#include "../device.h"
#include "../logger.h"
#include "../net.h"
#include "../route.h"
#include "../utils.h"
#include "../xalloc.h"

#ifndef TUNNEWPPA
#warning Missing net/if_tun.h, using hardcoded value for TUNNEWPPA
#define TUNNEWPPA       (('T'<<16) | 0x0001)
#endif

#define DEFAULT_TUN_DEVICE "/dev/tun"
#define DEFAULT_TAP_DEVICE "/dev/tap"
#define IP_DEVICE "/dev/udp"

static enum {
	DEVICE_TYPE_TUN,
	DEVICE_TYPE_TAP,
} device_type = DEVICE_TYPE_TUN;

int device_fd = -1;
static int if_fd = -1;
static int ip_fd = -1;
char *device = NULL;
char *iface = NULL;
static const char *device_info = NULL;

uint64_t device_total_in = 0;
uint64_t device_total_out = 0;

static bool setup_device(void) {
	char *type;

	if(!get_config_string(lookup_config(config_tree, "Device"), &device)) {
		if(routing_mode == RMODE_ROUTER) {
			device = xstrdup(DEFAULT_TUN_DEVICE);
		} else {
			device = xstrdup(DEFAULT_TAP_DEVICE);
		}
	}

	if(get_config_string(lookup_config(config_tree, "DeviceType"), &type)) {
		if(!strcasecmp(type, "tun"))
			/* use default */;
		else if(!strcasecmp(type, "tap")) {
			device_type = DEVICE_TYPE_TAP;
		} else {
			logger(LOG_ERR, "Unknown device type %s!", type);
			return false;
		}
	} else {
		if(strstr(device, "tap") || routing_mode != RMODE_ROUTER) {
			device_type = DEVICE_TYPE_TAP;
		}
	}

	if(device_type == DEVICE_TYPE_TUN) {
		device_info = "Solaris tun device";
	} else {
		device_info = "Solaris tap device";
	}

	if(device_type == DEVICE_TYPE_TAP && routing_mode == RMODE_ROUTER) {
		overwrite_mac = true;
	}

	/* The following is black magic copied from OpenVPN. */

	if((ip_fd = open(IP_DEVICE, O_RDWR, 0)) < 0) {
		logger(LOG_ERR, "Could not open %s: %s\n", IP_DEVICE, strerror(errno));
		return false;
	}

	if((device_fd = open(device, O_RDWR, 0)) < 0) {
		logger(LOG_ERR, "Could not open %s: %s\n", device, strerror(errno));
		return false;
	}

	/* Get unit number. */

	char *ptr = device;
	get_config_string(lookup_config(config_tree, "Interface"), &ptr);

	while(*ptr && !isdigit(*ptr)) {
		ptr++;
	}

	int ppa = atoi(ptr);

	/* Assign a new PPA and get its unit number. */

	struct strioctl strioc_ppa = {
		.ic_cmd = TUNNEWPPA,
		.ic_len = sizeof(ppa),
		.ic_dp = (char *) &ppa,
	};

	if(!*ptr) { /* no number given, try dynamic */
		bool found = false;

		while(!found && ppa < 64) {
			int new_ppa = ioctl(device_fd, I_STR, &strioc_ppa);

			if(new_ppa >= 0) {
				ppa = new_ppa;
				found = true;
				break;
			}

			ppa++;
		}

		if(!found) {
			logger(LOG_ERR, "Could not find free PPA for %s %s!", device_info, device);
			return false;
		}
	} else { /* try this particular one */
		if((ppa = ioctl(device_fd, I_STR, &strioc_ppa)) < 0) {
			logger(LOG_ERR, "Could not assign PPA %d for %s %s!", ppa, device_info, device);
			return false;
		}
	}

	if((if_fd = open(device, O_RDWR, 0)) < 0) {
		logger(LOG_ERR, "Could not open %s: %s\n", device, strerror(errno));
		return false;
	}

	if(ioctl(if_fd, I_PUSH, "ip") < 0) {
		logger(LOG_ERR, "Could not push IP module onto %s %s!", device_info, device);
		return false;
	}

	xasprintf(&iface, "%s%d", device_type == DEVICE_TYPE_TUN ? "tun" : "tap", ppa);

	{
		/* Remove muxes just in case they are left over from a crashed tincd */
		struct lifreq ifr = {};
		strncpy(ifr.lifr_name, iface, sizeof(ifr.lifr_name));

		if(ioctl(ip_fd, SIOCGLIFMUXID, &ifr) >= 0) {
			int muxid = ifr.lifr_arp_muxid;
			ioctl(ip_fd, I_PUNLINK, muxid);
			muxid = ifr.lifr_ip_muxid;
			ioctl(ip_fd, I_PUNLINK, muxid);
		}
	}

	if(device_type == DEVICE_TYPE_TUN) {
		/* Assign ppa according to the unit number returned by tun device */
		if(ioctl(if_fd, IF_UNITSEL, (char *)&ppa) < 0) {
			logger(LOG_ERR, "Could not set PPA %d on %s %s!", ppa, device_info, device);
			return false;
		}
	}

	int arp_fd = -1;

	if(device_type == DEVICE_TYPE_TAP) {
		struct lifreq ifr = {};

		if(ioctl(if_fd, SIOCGLIFFLAGS, &ifr) < 0) {
			logger(LOG_ERR, "Could not set flags on %s %s!", device_info, device);
			return false;
		}

		strncpy(ifr.lifr_name, iface, sizeof(ifr.lifr_name));
		ifr.lifr_ppa = ppa;

		/* Assign ppa according to the unit number returned by tun device */
		if(ioctl(if_fd, SIOCSLIFNAME, &ifr) < 0) {
			logger(LOG_ERR, "Could not set PPA %d on %s %s!", ppa, device_info, device);
			return false;
		}

		if(ioctl(if_fd, SIOCGLIFFLAGS, &ifr) < 0) {
			logger(LOG_ERR, "Could not set flags on %s %s!", device_info, device);
			return false;
		}

		/* Push arp module to if_fd */
		if(ioctl(if_fd, I_PUSH, "arp") < 0) {
			logger(LOG_ERR, "Could not push ARP module onto %s %s!", device_info, device);
			return false;
		}

		/* Pop any modules on the stream */
		while(true) {
			if(ioctl(ip_fd, I_POP, NULL) < 0) {
				break;
			}
		}

		/* Push arp module to ip_fd */
		if(ioctl(ip_fd, I_PUSH, "arp") < 0) {
			logger(LOG_ERR, "Could not push ARP module onto %s!", IP_DEVICE);
			return false;
		}

		/* Open arp_fd */
		if((arp_fd = open(device, O_RDWR, 0)) < 0) {
			logger(LOG_ERR, "Could not open %s: %s\n", device, strerror(errno));
			return false;
		}

		/* Push arp module to arp_fd */
		if(ioctl(arp_fd, I_PUSH, "arp") < 0) {
			logger(LOG_ERR, "Could not push ARP module onto %s %s!", device_info, device);
			return false;
		}

		/* Set ifname to arp */
		struct strioctl strioc_if = {
			.ic_cmd = SIOCSLIFNAME,
			.ic_len = sizeof(ifr),
			.ic_dp = (char *) &ifr,
		};

		if(ioctl(arp_fd, I_STR, &strioc_if) < 0) {
			logger(LOG_ERR, "Could not set ifname to %s %s", device_info, device);
			return false;
		}
	}

	int ip_muxid, arp_muxid;

	if((ip_muxid = ioctl(ip_fd, I_PLINK, if_fd)) < 0) {
		logger(LOG_ERR, "Could not link %s %s to IP", device_info, device);
		return false;
	}

	if(device_type == DEVICE_TYPE_TAP) {
		if((arp_muxid = ioctl(ip_fd, I_PLINK, arp_fd)) < 0) {
			logger(LOG_ERR, "Could not link %s %s to ARP", device_info, device);
			return false;
		}

		close(arp_fd);
	}

	struct lifreq ifr = {};

	strncpy(ifr.lifr_name, iface, sizeof(ifr.lifr_name));

	ifr.lifr_ip_muxid = ip_muxid;

	if(device_type == DEVICE_TYPE_TAP) {
		ifr.lifr_arp_muxid = arp_muxid;
	}

	if(ioctl(ip_fd, SIOCSLIFMUXID, &ifr) < 0) {
		if(device_type == DEVICE_TYPE_TAP) {
			ioctl(ip_fd, I_PUNLINK, arp_muxid);
		}

		ioctl(ip_fd, I_PUNLINK, ip_muxid);
		logger(LOG_ERR, "Could not set multiplexor id for %s %s", device_info, device);
		return false;
	}

	close(if_fd);

#ifdef FD_CLOEXEC
	fcntl(device_fd, F_SETFD, FD_CLOEXEC);
	fcntl(ip_fd, F_SETFD, FD_CLOEXEC);
#endif

	logger(LOG_INFO, "%s is a %s", device, device_info);

	return true;
}

static void close_device(void) {
	if(iface) {
		struct lifreq ifr = {};
		strncpy(ifr.lifr_name, iface, sizeof(ifr.lifr_name));

		if(ioctl(ip_fd, SIOCGLIFMUXID, &ifr) >= 0) {
			int muxid = ifr.lifr_arp_muxid;
			ioctl(ip_fd, I_PUNLINK, muxid);
			muxid = ifr.lifr_ip_muxid;
			ioctl(ip_fd, I_PUNLINK, muxid);
		}
	}

	close(ip_fd);
	close(device_fd);

	free(device);
	free(iface);
}

static bool read_packet(vpn_packet_t *packet) {
	int result;
	struct strbuf sbuf;
	int f = 0;

	switch(device_type) {
	case DEVICE_TYPE_TUN:
		sbuf.maxlen = MTU - 14;
		sbuf.buf = (char *)packet->data + 14;

		if((result = getmsg(device_fd, NULL, &sbuf, &f)) < 0) {
			logger(LOG_ERR, "Error while reading from %s %s: %s", device_info, device, strerror(errno));
			return false;
		}

		switch(packet->data[14] >> 4) {
		case 4:
			packet->data[12] = 0x08;
			packet->data[13] = 0x00;
			break;

		case 6:
			packet->data[12] = 0x86;
			packet->data[13] = 0xDD;
			break;

		default:
			ifdebug(TRAFFIC) logger(LOG_ERR, "Unknown IP version %d while reading packet from %s %s", packet->data[14] >> 4, device_info, device);
			return false;
		}

		memset(packet->data, 0, 12);
		packet->len = sbuf.len + 14;
		break;

	case DEVICE_TYPE_TAP:
		sbuf.maxlen = MTU;
		sbuf.buf = (char *)packet->data;

		if((result = getmsg(device_fd, NULL, &sbuf, &f)) < 0) {
			logger(LOG_ERR, "Error while reading from %s %s: %s", device_info, device, strerror(errno));
			return false;
		}

		packet->len = sbuf.len;
		break;

	default:
		abort();
	}

	device_total_in += packet->len;

	ifdebug(TRAFFIC) logger(LOG_DEBUG, "Read packet of %d bytes from %s", packet->len, device_info);

	return true;
}

static bool write_packet(vpn_packet_t *packet) {
	ifdebug(TRAFFIC) logger(LOG_DEBUG, "Writing packet of %d bytes to %s", packet->len, device_info);

	struct strbuf sbuf;

	switch(device_type) {
	case DEVICE_TYPE_TUN:
		sbuf.len = packet->len - 14;
		sbuf.buf = (char *)packet->data + 14;

		if(putmsg(device_fd, NULL, &sbuf, 0) < 0) {
			logger(LOG_ERR, "Can't write to %s %s: %s", device_info, device, strerror(errno));
			return false;
		}

		break;

	case DEVICE_TYPE_TAP:
		sbuf.len = packet->len;
		sbuf.buf = (char *)packet->data;

		if(putmsg(device_fd, NULL, &sbuf, 0) < 0) {
			logger(LOG_ERR, "Can't write to %s %s: %s", device_info, device, strerror(errno));
			return false;
		}

		break;

	default:
		abort();
	}

	device_total_out += packet->len;

	return true;
}

static void dump_device_stats(void) {
	logger(LOG_DEBUG, "Statistics for %s %s:", device_info, device);
	logger(LOG_DEBUG, " total bytes in:  %10"PRIu64, device_total_in);
	logger(LOG_DEBUG, " total bytes out: %10"PRIu64, device_total_out);
}

const devops_t os_devops = {
	.setup = setup_device,
	.close = close_device,
	.read = read_packet,
	.write = write_packet,
	.dump_stats = dump_device_stats,
};