16d49e1aeSJan Lentfer /* 26d49e1aeSJan Lentfer * WPA Supplicant - Layer2 packet interface definition 36d49e1aeSJan Lentfer * Copyright (c) 2003-2005, Jouni Malinen <j@w1.fi> 46d49e1aeSJan Lentfer * 53ff40c12SJohn Marino * This software may be distributed under the terms of the BSD license. 63ff40c12SJohn Marino * See README for more details. 76d49e1aeSJan Lentfer * 86d49e1aeSJan Lentfer * This file defines an interface for layer 2 (link layer) packet sending and 96d49e1aeSJan Lentfer * receiving. l2_packet_linux.c is one implementation for such a layer 2 106d49e1aeSJan Lentfer * implementation using Linux packet sockets and l2_packet_pcap.c another one 116d49e1aeSJan Lentfer * using libpcap and libdnet. When porting %wpa_supplicant to other operating 126d49e1aeSJan Lentfer * systems, a new l2_packet implementation may need to be added. 136d49e1aeSJan Lentfer */ 146d49e1aeSJan Lentfer 156d49e1aeSJan Lentfer #ifndef L2_PACKET_H 166d49e1aeSJan Lentfer #define L2_PACKET_H 176d49e1aeSJan Lentfer 186d49e1aeSJan Lentfer /** 196d49e1aeSJan Lentfer * struct l2_packet_data - Internal l2_packet data structure 206d49e1aeSJan Lentfer * 216d49e1aeSJan Lentfer * This structure is used by the l2_packet implementation to store its private 226d49e1aeSJan Lentfer * data. Other files use a pointer to this data when calling the l2_packet 236d49e1aeSJan Lentfer * functions, but the contents of this structure should not be used directly 246d49e1aeSJan Lentfer * outside l2_packet implementation. 256d49e1aeSJan Lentfer */ 266d49e1aeSJan Lentfer struct l2_packet_data; 276d49e1aeSJan Lentfer 286d49e1aeSJan Lentfer #ifdef _MSC_VER 296d49e1aeSJan Lentfer #pragma pack(push, 1) 306d49e1aeSJan Lentfer #endif /* _MSC_VER */ 316d49e1aeSJan Lentfer 326d49e1aeSJan Lentfer struct l2_ethhdr { 336d49e1aeSJan Lentfer u8 h_dest[ETH_ALEN]; 346d49e1aeSJan Lentfer u8 h_source[ETH_ALEN]; 356d49e1aeSJan Lentfer be16 h_proto; 366d49e1aeSJan Lentfer } STRUCT_PACKED; 376d49e1aeSJan Lentfer 386d49e1aeSJan Lentfer #ifdef _MSC_VER 396d49e1aeSJan Lentfer #pragma pack(pop) 406d49e1aeSJan Lentfer #endif /* _MSC_VER */ 416d49e1aeSJan Lentfer 42*a1157835SDaniel Fojt enum l2_packet_filter_type { 43*a1157835SDaniel Fojt L2_PACKET_FILTER_DHCP, 44*a1157835SDaniel Fojt L2_PACKET_FILTER_NDISC, 45*a1157835SDaniel Fojt L2_PACKET_FILTER_PKTTYPE, 46*a1157835SDaniel Fojt }; 47*a1157835SDaniel Fojt 486d49e1aeSJan Lentfer /** 496d49e1aeSJan Lentfer * l2_packet_init - Initialize l2_packet interface 506d49e1aeSJan Lentfer * @ifname: Interface name 516d49e1aeSJan Lentfer * @own_addr: Optional own MAC address if available from driver interface or 526d49e1aeSJan Lentfer * %NULL if not available 536d49e1aeSJan Lentfer * @protocol: Ethernet protocol number in host byte order 546d49e1aeSJan Lentfer * @rx_callback: Callback function that will be called for each received packet 556d49e1aeSJan Lentfer * @rx_callback_ctx: Callback data (ctx) for calls to rx_callback() 566d49e1aeSJan Lentfer * @l2_hdr: 1 = include layer 2 header, 0 = do not include header 576d49e1aeSJan Lentfer * Returns: Pointer to internal data or %NULL on failure 586d49e1aeSJan Lentfer * 596d49e1aeSJan Lentfer * rx_callback function will be called with src_addr pointing to the source 606d49e1aeSJan Lentfer * address (MAC address) of the the packet. If l2_hdr is set to 0, buf 616d49e1aeSJan Lentfer * points to len bytes of the payload after the layer 2 header and similarly, 626d49e1aeSJan Lentfer * TX buffers start with payload. This behavior can be changed by setting 636d49e1aeSJan Lentfer * l2_hdr=1 to include the layer 2 header in the data buffer. 646d49e1aeSJan Lentfer */ 656d49e1aeSJan Lentfer struct l2_packet_data * l2_packet_init( 666d49e1aeSJan Lentfer const char *ifname, const u8 *own_addr, unsigned short protocol, 676d49e1aeSJan Lentfer void (*rx_callback)(void *ctx, const u8 *src_addr, 686d49e1aeSJan Lentfer const u8 *buf, size_t len), 696d49e1aeSJan Lentfer void *rx_callback_ctx, int l2_hdr); 706d49e1aeSJan Lentfer 716d49e1aeSJan Lentfer /** 72*a1157835SDaniel Fojt * l2_packet_init_bridge - Like l2_packet_init() but with bridge workaround 73*a1157835SDaniel Fojt * 74*a1157835SDaniel Fojt * This version of l2_packet_init() can be used to enable a workaround for Linux 75*a1157835SDaniel Fojt * packet socket in case of a station interface in a bridge. 76*a1157835SDaniel Fojt */ 77*a1157835SDaniel Fojt struct l2_packet_data * l2_packet_init_bridge( 78*a1157835SDaniel Fojt const char *br_ifname, const char *ifname, const u8 *own_addr, 79*a1157835SDaniel Fojt unsigned short protocol, 80*a1157835SDaniel Fojt void (*rx_callback)(void *ctx, const u8 *src_addr, 81*a1157835SDaniel Fojt const u8 *buf, size_t len), 82*a1157835SDaniel Fojt void *rx_callback_ctx, int l2_hdr); 83*a1157835SDaniel Fojt 84*a1157835SDaniel Fojt /** 856d49e1aeSJan Lentfer * l2_packet_deinit - Deinitialize l2_packet interface 866d49e1aeSJan Lentfer * @l2: Pointer to internal l2_packet data from l2_packet_init() 876d49e1aeSJan Lentfer */ 886d49e1aeSJan Lentfer void l2_packet_deinit(struct l2_packet_data *l2); 896d49e1aeSJan Lentfer 906d49e1aeSJan Lentfer /** 916d49e1aeSJan Lentfer * l2_packet_get_own_addr - Get own layer 2 address 926d49e1aeSJan Lentfer * @l2: Pointer to internal l2_packet data from l2_packet_init() 936d49e1aeSJan Lentfer * @addr: Buffer for the own address (6 bytes) 946d49e1aeSJan Lentfer * Returns: 0 on success, -1 on failure 956d49e1aeSJan Lentfer */ 966d49e1aeSJan Lentfer int l2_packet_get_own_addr(struct l2_packet_data *l2, u8 *addr); 976d49e1aeSJan Lentfer 986d49e1aeSJan Lentfer /** 996d49e1aeSJan Lentfer * l2_packet_send - Send a packet 1006d49e1aeSJan Lentfer * @l2: Pointer to internal l2_packet data from l2_packet_init() 1016d49e1aeSJan Lentfer * @dst_addr: Destination address for the packet (only used if l2_hdr == 0) 1026d49e1aeSJan Lentfer * @proto: Protocol/ethertype for the packet in host byte order (only used if 1036d49e1aeSJan Lentfer * l2_hdr == 0) 1046d49e1aeSJan Lentfer * @buf: Packet contents to be sent; including layer 2 header if l2_hdr was 1056d49e1aeSJan Lentfer * set to 1 in l2_packet_init() call. Otherwise, only the payload of the packet 1066d49e1aeSJan Lentfer * is included. 1076d49e1aeSJan Lentfer * @len: Length of the buffer (including l2 header only if l2_hdr == 1) 1086d49e1aeSJan Lentfer * Returns: >=0 on success, <0 on failure 1096d49e1aeSJan Lentfer */ 1106d49e1aeSJan Lentfer int l2_packet_send(struct l2_packet_data *l2, const u8 *dst_addr, u16 proto, 1116d49e1aeSJan Lentfer const u8 *buf, size_t len); 1126d49e1aeSJan Lentfer 1136d49e1aeSJan Lentfer /** 1146d49e1aeSJan Lentfer * l2_packet_get_ip_addr - Get the current IP address from the interface 1156d49e1aeSJan Lentfer * @l2: Pointer to internal l2_packet data from l2_packet_init() 1166d49e1aeSJan Lentfer * @buf: Buffer for the IP address in text format 1176d49e1aeSJan Lentfer * @len: Maximum buffer length 1186d49e1aeSJan Lentfer * Returns: 0 on success, -1 on failure 1196d49e1aeSJan Lentfer * 1206d49e1aeSJan Lentfer * This function can be used to get the current IP address from the interface 1216d49e1aeSJan Lentfer * bound to the l2_packet. This is mainly for status information and the IP 1226d49e1aeSJan Lentfer * address will be stored as an ASCII string. This function is not essential 1236d49e1aeSJan Lentfer * for %wpa_supplicant operation, so full implementation is not required. 1246d49e1aeSJan Lentfer * l2_packet implementation will need to define the function, but it can return 1256d49e1aeSJan Lentfer * -1 if the IP address information is not available. 1266d49e1aeSJan Lentfer */ 1276d49e1aeSJan Lentfer int l2_packet_get_ip_addr(struct l2_packet_data *l2, char *buf, size_t len); 1286d49e1aeSJan Lentfer 1296d49e1aeSJan Lentfer 1306d49e1aeSJan Lentfer /** 1316d49e1aeSJan Lentfer * l2_packet_notify_auth_start - Notify l2_packet about start of authentication 1326d49e1aeSJan Lentfer * @l2: Pointer to internal l2_packet data from l2_packet_init() 1336d49e1aeSJan Lentfer * 1346d49e1aeSJan Lentfer * This function is called when authentication is expected to start, e.g., when 1356d49e1aeSJan Lentfer * association has been completed, in order to prepare l2_packet implementation 1366d49e1aeSJan Lentfer * for EAPOL frames. This function is used mainly if the l2_packet code needs 1376d49e1aeSJan Lentfer * to do polling in which case it can increasing polling frequency. This can 1386d49e1aeSJan Lentfer * also be an empty function if the l2_packet implementation does not benefit 1396d49e1aeSJan Lentfer * from knowing about the starting authentication. 1406d49e1aeSJan Lentfer */ 1416d49e1aeSJan Lentfer void l2_packet_notify_auth_start(struct l2_packet_data *l2); 1426d49e1aeSJan Lentfer 143*a1157835SDaniel Fojt /** 144*a1157835SDaniel Fojt * l2_packet_set_packet_filter - Set socket filter for l2_packet 145*a1157835SDaniel Fojt * @l2: Pointer to internal l2_packet data from l2_packet_init() 146*a1157835SDaniel Fojt * @type: enum l2_packet_filter_type, type of filter 147*a1157835SDaniel Fojt * Returns: 0 on success, -1 on failure 148*a1157835SDaniel Fojt * 149*a1157835SDaniel Fojt * This function is used to set the socket filter for l2_packet socket. 150*a1157835SDaniel Fojt * 151*a1157835SDaniel Fojt */ 152*a1157835SDaniel Fojt int l2_packet_set_packet_filter(struct l2_packet_data *l2, 153*a1157835SDaniel Fojt enum l2_packet_filter_type type); 154*a1157835SDaniel Fojt 1556d49e1aeSJan Lentfer #endif /* L2_PACKET_H */ 156