dali/bacnet_stack
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix BACnet/IP on OS to bind broadcast to specific port (#489)

Browse Source 
* Fixes #346 by binding the broadcast socket to the port specific broadcast address rather than INADDR_ANY or INADDR_BROADCAST. Added additional compile and environment options for those who might need them. 

* Changed the define USE_CLASSADDR to BACNET_IP_BROADCAST_USE_CLASSADDR to help manage namespaces.

* Added BACNET_IP_BROADCAST_BIND_ADDR environment variable to override the default broadcast binding address.

---------

Co-authored-by: Steve Karg <skarg@users.sourceforge.net>
This commit is contained in:
Steve Karg
2023-09-10 10:24:18 -05:00
committed by GitHub
parent 0001f85f29
commit 55b8b3d93c
18 changed files with 231 additions and 58 deletions
Download Patch File Download Diff File Expand all files Collapse all files
ports/bsd/bacport.h
+2
View File
@@ -88,10 +88,12 @@
#include <sys/un.h>
#include <sys/ioctl.h>
#include <netdb.h>
#include "bacnet/bacnet_stack_exports.h"
/** @file bsd/net.h Includes BSD network headers. */
/* Local helper functions for this port */
BACNET_STACK_EXPORT
extern int bip_get_local_netmask(
struct in_addr *netmask);
ports/bsd/bip-init.c
+56 -3
View File
@@ -58,6 +58,9 @@ static uint16_t BIP_Port;
static struct in_addr BIP_Address;
/* IP broadcast address - stored here in network byte order */
static struct in_addr BIP_Broadcast_Addr;
/* broadcast binding mechanism */
static bool BIP_Broadcast_Binding_Address_Override;
static struct in_addr BIP_Broadcast_Binding_Address;
/* enable debugging */
static bool BIP_Debug = false;
/* interface name */
@@ -188,6 +191,7 @@ void bip_get_broadcast_address(BACNET_ADDRESS *dest)
*/
bool bip_set_addr(BACNET_IP_ADDRESS *addr)
{
(void)addr;
/* not something we do within this driver */
return false;
}
@@ -214,6 +218,7 @@ bool bip_get_addr(BACNET_IP_ADDRESS *addr)
*/
bool bip_set_broadcast_addr(BACNET_IP_ADDRESS *addr)
{
(void)addr;
/* not something we do within this driver */
return false;
}
@@ -239,6 +244,7 @@ bool bip_get_broadcast_addr(BACNET_IP_ADDRESS *addr)
*/
bool bip_set_subnet_prefix(uint8_t prefix)
{
(void)prefix;
/* not something we do within this driver */
return false;
}
@@ -321,7 +327,7 @@ uint16_t bip_receive(
int max = 0;
struct timeval select_timeout;
struct sockaddr_in sin = { 0 };
BACNET_IP_ADDRESS addr = { { 0 } };
BACNET_IP_ADDRESS addr = { 0 };
socklen_t sin_len = sizeof(sin);
int received_bytes = 0;
int offset = 0;
@@ -547,6 +553,20 @@ int bip_get_local_netmask(struct in_addr *netmask)
return rv;
}
/**
* @brief Set the broadcast socket binding address
* @param baddr The broadcast socket binding address, in host order.
* @return 0 on success
*/
int bip_set_broadcast_binding(
const char *ip4_broadcast)
{
BIP_Broadcast_Binding_Address.s_addr = inet_addr(ip4_broadcast);
BIP_Broadcast_Binding_Address_Override = true;
return 0;
}
/** Gets the local IP address and local broadcast address from the system,
* and saves it into the BACnet/IP data structures.
*
@@ -572,6 +592,29 @@ void bip_set_interface(char *ifname)
fflush(stderr);
}
/* setup local broadcast address */
#ifdef BACNET_IP_BROADCAST_USE_CLASSADDR
long broadcast_address;
long net_address;
broadcast_address = 0;
net_address = local_address.s_addr;
if (IN_CLASSA(ntohl(net_address))) {
broadcast_address =
(ntohl(net_address) & ~IN_CLASSA_HOST) | IN_CLASSA_HOST;
} else if (IN_CLASSB(ntohl(net_address))) {
broadcast_address =
(ntohl(net_address) & ~IN_CLASSB_HOST) | IN_CLASSB_HOST;
} else if (IN_CLASSC(ntohl(net_address))) {
broadcast_address =
(ntohl(net_address) & ~IN_CLASSC_HOST) | IN_CLASSC_HOST;
} else if (IN_CLASSD(ntohl(net_address))) {
broadcast_address =
(ntohl(net_address) & ~IN_CLASSD_HOST) | IN_CLASSD_HOST;
} else {
broadcast_address = INADDR_BROADCAST;
}
BIP_Broadcast_Addr.s_addr = htonl(broadcast_address);
#else
request = "broadaddr";
rv = get_local_address(ifname, &broadcast_address, request);
if (rv < 0) {
@@ -579,6 +622,7 @@ void bip_set_interface(char *ifname)
} else {
BIP_Broadcast_Addr.s_addr = broadcast_address.s_addr;
}
#endif
if (BIP_Debug) {
fprintf(stderr, "BIP: Broadcast Address: %s\n",
inet_ntoa(BIP_Broadcast_Addr));
@@ -672,8 +716,17 @@ bool bip_init(char *ifname)
if (sock_fd < 0) {
return false;
}
sin.sin_addr.s_addr = htonl(INADDR_ANY);
if (BIP_Broadcast_Binding_Address_Override) {
sin.sin_addr.s_addr = BIP_Broadcast_Binding_Address.s_addr;
} else {
#if defined(BACNET_IP_BROADCAST_USE_INADDR_ANY)
sin.sin_addr.s_addr = htonl(INADDR_ANY);
#elif defined(BACNET_IP_BROADCAST_USE_INADDR_BROADCAST)
sin.sin_addr.s_addr = htonl(INADDR_BROADCAST);
#else
sin.sin_addr.s_addr = BIP_Broadcast_Addr.s_addr;
#endif
}
sock_fd = createSocket(&sin);
BIP_Broadcast_Socket = sock_fd;
if (sock_fd < 0) {
ports/linux/bacport.h
+3
View File
@@ -114,8 +114,11 @@
BACNET_STACK_EXPORT
extern int bip_get_local_netmask(
struct in_addr *netmask);
BACNET_STACK_EXPORT
extern int bip_get_local_address_ioctl(
char *ifname,
struct in_addr *addr,
int request);
#endif
ports/linux/bip-init.c
+62 -8
View File
@@ -73,6 +73,9 @@ static uint16_t BIP_Port;
static struct in_addr BIP_Address;
/* IP broadcast address - stored here in network byte order */
static struct in_addr BIP_Broadcast_Addr;
/* broadcast binding mechanism */
static bool BIP_Broadcast_Binding_Address_Override;
static struct in_addr BIP_Broadcast_Binding_Address;
/* enable debugging */
static bool BIP_Debug = false;
/* interface name */
@@ -409,9 +412,11 @@ uint16_t bip_receive(
debug_print_ipv4(
"Received MPDU->", &sin.sin_addr, sin.sin_port, received_bytes);
/* pass the packet into the BBMD handler */
offset = socket == BIP_Socket ?
bvlc_handler(&addr, src, npdu, received_bytes) :
bvlc_broadcast_handler(&addr, src, npdu, received_bytes);
if (socket == BIP_Socket) {
offset = bvlc_handler(&addr, src, npdu, received_bytes);
} else {
offset = bvlc_broadcast_handler(&addr, src, npdu, received_bytes);
}
if (offset > 0) {
npdu_len = received_bytes - offset;
debug_print_ipv4(
@@ -749,6 +754,20 @@ int bip_get_local_netmask(struct in_addr *netmask)
return rv;
}
/**
* @brief Set the broadcast socket binding address
* @param baddr The broadcast socket binding address, in host order.
* @return 0 on success
*/
int bip_set_broadcast_binding(
const char *ip4_broadcast)
{
BIP_Broadcast_Binding_Address.s_addr = inet_addr(ip4_broadcast);
BIP_Broadcast_Binding_Address_Override = true;
return 0;
}
/** Gets the local IP address and local broadcast address from the system,
* and saves it into the BACnet/IP data structures.
*
@@ -773,6 +792,29 @@ void bip_set_interface(char *ifname)
fflush(stderr);
}
/* setup local broadcast address */
#ifdef BACNET_IP_BROADCAST_USE_CLASSADDR
long broadcast_address;
long net_address;
broadcast_address = 0;
net_address = local_address.s_addr;
if (IN_CLASSA(ntohl(net_address))) {
broadcast_address =
(ntohl(net_address) & ~IN_CLASSA_HOST) | IN_CLASSA_HOST;
} else if (IN_CLASSB(ntohl(net_address))) {
broadcast_address =
(ntohl(net_address) & ~IN_CLASSB_HOST) | IN_CLASSB_HOST;
} else if (IN_CLASSC(ntohl(net_address))) {
broadcast_address =
(ntohl(net_address) & ~IN_CLASSC_HOST) | IN_CLASSC_HOST;
} else if (IN_CLASSD(ntohl(net_address))) {
broadcast_address =
(ntohl(net_address) & ~IN_CLASSD_HOST) | IN_CLASSD_HOST;
} else {
broadcast_address = INADDR_BROADCAST;
}
BIP_Broadcast_Addr.s_addr = htonl(broadcast_address);
#else
rv = bip_get_local_address_ioctl(ifname, &netmask, SIOCGIFNETMASK);
if (rv < 0) {
BIP_Broadcast_Addr.s_addr = ~0;
@@ -780,6 +822,7 @@ void bip_set_interface(char *ifname)
BIP_Broadcast_Addr = local_address;
BIP_Broadcast_Addr.s_addr |= (~netmask.s_addr);
}
#endif
if (BIP_Debug) {
fprintf(stderr, "BIP: Broadcast Address: %s\n",
inet_ntoa(BIP_Broadcast_Addr));
@@ -817,9 +860,11 @@ static int createSocket(struct sockaddr_in *sin)
return status;
}
/* Bind to the proper interface to send without default gateway */
setsockopt(sock_fd, SOL_SOCKET, SO_BINDTODEVICE, BIP_Interface_Name,
strlen(BIP_Interface_Name));
status = setsockopt(sock_fd, SOL_SOCKET, SO_BINDTODEVICE,
BIP_Interface_Name, strlen(BIP_Interface_Name));
if (status < 0) {
perror("SO_BINDTODEVICE: ");
}
/* bind the socket to the local port number and IP address */
status =
bind(sock_fd, (const struct sockaddr *)sin, sizeof(struct sockaddr));
@@ -876,8 +921,17 @@ bool bip_init(char *ifname)
if (sock_fd < 0) {
return false;
}
sin.sin_addr.s_addr = htonl(INADDR_ANY);
if (BIP_Broadcast_Binding_Address_Override) {
sin.sin_addr.s_addr = BIP_Broadcast_Binding_Address.s_addr;
} else {
#if defined(BACNET_IP_BROADCAST_USE_INADDR_ANY)
sin.sin_addr.s_addr = htonl(INADDR_ANY);
#elif defined(BACNET_IP_BROADCAST_USE_INADDR_BROADCAST)
sin.sin_addr.s_addr = htonl(INADDR_BROADCAST);
#else
sin.sin_addr.s_addr = BIP_Broadcast_Addr.s_addr;
#endif
}
sock_fd = createSocket(&sin);
BIP_Broadcast_Socket = sock_fd;
if (sock_fd < 0) {
ports/win32/bacport.h
+5 -1
View File
@@ -39,7 +39,7 @@
#endif
#include <windows.h>
#if (!defined(USE_CLASSADDR) || (USE_CLASSADDR == 0))
#ifndef BACNET_IP_BROADCAST_USE_CLASSADDR
#include <iphlpapi.h>
#if defined(_MSC_VER)
#pragma comment(lib, "IPHLPAPI.lib")
@@ -81,6 +81,10 @@ and globals in favor of more secure versions. */
#define snprintf _snprintf
#endif
BACNET_STACK_EXPORT
extern int bip_get_local_netmask(
struct in_addr *netmask);
#define BACNET_OBJECT_TABLE(table_name, _type, _init, _count, \
_index_to_instance, _valid_instance, _object_name, \
_read_property, _write_property, _RPM_list, \
ports/win32/bip-init.c
+54 -20
View File
@@ -45,10 +45,6 @@
#include "bacnet/basic/bbmd/h_bbmd.h"
#include "bacport.h"
#ifndef USE_CLASSADDR
#define USE_CLASSADDR 0
#endif
/* Windows sockets */
static SOCKET BIP_Socket = INVALID_SOCKET;
static SOCKET BIP_Broadcast_Socket = INVALID_SOCKET;
@@ -62,10 +58,12 @@ static uint16_t BIP_Port;
/* IP address - stored here in network byte order */
static struct in_addr BIP_Address;
/* IP broadcast address - stored here in network byte order */
static struct in_addr BIP_Broadcast_Address;
static struct in_addr BIP_Broadcast_Addr;
/* broadcast binding mechanism */
static bool BIP_Broadcast_Binding_Address_Override;
static struct in_addr BIP_Broadcast_Binding_Address;
/* enable debugging */
static bool BIP_Debug = false;
static bool BIP_Debug;
/**
* @brief Print the IPv4 address with debug info
@@ -328,7 +326,7 @@ void bip_get_broadcast_address(BACNET_ADDRESS *dest)
if (dest) {
dest->mac_len = 6;
memcpy(&dest->mac[0], &BIP_Broadcast_Address.s_addr, 4);
memcpy(&dest->mac[0], &BIP_Broadcast_Addr.s_addr, 4);
memcpy(&dest->mac[4], &BIP_Port, 2);
dest->net = BACNET_BROADCAST_NETWORK;
dest->len = 0; /* no SLEN */
@@ -388,7 +386,7 @@ bool bip_set_broadcast_addr(BACNET_IP_ADDRESS *addr)
bool bip_get_broadcast_addr(BACNET_IP_ADDRESS *addr)
{
if (addr) {
memcpy(&addr->address[0], &BIP_Broadcast_Address.s_addr, 4);
memcpy(&addr->address[0], &BIP_Broadcast_Addr.s_addr, 4);
addr->port = ntohs(BIP_Port);
}
@@ -418,8 +416,8 @@ uint8_t bip_get_subnet_prefix(void)
uint32_t mask = 0xFFFFFFFE;
uint8_t prefix = 0;
address = BIP_Broadcast_Address.s_addr;
broadcast = BIP_Broadcast_Address.s_addr;
address = BIP_Broadcast_Addr.s_addr;
broadcast = BIP_Broadcast_Addr.s_addr;
/* calculate the subnet prefix from the broadcast address */
for (prefix = 1; prefix <= 32; prefix++) {
test_broadcast = (address & mask) | (~mask);
@@ -653,7 +651,6 @@ static long gethostaddr(void)
return *(long *)host_ent->h_addr;
}
#if (USE_CLASSADDR == 0)
/* returns the subnet mask in network byte order */
static uint32_t getIpMaskForIpAddress(uint32_t ipAddress)
{
@@ -696,11 +693,38 @@ static uint32_t getIpMaskForIpAddress(uint32_t ipAddress)
return ipMask;
}
#endif
/**
* @brief Get the netmask of the BACnet/IP's interface via an ioctl() call.
* @param netmask [out] The netmask, in host order.
* @return 0 on success, else the error from the ioctl() call.
*/
int bip_get_local_netmask(struct in_addr *netmask)
{
if (netmask) {
netmask->s_addr = getIpMaskForIpAddress(BIP_Address.s_addr);
}
return 0;
}
/**
* @brief Set the broadcast socket binding address
* @param baddr The broadcast socket binding address, in host order.
* @return 0 on success
*/
int bip_set_broadcast_binding(
const char *ip4_broadcast)
{
BIP_Broadcast_Binding_Address.s_addr = inet_addr(ip4_broadcast);
BIP_Broadcast_Binding_Address_Override = true;
return 0;
}
static void set_broadcast_address(uint32_t net_address)
{
#if USE_CLASSADDR
#ifdef BACNET_IP_BROADCAST_USE_CLASSADDR
long broadcast_address = 0;
if (IN_CLASSA(ntohl(net_address)))
@@ -717,7 +741,7 @@ static void set_broadcast_address(uint32_t net_address)
(ntohl(net_address) & ~IN_CLASSD_HOST) | IN_CLASSD_HOST;
else
broadcast_address = INADDR_BROADCAST;
BIP_Broadcast_Address.s_addr = htonl(broadcast_address);
BIP_Broadcast_Addr.s_addr = htonl(broadcast_address);
#else
/* these are network byte order variables */
long broadcast_address = 0;
@@ -731,7 +755,7 @@ static void set_broadcast_address(uint32_t net_address)
fflush(stderr);
}
broadcast_address = (net_address & net_mask) | (~net_mask);
BIP_Broadcast_Address.s_addr = broadcast_address;
BIP_Broadcast_Addr.s_addr = broadcast_address;
#endif
}
@@ -754,7 +778,7 @@ void bip_set_interface(char *ifname)
fflush(stderr);
}
/* setup local broadcast address */
if (BIP_Broadcast_Address.s_addr == 0) {
if (BIP_Broadcast_Addr.s_addr == 0) {
set_broadcast_address(BIP_Address.s_addr);
}
}
@@ -829,13 +853,13 @@ bool bip_init(char *ifname)
BIP_Address.s_addr = gethostaddr();
}
/* has broadcast address been set? */
if (BIP_Broadcast_Address.s_addr == 0) {
if (BIP_Broadcast_Addr.s_addr == 0) {
set_broadcast_address(BIP_Address.s_addr);
}
if (BIP_Debug) {
fprintf(stderr, "BIP: Address: %s\n", inet_ntoa(BIP_Address));
fprintf(stderr, "BIP: Broadcast Address: %s\n",
inet_ntoa(BIP_Broadcast_Address));
inet_ntoa(BIP_Broadcast_Addr));
fprintf(stderr, "BIP: UDP Port: 0x%04X [%hu]\n", ntohs(BIP_Port),
ntohs(BIP_Port));
fflush(stderr);
@@ -855,7 +879,17 @@ bool bip_init(char *ifname)
if (sock_fd == INVALID_SOCKET) {
return false;
}
sin.sin_addr.s_addr = htonl(INADDR_ANY);
if (BIP_Broadcast_Binding_Address_Override) {
sin.sin_addr.s_addr = BIP_Broadcast_Binding_Address.s_addr;
} else {
#if defined(BACNET_IP_BROADCAST_USE_INADDR_ANY)
sin.sin_addr.s_addr = htonl(INADDR_ANY);
#elif defined(BACNET_IP_BROADCAST_USE_INADDR_BROADCAST)
sin.sin_addr.s_addr = htonl(INADDR_BROADCAST);
#else
sin.sin_addr.s_addr = BIP_Address.s_addr;
#endif
}
if (BIP_Debug) {
fprintf(stderr, "BIP: broadcast bind %s:%hu\n", inet_ntoa(sin.sin_addr),
ntohs(sin.sin_port));