packet_sniffer.c

#include <linux/module.h>
#include <linux/kernel.h>

#include <linux/netfilter.h>
#include <linux/netfilter_ipv4.h>
#include <linux/netfilter_ipv6.h>
#include <linux/if_ether.h>
#include <linux/ip.h>
#include <linux/ipv6.h>
#include <linux/icmpv6.h>
#include <linux/tcp.h>
#include <linux/udp.h>

#include <linux/cdev.h>
#include <linux/fs.h>
#include <linux/wait.h>
#include <linux/sched.h>
#include <linux/spinlock.h>
#include <linux/mutex.h>
#include <linux/version.h>
#include <linux/uaccess.h>
#include <linux/ktime.h>
#include <linux/preempt.h>
#include <linux/smp.h>

#include "packet_sniffer.h"

/* 
 * used to read incoming data along with wait_event_interruptible()
 * it will make the process sleep if there are no data
 * 
 */
static wait_queue_head_t wait_queue;

// netfilter hook operations
static struct nf_hook_ops nf_ops;
static struct nf_hook_ops nf_ops_ipv6;

// packet filled in by the kernel
static struct net_packet buffer[BUFFER_SIZE];

// spinlock used in the capture() funciton
// mutex used in the device_read() function
static DEFINE_SPINLOCK(buffer_spinlock);
static DEFINE_MUTEX(buffer_mutex);

// there are new data?
static int data_ready = 0;
// index in buffer
static int packet_index = 0;

// Character device management
static struct class *packet_class = NULL;
static struct device *packet_device = NULL;
static struct cdev char_dev;
static dev_t dev_num;

//
// Character Device callbacks
//
static ssize_t device_read(struct file *file, char __user *user_buffer, size_t len, loff_t *offset);
static int device_open(struct inode *inode, struct file *file);
static int device_release(struct inode *inode, struct file *file);

static struct file_operations f_ops = {
	.owner = THIS_MODULE,
	.read = device_read,
	.open = device_open,
	.release = device_release,
};

static int device_open(struct inode *inode, struct file *file) {
	pr_info("packet_sniffer: Device opened\n");
	return 0;
}

static int device_release(struct inode *inode, struct file *file) {
	pr_info("packet_sniffer: Device closed\n");
	return 0;
}

/*
 * read new data and copy them to the user buffer
 * The task is awaken by the wait_event_interruptible() function
 *
 * IMPORTANT: we can sleep in this context!
 * 
 */

static ssize_t device_read(struct file *file, char __user *user_buffer, size_t len, loff_t *offset) {
	int size_to_copy, packet_size;

	if (wait_event_interruptible(wait_queue, data_ready)) {
		return -ERESTARTSYS;
	}

	if(mutex_lock_interruptible(&buffer_mutex)) {
		return -ERESTARTSYS;
	}

	packet_size = sizeof(struct net_packet);
	size_to_copy = min(packet_index * packet_size, (int)len);

	if (likely(copy_to_user(user_buffer, buffer, size_to_copy))) {
		mutex_unlock(&buffer_mutex);
		return -EFAULT;
	}

	packet_index = 0;
	data_ready = 0;
	mutex_unlock(&buffer_mutex);

	return size_to_copy;
}

// TCP/UDP informations
static struct net_packet fill_transport_info(struct sk_buff *skb, struct net_packet *pkt) {
	struct tcphdr *tcp_header;
	struct udphdr *udp_header;
	struct igmphdr *igmp_header;
	struct icmp6hdr *icmpv6_header;    

	switch(pkt->protocol) {
		case IPPROTO_IGMP:
			igmp_header = igmp_hdr(skb);
			memcpy(&pkt->transport.igmph, igmp_header, sizeof(struct igmphdr));
		break;
		case IPPROTO_TCP:
			tcp_header = tcp_hdr(skb);
			memcpy(&pkt->transport.tcph, tcp_header, sizeof(struct tcphdr));
			//      fill_http_info(skb, tcp_header, &pkt);
		break;
		case IPPROTO_UDP:
			udp_header = udp_hdr(skb);
			memcpy(&pkt->transport.udph, udp_header, sizeof(struct udphdr));
		break;
		case NEXTHDR_ICMP: // ICMPv6
			icmpv6_header = icmp6_hdr(skb);
			memcpy(&pkt->transport.icmph.icmpv6h, icmpv6_header, sizeof(struct icmp6hdr));
		break;
	}

	return *pkt;
}

// collect IP & generic informations
static struct net_packet fill_packet_info(struct sk_buff *skb) {
	struct net_packet pkt;
	struct ethhdr *eth_header;
	struct iphdr *ip_header;
	struct ipv6hdr *ipv6_header;
	struct timespec64 ts;

	ts = ktime_to_timespec64(skb->tstamp);

	pkt.skb_len = skb->len;
	pkt.timestamp_sec = ts.tv_sec;
	pkt.timestamp_nsec = ts.tv_nsec;
	pkt.eth_protocol = skb->protocol;

	eth_header = eth_hdr(skb);
	memcpy(&pkt.ethh, eth_header, sizeof(struct ethhdr));

	if(skb->protocol == htons(ETH_P_IP)) {
		ip_header = ip_hdr(skb);
		pkt.protocol = ip_header->protocol;
		memcpy(&pkt.network.ipv4h, ip_header, sizeof(struct iphdr));	
	} 
	else {
		ipv6_header = ipv6_hdr(skb);
		pkt.protocol = ipv6_header->nexthdr;
		memcpy(&pkt.network.ipv6h, ipv6_header, sizeof(struct ipv6hdr));
	}

