_ipam.py

import ipaddress
import json
import requests
from enum import Enum
from pydantic import BaseSettings
from requests.auth import HTTPBasicAuth
from typing import Union

from gso import settings


class V4ServiceNetwork(BaseSettings):
    v4: ipaddress.IPv4Network


class V6ServiceNetwork(BaseSettings):
    v6: ipaddress.IPv6Network


class ServiceNetworks(BaseSettings):
    v4: ipaddress.IPv4Network
    v6: ipaddress.IPv6Network


class V4HostAddress(BaseSettings):
    v4: ipaddress.IPv4Address


class V6HostAddress(BaseSettings):
    v6: ipaddress.IPv6Address


class HostAddresses(BaseSettings):
    v4: ipaddress.IPv4Address
    v6: ipaddress.IPv6Address


class IPAMErrors(Enum):
    # HTTP error code, match in error message
    CONTAINER_FULL = 400, "Can not find requested number of networks"
    EXTATTR_UNKNOWN = 400, "Unknown extensible attribute"
    EXTATTR_BADVALUE = 400, "Bad value for extensible attribute"


# TODO: remove this!
# lab infoblox cert is not valid for the ipv4 address
#   ... disable warnings for now
requests.packages.urllib3.disable_warnings()


def _match_error_code(response, error_code):
    return response.status_code == error_code.value[0] \
        and error_code.value[1] in response.text


def _wapi(infoblox_params: settings.InfoBloxParams):
    return (f'https://{infoblox_params.host}'
            f'/wapi/{infoblox_params.wapi_version}')


def _ip_addr_version(addr):
    ip_version = None
    ip_addr = ipaddress.ip_address(addr)
    if isinstance(ip_addr, ipaddress.IPv4Address):
        ip_version = 4
    elif isinstance(ip_addr, ipaddress.IPv6Address):
        ip_version = 6
    assert ip_version in [4, 6]
    return ip_version


def _ip_network_version(network):
    ip_version = None
    ip_network = ipaddress.ip_network(network)
    if isinstance(ip_network, ipaddress.IPv4Network):
        ip_version = 4
    elif isinstance(ip_network, ipaddress.IPv6Network):
        ip_version = 6
    assert ip_version in [4, 6]
    return ip_version


def _find_networks(network_container=None, network=None, ip_version=4):
    """
    If network_container is not None, find all networks within the specified
    container.
    Otherwise, if network is not None, find the specified network.
    Otherwise find all networks.
    """
    assert ip_version in [4, 6]
    oss = settings.load_oss_params()
    assert oss.IPAM.INFOBLOX
    infoblox_params = oss.IPAM.INFOBLOX
    endpoint = 'network' if ip_version == 4 else 'ipv6network'
    params = None
    if network_container:
        params = {'network_container': network_container}
    elif network:
        params = {'network': network}
    r = requests.get(
        f'{_wapi(infoblox_params)}/{endpoint}',
        params=params,
        auth=HTTPBasicAuth(infoblox_params.username,
                           infoblox_params.password),
        verify=False
    )
    # TODO: propagate "network not found" error to caller
    assert r.status_code >= 200 and r.status_code < 300, \
        f"HTTP error {r.status_code}: {r.reason}\n\n{r.text}"
    return r.json()


def _get_network_capacity(network=None):
    """
    Get utilization of a IPv4 network in a fraction of 1000.
    """
    oss = settings.load_oss_params()
    assert oss.IPAM.INFOBLOX
    infoblox_params = oss.IPAM.INFOBLOX

    ip_version = _ip_network_version(network)
    assert ip_version == 4, "Utilization is only available for IPv4 networks."
    params = {
        'network': network,
        '_return_fields': 'network,total_hosts,utilization'
    }

    r = requests.get(
        f'{_wapi(infoblox_params)}/network',
        params=params,
        auth=HTTPBasicAuth(infoblox_params.username,
                           infoblox_params.password),
        verify=False
    )
    # Utilization info takes several minutes to converge.
    # The IPAM utilization bar in the GUI as well. Why?
    assert r.status_code >= 200 and r.status_code < 300, \
        f"HTTP error {r.status_code}: {r.reason}\n\n{r.text}"
    capacity_info = r.json()
    assert len(capacity_info) == 1, "Requested IPv4 network doesn't exist."
    assert 'utilization' in capacity_info[0]
    utilization = capacity_info[0]['utilization']
    return utilization


