Skip to content

# Iana

The tool to check the availability or syntax of domain, IP or URL.

::

    ██████╗ ██╗   ██╗███████╗██╗   ██╗███╗   ██╗ ██████╗███████╗██████╗ ██╗     ███████╗
    ██╔══██╗╚██╗ ██╔╝██╔════╝██║   ██║████╗  ██║██╔════╝██╔════╝██╔══██╗██║     ██╔════╝
    ██████╔╝ ╚████╔╝ █████╗  ██║   ██║██╔██╗ ██║██║     █████╗  ██████╔╝██║     █████╗
    ██╔═══╝   ╚██╔╝  ██╔══╝  ██║   ██║██║╚██╗██║██║     ██╔══╝  ██╔══██╗██║     ██╔══╝
    ██║        ██║   ██║     ╚██████╔╝██║ ╚████║╚██████╗███████╗██████╔╝███████╗███████╗
    ╚═╝        ╚═╝   ╚═╝      ╚═════╝ ╚═╝  ╚═══╝ ╚═════╝╚══════╝╚═════╝ ╚══════╝╚══════╝

Provides our iana file generator.

Author: Nissar Chababy, @funilrys, contactTATAfunilrysTODTODcom

Special thanks: https://pyfunceble.github.io/#/special-thanks

Contributors: https://pyfunceble.github.io/#/contributors

Project link: https://github.com/funilrys/PyFunceble

Project documentation: https://docs.pyfunceble.com

Project homepage: https://pyfunceble.github.io/

License: ::

    Copyright 2017, 2018, 2019, 2020, 2022, 2023, 2024, 2025 Nissar Chababy

    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.
    You may obtain a copy of the License at

        https://www.apache.org/licenses/LICENSE-2.0

    Unless required by applicable law or agreed to in writing, software
    distributed under the License is distributed on an "AS IS" BASIS,
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.

## `IanaDBGenerator`

Provides an interface for the generation of the iana database file.

