[mirror_ubuntu-focal-kernel.git] / include / net / netfilter / nf_log.h

/* SPDX-License-Identifier: GPL-2.0 */
#ifndef _NF_LOG_H
#define _NF_LOG_H

#include <linux/netfilter.h>
#include <linux/netfilter/nf_log.h>

/* Log tcp sequence, tcp options, ip options and uid owning local socket */
#define NF_LOG_DEFAULT_MASK	0x0f

/* This flag indicates that copy_len field in nf_loginfo is set */
#define NF_LOG_F_COPY_LEN	0x1

enum nf_log_type {
	NF_LOG_TYPE_LOG		= 0,
	NF_LOG_TYPE_ULOG,
	NF_LOG_TYPE_MAX
};

struct nf_loginfo {
	u_int8_t type;
	union {
		struct {
			/* copy_len will be used iff you set
			 * NF_LOG_F_COPY_LEN in flags
			 */
			u_int32_t copy_len;
			u_int16_t group;
			u_int16_t qthreshold;
			u_int16_t flags;
		} ulog;
		struct {
			u_int8_t level;
			u_int8_t logflags;
		} log;
	} u;
};

typedef void nf_logfn(struct net *net,
		      u_int8_t pf,
		      unsigned int hooknum,
		      const struct sk_buff *skb,
		      const struct net_device *in,
		      const struct net_device *out,
		      const struct nf_loginfo *li,
		      const char *prefix);

struct nf_logger {
	char			*name;
	enum nf_log_type	type;
	nf_logfn 		*logfn;
	struct module		*me;
};

/* sysctl_nf_log_all_netns - allow LOG target in all network namespaces */
extern int sysctl_nf_log_all_netns;

/* Function to register/unregister log function. */
int nf_log_register(u_int8_t pf, struct nf_logger *logger);
void nf_log_unregister(struct nf_logger *logger);

int nf_log_set(struct net *net, u_int8_t pf, const struct nf_logger *logger);
void nf_log_unset(struct net *net, const struct nf_logger *logger);

int nf_log_bind_pf(struct net *net, u_int8_t pf,
		   const struct nf_logger *logger);
void nf_log_unbind_pf(struct net *net, u_int8_t pf);

int nf_logger_find_get(int pf, enum nf_log_type type);
void nf_logger_put(int pf, enum nf_log_type type);
void nf_logger_request_module(int pf, enum nf_log_type type);

#define MODULE_ALIAS_NF_LOGGER(family, type) \
	MODULE_ALIAS("nf-logger-" __stringify(family) "-" __stringify(type))

/* Calls the registered backend logging function */
__printf(8, 9)
void nf_log_packet(struct net *net,
		   u_int8_t pf,
		   unsigned int hooknum,
		   const struct sk_buff *skb,
		   const struct net_device *in,
		   const struct net_device *out,
		   const struct nf_loginfo *li,
		   const char *fmt, ...);

__printf(8, 9)
void nf_log_trace(struct net *net,
		  u_int8_t pf,
		  unsigned int hooknum,
		  const struct sk_buff *skb,
		  const struct net_device *in,
		  const struct net_device *out,
		  const struct nf_loginfo *li,
		  const char *fmt, ...);

struct nf_log_buf;

struct nf_log_buf *nf_log_buf_open(void);
__printf(2, 3) int nf_log_buf_add(struct nf_log_buf *m, const char *f, ...);
void nf_log_buf_close(struct nf_log_buf *m);

/* common logging functions */
int nf_log_dump_udp_header(struct nf_log_buf *m, const struct sk_buff *skb,
			   u8 proto, int fragment, unsigned int offset);
int nf_log_dump_tcp_header(struct nf_log_buf *m, const struct sk_buff *skb,
			   u8 proto, int fragment, unsigned int offset,
			   unsigned int logflags);
void nf_log_dump_sk_uid_gid(struct nf_log_buf *m, struct sock *sk);
void nf_log_dump_packet_common(struct nf_log_buf *m, u_int8_t pf,
			       unsigned int hooknum, const struct sk_buff *skb,
			       const struct net_device *in,
			       const struct net_device *out,
			       const struct nf_loginfo *loginfo,
			       const char *prefix);
void nf_log_l2packet(struct net *net, u_int8_t pf,
		     __be16 protocol,
		     unsigned int hooknum,
		     const struct sk_buff *skb,
		     const struct net_device *in,
		     const struct net_device *out,
		     const struct nf_loginfo *loginfo, const char *prefix);

#endif /* _NF_LOG_H */
Commit	Line	Data
b2441318	1	/* SPDX-License-Identifier: GPL-2.0 */
f01ffbd6 PM	2	#ifndef _NF_LOG_H
	3	#define _NF_LOG_H
	4
ca735b3a	5	#include <linux/netfilter.h>
ff107d27	6	#include <linux/netfilter/nf_log.h>
ca735b3a	7
ff107d27 LZ	8	/* Log tcp sequence, tcp options, ip options and uid owning local socket */
ff107d27 LZ	9	#define NF_LOG_DEFAULT_MASK 0x0f
f01ffbd6	10
7643507f VP	11	/* This flag indicates that copy_len field in nf_loginfo is set */
	12	#define NF_LOG_F_COPY_LEN 0x1
	13