def _allocate_network(
    infoblox_params: settings.InfoBloxParams,
    network_params: Union[settings.V4NetworkParams, settings.V6NetworkParams],
    ip_version=4,
    comment="",
    extattrs={}
) -> Union[V4ServiceNetwork, V6ServiceNetwork]:
    assert ip_version in [4, 6]
    endpoint = 'network' if ip_version == 4 else 'ipv6network'
    ip_container = 'networkcontainer' if ip_version == 4 else \
        'ipv6networkcontainer'

    # only return in the response the allocated network, not all available
    # TODO: any validation needed for extrattrs wherever it's used?
    req_payload = {
        "network": {
            "_object_function": "next_available_network",
            "_parameters": {
                "cidr": network_params.mask
            },
            "_object": ip_container,
            "_object_parameters": {
                "network": str(network_params.containers[0])
            },
            "_result_field": "networks",
        },
        "comment": comment,
        "extattrs": extattrs
    }

    container_index = 0
    while True:
        r = requests.post(
            f'{_wapi(infoblox_params)}/{endpoint}',
            params={'_return_fields': 'network'},
            json=req_payload,
            auth=HTTPBasicAuth(infoblox_params.username,
                               infoblox_params.password),
            headers={'content-type': "application/json"},
            verify=False
        )
        if not _match_error_code(response=r,
                                 error_code=IPAMErrors.CONTAINER_FULL):
            break
        # Container full: try with next valid container for service (if any)
        container_index += 1
        if len(network_params.containers) < (container_index + 1):
            break
        req_payload["network"]["_object_parameters"]["network"] = \
            str(network_params.containers[container_index])

    assert r.status_code >= 200 and r.status_code < 300, \
        f"HTTP error {r.status_code}: {r.reason}\n\n{r.text}"

    assert 'network' in r.json()
    allocated_network = r.json()['network']
    if ip_version == 4:
        return V4ServiceNetwork(v4=allocated_network)
    else:
        return V6ServiceNetwork(v6=allocated_network)


def allocate_service_ipv4_network(service_type, comment="", extattrs={}
                                  ) -> V4ServiceNetwork:
    """
    Allocate IPv4 network within the container of the specified service type.
    """
    oss = settings.load_oss_params()
    assert oss.IPAM
    ipam_params = oss.IPAM
    assert hasattr(ipam_params, service_type) \
        and service_type != 'INFOBLOX', "Invalid service type."
    return _allocate_network(ipam_params.INFOBLOX,
                             getattr(ipam_params, service_type).V4,
                             4,
                             comment,
                             extattrs)


def allocate_service_ipv6_network(service_type, comment="", extattrs={}
                                  ) -> V6ServiceNetwork:
    """
    Allocate IPv6 network within the container of the specified service type.
    """
    oss = settings.load_oss_params()
    assert oss.IPAM
    ipam_params = oss.IPAM
    assert hasattr(ipam_params, service_type) \
        and service_type != 'INFOBLOX', "Invalid service type."
    return _allocate_network(ipam_params.INFOBLOX,
                             getattr(ipam_params, service_type).V6,
                             6,
                             comment,
                             extattrs)


