summaryrefslogtreecommitdiffstats
path: root/epan/addr_and_mask.h
diff options
context:
space:
mode:
Diffstat (limited to 'epan/addr_and_mask.h')
-rw-r--r--epan/addr_and_mask.h71
1 files changed, 71 insertions, 0 deletions
diff --git a/epan/addr_and_mask.h b/epan/addr_and_mask.h
new file mode 100644
index 00000000..db9ab16d
--- /dev/null
+++ b/epan/addr_and_mask.h
@@ -0,0 +1,71 @@
+/** @file
+ *
+ * Declarations of routines to fetch IPv4 and IPv6 addresses from a tvbuff
+ * and then mask out bits other than those covered by a prefix length
+ *
+ * Wireshark - Network traffic analyzer
+ * By Gerald Combs <gerald@wireshark.org>
+ * Copyright 1998 Gerald Combs
+ *
+ * SPDX-License-Identifier: GPL-2.0-or-later
+ */
+
+#ifndef __ADDR_AND_MASK_H__
+#define __ADDR_AND_MASK_H__
+
+#include <wsutil/inet_ipv4.h>
+#include <wsutil/inet_ipv6.h>
+
+#ifdef __cplusplus
+extern "C" {
+#endif /* __cplusplus */
+
+/*
+ * These routines return PREFIX_LEN_OK on success, PREFIX_LEN_TOO_LONG if
+ * the prefix length is too long, and PREFIX_LEN_ZERO if the prefix length
+ * is 0.
+ */
+
+#define PREFIX_LEN_OK 0
+#define PREFIX_LEN_TOO_LONG 1
+#define PREFIX_LEN_ZERO 2
+
+/**
+* Fetches an IPv4 address from a tvbuff and
+* masks out bits other than those covered by a prefix length
+*
+* @param tvb tvbuff to read an IPv4 address from
+* @param offset offset in the tvbuff to read the IPv4 address from
+* @param addr memory location where the IPv4 address read should be stored
+* @param prefix_len the length of the prefix (in bits)
+* @return the length (in bytes) of the address on success, or -1 on failure
+*/
+extern int tvb_get_ipv4_addr_with_prefix_len(tvbuff_t *tvb, int offset,
+ ws_in4_addr *addr, guint32 prefix_len);
+
+/**
+* Fetches an IPv6 address from a tvbuff and
+* masks out bits other than those covered by a prefix length
+*
+* @param tvb tvbuff to read an IPv6 address from
+* @param offset offset in the tvbuff to read the IPv6 address from
+* @param addr memory location where the IPv6 address read should be stored
+* @param prefix_len the length of the prefix (in bits)
+* @return the length (in bytes) of the address on success, or -1 on failure
+*/
+extern int tvb_get_ipv6_addr_with_prefix_len(tvbuff_t *tvb, int offset,
+ ws_in6_addr *addr, guint32 prefix_len);
+
+/**
+* Returns the IPv4 subnet mask of the specified length
+*
+* @param mask_length the number of bits in the subnet mask (max of 32)
+* @return the subnet mask of the specified length
+*/
+guint32 ip_get_subnet_mask(const guint32 mask_length);
+
+#ifdef __cplusplus
+}
+#endif /* __cplusplus */
+
+#endif /* __ADDR_AND_MASK_H__ */