[thirdparty/bird.git] / lib / flowspec.h

/*
 *	BIRD Library -- Flow specification (RFC 8955)
 *
 *	(c) 2016 CZ.NIC z.s.p.o.
 *
 *	Can be freely distributed and used under the terms of the GNU GPL.
 */

#ifndef _BIRD_FLOWSPEC_H_
#define _BIRD_FLOWSPEC_H_

#include "nest/bird.h"
#include "lib/buffer.h"
#include "lib/net.h"


/* Flow component operators */
#define FLOW_OP_FALSE		0x00	/* 0b000 */
#define FLOW_OP_EQ		0x01	/* 0b001 */
#define FLOW_OP_GT		0x02	/* 0b010 */
#define FLOW_OP_GEQ		0x03	/* 0b011 */
#define FLOW_OP_LT		0x04	/* 0b100 */
#define FLOW_OP_LEQ		0x05	/* 0b101 */
#define FLOW_OP_NEQ		0x06	/* 0b110 */
#define FLOW_OP_TRUE		0x07	/* 0b111 */

#define FLOW_OP_OR		0x00
#define FLOW_OP_AND		0x40


/* Types of components in flowspec */
enum flow_type {
  FLOW_TYPE_DST_PREFIX 		=  1,
  FLOW_TYPE_SRC_PREFIX 		=  2,
  FLOW_TYPE_IP_PROTOCOL 	=  3,
  FLOW_TYPE_NEXT_HEADER 	=  3,	/* IPv6 */
  FLOW_TYPE_PORT 		=  4,
  FLOW_TYPE_DST_PORT 		=  5,
  FLOW_TYPE_SRC_PORT 		=  6,
  FLOW_TYPE_ICMP_TYPE 		=  7,
  FLOW_TYPE_ICMP_CODE 		=  8,
  FLOW_TYPE_TCP_FLAGS 		=  9,
  FLOW_TYPE_PACKET_LENGTH 	= 10,
  FLOW_TYPE_DSCP 		= 11,	/* DiffServ Code Point */
  FLOW_TYPE_FRAGMENT 		= 12,
  FLOW_TYPE_LABEL 		= 13,	/* IPv6 */
  FLOW_TYPE_MAX
};

const char *flow_type_str(enum flow_type type, int ipv6);


/*
 * 	Length
 */

uint flow_write_length(byte *data, u16 len);

static inline u16 flow_hdr_length(const byte *data)
{ return ((*data & 0xf0) == 0xf0) ? 2 : 1; }

static inline u16 flow_read_length(const byte *data)
{ return ((*data & 0xf0) == 0xf0) ? get_u16(data) & 0x0fff : *data; }

static inline u16 flow4_get_length(const net_addr_flow4 *f)
{ return f->length - sizeof(net_addr_flow4); }

static inline u16 flow6_get_length(const net_addr_flow6 *f)
{ return f->length - sizeof(net_addr_flow6); }

static inline void flow4_set_length(net_addr_flow4 *f, u16 len)
{ f->length = sizeof(net_addr_flow4) + flow_write_length(f->data, len) + len; }

static inline void flow6_set_length(net_addr_flow6 *f, u16 len)
{ f->length = sizeof(net_addr_flow6) + flow_write_length(f->data, len) + len; }


/*
 * 	Iterators
 */

const byte *flow4_first_part(const net_addr_flow4 *f);
const byte *flow6_first_part(const net_addr_flow6 *f);
const byte *flow4_next_part(const byte *pos, const byte *end);
const byte *flow6_next_part(const byte *pos, const byte *end);
const byte *flow4_get_part(const net_addr_flow4 *f, uint type);
const byte *flow6_get_part(const net_addr_flow6 *f, uint type);


/*
 *	Flowspec accessors
 */

ip4_addr flow_read_ip4_part(const byte *part);
ip6_addr flow_read_ip6_part(const byte *part);
static inline int flow_read_pxlen(const byte *part) { return part[1]; }


/*
 * 	Flowspec Builder
 */

/* A data structure for keep a state of flow builder */
struct flow_builder {
  BUFFER_(byte) data;
  enum flow_type this_type;
  enum flow_type last_type;
  u16 last_op_offset;			/* Position of last operator in data.data */
  int ipv6;
  struct {
    u16 offset;				/* Beginning of a component */
    u16 length;				/* Length of a component */
  } parts[FLOW_TYPE_MAX];		/* Indexing all components */
};

struct flow_builder *flow_builder_init(pool *pool);
void flow_builder_clear(struct flow_builder *fb);
void flow_builder_set_type(struct flow_builder *fb, enum flow_type p);
int flow_builder4_add_pfx(struct flow_builder *fb, const net_addr_ip4 *n4);
int flow_builder6_add_pfx(struct flow_builder *fb, const net_addr_ip6 *n6, u32 offset);
int flow_builder_add_op_val(struct flow_builder *fb, byte op, u32 value);
int flow_builder_add_val_mask(struct flow_builder *fb, byte op, u32 value, u32 mask);
net_addr_flow4 *flow_builder4_finalize(struct flow_builder *fb, linpool *lpool);
net_addr_flow6 *flow_builder6_finalize(struct flow_builder *fb, linpool *lpool);