def _find_next_available_ip(infoblox_params, network_ref):
    r = requests.post(
        f'{_wapi(infoblox_params)}/{network_ref}?_function=next_available_ip&num=1',   # noqa: E501
        auth=HTTPBasicAuth(infoblox_params.username,
                           infoblox_params.password),
        verify=False
    )
    # TODO: propagate no more available IPs in the network
    assert r.status_code >= 200 and r.status_code < 300, \
        f"HTTP error {r.status_code}: {r.reason}\n\n{r.text}"
    assert 'ips' in r.json()
    received_ip = r.json()['ips']
    assert len(received_ip) == 1
    return received_ip[0]


def _allocate_host(hostname=None, addr=None, network=None, extattrs={}
                   ) -> Union[V4HostAddress, V6HostAddress]:
    """
    If network is not None, allocate host in that network.
    Otherwise if addr is not None, allocate host with that address.
    hostname parameter must be full name including domain name.
    """
    # TODO: should hostnames be unique
    # (i.e. fail if hostname already exists in this domain/service)?
    assert addr or network, \
        "You must specify either the host address or the network CIDR."
    oss = settings.load_oss_params()
    assert oss.IPAM.INFOBLOX
    infoblox_params = oss.IPAM.INFOBLOX

    if network:
        ip_version = _ip_network_version(network)
        # Find the next available IP address in the network
        network_info = _find_networks(network=network, ip_version=ip_version)
        assert len(network_info) == 1, \
            "Network does not exist. Create it first."
        assert '_ref' in network_info[0]
        addr = _find_next_available_ip(infoblox_params,
                                       network_info[0]["_ref"])

    else:
        ip_version = _ip_addr_version(addr)

    ip_req_payload = {
        f"ipv{ip_version}addrs": [
            {
                f"ipv{ip_version}addr": addr
            }
        ],
        "name": hostname,
        "configure_for_dns": False,
        "view": "default",
        "extattrs": extattrs
    }

    r = requests.post(
        f'{_wapi(infoblox_params)}/record:host',
        json=ip_req_payload,
        auth=HTTPBasicAuth(infoblox_params.username,
                           infoblox_params.password),
        verify=False
    )
    assert r.status_code >= 200 and r.status_code < 300, \
        f"HTTP error {r.status_code}: {r.reason}\n\n{r.text}"
    assert isinstance(r.json(), str)
    assert r.json().startswith("record:host/")

    dns_req_payload = {
        f"ipv{ip_version}addr": addr,
        "name": hostname,
        "view": "default",
        "extattrs": extattrs
    }

    endpoint = 'record:a' if ip_version == 4 else 'record:aaaa'

    r = requests.post(
        f'{_wapi(infoblox_params)}/{endpoint}',
        json=dns_req_payload,
        auth=HTTPBasicAuth(infoblox_params.username,
                           infoblox_params.password),
        verify=False
    )
    assert r.status_code >= 200 and r.status_code < 300, \
        f"HTTP error {r.status_code}: {r.reason}\n\n{r.text}"
    assert isinstance(r.json(), str)
    assert r.json().startswith(f"{endpoint}/")

    if ip_version == 4:
        return V4HostAddress(v4=addr)
    else:
        return V6HostAddress(v6=addr)