Source code in `PyFunceble/cli/scripts/iana.py`

     65
     66
     67
     68
     69
     70
     71
     72
     73
     74
     75
     76
     77
     78
     79
     80
     81
     82
     83
     84
     85
     86
     87
     88
     89
     90
     91
     92
     93
     94
     95
     96
     97
     98
     99
    100
    101
    102
    103
    104
    105
    106
    107
    108
    109
    110
    111
    112
    113
    114
    115
    116
    117
    118
    119
    120
    121
    122
    123
    124
    125
    126
    127
    128
    129
    130
    131
    132
    133
    134
    135
    136
    137
    138
    139
    140
    141
    142
    143
    144
    145
    146
    147
    148
    149
    150
    151
    152
    153
    154
    155
    156
    157
    158
    159
    160
    161
    162
    163
    164
    165
    166
    167
    168
    169
    170
    171
    172
    173
    174
    175
    176
    177
    178
    179
    180
    181
    182
    183
    184
    185
    186
    187
    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198
    199
    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236
    237
    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262
    263
    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300

    class IanaDBGenerator:
        """
        Provides an interface for the generation of the iana database file.
        """

        UPSTREAM_LINK: str = "https://www.iana.org/domains/root/db"
        """
        Provides the upstream link.
        """

        IANA_WHOIS_SERVER: str = "whois.iana.org"
        """
        The WHOIS server provided by the IANA.
        """

        MANUAL_SERVER: Dict[str, str] = {
            "bm": "whois.afilias-srs.net",
            "bz": "whois.afilias-grs.net",
            "cd": "chois.nic.cd",
            "cm": "whois.netcom.cm",
            "fj": "whois.usp.ac.fj",
            "ga": "whois.my.ga",
            "int": "whois.iana.org",
            "ipiranga": " whois.nic.ipiranga",
            "lc": "whois2.afilias-grs.net",
            "now": " whois.nic.now",
            "pharmacy": " whois.nic.pharmacy",
            "piaget": " whois.nic.piaget",
            "ps": "whois.pnina.ps",
            "rw": "whois.ricta.org.rw",
            "shaw": "whois.afilias-srs.net",
            "xn--1ck2e1b": "whois.nic.xn--1ck2e1b",
            "xn--2scrj9c": "whois.inregistry.net",
            "xn--3hcrj9c": "whois.inregistry.net",
            "xn--45br5cyl": "whois.inregistry.net",
            "xn--45brj9c": "whois.inregistry.net",
            "xn--8y0a063a": "whois.nic.xn--8y0a063a",
            "xn--bck1b9a5dre4c": "whois.nic.xn--bck1b9a5dre4c",
            "xn--cck2b3b": "whois.nic.xn--cck2b3b",
            "xn--czr694b": "whois.nic.xn--czr694b",
            "xn--e1a4c": "whois.eu",
            "xn--eckvdtc9d": "whois.nic.xn--eckvdtc9d",
            "xn--fct429k": "whois.nic.xn--fct429k",
            "xn--fpcrj9c3d": "whois.inregistry.net",
            "xn--fzc2c9e2c": "whois.nic.lk",
            "xn--g2xx48c": "whois.nic.xn--g2xx48c",
            "xn--gckr3f0f": "whois.nic.xn--gckr3f0f",
            "xn--gecrj9c": "whois.inregistry.net",
            "xn--gk3at1e": "whois.nic.xn--gk3at1e",
            "xn--h2breg3eve": "whois.inregistry.net",
            "xn--h2brj9c": "whois.inregistry.net",
            "xn--h2brj9c8c": "whois.inregistry.net",
            "xn--imr513n": "whois.nic.xn--imr513n",
            "xn--jvr189m": "whois.nic.xn--jvr189m",
            "xn--kpu716f": "whois.nic.xn--kpu716f",
            "xn--mgba3a3ejt": "whois.nic.xn--mgba3a3ejt",
            "xn--mgbb9fbpob": "whois.nic.xn--mgbb9fbpob",
            "xn--mgbbh1a": "whois.inregistry.net",
            "xn--mgbbh1a71e": "whois.inregistry.net",
            "xn--mgbgu82a": "whois.inregistry.net",
            "xn--nyqy26a": "whois.nic.xn--nyqy26a",
            "xn--otu796d": "whois.nic.xn--otu796d",
            "xn--pbt977c": "whois.nic.xn--pbt977c",
            "xn--rhqv96g": "whois.nic.xn--rhqv96g",
            "xn--rovu88b": "whois.nic.xn--rovu88b",
            "xn--rvc1e0am3e": "whois.inregistry.net",
            "xn--s9brj9c": "whois.inregistry.net",
            "xn--ses554g": "whois.registry.knet.cn",
            "xn--wgbh1c": "whois.dotmasr.eg",
            "xn--xkc2al3hye2a": "whois.nic.lk",
            "xn--xkc2dl3a5ee0h": "whois.inregistry.net",
            "za": "whois.registry.net.za",
        }

        _destination: Optional[str] = None

        database: dict = {}
        """
        An internal storage map.
        """

        whois_query_tool: Optional[WhoisQueryTool] = None
        regex_helper: Optional[RegexHelper] = None

        def __init__(self, destination: Optional[str] = None) -> None:
            if destination is not None:
                self.destination = destination
            else:
                self.destination = IanaDataset().source_file

            self.whois_query_tool = WhoisQueryTool()
            self.regex_helper = RegexHelper()

        @property
        def destination(self) -> Optional[str]:
            """
            Provides the current state of the :code:`_destination` attribute.
            """

            return self._destination

        @destination.setter
        def destination(self, value: str) -> None:
            """
            Sets the destination to write.

            :param value:
                The value to set.

            :raise TypeError:
                When the given :code:`value` is not a :py:class:`str`.
            :raise ValueError:
                When the given :code:`value` is empty.
            """

            if not isinstance(value, str):
                raise TypeError(f"<value> should be {str}, {type(value)} given.")

            if not value:
                raise ValueError("<value> should not be empty.")

            self._destination = value

        def set_destination(self, value: str) -> "IanaDBGenerator":
            """
            Sets the destination to write.

            :param value:
                The value to set.
            """

            self.destination = value

            return self

        def get_referrer_from_extension(self, extension: str) -> Optional[str]:
            """
            Given an extension, tries to get or guess its extension.
            """

            dummy_domain = f"hello.{extension}"
            iana_record = (
                self.whois_query_tool.set_server(self.IANA_WHOIS_SERVER)
                .set_subject(dummy_domain)
                .record
            )

            if iana_record and "refer" in iana_record:
                regex_referrer = r"(?s)refer\:\s+([a-zA-Z0-9._-]+)\n"

                matched = self.regex_helper.set_regex(regex_referrer).match(
                    iana_record, return_match=True, group=1
                )

                if matched:
                    return matched

            possible_server = f"whois.nic.{extension}"
            response = self.whois_query_tool.set_server(possible_server).record

            if response:
                return possible_server

            if extension in self.MANUAL_SERVER:
                possible_server = self.MANUAL_SERVER[extension]

                response = self.whois_query_tool.set_server(possible_server).record

                if response:
                    return possible_server

            return None

        def get_extension_and_referrer_from_block(
            self, block: str
        ) -> Tuple[Optional[str], Optional[str]]:
            """
            Given an HTML block, we try to extract an extension and it's underlying
            referrer (WHOIS server).

            The referrer is extracted from the official IANA page, and guessed if
            missing.

            :param block:
                The block to parse.
            """

            regex_valid_extension = r"(/domains/root/db/)(.*)(\.html)"

            if self.regex_helper.set_regex(regex_valid_extension).match(
                block, return_match=False
            ):
                extension = self.regex_helper.match(block, return_match=True, group=2)

                if extension:
                    return extension, self.get_referrer_from_extension(extension)

            return None, None

        def start(self, max_workers: Optional[int] = None) -> "IanaDBGenerator":
            """
            Starts the generation of the dataset file.

            :param max_workers:
                The maximal number of workers we are allowed to use.
            """

            raw_data = (
                DownloadHelper(
                    self.UPSTREAM_LINK,
                    certificate_validation=(
                        PyFunceble.storage.CONFIGURATION.verify_ssl_certificate
                        if PyFunceble.storage.CONFIGURATION
                        else True
                    ),
                    own_proxy_handler=True,
                    proxies=PyFunceble.storage.PROXY,
                )
                .download_text()
                .split('<span class="domain tld">')
            )

            with concurrent.futures.ThreadPoolExecutor(max_workers=max_workers) as executor:
                for extension, whois_server in executor.map(
                    self.get_extension_and_referrer_from_block, raw_data
                ):
                    if extension:
                        self.database[extension] = whois_server

                        PyFunceble.facility.Logger.debug(
                            "Got: extension: %r ; whois server: %r", extension, whois_server
                        )

            DictHelper(self.database).to_json_file(self.destination)

            return self

