com.atakmap.comms

Class NetworkDeviceManager

java.lang.Object

com.atakmap.comms.NetworkDeviceManager

Deprecated.

as of Android 11 the mac address can no longer be used. Please see NetworkManagerLite for code that is still used.

@Deprecated
public class NetworkDeviceManager
extends java.lang.Object

Contains a network device mapping that is created through an external Network learning application and read when ATAK is started up. The format of the file is CSV and describes valid network configurations and the services they provide. A major hurdle when starting ATAK with multiple network resources is that there is really no way to tell which network resource is used for CoT traffic and which one might provide a specialized service such as video. When these devices are plugged in and before they are configured, there is no way to tell what they are (eth0 vs eth1). Without knowing anything else, the video receiver might end up being the device that cursor on target messages are sent over. And the ISRV tool might attempt to talk with a PRC-152 incorrectly. The CSV file maps mac addresses to required configurations and capabilities. This makes use of the CSV file in the format: static - macaddress,label,type,Configration.STATIC.getValue(),address,netmask,gateway dhcp - macaddress,label,type,Configration.DHCP.getValue() none - macaddress,label,type,Configuration.NONE.getValue()

or # at the begining indicates comment.

where type is one of Type.*.getValue() and if multiple types exist they are separated by a semicolon ;

Additionally, if a gateway is set, this will become the default route for the system. Currently, the network configuration is not advanced enough to deal with static routing tables. The short term use case assumes at most one routable network and several non-routable (flat) networks.

The NetworkDeviceManager can be used in an enabled or disabled state. In the case that the NetworkDeviceManager is enabled, the network.map file will be loaded and utilized to describe how to use the network interfaces.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	NetworkDeviceManager.NetworkDevice Deprecated. The network device is described by its macaddress, label, type and the preferred network configuration,

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONFIG_ALTERED Deprecated.
static java.lang.String	TAG Deprecated.

Constructor Summary

Constructors

Constructor and Description
NetworkDeviceManager() Deprecated.

Method Summary

Modifier and Type	Method and Description
static boolean	addNetworkDevice(NetworkDeviceManager.NetworkDevice nd, java.io.File directory) Deprecated. add a discovered networkDevice to the list
static java.lang.String	byteToMac(byte[] mac) Deprecated. Creates a stringified mac address in pseudo human readable form.
static void	configure(NetworkDeviceManager.NetworkDevice nd) Deprecated. Configure an interface just given the mac address.
static boolean	configure(java.lang.String ifaceNameRaw) Deprecated. Given the interfacename switches to the root user and configures the network.
static boolean	configure(java.lang.String ifaceNameRaw, java.lang.String addressRaw, java.lang.String netmaskRaw, java.lang.String gatewayRaw, boolean createDefaultRoute, java.lang.String dnsRaw) Deprecated. Given the interfacename and the address, netmask, gateway this method switches to the root user and configures the network.
static void	enable(boolean state) Deprecated. Initializes the network mappings.
static java.lang.String	getAddress(java.net.NetworkInterface ni) Deprecated. Gets the ip address of an interface that is up, return null if interface is not up or has no address.
static NetworkDeviceManager.NetworkDevice	getDevice(java.lang.String macaddr) Deprecated. Finds a network device in the network map specified by the macaddres.
static java.net.NetworkInterface	getInterface(java.lang.String macaddr) Deprecated.
static java.net.NetworkInterface	getInterface(java.lang.String macaddr, boolean clean) Deprecated. Get the network interface of the device described in the network map file.
static java.lang.String	getIPv4Address(java.lang.String macaddr) Deprecated.
static java.lang.String	getMacAddress(java.net.NetworkInterface ni) Deprecated. Given a NetworkInterface, return the MAC address in the XX:XX:XX:XX:XX:XX format if no HardwareAddress is available, use a synthetically generated address based on the device name.
static java.util.List<NetworkDeviceManager.NetworkDevice>	getNetworkDevices() Deprecated. Returns an unmodifiable list of network devices read from the network.map file.
static java.util.Collection<java.net.NetworkInterface>	getUnmanagedInterfaces() Deprecated. Returns a list of unmanaged network devices constructed by scanning the list of managed network devices and the list of NetworkInterfaces from Android and returns the difference.
static java.lang.String	getUnmanagedIPv4Address(java.lang.String macaddr) Deprecated. Given a mac address, get the ip address for any unmanaged interfaces
static boolean	removeNetworkDevice(java.lang.String macaddr, java.io.File directory) Deprecated. remove a device with the given mac address from the device list
static void	setContext(android.content.Context c) Deprecated.
static void	setDirectory(java.io.File dir) Deprecated. Sets the directory for the network mapping.
static boolean	unconfigure(NetworkDeviceManager.NetworkDevice nd) Deprecated.
static boolean	unconfigure(java.lang.String ifaceNameRaw) Deprecated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