def allocate_service_host(hostname=None,
                          service_type=None,
                          service_networks: ServiceNetworks = None,
                          host_addresses: HostAddresses = None,
                          extattrs={}
                          ) -> HostAddresses:
    """
    Allocate host with both IPv4 and IPv6 address (and respective DNS
    records).
    The domain name is also taken from the service type and appended to
    specified hostname.
    If service_networks is provided, that one is used.
    If service_networks is not provided, and host_addresses is provided,
    those specific addresses are used.
    If neither is not provided, the first network with available space for
    this service type is used.
        Note that if WFO will always specify the network/addresses after
        creating it, this mode won't be needed. Currently this mode doesn't
        look further than the first container, so if needed, this will need
        to be updated.
    """
    oss = settings.load_oss_params()
    assert oss.IPAM
    ipam_params = oss.IPAM

    assert hasattr(ipam_params, service_type) \
        and service_type != 'INFOBLOX', "Invalid service type."
    ipv4_containers = getattr(ipam_params, service_type).V4.containers
    ipv6_containers = getattr(ipam_params, service_type).V6.containers
    domain_name = getattr(ipam_params, service_type).domain_name

    # IPv4
    if not service_networks and not host_addresses:
        ipv4_networks_info = _find_networks(
            network_container=str(ipv4_containers[0]), ip_version=4)
        assert len(ipv4_networks_info) >= 1, \
            "No IPv4 network exists in the container for this service type."
        first_nonfull_ipv4_network = None
        for ipv4_network_info in ipv4_networks_info:
            assert 'network' in ipv4_network_info
            capacity = _get_network_capacity(ipv4_network_info["network"])
            if capacity < 1000:
                first_nonfull_ipv4_network = ipv4_network_info["network"]
                break
        # Create a new network if the existing networks in the container for
        # the service type are all full.
        if not first_nonfull_ipv4_network:
            first_nonfull_ipv4_network = str(allocate_service_ipv4_network(
                service_type=service_type).v4)
        assert first_nonfull_ipv4_network, \
            "No available IPv4 addresses for this service type."
        v4_host = _allocate_host(hostname=hostname+domain_name,
                                 network=first_nonfull_ipv4_network,
                                 extattrs=extattrs)
    elif service_networks:
        network = service_networks.v4
        assert any(network.subnet_of(ipv4_container)
                   for ipv4_container in ipv4_containers)
        v4_host = _allocate_host(hostname=hostname+domain_name,
                                 network=str(network),
                                 extattrs=extattrs)
    elif host_addresses:
        addr = host_addresses.v4
        assert any(addr in ipv4_container
                   for ipv4_container in ipv4_containers)
        v4_host = _allocate_host(hostname=hostname+domain_name,
                                 addr=str(addr),
                                 extattrs=extattrs)

    # IPv6
    if not service_networks and not host_addresses:
        # ipv6 does not support capacity fetching (not even the GUI displays
        # it). Maybe it's assumed that there is always available space?
        ipv6_networks_info = _find_networks(
            network_container=str(ipv6_containers[0]),
            ip_version=6)
        assert len(ipv6_networks_info) >= 1, \
            "No IPv6 network exists in the container for this service type."
        assert 'network' in ipv6_networks_info[0]
        # TODO: if "no available IP" error, create a new network?
        v6_host = _allocate_host(hostname=hostname+domain_name,
                                 network=ipv6_networks_info[0]['network'],
                                 extattrs=extattrs)
    elif service_networks:
        network = service_networks.v6
        assert any(network.subnet_of(ipv6_container)
                   for ipv6_container in ipv6_containers)
        v6_host = _allocate_host(hostname=hostname+domain_name,
                                 network=str(network),
                                 extattrs=extattrs)
    elif host_addresses:
        addr = host_addresses.v6
        assert any(addr in ipv6_container
                   for ipv6_container in ipv6_containers)
        v6_host = _allocate_host(hostname=hostname+domain_name,
                                 addr=str(addr),
                                 extattrs=extattrs)

    return HostAddresses(v4=v4_host.v4, v6=v6_host.v6)


"""
Below methods are not used for supported outside calls
"""


def _find_containers(network=None, ip_version=4):
    """
    If network is not None, find that container.
    Otherwise find all containers.
    """
    assert ip_version in [4, 6]
    oss = settings.load_oss_params()
    assert oss.IPAM.INFOBLOX
    infoblox_params = oss.IPAM.INFOBLOX
    endpoint = 'networkcontainer' if ip_version == 4 \
        else 'ipv6networkcontainer'
    r = requests.get(
        f'{_wapi(infoblox_params)}/{endpoint}',
        params={'network': network} if network else None,
        auth=HTTPBasicAuth(infoblox_params.username,
                           infoblox_params.password),
        verify=False
    )
    assert r.status_code >= 200 and r.status_code < 300, \
        f"HTTP error {r.status_code}: {r.reason}\n\n{r.text}"
    return r.json()


