以太网编程实践(Python语言)

注解

Python 目前有两个主流版本,我们以 Python 3 为准。

本节的目标是,实现一个 Python 程序 send_ether.py ,用于通过网卡发送以太网数据帧。 我们将从最基础的知识开始,一步步朝着目标努力。

send_ether 在前面章节已经用过,并不陌生,基本用法如:表格-1。

表格-1 命令行选项
选项 含义
-i –iface 发送网卡名
-t –to 目的MAC地址
-T –type 类型
-d –data 待发送数据

下面是一个命令行执行实例:

$ python send_ether.py -i enp0s8 -t 0a:00:27:00:00:00 -T 0x1024 -d "Hello, world!"

处理命令行参数

我们要解决的第一问题是,如何获取命令行选项。 在 Python 中,命令行参数可以通过 sys 模块 argv 属性获取:

import sys
sys.argv

以上述命令为例, argv 列表等价于:

[
    "send_ether.py",
    "-i",
    "enp0s8",
    "-t",
    "0a:00:27:00:00:00",
    "-T",
    "0x1024",
    "-d",
    "Hello, world!",
]

你可以遍历这个列表,各种判断 -i-t ,获取想要的参数值。

不过,更优雅的方式是使用标准库 argparse 。 以上述命令为例, argparse 用法如下:

parse_arguments()
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
def parse_arguments():
    '''
        Parse command line arguments.

        Arguments

        Returns
            An argparse.Namespace is return, in which command options and
            arguments are stored.
    '''

    # parser for command line arguments
    parser = ArgumentParser(description='Send ethernet frame.')

    # Argument: name of iface for sending
    parser.add_argument(
        '-i',
        '--iface',
        dest='iface',
        required=True,
    )
    # Argument: destination MAC address
    parser.add_argument(
        '-t',
        '--to',
        dest='to',
        required=True,
    )
    # Argument: data to send
    parser.add_argument(
        '-d',
        '--data',
        dest='data',
        default='a' * 46,
        required=False,
    )
    # Argument: protocol type
    parser.add_argument(
        '-T',
        '--type',
        dest='_type',
        default='0x0900',
        required=False,
    )

    # parse arguments
    args = parser.parse_args()

    return args

如上,我们定义了一个函数 parse_arguments ,来解析命令行参数。 parse_arguments 依赖标准库 argparse ,处理步骤如下:

  1. 实例化一个解析器对象( 3 行);
  2. 登记命令行选项配置( 5 - 34 行);
  3. 调用 parse_args 方法解析命令行参数( 37 行);
  4. 返回结果;

以太网帧

接下来,重温 以太网帧 ,看到下图应该不难回忆:

../_images/97c13f044de260baf0ed8051091dd251.png

以太网帧:目的地址、源地址、类型、数据、校验和

从数学的角度,重新审视以太网帧结构: 每个字段有固定或不固定的 长度 ,单位为字节。 字段开头与帧开头之间的距离称为 偏移量 ,第一个字段偏移量是 0 , 后一个字段偏移量是前一个字段偏移量加长度,依次类推。

各字段 长度 以及 偏移量 列举如下:

表格-3 以太网帧字段长度及偏移量
字段 长度(字节) 偏移量(字节)
目的地址 6 0
源地址 6 6
类型 2 12
数据 46-1500 14

struct 语言,数据帧头部可以表示为: !6s6sH 。 其中, ! 表示 网络 字节序 ,即 大端6s 表示一个 6 字节长的字段; H 表示一个 2 字节整数,即 short

转换MAC地址

二进制

MAC 地址为 6 字节长,在 Python 中,用 bytes 类型表示:

>>> n = b'\x08\x00\x27\xc8\x04\x83'
>>> n
b"\x08\x00'\xc8\x04\x83"

注意到,第三个字节为 0x27 ,在 ASCII 表中表示 ' ,是可读的。

冒分十六进制

ASCII 表只定义了字节中的 7 位,低于 127 部分, 而且其中有相当部分是不可读的(或者说不可显示的)。 因此,不能直接使用 ASCII 显示 MAC 地址。

尽管如此,还是可以用多个可读字符表示一个原始字节,思想与 Base64 类似。 使用 2 个十六进制字符就可表示一个原始字节,为了可读性,字节间用冒号 : 分隔。 这就是 冒分十六进制

>>> s = '08:00:27:c8:04:83'
>>> s
'08:00:27:c8:04:83'

mac_ntoa

将二进制转换成可读形式比较简单,定义一个格式化传即可:

mac_ntoa(n)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
def mac_ntoa(n):
    '''
        Convert binary MAC address to readable format.

        Arguments
            n: binary format, must be bytes type of size 6.

        Returns
            A str type which is the readable format, like '08:00:27:c8:04:83'.
    '''

    return '%02x:%02x:%02x:%02x:%02x:%02x' % tuple(n)

mac_aton

将冒分十六进制形式中的冒号去除之后,得到的是 6 个原始字节的 Base16 形式:

>>> '61:62:63:64:65:00'.replace(':', '')
'616263646500'

接下来使用 Base16 解码便可得到二进制形式的 MAC 地址:

mac_aton(a)
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
def mac_aton(a):
    '''
        Convert readable MAC address to binary format.

        Arguments
            a: readable format, str type of Colon-Separated Hexadecimal.

        Returns
            A bytes type of size 6, which is the binary format.
    '''

    return base64.b16decode(a.upper().replace(':', ''))

获取网卡地址

发送以太网帧,我们需要 目的地址源地址类型 以及 数据目的地址 以及 数据 分别由命令行参数 -t 以及 -d 指定。 那么, 源地址 从哪来呢?