	fill_transport_info(skb, &pkt);

	return pkt;
}

/*
 * Netfilter hook entry point
 *
 * spinlock to protect the buffer 
 * when data are available, the task waiting on the queue is woken up
 *
 * Better don't sleep here...
 *
 */
static unsigned int capture(void *priv, struct sk_buff *skb, const struct nf_hook_state *state) {
	struct net_packet pkt;
	unsigned long flags;

	if (skb->protocol != htons(ETH_P_IP) && skb->protocol != htons(ETH_P_IPV6)) {
		pr_info("Accepted unsupported protocol: %d", skb->protocol);
		return NF_ACCEPT;
	}

	pkt = fill_packet_info(skb);
	pkt.cpu_id = smp_processor_id();

	spin_lock_irqsave(&buffer_spinlock, flags);

	if(unlikely(packet_index >= BUFFER_SIZE)) {
		pr_info("packet_sniffer: Buffer is full, reset buffer...");
		//memset(buffer, 0, BUFFER_SIZE);
		packet_index = 0;
	}	
		
	memcpy(&buffer[packet_index++], &pkt, sizeof(struct net_packet));
	data_ready = 1;
	spin_unlock_irqrestore(&buffer_spinlock, flags);
	wake_up_interruptible(&wait_queue);

	return NF_ACCEPT;
}

#define CLASS_NAME "packet_sniffer_class"

static int register_net_hook(void) {
	int ret = 0;

	// IPv4 Netfilter Hook
	nf_ops.hook = capture;
	nf_ops.hooknum = NF_INET_PRE_ROUTING;
	nf_ops.pf = PF_INET;
	nf_ops.priority = NF_IP_PRI_FIRST;

	// IPv6 Netfilter Hook
	nf_ops_ipv6.hook = capture;
	nf_ops_ipv6.hooknum = NF_INET_PRE_ROUTING;
	nf_ops_ipv6.pf = PF_INET6;
	nf_ops_ipv6.priority = NF_IP6_PRI_FIRST;

	ret = nf_register_net_hook(&init_net, &nf_ops);
	if (ret) {
		pr_err("packet_sniffer: Netfilter registration failed\n");
		goto net_reg_failed;
	}

	ret = nf_register_net_hook(&init_net, &nf_ops_ipv6);
	if (ret) {
		pr_err("packet_sniffer: Netfilter registration failed\n");
		nf_unregister_net_hook(&init_net, &nf_ops);
	}

net_reg_failed:

	return ret;
}

static int __init packet_sniffer_init(void) {
	int ret;

	init_waitqueue_head(&wait_queue);

	if(register_net_hook())
		goto err_nf_unregister_net_hook;

	ret = alloc_chrdev_region(&dev_num, 0, 1, DEVICE_NAME);
	if (ret) {
		pr_err("packet_sniffer: Character device region allocation failed\n");
		goto err_nf_unregister_net_hook;
	}

	cdev_init(&char_dev, &f_ops);
	char_dev.owner = THIS_MODULE;

	ret = cdev_add(&char_dev, dev_num, 1);
	if (ret) {
		pr_err("packet_sniffer: Failed to add character device\n");
		goto err_unregister_chrdev_region;
	}

#if LINUX_VERSION_CODE >= KERNEL_VERSION(6,4,0)
	packet_class = class_create(CLASS_NAME);
#else
	packet_class = class_create(THIS_MODULE, CLASS_NAME);
#endif

	if (IS_ERR(packet_class)) {
		pr_err("packet_sniffer: Failed to create device class\n");
		ret = PTR_ERR(packet_class);
		goto err_cdev_del;
	}

	packet_device = device_create(packet_class, NULL, dev_num, NULL, DEVICE_NAME);

	if (IS_ERR(packet_device)) {
		pr_err("packet_sniffer: Failed to create device\n");
		ret = PTR_ERR(packet_device);
		goto err_class_destroy;
	}

	pr_info("packet_sniffer: Module loaded\n");
	pr_info("Size of the allocated net_packet buffer: %lu bytes, size of net_packet: %lu bytes", sizeof(buffer), sizeof(struct net_packet));

	return 0;

err_class_destroy:
	class_destroy(packet_class);
err_cdev_del:
	cdev_del(&char_dev);
err_unregister_chrdev_region:
	unregister_chrdev_region(dev_num, 1);
err_nf_unregister_net_hook:
	nf_unregister_net_hook(&init_net, &nf_ops);
	nf_unregister_net_hook(&init_net, &nf_ops_ipv6);

	return ret;
}

static void __exit packet_sniffer_exit(void) {
	device_destroy(packet_class, dev_num);
	class_unregister(packet_class);
	class_destroy(packet_class);
	cdev_del(&char_dev);
	unregister_chrdev_region(dev_num, 1);
	nf_unregister_net_hook(&init_net, &nf_ops);
	nf_unregister_net_hook(&init_net, &nf_ops_ipv6);
	pr_info("packet_sniffer: Module unloaded\n");
}

module_init(packet_sniffer_init);
module_exit(packet_sniffer_exit);

MODULE_LICENSE("GPL");
MODULE_AUTHOR("Marco Crivellari");
MODULE_DESCRIPTION("Packet sniffer and analyzer");