#embedded/wifi
Xu 0.13.1 API
导入方式: #embedded/wifi
公开 API: 13 函数, 4 方法, 6 类型, 13 常量, 0 方法集
协议基础组件与设备职责
本包提供有界信标解析、AP 选择、关联及受限的 PSK/CCMP pairwise 握手。它负责构造协议消息、验证接收字节;控制器事件循环、密钥安装、重放计数器和报文所有权由应用维护。解析 DMA 数据前须确认硬件完成状态与 RX 状态。
key_data 负责包装密钥数据验证,ccmp 处理认证保护帧,ipv4 提供 DHCP/ARP/ICMP 获取探针。标准 WifiDevice 操作仍返回未接入;持久站点服务、租约续期、DNS/TCP、WPA3/PMF 与 BLE/Wi-Fi 共存仍需后续实现。
struct Beacon
pub struct Beacon {
pub valid bool
pub ssid []int
pub bssid []int
pub channel int
pub interval_tu int
pub privacy bool
}
用途
承载 valid、ssid、bssid、channel、interval_tu 等属性的结构体。
公开字段
valid bool- 字段(bool)
ssid []int- 字段([]int)
bssid []int- 字段([]int)
channel int- 字段(int)
interval_tu int- 字段(int)
privacy bool- 字段(bool)
beacon_parse_bytes
pub fn beacon_parse_bytes(frame &string) Beacon
用途
执行 beacon parse bytes 操作。
参数
frame &string- frame(只读借用,调用方仍持有原值;类型 &string)
返回值
Beacon — 该类型的值
beacon_parse
pub fn beacon_parse(frame &[]int) Beacon
用途
执行 beacon parse 操作。
参数
frame &[]int- frame(只读借用,调用方仍持有原值;类型 &[]int)
返回值
Beacon — 该类型的值
const STA_IDLE
用途
常量 STA_IDLE,定义了相关的协议或算法配置参数。
const STA_READY
用途
常量 STA_READY,定义了相关的协议或算法配置参数。
const STA_AUTH_WAIT
pub const STA_AUTH_WAIT = 2
用途
常量 STA_AUTH_WAIT,定义了相关的协议或算法配置参数。
const STA_AUTHENTICATED
pub const STA_AUTHENTICATED = 3
用途
常量 STA_AUTHENTICATED,定义了相关的协议或算法配置参数。
const STA_ASSOC_WAIT
pub const STA_ASSOC_WAIT = 4
用途
常量 STA_ASSOC_WAIT,定义了相关的协议或算法配置参数。
const STA_ASSOCIATED
pub const STA_ASSOCIATED = 5
用途
常量 STA_ASSOCIATED,定义了相关的协议或算法配置参数。
const STA_REJECTED
pub const STA_REJECTED = 6
用途
常量 STA_REJECTED,定义了相关的协议或算法配置参数。
const STA_SECURITY_OPEN
pub const STA_SECURITY_OPEN = 0
用途
常量 STA_SECURITY_OPEN,定义了相关的协议或算法配置参数。
const STA_SECURITY_WPA2_PSK_CCMP
pub const STA_SECURITY_WPA2_PSK_CCMP = 2
用途
常量 STA_SECURITY_WPA2_PSK_CCMP,定义了相关的协议或算法配置参数。
struct StationAp
pub struct StationAp {
pub valid bool
pub ssid string
pub bssid string
pub channel int
pub capability int
pub rates []int // common legacy rates in units of 500kb/s; bit7 = basic
pub security int
pub rsn string // selected association-request RSN IE, including ID/length
}
用途
承载 valid、ssid、bssid、channel、capability 等属性的结构体。
公开字段
valid bool- 字段(bool)
ssid string- 字段(string)
bssid string- 字段(string)
channel int- 字段(int)
capability int- 字段(int)
rates []int // common legacy rates in units of 500kb/s; bit7 = basic- 字段([]int // common legacy rates in units of 500kb/s; bit7 = basic)
security int- 字段(int)
rsn string // selected association-request RSN IE, including ID/length- 字段(string // selected association-request RSN IE, including ID/length)
struct Station
pub struct Station {
pub state int
pub mac string
pub ap StationAp
pub sequence int // our management sequence counter, modulo 4096
pub status_code int // last matched authentication/association status
pub aid int // set only after a successful matched association response
}
用途
承载 state、mac、ap、sequence、status_code 等属性的结构体。
公开字段
state int- 字段(int)
mac string- 字段(string)
ap StationAp- 字段(StationAp)
sequence int // our management sequence counter, modulo 4096- 字段(int // our management sequence counter, modulo 4096)
status_code int // last matched authentication/association status- 字段(int // last matched authentication/association status)
aid int // set only after a successful matched association response- 字段(int // set only after a successful matched association response)
station_ap_from_beacon
pub fn station_ap_from_beacon(frame &string, rx_channel int) StationAp
用途
执行 station ap from beacon 操作。
参数
frame &string- frame(只读借用,调用方仍持有原值;类型 &string)
rx_channel int- rx_channel(int)
返回值
StationAp — 该类型的值
station_create
pub fn station_create(mac string, ap StationAp) Station
用途
创建station。
参数
mac string- mac(string)
ap StationAp- ap(StationAp)
返回值
Station — 该类型的值
($&Station) authentication_request
pub fn (sta $&Station) authentication_request() string
用途
$&Station 上的操作:执行 authentication request 操作。
参数
sta $&Station- 本次调用使用的
Station 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
返回值
string — 结果字符串
($&Station) association_request
pub fn (sta $&Station) association_request() string
用途
$&Station 上的操作:执行 association request 操作。
参数
sta $&Station- 本次调用使用的
Station 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
返回值
string — 结果字符串
($&Station) receive_management
pub fn (sta $&Station) receive_management(frame &string) bool
用途
$&Station 上的操作:执行 receive management 操作。
参数
sta $&Station- 本次调用使用的
Station 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
frame &string- frame(只读借用,调用方仍持有原值;类型 &string)
返回值
bool — 是否成立
($&Station) reset_management
pub fn (sta $&Station) reset_management()
用途
$&Station 上的操作:执行 reset management 操作。
参数
sta $&Station- 本次调用使用的
Station 实例;以独占借用传入,方法可修改它,调用方仍持有实例。
返回值
不返回值。
station_ap_from_probe_response
pub fn station_ap_from_probe_response(frame &string, rx_channel int, receiver &string) StationAp
用途
执行 station ap from probe response 操作。
参数
frame &string- frame(只读借用,调用方仍持有原值;类型 &string)
rx_channel int- rx_channel(int)
receiver &string- receiver(只读借用,调用方仍持有原值;类型 &string)
返回值
StationAp — 该类型的值
const WPA2_WAIT_M1
pub const WPA2_WAIT_M1 = 1
用途
常量 WPA2_WAIT_M1,定义了相关的协议或算法配置参数。
const WPA2_WAIT_M3
pub const WPA2_WAIT_M3 = 2
用途
常量 WPA2_WAIT_M3,定义了相关的协议或算法配置参数。
const WPA2_KEY_DATA_PENDING
pub const WPA2_KEY_DATA_PENDING = 3
用途
常量 WPA2_KEY_DATA_PENDING,定义了相关的协议或算法配置参数。
const WPA2_M4_READY
pub const WPA2_M4_READY = 4
用途
常量 WPA2_M4_READY,定义了相关的协议或算法配置参数。
wpa2_hmac_sha1
pub fn wpa2_hmac_sha1(key &string, data &string) string
用途
执行 wpa2 hmac sha1 操作。
参数
key &string- 键(只读借用,调用方仍持有原值;类型 &string)
data &string- 数据(只读借用,调用方仍持有原值;类型 &string)
返回值
string — 结果字符串
wpa2_pmk
pub fn wpa2_pmk(passphrase &string, ssid &string) string
用途
执行 wpa2 pmk 操作。
参数
passphrase &string- passphrase(只读借用,调用方仍持有原值;类型 &string)
ssid &string- ssid(只读借用,调用方仍持有原值;类型 &string)
返回值
string — 结果字符串
wpa2_ptk
pub fn wpa2_ptk(pmk &string, aa &string, spa &string, anonce &string, snonce &string) string
用途
执行 wpa2 ptk 操作。
参数
pmk &string- pmk(只读借用,调用方仍持有原值;类型 &string)
aa &string- aa(只读借用,调用方仍持有原值;类型 &string)
spa &string- spa(只读借用,调用方仍持有原值;类型 &string)
anonce &string- anonce(只读借用,调用方仍持有原值;类型 &string)
snonce &string- snonce(只读借用,调用方仍持有原值;类型 &string)
返回值
string — 结果字符串
struct Wpa2Key
pub struct Wpa2Key {
pub valid bool
pub version int
pub info int
pub key_length int
pub replay string
pub nonce string
pub mic string
pub key_data string
}
用途
承载 valid、version、info、key_length、replay 等属性的结构体。
公开字段
valid bool- 字段(bool)
version int- 字段(int)
info int- 字段(int)
key_length int- 字段(int)
replay string- 字段(string)
nonce string- 字段(string)
mic string- 字段(string)
key_data string- 字段(string)
wpa2_key_parse
pub fn wpa2_key_parse(frame &string) Wpa2Key
用途
wpa2键解析。
参数
frame &string- frame(只读借用,调用方仍持有原值;类型 &string)
返回值
Wpa2Key — 该类型的值
struct Wpa2Handshake
pub struct Wpa2Handshake {
pub valid bool
pub phase int
}
用途
承载 valid、phase 等属性的结构体。
公开字段
valid bool- 字段(bool)
phase int- 字段(int)
struct Wpa2Step
pub struct Wpa2Step {
pub valid bool
pub transmit string
pub validate_key_data bool
pub key_data string
pub kek string
pub tk string
}
用途
承载 valid、transmit、validate_key_data、key_data、kek 等属性的结构体。
公开字段
valid bool- 字段(bool)
transmit string- 字段(string)
validate_key_data bool- 字段(bool)
key_data string- 字段(string)
kek string- 字段(string)
tk string- 字段(string)
wpa2_handshake_empty
pub fn wpa2_handshake_empty() Wpa2Handshake
用途
执行 wpa2 handshake empty 操作。
参数
无需传入参数。
返回值
Wpa2Handshake — 该类型的值
wpa2_handshake_start
pub fn wpa2_handshake_start(pmk &string, aa &string, spa &string, snonce &string, rsn_ie &string) Wpa2Handshake
用途
执行 wpa2 handshake start 操作。
参数
pmk &string- pmk(只读借用,调用方仍持有原值;类型 &string)
aa &string- aa(只读借用,调用方仍持有原值;类型 &string)
spa &string- spa(只读借用,调用方仍持有原值;类型 &string)
snonce &string- snonce(只读借用,调用方仍持有原值;类型 &string)
rsn_ie &string- rsn_ie(只读借用,调用方仍持有原值;类型 &string)
返回值
Wpa2Handshake — 该类型的值
wpa2_handshake_receive
pub fn wpa2_handshake_receive(s $&Wpa2Handshake, frame &string) Wpa2Step
用途
执行 wpa2 handshake receive 操作。
参数
s $&Wpa2Handshake- s(独占借用,可修改原值;类型 $&Wpa2Handshake)
frame &string- frame(只读借用,调用方仍持有原值;类型 &string)
返回值
Wpa2Step — 该类型的值
wpa2_handshake_confirm_keys
pub fn wpa2_handshake_confirm_keys(s $&Wpa2Handshake, verified_m3 &string) string
用途
执行 wpa2 handshake confirm keys 操作。
参数
s $&Wpa2Handshake- s(独占借用,可修改原值;类型 $&Wpa2Handshake)
verified_m3 &string- verified_m3(只读借用,调用方仍持有原值;类型 &string)
返回值
string — 结果字符串