\r\n

51Degrees Device Detection C/C++  4.4

A device detection library that is used natively or by 51Degrees products

ip.h

1 /* *********************************************************************
2  * This Original Work is copyright of 51 Degrees Mobile Experts Limited.
3  * Copyright 2023 51 Degrees Mobile Experts Limited, Davidson House,
4  * Forbury Square, Reading, Berkshire, United Kingdom RG1 3EU.
5  *
6  * This Original Work is licensed under the European Union Public Licence
7  * (EUPL) v.1.2 and is subject to its terms as set out below.
8  *
9  * If a copy of the EUPL was not distributed with this file, You can obtain
10  * one at https://opensource.org/licenses/EUPL-1.2.
11  *
12  * The 'Compatible Licences' set out in the Appendix to the EUPL (as may be
13  * amended by the European Commission) shall be deemed incompatible for
14  * the purposes of the Work and the provisions of the compatibility
15  * clause in Article 5 of the EUPL shall not apply.
16  *
17  * If using the Work as, or as part of, a network application, by
18  * including the attribution notice(s) required under Article 5 of the EUPL
19  * in the end user terms of the application under an appropriate heading,
20  * such notice(s) shall fulfill the requirements of that article.
21  * ********************************************************************* */
22 
23 #ifndef FIFTYONE_DEGREES_IP_H_INCLUDED
24 #define FIFTYONE_DEGREES_IP_H_INCLUDED
25 
40 #include <stdint.h>
41 #include <stdbool.h>
42 #include <stdlib.h>
43 #include "data.h"
44 #include "common.h"
45 
49 #define FIFTYONE_DEGREES_IPV4_LENGTH 4
50 
54 #define FIFTYONE_DEGREES_IPV6_LENGTH 16
55 
59 typedef enum e_fiftyone_degrees_evidence_ip_type {
60  FIFTYONE_DEGREES_EVIDENCE_IP_TYPE_IPV4 = 0,
61  FIFTYONE_DEGREES_EVIDENCE_IP_TYPE_IPV6 = 1,
62  FIFTYONE_DEGREES_EVIDENCE_IP_TYPE_INVALID = 2,
63 } fiftyoneDegreesEvidenceIpType;
64 
66 typedef struct fiftyone_degrees_evidence_ip_address
67  fiftyoneDegreesEvidenceIpAddress;
75 typedef struct fiftyone_degrees_evidence_ip_address {
76  fiftyoneDegreesEvidenceIpType type;
77  byte *address;
78  byte *current;
79  fiftyoneDegreesEvidenceIpAddress *next;
81  byte bytesPresent;
83  // const char *originalStart; // The first character for the IP address
84  // const char *originalEnd; // The last character for the IP addresses
85 } fiftyoneDegreesEvidenceIpAddress;
86 
93 EXTERNAL void fiftyoneDegreesIpFreeAddresses(
94  void(*free)(void*),
95  fiftyoneDegreesEvidenceIpAddress *addresses);
96 
104 EXTERNAL fiftyoneDegreesEvidenceIpAddress* fiftyoneDegreesIpParseAddress(
105  void*(*malloc)(size_t),
106  const char *start,
107  const char *end);
108 
115 EXTERNAL fiftyoneDegreesEvidenceIpAddress* fiftyoneDegreesIpParseAddresses(
116  void*(*malloc)(size_t),
117  const char *start);
118 
131 EXTERNAL int fiftyoneDegreesCompareIpAddresses(
132  const unsigned char *ipAddress1,
133  const unsigned char *ipAddress2,
134  fiftyoneDegreesEvidenceIpType type);
135 
140 #endif
FIFTYONE_DEGREES_EVIDENCE_IP_TYPE_IPV4
An IPv4 address.
Definition: ip.h:60
fiftyoneDegreesEvidenceIpAddress
IP address structure containing the bytes of a v4 or v6 IP address.
Definition: ip.h:75
FIFTYONE_DEGREES_EVIDENCE_IP_TYPE_INVALID
Invalid IP address.
Definition: ip.h:62
fiftyoneDegreesIpParseAddress
fiftyoneDegreesEvidenceIpAddress * fiftyoneDegreesIpParseAddress(void *(*malloc)(size_t), const char *start, const char *end)
Parse a single IP address string.
fiftyoneDegreesCompareIpAddresses
int fiftyoneDegreesCompareIpAddresses(const unsigned char *ipAddress1, const unsigned char *ipAddress2, fiftyoneDegreesEvidenceIpType type)
Compare two IP addresses in its binary form.
fiftyoneDegreesEvidenceIpAddress::type
fiftyoneDegreesEvidenceIpType type
The type of address (v4 or v6)
Definition: ip.h:76
fiftyoneDegreesEvidenceIpAddress::next
fiftyoneDegreesEvidenceIpAddress * next
Next address in the list or NULL.
Definition: ip.h:79
fiftyoneDegreesEvidenceIpType
fiftyoneDegreesEvidenceIpType
Enum indicating the type of IP address.
Definition: ip.h:59
fiftyoneDegreesIpFreeAddresses
void fiftyoneDegreesIpFreeAddresses(void(*free)(void *), fiftyoneDegreesEvidenceIpAddress *addresses)
Free a linked list of IP addresses.
FIFTYONE_DEGREES_EVIDENCE_IP_TYPE_IPV6
An IPv6 address.
Definition: ip.h:61
fiftyoneDegreesIpParseAddresses
fiftyoneDegreesEvidenceIpAddress * fiftyoneDegreesIpParseAddresses(void *(*malloc)(size_t), const char *start)
Parse a list of IP addresses and return as a linked list.
fiftyoneDegreesEvidenceIpAddress::current
byte * current
When building the address the next byte to update.
Definition: ip.h:78
fiftyoneDegreesEvidenceIpAddress::address
byte * address
The first byte of the address.
Definition: ip.h:77
fiftyoneDegreesEvidenceIpAddress::bytesPresent
byte bytesPresent
Number of bytes in the original string which are not abbreviated.
Definition: ip.h:81

Generated by doxygen 1.8.15