def _delete_network(network) -> Union[V4ServiceNetwork, V6ServiceNetwork]:
    """
    Delete IPv4 or IPv6 network by CIDR.
    """
    # TODO: should we check that there are no hosts in this network before
    # deleting? Deleting a network deletes the hosts in it, but not the
    # associated DNS records.
    oss = settings.load_oss_params()
    assert oss.IPAM.INFOBLOX
    infoblox_params = oss.IPAM.INFOBLOX

    ip_version = _ip_network_version(network)

    network_info = _find_networks(network=network, ip_version=ip_version)
    assert len(network_info) == 1, "Network does not exist."
    assert '_ref' in network_info[0]

    r = requests.delete(
        f'{_wapi(infoblox_params)}/{network_info[0]["_ref"]}',
        auth=HTTPBasicAuth(infoblox_params.username,
                           infoblox_params.password),
        verify=False
    )
    assert r.status_code >= 200 and r.status_code < 300, \
        f"HTTP error {r.status_code}: {r.reason}\n\n{r.text}"

    # Extract ipv4/ipv6 address from the network reference obtained in the
    # response
    r_json = r.json()
    network_address = ipaddress.ip_network(
        r_json.rsplit("/", 1)[0].split(":")[1].replace("%3A", ":"))
    if ip_version == 4:
        return V4ServiceNetwork(v4=network_address)
    else:
        return V6ServiceNetwork(v6=network_address)


def _delete_host_by_ip(addr) -> Union[V4HostAddress, V6HostAddress]:
    """
    Delete IPv4 or IPv6 host by its address.
    """
    oss = settings.load_oss_params()
    assert oss.IPAM.INFOBLOX
    infoblox_params = oss.IPAM.INFOBLOX

    ip_version = _ip_addr_version(addr)
    ip_param = 'ipv4addr' if ip_version == 4 else 'ipv6addr'

    # Find host record reference
    r = requests.get(
        f'{_wapi(infoblox_params)}/record:host',
        params={ip_param: addr},
        auth=HTTPBasicAuth(infoblox_params.username,
                           infoblox_params.password),
        verify=False
    )
    host_data = r.json()
    assert len(host_data) == 1, "Host does not exist."
    assert '_ref' in host_data[0]
    host_ref = host_data[0]['_ref']

    # Delete it
    r = requests.delete(
        f'{_wapi(infoblox_params)}/{host_ref}',
        auth=HTTPBasicAuth(infoblox_params.username,
                           infoblox_params.password),
        verify=False
    )
    assert r.status_code >= 200 and r.status_code < 300, \
        f"HTTP error {r.status_code}: {r.reason}\n\n{r.text}"

    # Also find and delete the associated dns a/aaaa record
    endpoint = 'record:a' if ip_version == 4 else 'record:aaaa'

    r = requests.get(
        f'{_wapi(infoblox_params)}/{endpoint}',
        params={ip_param: addr},
        auth=HTTPBasicAuth(infoblox_params.username,
                           infoblox_params.password),
        verify=False
    )
    dns_data = r.json()
    assert len(dns_data) == 1, "DNS record does not exist."
    assert '_ref' in dns_data[0]
    dns_ref = dns_data[0]['_ref']

    r = requests.delete(
        f'{_wapi(infoblox_params)}/{dns_ref}',
        auth=HTTPBasicAuth(infoblox_params.username,
                           infoblox_params.password),
        verify=False
    )
    assert r.status_code >= 200 and r.status_code < 300, \
        f"HTTP error {r.status_code}: {r.reason}\n\n{r.text}"

    if ip_version == 4:
        return V4HostAddress(v4=addr)
    else:
        return V6HostAddress(v6=addr)