/*
 * 	Validation
 */

/* Results of validation Flow specification */
enum flow_validated_state {
  FLOW_ST_UNKNOWN_COMPONENT,
  FLOW_ST_VALID,
  FLOW_ST_NOT_COMPLETE,
  FLOW_ST_EXCEED_MAX_PREFIX_LENGTH,
  FLOW_ST_EXCEED_MAX_PREFIX_OFFSET,
  FLOW_ST_EXCEED_MAX_VALUE_LENGTH,
  FLOW_ST_BAD_TYPE_ORDER,
  FLOW_ST_AND_BIT_SHOULD_BE_UNSET,
  FLOW_ST_ZERO_BIT_SHOULD_BE_UNSED,
  FLOW_ST_DEST_PREFIX_REQUIRED,
  FLOW_ST_INVALID_TCP_FLAGS,
  FLOW_ST_CANNOT_USE_DONT_FRAGMENT
};

const char *flow_validated_state_str(enum flow_validated_state code);
enum flow_validated_state flow4_validate(const byte *nlri, uint len);
enum flow_validated_state flow6_validate(const byte *nlri, uint len);
void flow_check_cf_value_length(struct flow_builder *fb, u32 expr);
void flow_check_cf_bmk_values(struct flow_builder *fb, u8 neg, u32 val, u32 mask);
void flow4_validate_cf(net_addr_flow4 *f);
void flow6_validate_cf(net_addr_flow6 *f);


/*
 * 	Net Formatting
 */

uint flow4_net_format(char *buf, uint blen, const net_addr_flow4 *f);
uint flow6_net_format(char *buf, uint blen, const net_addr_flow6 *f);

#endif /* _BIRD_FLOWSPEC_H_ */
Commit	Line	Data
77234bbb	1	/*
deec84ca	2	* BIRD Library -- Flow specification (RFC 8955)
77234bbb OZ	3	*
	4	* (c) 2016 CZ.NIC z.s.p.o.
	5	*
	6	* Can be freely distributed and used under the terms of the GNU GPL.
	7	*/
	8
	9	#ifndef _BIRD_FLOWSPEC_H_
	10	#define _BIRD_FLOWSPEC_H_
	11
	12	#include "nest/bird.h"
	13	#include "lib/buffer.h"
	14	#include "lib/net.h"
	15
	16
734e9fb8	17	/* Flow component operators */
d114959e	18	#define FLOW_OP_FALSE 0x00 /* 0b000 */
734e9fb8 OZ	19	#define FLOW_OP_EQ 0x01 /* 0b001 */
	20	#define FLOW_OP_GT 0x02 /* 0b010 */
	21	#define FLOW_OP_GEQ 0x03 /* 0b011 */
	22	#define FLOW_OP_LT 0x04 /* 0b100 */
	23	#define FLOW_OP_LEQ 0x05 /* 0b101 */
	24	#define FLOW_OP_NEQ 0x06 /* 0b110 */
d114959e	25	#define FLOW_OP_TRUE 0x07 /* 0b111 */
734e9fb8 OZ	26
	27	#define FLOW_OP_OR 0x00
	28	#define FLOW_OP_AND 0x40
	29
	30
77234bbb OZ	31	/* Types of components in flowspec */
	32	enum flow_type {
	33	FLOW_TYPE_DST_PREFIX = 1,
	34	FLOW_TYPE_SRC_PREFIX = 2,
	35	FLOW_TYPE_IP_PROTOCOL = 3,
	36	FLOW_TYPE_NEXT_HEADER = 3, /* IPv6 */
	37	FLOW_TYPE_PORT = 4,
	38	FLOW_TYPE_DST_PORT = 5,
	39	FLOW_TYPE_SRC_PORT = 6,
	40	FLOW_TYPE_ICMP_TYPE = 7,
	41	FLOW_TYPE_ICMP_CODE = 8,
	42	FLOW_TYPE_TCP_FLAGS = 9,
	43	FLOW_TYPE_PACKET_LENGTH = 10,
	44	FLOW_TYPE_DSCP = 11, /* DiffServ Code Point */
	45	FLOW_TYPE_FRAGMENT = 12,
	46	FLOW_TYPE_LABEL = 13, /* IPv6 */
	47	FLOW_TYPE_MAX
	48	};
	49
	50	const char *flow_type_str(enum flow_type type, int ipv6);
	51
	52
	53	/*
	54	* Length
	55	*/
	56
	57	uint flow_write_length(byte *data, u16 len);
	58
ac3ad139 OZ	59	static inline u16 flow_hdr_length(const byte *data)
	60	{ return ((*data & 0xf0) == 0xf0) ? 2 : 1; }
	61
