udhcp源码详解(四) 之DHCP包--options字段
Created : 2010-10-25
中间有很长一段时间没有更新udhcp源码详解的博客,主要是源码里的函数太多,不知道要不要一个一个讲下去,要知道讲DHCP的实现理论的话一篇博文也就可以大致的讲完,但实现的源码却要关心很多的问题,比如说,理论上说从IP地址池取到一个空闲的IP,就这么一句,在源码的体现也是一大段。算啦,讲多少算多少吧,进入主题!
struct dhcpMessage报文里uint8_t options[308]字段,在整个DHCP过程中是报文的一个很重要的字段,博文的系列(二)有讲解该字段的数据组织方式,CLV(Code + Len + Value),现在来讲解下怎么把选项信息添加进该字段,以及怎么从该字段取到相应的选项信息。
options字段存储三类数据:
a). DHCP_PADDING 填充字节, 没有任何意义,填充 0x00
b). DHCP_END potions字段结束的标志 0xFF
c). 选项信息<CLV> 对于DHCP过程真正有价值的信息,承载了选项数据(V)
对于选options字段的操作主要就是read/write value:
1、根据选项信息的CODE从option字段取出选项信息.
- /*
- * 参数struct dhcpMessage *packet DHCP报文
- * int code需要获得什么选项信息(选项信息的标识)
- *
- * 返回指向选项信息的指针(去除了 OPT_CODE,OPT_LEN)
- * 未找到返回NULL
- */
- uint8_t *get_option(struct dhcpMessage *packet, int code)
- {
- int i, length;
- uint8_t *optionptr;
- int over = 0, done = 0, curr = OPTION_FIELD;
- optionptr = packet->options;
- i = 0;
- length = 308; /* 整个options字段的长度308 */
- /* 在options字段里查找code选项标识信息*/
- while (!done) {
- if (i >= length) { /* 查找完所有字段都未找到code标识的信息,返回NULL */
- LOG(LOG_WARNING, "bogus packet, option fields too long.");
- return NULL;
- }
- //CLV方式存储数据
- //这里与struct option_set的data存储相似
- //OPT_CODE字节上存储code标识
- //OPT_LEN 字节上存储信息长度
- //OPT_LEN后就是存储信息
- if (optionptr[i + OPT_CODE] == code) { //Found
- if (i + 1 + optionptr[i + OPT_LEN] >= length) { //检查选项信息长度
- LOG(LOG_WARNING, "bogus packet, option fields too long.");
- return NULL;
- }
- return optionptr + i + 2; //Found,返回选项信息的首地址
- }
- switch (optionptr[i + OPT_CODE]) {
- case DHCP_PADDING: //DHCP_PADING(填充)字节,直接 i++;
- i++;
- break;
- case DHCP_OPTION_OVER: //选项过载DHCP_OPTION_OVER
- if (i + 1 + optionptr[i + OPT_LEN] >= length) {
- LOG(LOG_WARNING, "bogus packet, option fields too long.");
- return NULL;
- }
- /*
- optionptr[i + OPT_CODE] == DHCP_OPTION_OVER选项过载;
- optionptr[i + 3]存放了采用哪个字段来存储过载的选项
- 可能存储过载选项的字段:
- uint8_t sname[64]; //server host name (ASCIZ)
- uint8_t file[128]; // boot file name (ASCIZ)
- over = optionptr[i + 3];记录下使用那个字段存储过载选项
- */
- /*
- *
- The code for this option is 52, and its length is 1. Legal values
- for this option are:
- Value Meaning
- ----- --------
- 1 the 'file' field is used to hold options
- 2 the 'sname' field is used to hold options
- 3 both fields are used to hold options
- Code Len Value
- +-----+-----+-----+
- | 52 | 1 |1/2/3|
- +-----+-----+-----+
- */
- over = optionptr[i + OPT_DATA];
- i += optionptr[i + OPT_LEN] + 2;
- // over = optionptr[i + 3]; /* Error */
- // i += optionptr[OPT_LEN] + 2; /* Error */
- break;
- case DHCP_END: //选项字段结束标志 DHCP_END 0xff
- /*
- * 当选项过载的时候(curr == OPTION_FILE允许选项过载)
- * 首先用file字段,不够的话再用sname字段
- * 使用file字段的时候:
- * over的右起的第0位必须为1
- * 使用sname字段:
- * over的右起的第一位必须为1
- */
- if (curr == OPTION_FIELD && over & FILE_FIELD) {
- optionptr = packet->file;
- i = 0;
- length = 128;
- curr = FILE_FIELD;
- } else if (curr == FILE_FIELD && over & SNAME_FIELD) {
- optionptr = packet->sname;
- i = 0;
- length = 64;
- curr = SNAME_FIELD;
- //没有或不允许选项过载或over(options[i + 3])标志不允许,结束查找返回NULL
- } else done = 1;
- break;
- /*
- * 不是填充信息:DHCP_PADDING
- * 选项过载:DHCP_OPTION_OVER
- * 选项结束:DHCP_END
- *
- * 表明是属于选项信息,所以可以直接改变偏移量:
- * i += option[OPT_LEN + i] + 2;
- */
- default:
- i += optionptr[OPT_LEN + i] + 2;
- }
- }
- return NULL;
- }
在源码busybox 1.2的udhcp源码中,对于从options字段取出选项信息,在对选项过载的处理是存在错误的,
- case DHCP_OPTION_OVER: //选项过载DHCP_OPTION_OVER
- if (i + 1 + optionptr[i + OPT_LEN] >= length) {
- LOG(LOG_WARNING, "bogus packet, option fields too long.");
- return NULL;
- }
- /*
- * Code Len Value
- * +-----+-----+-----+
- * | 52 | 1 |1/2/3|
- * +-----+-----+-----+
- */
- over = optionptr[i + OPT_DATA];
- i += optionptr[i + OPT_LEN] + 2;
- // over = optionptr[i + 3]; /* 未改动源码 */
- // i += optionptr[OPT_LEN] + 2; /* 未改动源码 */
- break;
2、向options字段写入选项信息
a). 写入是添加在options字段中最后的选项后面,即DHCP_END标志之前
查找DHCP_END标志字段:
- /* return the position of the 'end' option (no bounds checking) */
- int end_option(uint8_t *optionptr)
- {
- int i = 0;
- /* 在选项字段里找到DHCP_END的偏移 */
- /* 在选项字段里面里三类信息:
- 1.DHCP_PADDING 填充字节
- 2.DHCP_END 选项结束字节
- 3.选项信息<CLV> code + length + value
- */
- while (optionptr[i] != DHCP_END) {
- if (optionptr[i] == DHCP_PADDING) i++; //填充字节DHCP_PADDING
- else i += optionptr[i + OPT_LEN] + 2; //选项信息
- }
- return i;
- }
b). 选项信息已经在一个字符串里以CLV方式组织好,直接copy到DHCP_END标志位置,DHCP_END向后移动:
- /* add an option string to the options (an option string contains an option code,
- * length, then data) */
- int add_option_string(uint8_t *optionptr, uint8_t *string)
- {
- int end = end_option(optionptr);//找到DHCP_END在选项字段里偏移
- /* end position + string length + option code/length + end option */
- //检查需要添加的选项信息后的长度是否大于选项字段的最大长度
- if (end + string[OPT_LEN] + 2 + 1 >= 308) {
- LOG(LOG_ERR,"Option 0x%02x did not fit into packet!",string[OPT_CODE]);
- return 0;
- }
- DEBUG(LOG_INFO, "adding option 0x%02x", string[OPT_CODE]);
- memcpy(optionptr + end, string, string[OPT_LEN] + 2);
- optionptr[end + string[OPT_LEN] + 2] = DHCP_END;//在<CLV>的最后添加上DHCP_END
- return string[OPT_LEN] + 2; //返回<CLV>长度
- }
c). 把选项信息按CLV的方式组织好存放到一个字符串里,最后调用add_option_string把在字符串内组织好的选项信息添加进options字段:
- /* add a one to four byte option to a packet */
- /* add_simple_option函数只能想选项字段添加OPT_LEN = 4 bytes的选项 */
- /* optionptr: 报文选项字段的首地址
- code: 选项code
- data: 选项value
- 返回值是 <CLV>的长度
- 返回0 表示添加失败
- */
- int add_simple_option(uint8_t *optionptr, uint8_t code, uint32_t data)
- {
- struct dhcp_option *dh;
- /* 检查需要添加的选项是否符合标准的选项 */
- /* 在dhcp_options数组里查找 */
- for (dh=dhcp_options; dh->code; dh++) {
- if (dh->code == code) { //Found
- uint8_t option[6], len;
- option[OPT_CODE] = code; //添加code
- len = option_lengths[dh->flags & TYPE_MASK];//计算length
- option[OPT_LEN] = len; //添加length
- /*
- * 假设data长度是一个字节,但在大端字节序的机器里
- * 但存放在uint32_t里的放在最高地址的地方,
- * 所以data << 8 * (4 - len) 把她移到低位
- */
- if (BB_BIG_ENDIAN) data <<= 8 * (4 - len);
- /* This memcpy is for broken processors which can't
- * handle a simple unaligned 32-bit assignment */
- memcpy(&option[OPT_DATA], &data, 4);
- return add_option_string(optionptr, option);
- }
- }
- DEBUG(LOG_ERR, "Could not add option 0x%02x", code);
- return 0;
- }