Differences

This shows you the differences between two versions of the page.

--- summerofcode2020projects:networkconfigurationlibraries [2020/08/25 19:28] – AhsanBarkati
+++ summerofcode2020projects:networkconfigurationlibraries [2021/06/13 19:15] (current) – Formatting fix ChristosMargiolis
@@ Line 1: / Line 1: @@
 ====== Network Configuration Libraries ======
-  * Student: **[[/AhsanBarkati|Ahsan Barkati]]** (ahsanb@%%FreeBSD%%.org)
+  * Student: [[/AhsanBarkati|AhsanBarkati]] (ahsanb@)
   * Mentors:
-    * [[/KristofProvost|KristofProvost]] (kp@freebsd.org)
+    * [[/KristofProvost|KristofProvost]] (kp@)
-    * [[/TomJones|TomJones]] (thj@freebsd.org)
+    * [[/TomJones|TomJones]] (thj@)
-===== Project description =====
+===== The Code =====
-%%FreeBSD%% has high quality tools for  management of the network, which includes tools to configure and manage interfaces, the firewalls and more. However these tools are not available as libraries, any software that wishes to incorporate network management must shell out to the command line tools. This limits the range of possible tools for automating control of a %%FreeBSD%% system. The aim of this project is to develop libroute, a library with APIs to manage routes.
-===== Libroute =====
+https://github.com/ahsanbarkati/freebsd/tree/libroute/lib/libroute
-Manual manipulation of the network routing tables is generally achieved by the /sbin/route utility. It provides functionality to add, flush, change, show the routes along with optional modifiers which enable setting some initial parameters to the routes such as RTT, MTU etc. This project aims to create a library which brings in a method to programmatically manage the routing. This library will allow addition of the routes to the FIB and also a method to change a particular route, delete a route or even flush the whole routing table. It is also intended that the library should be able to read the complete routing table of the system and hence simulate the netstat -r command line utility.
+===== Revisions Submitted =====
-===== Differential revisions Submitted =====
 ^  Differential  ^  Title  ^  Status  ^
@@ Line 18: / Line 15: @@
 | [[https://reviews.freebsd.org/D26078|D26078]] | Add libroute and basic librarification of route utility | In Review |
-===== The Code =====
+===== Project description =====
+%%FreeBSD%% has high quality tools for  management of the network, which includes tools to configure and manage interfaces, the firewalls and more. However these tools are not available as libraries, any software that wishes to incorporate network management must shell out to the command line tools. This limits the range of possible tools for automating control of a %%FreeBSD%% system. The aim of this project is to develop libroute, a library with APIs to manage routes.
-https://github.com/ahsanbarkati/freebsd/tree/libroute/lib/libroute
+===== Libroute =====
+Manual manipulation of the network routing tables is generally achieved by the ''%%/sbin/route%%'' utility. It provides functionality to add, flush, change, show the routes along with optional modifiers which enable setting some initial parameters to the routes such as RTT, MTU etc. This project aims to create a library which brings in a method to programmatically manage the routing. This library will allow addition of the routes to the FIB and also a method to change a particular route, delete a route or even flush the whole routing table.
 ===== Status of libroute =====
@@ Line 27: / Line 27: @@
   * There is a bug with the default route addition, I am currently looking into it.
   * The man page for libroute can be found [[https://github.com/ahsanbarkati/freebsd/blob/libroute/lib/libroute/libroute.3|here]].
+The general design of libroute is primarily characterized by the use of a handle. The library provides a method to get a libroute handle (via the ''%%libroute_open()%%'' API) and all the functionalities of the library is accessed by making use of this handle. The handle stores the FIB number on which it will operate and the socket that it will use to communicate with the kernel. At any point of time, this FIB number can be modified using the ''%%libroute_setfib()%%'' API. At the end this handle needs to be closed and this will free the memory held by the handle. There are various functions that this library provides:
+  * ''%%libroute_modify()%%''
+  * ''%%libroute_add()%%''
+  * ''%%libroute_change()%%''
+  * ''%%libroute_delete()%%''
+  * ''%%libroute_get()%%''
+Example usage of library:
+<code>
+#include <stdio.h>
+#include <libroute.h>
+int
+main()
+{
+        rt_handle *h;
+	struct sockaddr *sa_dest, *sa_gateway;
+	int defaultfib, error;
+        // get the default FIB number
+        size_t len = sizeof(defaultfib);
+	sysctlbyname("net.my_fibnum", (void *)&defaultfib, &len, NULL,0);
+        // Open the libroute handle
+	h = libroute_open(defaultfib);
+	if (h == NULL)
+		printf("failed to open handle\n");
+	dest = "192.168.2.6";
+	gateway = "172.16.2.1";
+        // convert addresses to sockaddr structs
+	sa_dest = str_to_sockaddr(dest);
+	sa_gateway = str_to_sockaddr(gateway);
+        // add the new route
+	error = libroute_add(h, sa_dest, sa_gateway);
+        if (error == -1 )
+                printf("Failed to add route, error code is %d", libroute_geterr(h));
+        libroute_close(h);
+        return (0);
+}
+</code>
+===== Test Plan =====
+Currently the testing of the library is not done directly, but it relies on the route utility for it. During this project, we have written tests for the route utility. The tests running on the librarified route indirectly tests the library. We have plans
+to add tests which directly tests the library.
+===== Future Work =====
+==== Bugs ====
+  * Modification to default route is broken.
+  * Scope of buffer overflow in ''%%fill_so()%%'' function.
+==== Testing ====
+  * A test suite for the library, written in C.
 ===== Useful links =====