77234bbb OZ	62	static inline u16 flow_read_length(const byte *data)
	63	{ return ((data & 0xf0) == 0xf0) ? get_u16(data) & 0x0fff : data; }
	64
	65	static inline u16 flow4_get_length(const net_addr_flow4 *f)
	66	{ return f->length - sizeof(net_addr_flow4); }
	67
	68	static inline u16 flow6_get_length(const net_addr_flow6 *f)
	69	{ return f->length - sizeof(net_addr_flow6); }
	70
	71	static inline void flow4_set_length(net_addr_flow4 *f, u16 len)
	72	{ f->length = sizeof(net_addr_flow4) + flow_write_length(f->data, len) + len; }
	73
	74	static inline void flow6_set_length(net_addr_flow6 *f, u16 len)
	75	{ f->length = sizeof(net_addr_flow6) + flow_write_length(f->data, len) + len; }
	76
	77
	78	/*
	79	* Iterators
	80	*/
	81
	82	const byte flow4_first_part(const net_addr_flow4 f);
	83	const byte flow6_first_part(const net_addr_flow6 f);
	84	const byte flow4_next_part(const byte pos, const byte *end);
	85	const byte flow6_next_part(const byte pos, const byte *end);
ff2ca10c OZ	86	const byte flow4_get_part(const net_addr_flow4 f, uint type);
ff2ca10c OZ	87	const byte flow6_get_part(const net_addr_flow6 f, uint type);
77234bbb OZ	88
77234bbb OZ	89
0f882002 OZ	90	/*
	91	* Flowspec accessors
	92	*/
	93
	94	ip4_addr flow_read_ip4_part(const byte *part);
	95	ip6_addr flow_read_ip6_part(const byte *part);
ff2ca10c	96	static inline int flow_read_pxlen(const byte *part) { return part[1]; }
0f882002 OZ	97
0f882002 OZ	98
77234bbb OZ	99	/*
	100	* Flowspec Builder
	101	*/
	102
	103	/* A data structure for keep a state of flow builder */
	104	struct flow_builder {
a32a7b58	105	BUFFER_(byte) data;
77234bbb OZ	106	enum flow_type this_type;
	107	enum flow_type last_type;
	108	u16 last_op_offset; /* Position of last operator in data.data */
	109	int ipv6;
	110	struct {
	111	u16 offset; /* Beginning of a component */
	112	u16 length; /* Length of a component */
	113	} parts[FLOW_TYPE_MAX]; /* Indexing all components */
	114	};
	115
	116	struct flow_builder flow_builder_init(pool pool);
	117	void flow_builder_clear(struct flow_builder *fb);
	118	void flow_builder_set_type(struct flow_builder *fb, enum flow_type p);
	119	int flow_builder4_add_pfx(struct flow_builder fb, const net_addr_ip4 n4);
	120	int flow_builder6_add_pfx(struct flow_builder fb, const net_addr_ip6 n6, u32 offset);
	121	int flow_builder_add_op_val(struct flow_builder *fb, byte op, u32 value);
	122	int flow_builder_add_val_mask(struct flow_builder *fb, byte op, u32 value, u32 mask);
	123	net_addr_flow4 flow_builder4_finalize(struct flow_builder fb, linpool *lpool);
	124	net_addr_flow6 flow_builder6_finalize(struct flow_builder fb, linpool *lpool);
	125
	126
	127	/*
	128	* Validation
	129	*/
	130
	131	/* Results of validation Flow specification */
	132	enum flow_validated_state {
	133	FLOW_ST_UNKNOWN_COMPONENT,
	134	FLOW_ST_VALID,
	135	FLOW_ST_NOT_COMPLETE,
	136	FLOW_ST_EXCEED_MAX_PREFIX_LENGTH,
	137	FLOW_ST_EXCEED_MAX_PREFIX_OFFSET,
	138	FLOW_ST_EXCEED_MAX_VALUE_LENGTH,
	139	FLOW_ST_BAD_TYPE_ORDER,
	140	FLOW_ST_AND_BIT_SHOULD_BE_UNSET,
	141	FLOW_ST_ZERO_BIT_SHOULD_BE_UNSED,
	142	FLOW_ST_DEST_PREFIX_REQUIRED,
5ca4bd5d	143	FLOW_ST_INVALID_TCP_FLAGS,
77234bbb OZ	144	FLOW_ST_CANNOT_USE_DONT_FRAGMENT
	145	};
	146
	147	const char *flow_validated_state_str(enum flow_validated_state code);
	148	enum flow_validated_state flow4_validate(const byte *nlri, uint len);
	149	enum flow_validated_state flow6_validate(const byte *nlri, uint len);
	150	void flow_check_cf_value_length(struct flow_builder *fb, u32 expr);
	151	void flow_check_cf_bmk_values(struct flow_builder *fb, u8 neg, u32 val, u32 mask);
	152	void flow4_validate_cf(net_addr_flow4 *f);
	153	void flow6_validate_cf(net_addr_flow6 *f);
	154
	155
	156	/*
	157	* Net Formatting
	158	*/
	159
eeba61cc OZ	160	uint flow4_net_format(char buf, uint blen, const net_addr_flow4 f);
eeba61cc OZ	161	uint flow6_net_format(char buf, uint blen, const net_addr_flow6 f);
77234bbb OZ	162
77234bbb OZ	163	#endif /* _BIRD_FLOWSPEC_H_ */