### `IANA_WHOIS_SERVER = 'whois.iana.org'` `class-attribute` `instance-attribute`

The WHOIS server provided by the IANA.

### `UPSTREAM_LINK = 'https://www.iana.org/domains/root/db'` `class-attribute` `instance-attribute`

Provides the upstream link.

### `database = {}` `class-attribute` `instance-attribute`

An internal storage map.

### `destination` `property` `writable`

Provides the current state of the :code:`_destination` attribute.

### `get_extension_and_referrer_from_block(block)`

Given an HTML block, we try to extract an extension and it's underlying referrer (WHOIS server).

The referrer is extracted from the official IANA page, and guessed if missing.

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`block` | `str` | The block to parse. | required

Source code in `PyFunceble/cli/scripts/iana.py`

    238
    239
    240
    241
    242
    243
    244
    245
    246
    247
    248
    249
    250
    251
    252
    253
    254
    255
    256
    257
    258
    259
    260
    261
    262

    def get_extension_and_referrer_from_block(
        self, block: str
    ) -> Tuple[Optional[str], Optional[str]]:
        """
        Given an HTML block, we try to extract an extension and it's underlying
        referrer (WHOIS server).

        The referrer is extracted from the official IANA page, and guessed if
        missing.

        :param block:
            The block to parse.
        """

        regex_valid_extension = r"(/domains/root/db/)(.*)(\.html)"

        if self.regex_helper.set_regex(regex_valid_extension).match(
            block, return_match=False
        ):
            extension = self.regex_helper.match(block, return_match=True, group=2)

            if extension:
                return extension, self.get_referrer_from_extension(extension)

        return None, None