TAG

public static final java.lang.String TAG

Deprecated.

See Also:

Constant Field Values

CONFIG_ALTERED

public static final java.lang.String CONFIG_ALTERED

Deprecated.

See Also:

Constant Field Values

Constructor Detail

NetworkDeviceManager

public NetworkDeviceManager()

Deprecated.

Method Detail

setDirectory

public static void setDirectory(java.io.File dir)

Deprecated.

Sets the directory for the network mapping.

Parameters:

dir - if the location does not exist, or the location is null Environment.getExternalStorageDirectory(), "atak") is used when the NetworkDeviceManager is enabled.

enable

public static void enable(boolean state)

Deprecated.

Initializes the network mappings. NetworkDeviceManager works when disabled, but no NetworkDevices will be managed. Attempts to call enable on an enabled manager will reread the network.map file.

setContext

public static void setContext(android.content.Context c)

Deprecated.

removeNetworkDevice

public static boolean removeNetworkDevice(java.lang.String macaddr,
                                          java.io.File directory)

Deprecated.

remove a device with the given mac address from the device list

Parameters:

macaddr - the mac of the device to remove in the format XX:XX:XX:XX:XX:XX

directory - should be consistent with FileSystemUtils.getRoot()

addNetworkDevice

public static boolean addNetworkDevice(NetworkDeviceManager.NetworkDevice nd,
                                       java.io.File directory)

Deprecated.

add a discovered networkDevice to the list

Parameters:

nd - the NetworkDevice to be added

directory - should be consistent with FileSystemUtils.getRoot()

Returns:

true if success

getNetworkDevices

public static java.util.List<NetworkDeviceManager.NetworkDevice> getNetworkDevices()

Deprecated.

Returns an unmodifiable list of network devices read from the network.map file. If this list is empty, it is assumed that whatever networks ATAK needs are already configured and no multinic netowork issues are expected. (Multicast pub/sub is subjected to the default route of the system).

Returns:

all of the network devices that are in the network.map or empty if no devices are defined. Only interfaces that are present will have a valid interface name defined within the NetworkDevice iface field. If the NetworkManager has not been enabled is list will be empty.

getUnmanagedInterfaces

public static java.util.Collection<java.net.NetworkInterface> getUnmanagedInterfaces()

Deprecated.

Returns a list of unmanaged network devices constructed by scanning the list of managed network devices and the list of NetworkInterfaces from Android and returns the difference. This method is selective on what it will consider an unmanaged interface { eth }, managed interfaces are those that are externally managed by Android (wlan0, ppp0, rmnet0, csctun0, tun0).

getDevice

public static NetworkDeviceManager.NetworkDevice getDevice(java.lang.String macaddr)

Deprecated.

Finds a network device in the network map specified by the macaddres.

Parameters:

macaddr - is in the format XX:XX:XX:XX:XX:XX

Returns:

the NetworkDevice matching the specified mac address or null if no device is described.

getIPv4Address

@Deprecated
public static java.lang.String getIPv4Address(java.lang.String macaddr)

