/* Copyright (C) 2003 Art Yerkes * A reimplementation of ifenum.c by Juan Lang * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation; either * version 2.1 of the License, or (at your option) any later version. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA * * Implementation notes * - Our bretheren use IOCTL_TCP_QUERY_INFORMATION_EX to get information * from tcpip.sys and IOCTL_TCP_SET_INFORMATION_EX to set info (such as * the route table). These ioctls mirror WsControl exactly in usage. * - This iphlpapi does not rely on any reactos-only features. * - This implementation is meant to be largely correct. I am not, however, * paying any attention to performance. It can be done faster, and * someone should definately optimize this code when speed is more of a * priority than it is now. * * Edited implementation notes from the original -- Basically edited to add * information and prune things which are not accurate about this file. * Interface index fun: * - Windows may rely on an index being cleared in the topmost 8 bits in some * APIs; see GetFriendlyIfIndex and the mention of "backward compatible" * indexes. It isn't clear which APIs might fail with non-backward-compatible * indexes, but I'll keep them bits clear just in case. * FIXME: * - We don't support IPv6 addresses here yet -- I moved the upper edge * functions into iphlpv6.c (arty) */ #include "iphlpapi_private.h" WINE_DEFAULT_DEBUG_CHANNEL(iphlpapi); /* Functions */ /* I'm a bit skittish about maintaining this info in memory, as I'd rather * not add any mutex or critical section blockers to these functions. I've * encountered far too many windows functions that contribute to deadlock * by not announcing themselves. */ void interfaceMapInit(void) { /* For now, nothing */ } void interfaceMapFree(void) { /* Ditto. */ } NTSTATUS tdiGetMibForIfEntity ( HANDLE tcpFile, TDIEntityID *ent, IFEntrySafelySized *entry ) { TCP_REQUEST_QUERY_INFORMATION_EX req = TCP_REQUEST_QUERY_INFORMATION_INIT; NTSTATUS status = STATUS_SUCCESS; DWORD returnSize; WARN("TdiGetMibForIfEntity(tcpFile %p,entityId %p)\n", tcpFile, ent->tei_instance); req.ID.toi_class = INFO_CLASS_PROTOCOL; req.ID.toi_type = INFO_TYPE_PROVIDER; req.ID.toi_id = IF_MIB_STATS_ID; req.ID.toi_entity = *ent; status = DeviceIoControl( tcpFile, IOCTL_TCP_QUERY_INFORMATION_EX, &req, sizeof(req), entry, sizeof(*entry), &returnSize, NULL ); if(!status) { WARN("IOCTL Failed\n"); return STATUS_UNSUCCESSFUL; } TRACE("TdiGetMibForIfEntity() => {\n" " if_index ....................... %x\n" " if_type ........................ %x\n" " if_mtu ......................... %d\n" " if_speed ....................... %x\n" " if_physaddrlen ................. %d\n", entry->ent.if_index, entry->ent.if_type, entry->ent.if_mtu, entry->ent.if_speed, entry->ent.if_physaddrlen); TRACE(" if_physaddr .................... %02x:%02x:%02x:%02x:%02x:%02x\n" " if_descr ....................... %s\n", entry->ent.if_physaddr[0] & 0xff, entry->ent.if_physaddr[1] & 0xff, entry->ent.if_physaddr[2] & 0xff, entry->ent.if_physaddr[3] & 0xff, entry->ent.if_physaddr[4] & 0xff, entry->ent.if_physaddr[5] & 0xff, entry->ent.if_descr); TRACE("} status %08x\n",status); return STATUS_SUCCESS; } BOOL isInterface( TDIEntityID *if_maybe ) { return if_maybe->tei_entity == IF_ENTITY; } BOOL isLoopback( HANDLE tcpFile, TDIEntityID *loop_maybe ) { IFEntrySafelySized entryInfo; NTSTATUS status; status = tdiGetMibForIfEntity( tcpFile, loop_maybe, &entryInfo ); return NT_SUCCESS(status) && (entryInfo.ent.if_type == IFENT_SOFTWARE_LOOPBACK); } BOOL hasArp( HANDLE tcpFile, TDIEntityID *arp_maybe ) { TCP_REQUEST_QUERY_INFORMATION_EX req = TCP_REQUEST_QUERY_INFORMATION_INIT; NTSTATUS status = STATUS_SUCCESS; DWORD returnSize, type; req.ID.toi_class = INFO_CLASS_GENERIC; req.ID.toi_type = INFO_TYPE_PROVIDER; req.ID.toi_id = ENTITY_TYPE_ID; req.ID.toi_entity.tei_entity = AT_ENTITY; req.ID.toi_entity.tei_instance = arp_maybe->tei_instance; status = DeviceIoControl( tcpFile, IOCTL_TCP_QUERY_INFORMATION_EX, &req, sizeof(req), &type, sizeof(type), &returnSize, NULL ); if( !NT_SUCCESS(status) ) return FALSE; return (type & AT_ARP); } static NTSTATUS getInterfaceInfoSet( HANDLE tcpFile, IFInfo **infoSet, PDWORD numInterfaces ) { DWORD numEntities; TDIEntityID *entIDSet = NULL; NTSTATUS status = tdiGetEntityIDSet( tcpFile, &entIDSet, &numEntities ); IFInfo *infoSetInt = 0; int curInterf = 0, i; if (!NT_SUCCESS(status)) { ERR("getInterfaceInfoSet: tdiGetEntityIDSet() failed: 0x%lx\n", status); return status; } infoSetInt = HeapAlloc( GetProcessHeap(), 0, sizeof(IFInfo) * numEntities ); if( infoSetInt ) { for( i = 0; i < numEntities; i++ ) { if( isInterface( &entIDSet[i] ) ) { infoSetInt[curInterf].entity_id = entIDSet[i]; status = tdiGetMibForIfEntity ( tcpFile, &entIDSet[i], &infoSetInt[curInterf].if_info ); TRACE("tdiGetMibForIfEntity: %08x\n", status); if( NT_SUCCESS(status) ) { DWORD numAddrs; IPAddrEntry *addrs; TDIEntityID ip_ent; int j; status = getNthIpEntity( tcpFile, curInterf, &ip_ent ); if( NT_SUCCESS(status) ) status = tdiGetIpAddrsForIpEntity ( tcpFile, &ip_ent, &addrs, &numAddrs ); for( j = 0; NT_SUCCESS(status) && j < numAddrs; j++ ) { TRACE("ADDR %d: index %d (target %d)\n", j, addrs[j].iae_index, infoSetInt[curInterf].if_info.ent.if_index); if( addrs[j].iae_index == infoSetInt[curInterf].if_info.ent.if_index ) { memcpy( &infoSetInt[curInterf].ip_addr, &addrs[j], sizeof( addrs[j] ) ); curInterf++; break; } } if ( NT_SUCCESS(status) ) tdiFreeThingSet(addrs); } } } tdiFreeThingSet(entIDSet); if (NT_SUCCESS(status)) { *infoSet = infoSetInt; *numInterfaces = curInterf; } else { HeapFree(GetProcessHeap(), 0, infoSetInt); } return status; } else { tdiFreeThingSet(entIDSet); return STATUS_INSUFFICIENT_RESOURCES; } } static DWORD getNumInterfacesInt(BOOL onlyNonLoopback) { DWORD numEntities, numInterfaces = 0; TDIEntityID *entitySet; HANDLE tcpFile; NTSTATUS status; int i; status = openTcpFile( &tcpFile, FILE_READ_DATA ); if( !NT_SUCCESS(status) ) { WARN("getNumInterfaces: failed %08x\n", status ); return 0; } status = tdiGetEntityIDSet( tcpFile, &entitySet, &numEntities ); if( !NT_SUCCESS(status) ) { WARN("getNumInterfaces: failed %08x\n", status ); closeTcpFile( tcpFile ); return 0; } for( i = 0; i < numEntities; i++ ) { if( isInterface( &entitySet[i] ) && (!onlyNonLoopback || (onlyNonLoopback && !isLoopback( tcpFile, &entitySet[i] ))) ) numInterfaces++; } TRACE("getNumInterfaces: success: %d %d %08x\n", onlyNonLoopback, numInterfaces, status ); closeTcpFile( tcpFile ); tdiFreeThingSet( entitySet ); return numInterfaces; } DWORD getNumInterfaces(void) { return getNumInterfacesInt( FALSE ); } DWORD getNumNonLoopbackInterfaces(void) { return getNumInterfacesInt( TRUE ); } DWORD getNthInterfaceEntity( HANDLE tcpFile, DWORD index, TDIEntityID *ent ) { DWORD numEntities = 0; DWORD numInterfaces = 0; TDIEntityID *entitySet = 0; NTSTATUS status = tdiGetEntityIDSet( tcpFile, &entitySet, &numEntities ); int i; if( !NT_SUCCESS(status) ) return status; for( i = 0; i < numEntities; i++ ) { if( isInterface( &entitySet[i] ) ) { if( numInterfaces == index ) break; else numInterfaces++; } } TRACE("Index %d is entity #%d - %04x:%08x\n", index, i, entitySet[i].tei_entity, entitySet[i].tei_instance ); if( numInterfaces == index && i < numEntities ) { memcpy( ent, &entitySet[i], sizeof(*ent) ); tdiFreeThingSet( entitySet ); return STATUS_SUCCESS; } else { tdiFreeThingSet( entitySet ); return STATUS_UNSUCCESSFUL; } } NTSTATUS getInterfaceInfoByIndex( HANDLE tcpFile, DWORD index, IFInfo *info ) { IFInfo *ifInfo; DWORD numInterfaces; NTSTATUS status = getInterfaceInfoSet( tcpFile, &ifInfo, &numInterfaces ); int i; if( NT_SUCCESS(status) ) { for( i = 0; i < numInterfaces; i++ ) { if( ifInfo[i].if_info.ent.if_index == index ) { memcpy( info, &ifInfo[i], sizeof(*info) ); break; } } HeapFree(GetProcessHeap(), 0, ifInfo); return i < numInterfaces ? STATUS_SUCCESS : STATUS_UNSUCCESSFUL; } return status; } NTSTATUS getInterfaceInfoByName( HANDLE tcpFile, char *name, IFInfo *info ) { IFInfo *ifInfo; DWORD numInterfaces; int i; NTSTATUS status = getInterfaceInfoSet( tcpFile, &ifInfo, &numInterfaces ); if( NT_SUCCESS(status) ) { for( i = 0; i < numInterfaces; i++ ) { if( !strcmp((PCHAR)ifInfo[i].if_info.ent.if_descr, name) ) { memcpy( info, &ifInfo[i], sizeof(*info) ); break; } } HeapFree(GetProcessHeap(), 0,ifInfo); return i < numInterfaces ? STATUS_SUCCESS : STATUS_UNSUCCESSFUL; } return status; } /* Note that the result of this operation must be freed later */ const char *getInterfaceNameByIndex(DWORD index) { IFInfo ifInfo; HANDLE tcpFile; char *interfaceName = 0, *adapter_name = 0; NTSTATUS status = openTcpFile( &tcpFile, FILE_READ_DATA ); if( NT_SUCCESS(status) ) { status = getInterfaceInfoByIndex( tcpFile, index, &ifInfo ); if( NT_SUCCESS(status) ) { adapter_name = (char *)ifInfo.if_info.ent.if_descr; interfaceName = HeapAlloc( GetProcessHeap(), 0, strlen(adapter_name) + 1 ); if (!interfaceName) return NULL; strcpy( interfaceName, adapter_name ); } closeTcpFile( tcpFile ); } return interfaceName; } void consumeInterfaceName(const char *name) { HeapFree( GetProcessHeap(), 0, (char *)name ); } DWORD getInterfaceIndexByName(const char *name, PDWORD index) { IFInfo ifInfo; HANDLE tcpFile; NTSTATUS status = openTcpFile( &tcpFile, FILE_READ_DATA ); if( NT_SUCCESS(status) ) { status = getInterfaceInfoByName( tcpFile, (char *)name, &ifInfo ); if( NT_SUCCESS(status) ) { *index = ifInfo.if_info.ent.if_index; } closeTcpFile( tcpFile ); } return status; } InterfaceIndexTable *getInterfaceIndexTableInt( BOOL nonLoopbackOnly ) { DWORD numInterfaces, curInterface = 0; int i; IFInfo *ifInfo; InterfaceIndexTable *ret = 0; HANDLE tcpFile; NTSTATUS status = openTcpFile( &tcpFile, FILE_READ_DATA ); if( NT_SUCCESS(status) ) { status = getInterfaceInfoSet( tcpFile, &ifInfo, &numInterfaces ); TRACE("InterfaceInfoSet: %08x, %04x:%08x\n", status, ifInfo->entity_id.tei_entity, ifInfo->entity_id.tei_instance); if( NT_SUCCESS(status) ) { ret = (InterfaceIndexTable *) calloc(1, sizeof(InterfaceIndexTable) + (numInterfaces - 1) * sizeof(DWORD)); if (ret) { ret->numAllocated = numInterfaces; TRACE("NumInterfaces = %d\n", numInterfaces); for( i = 0; i < numInterfaces; i++ ) { TRACE("Examining interface %d\n", i); if( !nonLoopbackOnly || !isLoopback( tcpFile, &ifInfo[i].entity_id ) ) { TRACE("Interface %d matches (%d)\n", i, curInterface); ret->indexes[curInterface++] = ifInfo[i].if_info.ent.if_index; } } ret->numIndexes = curInterface; } tdiFreeThingSet( ifInfo ); } closeTcpFile( tcpFile ); } return ret; } InterfaceIndexTable *getInterfaceIndexTable(void) { return getInterfaceIndexTableInt( FALSE ); } InterfaceIndexTable *getNonLoopbackInterfaceIndexTable(void) { return getInterfaceIndexTableInt( TRUE ); } DWORD getInterfaceIPAddrByName(const char *name) { return INADDR_ANY; } NTSTATUS getIPAddrEntryForIf(HANDLE tcpFile, char *name, DWORD index, IFInfo *ifInfo) { NTSTATUS status = name ? getInterfaceInfoByName( tcpFile, name, ifInfo ) : getInterfaceInfoByIndex( tcpFile, index, ifInfo ); if (!NT_SUCCESS(status)) { ERR("getIPAddrEntryForIf returning %lx\n", status); } return status; } DWORD getAddrByIndexOrName( char *name, DWORD index, IPHLPAddrType addrType ) { IFInfo ifInfo; HANDLE tcpFile; NTSTATUS status = STATUS_SUCCESS; DWORD addrOut = INADDR_ANY; status = openTcpFile( &tcpFile, FILE_READ_DATA ); if( NT_SUCCESS(status) ) { status = getIPAddrEntryForIf( tcpFile, name, index, &ifInfo ); if( NT_SUCCESS(status) ) { switch( addrType ) { case IPAAddr: addrOut = ifInfo.ip_addr.iae_addr; break; case IPABcast: addrOut = ifInfo.ip_addr.iae_bcastaddr; break; case IPAMask: addrOut = ifInfo.ip_addr.iae_mask; break; case IFMtu: addrOut = ifInfo.if_info.ent.if_mtu; break; case IFStatus: addrOut = ifInfo.if_info.ent.if_operstatus; break; } } closeTcpFile( tcpFile ); } return addrOut; } DWORD getInterfaceIPAddrByIndex(DWORD index) { return getAddrByIndexOrName( 0, index, IPAAddr ); } DWORD getInterfaceBCastAddrByName(const char *name) { return getAddrByIndexOrName( (char *)name, 0, IPABcast ); } DWORD getInterfaceBCastAddrByIndex(DWORD index) { return getAddrByIndexOrName( 0, index, IPABcast ); } DWORD getInterfaceMaskByName(const char *name) { return getAddrByIndexOrName( (char *)name, 0, IPAMask ); } DWORD getInterfaceMaskByIndex(DWORD index) { return getAddrByIndexOrName( 0, index, IPAMask ); } void getInterfacePhysicalFromInfo( IFInfo *info, PDWORD len, PBYTE addr, PDWORD type ) { *len = info->if_info.ent.if_physaddrlen; memcpy( addr, info->if_info.ent.if_physaddr, *len ); *type = info->if_info.ent.if_type; } DWORD getInterfacePhysicalByName(const char *name, PDWORD len, PBYTE addr, PDWORD type) { HANDLE tcpFile; IFInfo info; NTSTATUS status = openTcpFile( &tcpFile, FILE_READ_DATA ); if( NT_SUCCESS(status) ) { status = getInterfaceInfoByName( tcpFile, (char *)name, &info ); if( NT_SUCCESS(status) ) getInterfacePhysicalFromInfo( &info, len, addr, type ); closeTcpFile( tcpFile ); } return status; } DWORD getInterfacePhysicalByIndex(DWORD index, PDWORD len, PBYTE addr, PDWORD type) { HANDLE tcpFile; IFInfo info; NTSTATUS status = openTcpFile( &tcpFile, FILE_READ_DATA ); if( NT_SUCCESS(status) ) { status = getInterfaceInfoByIndex( tcpFile, index, &info ); if( NT_SUCCESS(status) ) getInterfacePhysicalFromInfo( &info, len, addr, type ); closeTcpFile( tcpFile ); } return status; } DWORD getInterfaceMtuByName(const char *name, PDWORD mtu) { *mtu = getAddrByIndexOrName( (char *)name, 0, IFMtu ); return STATUS_SUCCESS; } DWORD getInterfaceMtuByIndex(DWORD index, PDWORD mtu) { *mtu = getAddrByIndexOrName( 0, index, IFMtu ); return STATUS_SUCCESS; } DWORD getInterfaceStatusByName(const char *name, PDWORD status) { *status = getAddrByIndexOrName( (char *)name, 0, IFStatus ); return STATUS_SUCCESS; } DWORD getInterfaceStatusByIndex(DWORD index, PDWORD status) { *status = getAddrByIndexOrName( 0, index, IFStatus ); return STATUS_SUCCESS; } DWORD getInterfaceEntryByName(const char *name, PMIB_IFROW entry) { HANDLE tcpFile; IFInfo info; NTSTATUS status = openTcpFile( &tcpFile, FILE_READ_DATA ); TRACE("Called.\n"); if( NT_SUCCESS(status) ) { status = getInterfaceInfoByName( tcpFile, (char *)name, &info ); if( NT_SUCCESS(status) ) { memcpy( &entry->wszName[MAX_INTERFACE_NAME_LEN], &info.if_info, sizeof(info.if_info) ); } TRACE("entry->bDescr = %s\n", entry->bDescr); closeTcpFile( tcpFile ); } return status; } DWORD getInterfaceEntryByIndex(DWORD index, PMIB_IFROW entry) { HANDLE tcpFile; IFInfo info; NTSTATUS status = openTcpFile( &tcpFile, FILE_READ_DATA ); TRACE("Called.\n"); if( NT_SUCCESS(status) ) { status = getInterfaceInfoByIndex( tcpFile, index, &info ); if( NT_SUCCESS(status) ) { memcpy( &entry->wszName[MAX_INTERFACE_NAME_LEN], &info.if_info, sizeof(info.if_info) ); } closeTcpFile( tcpFile ); } return status; } char *toIPAddressString(unsigned int addr, char string[16]) { struct in_addr iAddr; iAddr.s_addr = addr; if (string) strncpy(string, inet_ntoa(iAddr), 16); return inet_ntoa(iAddr); } NTSTATUS addIPAddress( IPAddr Address, IPMask Mask, DWORD IfIndex, PULONG NteContext, PULONG NteInstance ) { HANDLE tcpFile; NTSTATUS status = openTcpFile( &tcpFile, FILE_READ_DATA | FILE_WRITE_DATA ); IP_SET_DATA Data; IO_STATUS_BLOCK Iosb; TRACE("Called.\n"); if( !NT_SUCCESS(status) ) return status; Data.NteContext = IfIndex; Data.NewAddress = Address; Data.NewNetmask = Mask; status = NtDeviceIoControlFile( tcpFile, NULL, NULL, NULL, &Iosb, IOCTL_SET_IP_ADDRESS, &Data, sizeof(Data), &Data, sizeof(Data) ); closeTcpFile( tcpFile ); if( NT_SUCCESS(status) ) { *NteContext = Iosb.Information; *NteInstance = Data.NewAddress; } if (!NT_SUCCESS(status)) { ERR("addIPAddress for if %d returning 0x%lx\n", IfIndex, status); } return status; } NTSTATUS deleteIpAddress( ULONG NteContext ) { HANDLE tcpFile; NTSTATUS status = openTcpFile( &tcpFile, FILE_READ_DATA | FILE_WRITE_DATA ); IO_STATUS_BLOCK Iosb; TRACE("Called.\n"); if( !NT_SUCCESS(status) ) return status; status = NtDeviceIoControlFile( tcpFile, NULL, NULL, NULL, &Iosb, IOCTL_DELETE_IP_ADDRESS, &NteContext, sizeof(USHORT), NULL, 0 ); closeTcpFile( tcpFile ); if (!NT_SUCCESS(status)) { ERR("deleteIpAddress(%lu) returning 0x%lx\n", NteContext, status); } return status; }