{"id":19851,"date":"2023-01-09T09:00:00","date_gmt":"2023-01-09T08:00:00","guid":{"rendered":"https:\/\/www.codemotion.com\/magazine\/?p=19851"},"modified":"2023-06-19T12:29:46","modified_gmt":"2023-06-19T10:29:46","slug":"how-to-validate-an-ip-address-using-python","status":"publish","type":"post","link":"https:\/\/www.codemotion.com\/magazine\/languages\/how-to-validate-an-ip-address-using-python\/","title":{"rendered":"How to Validate an IP Address Using Python"},"content":{"rendered":"\n

Did you know that there are currently around 4,294,967,296<\/a> IPv4 addresses in use?<\/p>\n\n\n\n

That\u2019s a big number.<\/p>\n\n\n\n

So big, in fact, that a new standard is being introduced to cope with demand: IPv6.<\/p>\n\n\n\n

In this article, we\u2019re going to explore how to validate an IP address using Python<\/a><\/strong>. This can be useful for all sorts of scenarios, whether you\u2019re working on fraud prevention or on more general projects like developing an iPaaS platform (you can find an iPaaS definition<\/a> here).<\/p>\n\n\n\n

But first, let\u2019s look in more detail at the differences between the IPv4 and IPv6 IP address formats<\/strong>. When it comes to IP address validation, you may need to tweak your code to take account of these variations.<\/p>\n\n\n\n

What\u2019s the difference between IPv4 and IPv6?<\/h2>\n\n\n\n

Imagine, if you will, the very early days of the internet, before things like cloud phone systems<\/a> were even a twinkle in a telecoms executive\u2019s eye. The very first engineers working on IP (internet Protocol) invented IPv4, which \u2013 despite the \u201cversion 4\u201d bit \u2013 was actually the first internet protocol introduced<\/strong> and is still in use today.<\/p>\n\n\n\n

You will of course be very familiar with the format, which is four numbers between 0 and 255 separated by periods, like this: 38.251.131.135<\/p>\n\n\n\n

Each number is an 8-bit field and represents a single byte of the IP address. That means that the complete IP is a 32-bit (4 x 8 bits) address space.<\/strong> Altogether, this allows for enough combinations to generate 4.3 billion unique addresses.<\/p>\n\n\n\n

Now, back when those early engineers were coming up with this concept, they couldn\u2019t have foreseen the scale of the modern internet or imagined that tens of millions of devices<\/strong> might want to access a single co.nz<\/a> domain at once. Quite understandably, they assumed that 4.3 billion addresses would be more than enough.<\/p>\n\n\n\n

Well, as we saw at the beginning of this article, we\u2019ve already nearly reached that.<\/p>\n\n\n\n

Fortunately, some smart people noticed this issue coming down the tracks years ago and set up the Internet Engineering Task Force (IETF). Back in 1998, this august body introduced IPv6, which instead uses 128-bit addressing. This means it can be used to support around 340 trillion trillion addresses<\/strong>. So hopefully, it will be a long time before we run out of IPv6 capacity. Tasks like VoIP migration<\/a> should be easily achievable for many years to come.<\/p>\n\n\n\n

IPv6 format is eight hexadecimal numbers separated by colons and looks like this: <\/p>\n\n\n\n

2510:cc:8000:1c82:543c:cd2e:f2fa:5a8b<\/p>\n\n\n\n

In this article we\u2019ll be focusing on validating IPv4 addresses, but the same principles we cover here are applicable to IPv6 addresses too.<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Free to use image from Unsplash<\/p>\n\n\n\n

Validating an IP address with Python<\/h2>\n\n\n\n

Python is an object-oriented and dynamically typed coding language well loved by amateur coders and senior developers alike. Because it\u2019s so flexible and scalable<\/strong>, it can be used for all sorts of applications. From using Python for automation<\/a> to developing websites and data visualisation tools, it\u2019s a terrific option for accomplishing varied technical tasks. <\/p>\n\n\n\n

There are a number of ways of validating IP addresses in Python. Here we present two of the most straightforward methods: using the ipaddress() module and using your own custom regex. We\u2019ll also have a look at setting up your own custom function.<\/p>\n\n\n\n

Validating an IP address using the ipaddress() module<\/h3>\n\n\n\n

This is by far the simplest method and one of the most secure. The ipaddress() function won\u2019t actually tell you that an IP address is valid as such, but it can perform basic arithmetic with it<\/strong>. With a bit of custom juggling, we can use this to return a result about its validity.<\/p>\n\n\n\n

The first step is to import the ipaddress() module into your code. Then, call the .ip_address() method on the ipaddress class, and pass it an IP string. If it\u2019s a valid IPv4 or IPv6 address, the ipaddress module will use the string to produce a new IP address object.<\/p>\n\n\n\n

If, on the other hand, the string you pass it is not a valid IP address, the ipaddress() function will return a value error. As we already explained, the module tries to use the string you provide to create a Python IP address object<\/strong>. So in order to actually validate an IP, you have to create your own IP validation function. Here\u2019s an example:<\/p>\n\n\n\n

\"\"<\/figure>\n\n\n\n

Note: this will also work with IPv6 addresses.<\/p>\n\n\n\n

Validating an IP address with a custom regex<\/h3>\n\n\n\n

If you\u2019re used to working with Python frameworks<\/a>, you\u2019ll appreciate its versatility as a coding language. So there are multiple approaches possible for any given coding task. Another way we can determine whether an IP address is valid or not is by using a regular expression<\/strong> (regex) to match the required pattern.<\/p>\n\n\n\n

In this case, that means four numbers between 0 and 255 separated by dots. Because the values of the numbers are restricted to 0 \u2264 n \u2264 255, you\u2019ll have to add some more code of your own for additional verification.<\/p>\n\n\n\n

(Also, since you\u2019ll be defining the shape of the address, that means that you\u2019ll need to write separate functions to check IPv4 and IPv6 addresses, since their shapes are very different.)<\/p>\n\n\n\n

What you\u2019re going to do is import the re library so you can use the .match() method to check whether your string matches the defined pattern.<\/p>\n\n\n\n

After you\u2019ve done this, the next step is to create your regex string. This defines the shape for matching. There are several ways of doing this, but here\u2019s a straightforward example:<\/p>\n\n\n\n

“[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}\\.[0-9]{1,3}”<\/p>\n\n\n\n

Let\u2019s have a look at what\u2019s going on there. This expression consists of:<\/p>\n\n\n\n

[0-9]<\/strong> \u2013 you want numbers between 1 and 9<\/p>\n\n\n\n

{1,3}<\/strong> \u2013 you want between 1 and 3 digits in each section<\/p>\n\n\n\n

\\.<\/strong> \u2013 tells the parser to look for the \u201c.\u201d symbol. This is important because in regex, \u201c.\u201d is a special character meaning \u201cany character\u201d, so if you want the parser to look for the character \u201c.\u201d itself, you have to include the backslash to tell it to do that.<\/p>\n\n\n\n

Together, these components define one byte, so you require four of them to define the pattern of the IP address as a whole. (Although don\u2019t forget not to put \u201c\\.\u201d at the end \u2013 you only need to put them between each section.)<\/p>\n\n\n\n

This is okay as far as it goes, but there\u2019s more work to do. That\u2019s because you haven\u2019t yet specified that the value of each number has to be between 0 and 255. At the moment, a number like 495 would return a positive match. So you need to set up an additional check to verify this.<\/p>\n\n\n\n

Putting it all together, you\u2019ll end up with something like this:<\/p>\n\n\n\n

\"validate<\/figure>\n\n\n\n

Validating an IP address using a custom function<\/h3>\n\n\n\n

Just as there are billions of IP addresses being used all over the world, whether on a desktop, a hosted IP phone<\/a>, or a laptop, sometimes it feels as if there are billions of ways of achieving the result you want with Python.<\/p>\n\n\n\n

So let\u2019s look at one method of validating IP addresses in a slightly more freestyle way.<\/p>\n\n\n\n

Breaking down the task into its constituent parts, we can see that we\u2019ll need to do the following:<\/p>\n\n\n\n