别急, -i 参数不是指定发送网卡名吗?——发送网卡物理地址就是 源地址 ! 现在的问题是,如何获取网卡物理地址?

Linux 下可以通过 ioctl 系统调用获取网络设备信息,request 类型是 SIOCGIFHWADDR 。 下面,写一个程序 show_mac.py ,演示查询网卡物理地址的方法。 show_mac.py 需要接收一个参数,以指定待查询网卡名:

$ python show_mac.py enp0s8
IFace: enp0s8
MAC: 08:00:27:c8:04:83

show_mac.py 程序源码如下:

/_src/python/ethernet/show_mac.py
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
#!/usr/bin/env python
# -*- encoding=utf8 -*-

'''
FileName:   show_mac.py
Author:     Fasion Chan
@contact:   fasionchan@gmail.com
@version:   $Id$

Description:

Changelog:

'''

import base64
import struct
import sys

from fcntl import (
    ioctl,
)
from socket import (
    AF_INET,
    SOCK_DGRAM,
    socket,
)


def mac_ntoa(n):
    '''
        Convert binary MAC address to readable format.

        Arguments
            n: binary format, must be bytes type of size 6.

        Returns
            A str type which is the readable format, like '08:00:27:c8:04:83'.
    '''

    return '%02x:%02x:%02x:%02x:%02x:%02x' % tuple(n)


def fetch_iface_mac(iface, s=None):
    '''
        Fetch MAC address of given iface.

        Arguments
            iface: iface name, str type.

        Returns
            A bytes type of size 6, which is the MAC address in binary format.
    '''

    # create socket if not given, any type is ok
    if not s:
        s = socket(AF_INET, SOCK_DGRAM)

    # pack iface name to struct ifreq
    iface_buf = struct.pack('64s', iface.encode('utf8'))

    # call ioctl to get hardware address
    # according to C header file, SIOCGIFHWADDR is 0x8927
    mac = ioctl(s.fileno(), 0x8927, iface_buf)[18:24]

    return mac


def main():
    # name of iface
    iface = sys.argv[1]

    # Fetch mac address
    mac = fetch_iface_mac(iface)

    # output result
    print('iFace: {iface}'.format(iface=iface))
    print('MAC: {mac}'.format(mac=mac_ntoa(mac)))


if __name__ == '__main__':
    main()

程序入口 main 函数先从 sys.argv 列表中取出参数:待查网卡名; 然后调用 fetch_iface_mac 函数获取网卡物理地址; 最后输出结果。

fetch_iface_mac 接收两个参数:①待查网卡名 iface ;②套接字 s 。 传递套接字的目的是,复用现有套接字,避免套接字创建及销毁的开销。 如无可用套接字,函数负责创建。

fetch_iface_mac 函数执行步骤如下:

  1. 检查套接字,必要时创建( 56 - 57 行);
  2. 使用 struct 模块构造二进制结构体 struct ifreq ,填充网卡名( 60 行);
  3. 调动 ioctl 系统调用获取 MAC 地址( 64 行);

警告

fetch_iface_mac 函数依赖垃圾回收机制销毁套接字。 因此,存在这样的可能性:套接字在垃圾回收触发前就耗尽了。

更严谨的做法是,显示调用s.close关闭套接字。 这样一来,虽然内存回收仍然依赖垃圾回收机制, 但套接字文件描述符已经及时关闭,降低耗尽风险。

发送以太网帧

Linux 下,发送以太网帧,需要使用原始套接字。 接下来我们看看发送代码:

/python/ethernet/send_ether.py
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
def send_ether(iface, to, _type, data, s=None):
    '''
        Send data through ethernet protocol, using raw socket.

        Arguments
            iface: name of iface for sending, str type.

            to: destination MAC addres, str type for readable or
                bytes type for binary.

            _type: protocol type, int type.

            data: data to send, str type or bytes type.
    '''

    # if destination address is readable format, convert first
    if isinstance(to, str):
        to = mac_aton(to)

    # if data is str type, encode it first
    if isinstance(data, str):
        data = data.encode('utf8')

    # create raw socket if not given
    if s is None:
        s = socket(AF_PACKET, SOCK_RAW)

    # bind to the sending iface
    s.bind((iface, 0))

    # get MAC address of sending iface, which is the source address
    fr = fetch_iface_mac(iface, s)

    # pack ethernet header
    header = struct.pack('!6s6sH', to, fr, _type)
    # pack ethernet frame
    frame = header + data

    # send the ethernet frame
    s.send(frame)

函数总共接收 5 个参数:发送网卡名 iface ;目的地址 to ; 类型 _type ; 待发送数据 data ;以及套接字 s

函数执行步骤如下:

  1. 检查目的 MAC 地址,必要时转换( 17 - 18 行);
  2. 检查待发送数据,确保是 bytes 类型( 21 - 22 行);
  3. 检查套接字,必要时创建( 25 - 26 行);
  4. 套接字绑定发送网卡( 29 行);
  5. 查询发送网卡 MAC 地址,也就是数据帧的源地址( 32 行);
  6. 封装数据帧,包括头部和数据两部分( 35 - 37 行);
  7. 发送数据帧( 40 行);

整个程序代码有点长,就不在这里贴了,请在 GitHub 上查看: python/ethernet/send_ether.py

总结

本节,我们从 处理命令行参数 开始, 重温 以太网帧 , 学习如何 转换MAC地址 以及如何 获取网卡地址 , 一步步实现终极目标: 发送以太网帧

下一步

本节以 Python 语言为例,演示了以太网编程方法。 如果你对其他语言感兴趣,请按需取用:

订阅更新,获取更多学习资料,请关注我们的 微信公众号

../_images/wechat-mp-qrcode.png

小菜学编程