def _get_network_usage_status(network):
    """
    Get status and usage fields of all hosts in the specified ipv4 or ipv6
    network.
    """
    oss = settings.load_oss_params()
    assert oss.IPAM.INFOBLOX
    infoblox_params = oss.IPAM.INFOBLOX

    ip_version = _ip_network_version(network)
    endpoint = 'ipv4address' if ip_version == 4 else 'ipv6address'

    r = requests.get(
        f'{_wapi(infoblox_params)}/{endpoint}',
        params={
            '_return_fields': 'ip_address,status,usage',
            'network': network},
        auth=HTTPBasicAuth(infoblox_params.username,
                           infoblox_params.password),
        verify=False
    )
    assert r.status_code >= 200 and r.status_code < 300, \
        f"HTTP error {r.status_code}: {r.reason}\n\n{r.text}"
    return r.json()


if __name__ == '__main__':
    while True:
        print("1. Find all containers")
        print("2. Find all networks")
        print("3. Get network capacity")
        print("4. Create new network")
        print("5. Delete network")
        print("6. Allocate host by IP")
        print("7. Allocate host by network CIDR")
        print("8. Allocate host by service type")
        print("9. Delete host by IP")
        print("10. Get network usage status")
        print("11. Exit")

        choice = input("Enter your choice: ")

        if choice == '1':
            ip_version = int(input("Enter IP version (4 or 6): "))
            containers = _find_containers(ip_version=ip_version)
            print(json.dumps(containers, indent=2))

        elif choice == '2':
            ip_version = int(input("Enter IP version (4 or 6): "))
            networks = _find_networks(ip_version=ip_version)
            print(json.dumps(networks, indent=2))

        elif choice == '3':
            network = input("Enter network (in CIDR notation): ")
            network_capacity = _get_network_capacity(network=network)
            print(json.dumps(network_capacity, indent=2))

        elif choice == '4':
            service_type = input("Enter service type: ")
            comment = input("Enter a comment for the network: ")
            ip_version = int(input("Enter IP version (4 or 6): "))
            if ip_version == 4:
                new_network = allocate_service_ipv4_network(
                    comment=comment, service_type=service_type)
            elif ip_version == 6:
                new_network = allocate_service_ipv6_network(
                    comment=comment, service_type=service_type)
            else:
                print("Invalid IP version. Please enter either 4 or 6.")
                continue
            print(json.dumps(str(new_network), indent=2))

        elif choice == '5':
            network = input("Enter network to delete (in CIDR notation): ")
            deleted_network = _delete_network(network=network)
            print(json.dumps(str(deleted_network), indent=2))

        elif choice == '6':
            hostname = input("Enter host name (full name w/ domain name): ")
            addr = input("Enter IP address to allocate: ")
            alloc_ip = _allocate_host(hostname=hostname, addr=addr)
            print(json.dumps(str(alloc_ip), indent=2))

        elif choice == '7':
            hostname = input("Enter host name (full name w/ domain name): ")
            network = input(
                "Enter existing network to allocate from (CIDR notation): ")
            alloc_ip = _allocate_host(hostname=hostname, network=network)
            print(json.dumps(str(alloc_ip), indent=2))

        elif choice == '8':
            hostname = input("Enter host name (w/o domain name): ")
            service_type = input("Enter service type: ")
            alloc_ip = allocate_service_host(
                hostname=hostname,
                service_type=service_type)
            print(json.dumps(str(alloc_ip), indent=2))

        elif choice == '9':
            addr = input("Enter IP address of host to delete: ")
            deleted_host = _delete_host_by_ip(addr=addr)
            print(json.dumps(str(deleted_host), indent=2))

        elif choice == '10':
            network = input(
                "Enter network to get host usage status (CIDR notation): ")
            usage_status_info = _get_network_usage_status(network=network)
            print(json.dumps(usage_status_info, indent=2))

        elif choice == '11':
            print("Exiting...")
            break

        else:
            print("Invalid choice. Please try again.")