macaddress.hpp

//  SPDX-License-Identifier: GPL-3.0-or-later
//
//  Copyright (c) 2013-2023 plan44.ch / Lukas Zeller, Zurich, Switzerland
//
//  Author: Lukas Zeller <luz@plan44.ch>
//
//  This file is part of p44utils.
//
//  p44utils is free software: you can redistribute it and/or modify
//  it under the terms of the GNU General Public License as published by
//  the Free Software Foundation, either version 3 of the License, or
//  (at your option) any later version.
//
//  p44utils 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 General Public License for more details.
//
//  You should have received a copy of the GNU General Public License
//  along with p44utils. If not, see <http://www.gnu.org/licenses/>.
//

#ifndef __p44utils__macaddress__
#define __p44utils__macaddress__

#include "p44utils_minimal.hpp"

#include <stdint.h>
#include <cstddef>

namespace p44 {

  /// get MAC address of this machine
  /// @return MAC address as 64bit int (upper 16bits zero) or 0 if none could be determined
  /// @note see getIfInfo() for details how MAC address is obtained
  uint64_t macAddress(const char *aIfName = NULL);

  /// get IPv4 address of this machine
  /// @return IPv4 address as 32bit int or 0 if none could be determined
  /// @note see getIfInfo() for details how interface is determined
  uint32_t ipv4Address(const char *aIfName = NULL);

  /// get network interface information
  /// @param aMacAddressP if not NULL: is set to the (a) MAC address of this machine
  /// @param aIPv4AddressP if not NULL: is set to the (a) current IPv4 address of this machine
  /// @param aIfIndexP if not NULL: is set to interface index of the interface which returned the MAC address
  ///   (which is NOT necessarily the interface that returns the IP address, unless specified by name!)
  /// @return true if MAC (optionally along with the IP of that MAC if any is set) was found, or,
  ///   when querying only IPv4, if a IPv4 address was found.
  /// @note On Linux, the first non-loopback interface's MAC will be used (as enumerated by ifr_ifindex 1..n)
  /// @note On OS X, the MAC address of the "en0" device will be used (every Mac has a en0, which is the
  ///   built-in network port of the machine; ethernet port for Macs that have one, WiFi port otherwise)
  bool getIfInfo(uint64_t *aMacAddressP, uint32_t *aIPv4AddressP, int *aIfIndexP, const char *aIfName = NULL);

  /// get MAC address of a remote party by IP
  /// @param aIPv4Address an IPv4 address to find out MAC address for
  /// @param aMacAddress if not NULL: is set to the MAC address of the
  /// @return true if MAC of remote IP could be found
  bool getMacAddressByIpv4(uint32_t aIPv4Address, uint64_t &aMacAddress);


} // namespace p44


#endif /* defined(__p44utils__macaddress__) */