Deprecated.

Find the preferred IPv4 address for a interface described by the macaddres.

Parameters:

macaddr - is in the format XX:XX:XX:XX:XX:XX

Returns:

the stringified IPv4 interface otherwise, null if the mac address does not resolve to a valid IPv4 interface.

getUnmanagedIPv4Address

public static java.lang.String getUnmanagedIPv4Address(java.lang.String macaddr)

Deprecated.

Given a mac address, get the ip address for any unmanaged interfaces

getInterface

@Deprecated
public static java.net.NetworkInterface getInterface(java.lang.String macaddr)

Deprecated.

This calls getInterface with a macaddress and false so the network interface will be checked to see if it exists in the cache and is up. This will allow for the return to be a dirty or cached network interface which is only a problem when performing a multicast join.

getInterface

public static java.net.NetworkInterface getInterface(java.lang.String macaddr,
                                                     boolean clean)

Deprecated.

Get the network interface of the device described in the network map file. The configuration of the actual interface should only be obtained from the NetworkInterface and not from the preferred values. The implementation of this method makes use of a cached mapping between stringified mac addresses and the actual network interface. When a request is made for a mac address currently in the mac/network interface cache and the actual network interface does not actually have that mac address, the entire cache is considered invalid and discarded. The cache is then repopulated with all of the devices and if found, the new network interface is returned.

Parameters:

macaddr - is in the format XX:XX:XX:XX:XX:XX

Returns:

the interface that describes the specific interface as defined by the network map. The network interface may have a name such as eth0, eth1, eth2, wlan0, ppp0, rmnet0, etc to use, or null if the interface is not present. The interface should be examined for the actual configuration of the device.

If for any reason rhe Network Interface is believed to be bad, a call *MUST* be made to request a clean interface.

Currently, we are observing a case where the NetworkInteface seems perfectly fine and will work for most things, but a call to joinAddress will FAIL.

unconfigure

public static boolean unconfigure(NetworkDeviceManager.NetworkDevice nd)

Deprecated.

configure

public static void configure(NetworkDeviceManager.NetworkDevice nd)

Deprecated.

Configure an interface just given the mac address. Could be written better to possibly ignore interfaces that are already configured.

byteToMac

public static java.lang.String byteToMac(byte[] mac)

Deprecated.

Creates a stringified mac address in pseudo human readable form. This is usually printed on the device.

getMacAddress

public static java.lang.String getMacAddress(java.net.NetworkInterface ni)

Deprecated.

Given a NetworkInterface, return the MAC address in the XX:XX:XX:XX:XX:XX format if no HardwareAddress is available, use a synthetically generated address based on the device name. otherwise returns null.

getAddress

public static java.lang.String getAddress(java.net.NetworkInterface ni)

Deprecated.

Gets the ip address of an interface that is up, return null if interface is not up or has no address.

Parameters:

ni - the interface to get the ip address of.

unconfigure

public static boolean unconfigure(java.lang.String ifaceNameRaw)

Deprecated.

configure

public static boolean configure(java.lang.String ifaceNameRaw,
                                java.lang.String addressRaw,
                                java.lang.String netmaskRaw,
                                java.lang.String gatewayRaw,
                                boolean createDefaultRoute,
                                java.lang.String dnsRaw)

Deprecated.

Given the interfacename and the address, netmask, gateway this method switches to the root user and configures the network. Replaces the default route if the network is of NetworkType.NORMAL

Parameters:

ifaceNameRaw - the name of the interface to configure

addressRaw - in IPv4 notation.

netmaskRaw - in long form.

gatewayRaw - in IPv4 notation, can be null or the empty string to denote no gateway exists. if no gateway exists, do not set the default route.

createDefaultRoute - create a default route

dnsRaw - the dns server, not set if dns is the empty string or null.

configure

public static boolean configure(java.lang.String ifaceNameRaw)

Deprecated.

Given the interfacename switches to the root user and configures the network.