### `get_referrer_from_extension(extension)`

Given an extension, tries to get or guess its extension.

Source code in `PyFunceble/cli/scripts/iana.py`

    200
    201
    202
    203
    204
    205
    206
    207
    208
    209
    210
    211
    212
    213
    214
    215
    216
    217
    218
    219
    220
    221
    222
    223
    224
    225
    226
    227
    228
    229
    230
    231
    232
    233
    234
    235
    236

    def get_referrer_from_extension(self, extension: str) -> Optional[str]:
        """
        Given an extension, tries to get or guess its extension.
        """

        dummy_domain = f"hello.{extension}"
        iana_record = (
            self.whois_query_tool.set_server(self.IANA_WHOIS_SERVER)
            .set_subject(dummy_domain)
            .record
        )

        if iana_record and "refer" in iana_record:
            regex_referrer = r"(?s)refer\:\s+([a-zA-Z0-9._-]+)\n"

            matched = self.regex_helper.set_regex(regex_referrer).match(
                iana_record, return_match=True, group=1
            )

            if matched:
                return matched

        possible_server = f"whois.nic.{extension}"
        response = self.whois_query_tool.set_server(possible_server).record

        if response:
            return possible_server

        if extension in self.MANUAL_SERVER:
            possible_server = self.MANUAL_SERVER[extension]

            response = self.whois_query_tool.set_server(possible_server).record

            if response:
                return possible_server

        return None

### `set_destination(value)`

Sets the destination to write.

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`value` | `str` | The value to set. | required

Source code in `PyFunceble/cli/scripts/iana.py`

    188
    189
    190
    191
    192
    193
    194
    195
    196
    197
    198

    def set_destination(self, value: str) -> "IanaDBGenerator":
        """
        Sets the destination to write.

        :param value:
            The value to set.
        """

        self.destination = value

        return self

### `start(max_workers=None)`

Starts the generation of the dataset file.

Parameters:

Name | Type | Description | Default
--- | --- | --- | ---
`max_workers` | `Optional[int]` | The maximal number of workers we are allowed to use. | `None`

Source code in `PyFunceble/cli/scripts/iana.py`

    264
    265
    266
    267
    268
    269
    270
    271
    272
    273
    274
    275
    276
    277
    278
    279
    280
    281
    282
    283
    284
    285
    286
    287
    288
    289
    290
    291
    292
    293
    294
    295
    296
    297
    298
    299
    300

    def start(self, max_workers: Optional[int] = None) -> "IanaDBGenerator":
        """
        Starts the generation of the dataset file.

        :param max_workers:
            The maximal number of workers we are allowed to use.
        """

        raw_data = (
            DownloadHelper(
                self.UPSTREAM_LINK,
                certificate_validation=(
                    PyFunceble.storage.CONFIGURATION.verify_ssl_certificate
                    if PyFunceble.storage.CONFIGURATION
                    else True
                ),
                own_proxy_handler=True,
                proxies=PyFunceble.storage.PROXY,
            )
            .download_text()
            .split('<span class="domain tld">')
        )

        with concurrent.futures.ThreadPoolExecutor(max_workers=max_workers) as executor:
            for extension, whois_server in executor.map(
                self.get_extension_and_referrer_from_block, raw_data
            ):
                if extension:
                    self.database[extension] = whois_server

                    PyFunceble.facility.Logger.debug(
                        "Got: extension: %r ; whois server: %r", extension, whois_server
                    )

        DictHelper(self.database).to_json_file(self.destination)

        return self