5962815a PNA	14	enum nf_log_type {
	15	NF_LOG_TYPE_LOG = 0,
	16	NF_LOG_TYPE_ULOG,
	17	NF_LOG_TYPE_MAX
	18	};
f01ffbd6 PM	19
	20	struct nf_loginfo {
	21	u_int8_t type;
	22	union {
	23	struct {
7643507f VP	24	/* copy_len will be used iff you set
	25	* NF_LOG_F_COPY_LEN in flags
	26	*/
f01ffbd6 PM	27	u_int32_t copy_len;
	28	u_int16_t group;
	29	u_int16_t qthreshold;
7643507f	30	u_int16_t flags;
f01ffbd6 PM	31	} ulog;
	32	struct {
	33	u_int8_t level;
	34	u_int8_t logflags;
	35	} log;
	36	} u;
	37	};
	38
8cdb46da HS	39	typedef void nf_logfn(struct net *net,
8cdb46da HS	40	u_int8_t pf,
f01ffbd6 PM	41	unsigned int hooknum,
	42	const struct sk_buff *skb,
	43	const struct net_device *in,
	44	const struct net_device *out,
	45	const struct nf_loginfo *li,
	46	const char *prefix);
	47
	48	struct nf_logger {
5962815a PNA	49	char *name;
	50	enum nf_log_type type;
	51	nf_logfn *logfn;
	52	struct module *me;
f01ffbd6 PM	53	};
f01ffbd6 PM	54
2851940f MK	55	/* sysctl_nf_log_all_netns - allow LOG target in all network namespaces */
	56	extern int sysctl_nf_log_all_netns;
	57
f01ffbd6	58	/* Function to register/unregister log function. */
ca735b3a EL	59	int nf_log_register(u_int8_t pf, struct nf_logger *logger);
	60	void nf_log_unregister(struct nf_logger *logger);
	61
779994fa	62	int nf_log_set(struct net net, u_int8_t pf, const struct nf_logger logger);
30e0c6a6 G	63	void nf_log_unset(struct net net, const struct nf_logger logger);
	64
	65	int nf_log_bind_pf(struct net *net, u_int8_t pf,
	66	const struct nf_logger *logger);
	67	void nf_log_unbind_pf(struct net *net, u_int8_t pf);
f01ffbd6	68
fab4085f PNA	69	int nf_logger_find_get(int pf, enum nf_log_type type);
fab4085f PNA	70	void nf_logger_put(int pf, enum nf_log_type type);
960649d1	71	void nf_logger_request_module(int pf, enum nf_log_type type);
fab4085f PNA	72
	73	#define MODULE_ALIAS_NF_LOGGER(family, type) \
	74	MODULE_ALIAS("nf-logger-" __stringify(family) "-" __stringify(type))
	75
f01ffbd6	76	/* Calls the registered backend logging function */
30e0c6a6 G	77	__printf(8, 9)
	78	void nf_log_packet(struct net *net,
	79	u_int8_t pf,
f01ffbd6 PM	80	unsigned int hooknum,
	81	const struct sk_buff *skb,
	82	const struct net_device *in,
	83	const struct net_device *out,
7b2f9631	84	const struct nf_loginfo *li,
b9075fa9	85	const char *fmt, ...);
f01ffbd6	86
4017a7ee PNA	87	__printf(8, 9)
	88	void nf_log_trace(struct net *net,
	89	u_int8_t pf,
	90	unsigned int hooknum,
	91	const struct sk_buff *skb,
	92	const struct net_device *in,
	93	const struct net_device *out,
	94	const struct nf_loginfo *li,
	95	const char *fmt, ...);
	96
27fd8d90 PNA	97	struct nf_log_buf;
	98
	99	struct nf_log_buf *nf_log_buf_open(void);
	100	__printf(2, 3) int nf_log_buf_add(struct nf_log_buf m, const char f, ...);
	101	void nf_log_buf_close(struct nf_log_buf *m);
	102
83e96d44 PNA	103	/* common logging functions */
	104	int nf_log_dump_udp_header(struct nf_log_buf m, const struct sk_buff skb,
	105	u8 proto, int fragment, unsigned int offset);
	106	int nf_log_dump_tcp_header(struct nf_log_buf m, const struct sk_buff skb,
	107	u8 proto, int fragment, unsigned int offset,
	108	unsigned int logflags);
	109	void nf_log_dump_sk_uid_gid(struct nf_log_buf m, struct sock sk);
	110	void nf_log_dump_packet_common(struct nf_log_buf *m, u_int8_t pf,
	111	unsigned int hooknum, const struct sk_buff *skb,
	112	const struct net_device *in,
	113	const struct net_device *out,
	114	const struct nf_loginfo *loginfo,
	115	const char *prefix);
673ab46f LZ	116	void nf_log_l2packet(struct net *net, u_int8_t pf,
	117	__be16 protocol,
	118	unsigned int hooknum,
1fddf4ba PNA	119	const struct sk_buff *skb,
	120	const struct net_device *in,
	121	const struct net_device *out,
	122	const struct nf_loginfo loginfo, const char prefix);
83e96d44	123
f01ffbd6	124	#endif /* _NF_LOG_H */