Merge lp:~fahad-aizaz/hipl/hipd-init-config into lp:hipl

[Fahad Aizaz]

The run-time generation for configuration file removal. The following configuration files are affected by this change.

hipd.conf
hosts
nsupdate.conf

These configuration files are no longer part of HIP code. And are distributed along the HIPL package. With this the other packages namely Debian, OpenWRT, RPM are also updated so that these configuration files are also part of them.

Makefile.am is also updated by adding script to handle the location/placement of these configuration files.

[Diego Biurrun (diego-biurrun)]

 review needs-info

On Tue, Dec 06, 2011 at 12:32:26PM +0000, Fahad Aizaz wrote:
> --- packaging/hipl.spec 2011-12-01 21:29:13 +0000
> +++ packaging/hipl.spec 2011-12-06 12:31:24 +0000
> @@ -154,6 +154,9 @@
> %{_sbindir}/pisacert
> %{_sbindir}/nsupdate.pl
> %{_initddir}/hipd
> +%config(noreplace) %{_sysconfdir}/hip/hipd.conf
> +%config(noreplace) %{_sysconfdir}/hip/hosts
> +%config(noreplace) %{_sysconfdir}/hip/nsupdate.conf

Did you test this? configure should set sysconfdir to the correct value,
why did you add a hip/ subdirectory?

Diego

review: Needs Information

[Miika Komu (miika-iki)]

Fine by me, good work.

review: Approve

Unmerged revisions

6188. By Fahad Aizaz on 2011-12-06

The runtime generation of configuration files needs to be removed.

The changes made to 'init.c' removes the run-time generation of the
the following configuration files:

hipd.conf
hosts
nsupdate.conf

6187. By Fahad Aizaz on 2011-12-06

The OpenWRT package needs to be updated for configuration files.

The following configuration files are part of OpenWRT package:

hipd.conf
hosts
nsupdate.conf

6186. By Fahad Aizaz on 2011-12-06

The RPM package needs to be updated for configuration files.

The following configuration files are part of RPM package:

hipd.conf
hosts
nsupdate.conf

6185. By Fahad Aizaz on 2011-12-06

The configuration files need to be added to the Makefile.am.

The following configuration files are part of Makefile.am

hipd.conf
hosts
nsupdate.conf

6184. By Fahad Aizaz on 2011-12-06

Fix merge conflict

6183. By Fahad Aizaz on 2011-12-06

Debian: package update to handle configuration files.

The changes made in these files updates the debian package to
take care of configuration files placement. The following configuration
files:

hipd.conf
hosts
nsupdate.conf

are placed at the following location

etc/hip

6182. By Fahad Aizaz on 2011-12-06

Adding configuration files to HIPL package.

Following configuration are part of HIPL package:
hipd.conf
hosts
nsupdate.conf

=== modified file 'Makefile.am'
--- Makefile.am	2011-11-25 13:52:20 +0000
+++ Makefile.am	2011-12-06 12:31:24 +0000
@@ -134,6 +134,10 @@
                     modules/midauth/hipd/midauth.c      \
                     hipd/main.c
 
+dist_sysconf_DATA = hipd/hipd.conf        \
+                    hipd/hosts            \
+                    hipd/nsupdate.conf
+
 hipfw_hipfw_sources = hipfw/cache.c               \
                       hipfw/dlist.c               \
                       hipfw/esp_prot_api.c        \

=== modified file 'debian/hipl-daemon.dirs'
--- debian/hipl-daemon.dirs	2010-12-28 16:53:40 +0000
+++ debian/hipl-daemon.dirs	2011-12-06 12:31:24 +0000
@@ -1,1 +1,2 @@
 usr/sbin
+etc/hip

=== modified file 'debian/hipl-daemon.install'
--- debian/hipl-daemon.install	2010-12-28 16:53:40 +0000
+++ debian/hipl-daemon.install	2011-12-06 12:31:24 +0000
@@ -2,3 +2,6 @@
 debian/tmp/usr/sbin/hipconf usr/sbin/
 debian/tmp/usr/sbin/pisacert usr/sbin/
 debian/tmp/usr/sbin/nsupdate.pl usr/sbin/
+debian/tmp/etc/hip/hipd.conf etc/hip/
+debian/tmp/etc/hip/hosts etc/hip/
+debian/tmp/etc/hip/nsupdate.conf etc/hip/

=== added file 'hipd/hipd.conf'
--- hipd/hipd.conf	1970-01-01 00:00:00 +0000
+++ hipd/hipd.conf	2011-12-06 12:31:24 +0000
@@ -0,0 +1,21 @@
+# Format of this file is as with hipconf, but without "hipconf daemon" prefix
+# add hi default    # add all four HITs (see bug id 592127)
+# add map HIT IP    # preload some HIT-to-IP mappings to hipd
+# add service rvs   # the host acts as HIP rendezvous (also see relay.conf)
+# add server rvs [RVS-HIT] <RVS-IP-OR-HOSTNAME> <lifetime-secs> # register to rendezvous server
+# add server relay [RELAY-HIT] <RVS-IP-OR-HOSTNAME> <lifetime-secs> # register to relay server
+# add server full-relay [RELAY-HIT] <RVS-IP-OR-HOSTNAME> <lifetime-secs> # register to relay server
+hit-to-ip on # resolve HITs to locators in dynamic DNS zone
+# hit-to-ip set hit-to-ip.infrahip.net. # resolve HITs to locators in dynamic DNS zone
+nsupdate on # send dynamic DNS updates
+# add server rvs hiprvs.infrahip.net 50000 # Register to free RVS at infrahip
+# heartbeat 10 # send ICMPv6 messages inside HIP tunnels
+# locator on        # host sends all of its locators in base exchange
+# shotgun on # use all possible src/dst IP combinations to send I1/UPDATE
+# broadcast on # broadcast to LAN if no matching IP address found
+# opp normal|advanced|none
+# transform order 213 # crypto preference order (1=AES, 2=3DES, 3=NULL)
+nat plain-udp       # use UDP capsulation (for NATted environments)
+#nat port local 11111 # change local default UDP port
+#nat port peer 22222 # change local peer UDP port
+debug medium        # debug verbosity: all, medium, low or none

=== added file 'hipd/hosts'
--- hipd/hosts	1970-01-01 00:00:00 +0000
+++ hipd/hosts	2011-12-06 12:31:24 +0000
@@ -0,0 +1,4 @@
+# This file stores the HITs of the hosts, in a similar fashion to /etc/hosts.
+# The aliases are optional.  Examples:
+#2001:1e:361f:8a55:6730:6f82:ef36:2fff kyle kyle.com # This is a HIT with alias
+#2001:17:53ab:9ff1:3cba:15f:86d6:ea2e kenny       # This is a HIT without alias

=== modified file 'hipd/init.c'
--- hipd/init.c	2011-11-29 11:37:54 +0000
+++ hipd/init.c	2011-12-06 12:31:24 +0000
@@ -141,117 +141,6 @@
 }
 
 /**
- * Create a file with the given contents unless it already exists
- *
- * @param path the file with its path
- * @param contents a string to write to the file
- */
-static void create_file_unless_exists(const char *path, const char *contents)
-{
-    struct stat status;
-    FILE       *fp;
-    size_t      items;
-
-    if (stat(path, &status) == 0) {
-        return;
-    }
-
-    fp = fopen(path, "w");
-    HIP_ASSERT(fp);
-    items = fwrite(contents, strlen(contents), 1, fp);
-    HIP_ASSERT(items > 0);
-    fclose(fp);
-}
-
-#define HIPL_CONFIG_FILE_EX \
-    "# Format of this file is as with hipconf, but without \"hipconf daemon\" prefix\n\
-# add hi default    # add all four HITs (see bug id 592127)\n\
-# add map HIT IP    # preload some HIT-to-IP mappings to hipd\n\
-# add service rvs   # the host acts as HIP rendezvous (also see relay.conf)\n\
-# add server rvs [RVS-HIT] <RVS-IP-OR-HOSTNAME> <lifetime-secs> # register to rendezvous server\n\
-# add server relay [RELAY-HIT] <RVS-IP-OR-HOSTNAME> <lifetime-secs> # register to relay server\n\
-# add server full-relay [RELAY-HIT] <RVS-IP-OR-HOSTNAME> <lifetime-secs> # register to relay server\n\
-hit-to-ip on # resolve HITs to locators in dynamic DNS zone\n\
-# hit-to-ip set hit-to-ip.infrahip.net. # resolve HITs to locators in dynamic DNS zone\n\
-nsupdate on # send dynamic DNS updates\n\
-# add server rvs hiprvs.infrahip.net 50000 # Register to free RVS at infrahip\n\
-# heartbeat 10 # send ICMPv6 messages inside HIP tunnels\n\
-# locator on        # host sends all of its locators in base exchange\n\
-# shotgun on # use all possible src/dst IP combinations to send I1/UPDATE\n\
-# broadcast on # broadcast to LAN if no matching IP address found\n\
-# opp normal|advanced|none\n\
-# transform order 213 # crypto preference order (1=AES, 2=3DES, 3=NULL)\n\
-nat plain-udp       # use UDP capsulation (for NATted environments)\n\
-#nat port local 11111 # change local default UDP port\n\
-#nat port peer 22222 # change local peer UDP port\n\
-debug medium        # debug verbosity: all, medium, low or none\n"
-
-#define HIPL_HOSTS_FILE_EX \
-    "# This file stores the HITs of the hosts, in a similar fashion to /etc/hosts.\n\
-# The aliases are optional.  Examples:\n\
-#2001:1e:361f:8a55:6730:6f82:ef36:2fff kyle kyle.com # This is a HIT with alias\n\
-#2001:17:53ab:9ff1:3cba:15f:86d6:ea2e kenny       # This is a HIT without alias\n"
-
-#define HIPL_NSUPDATE_CONF_FILE     HIPL_SYSCONFDIR "/nsupdate.conf"
-
-#define HIPL_NSUPDATE_CONF_FILE_EX \
-    "##########################################################\n" \
-    "# configuration examples\n" \
-    "##########################################################\n" \
-    "# update records for 5.7.d.1.c.c.8.d.0.6.3.b.a.4.6.2.5.0.5.2.e.4.7.5.e.1.0.0.1.0.0.2.hit-to-ip.infrahip.net.\n" \
-    "# $HIT_TO_IP_ZONE = 'hit-to-ip.infrahip.net.';\n" \
-    "# or in some other zone\n" \
-    "# $HIT_TO_IP_ZONE = 'hit-to-ip.example.org.';\n" \
-    "\n" \
-    "# update is sent to SOA if server empty\n" \
-    "# $HIT_TO_IP_SERVER = '';\n" \
-    "# or you may define it \n" \
-    "# $HIT_TO_IP_SERVER = 'ns.example.net.';\n" \
-    "\n" \
-    "# name of key if you configured it on the server\n" \
-    "# please also chown this file to nobody and chmod 400\n" \
-    "# $HIT_TO_IP_KEY_NAME='key.hit-to-ip';\n" \
-    "# $HIT_TO_IP_KEY_NAME = '';\n" \
-    "\n" \
-    "# secret of that key\n" \
-    "# $HIT_TO_IP_KEY_SECRET='Ousu6700S9sfYSL4UIKtvnxY4FKwYdgXrnEgDAu/rmUAoyBGFwGs0eY38KmYGLT1UbcL/O0igGFpm+NwGftdEQ==';\n" \
-    "# $HIT_TO_IP_KEY_SECRET = '';\n" \
-    "\n" \
-    "# TTL inserted for the records\n" \
-    "# $HIT_TO_IP_TTL = 1;\n" \
-    "###########################################################\n" \
-    "# domain with ORCHID prefix \n" \
-    "# $REVERSE_ZONE = '1.0.0.1.0.0.2.ip6.arpa.'; \n" \
-    "# \n" \
-    "# $REVERSE_SERVER = 'ptr-soa-hit.infrahip.net.'; # since SOA 1.0.0.1.0.0.2.ip6.arpa. is dns1.icann.org. now\n" \
-    "# $REVERSE_KEY_NAME = '';\n" \
-    "# $REVERSE_KEY_SECRET = '';\n" \
-    "# $REVERSE_TTL = 86400;\n" \
-    "# System hostname is used if empty\n" \
-    "# $REVERSE_HOSTNAME = 'stargazer-hit.pc.infrahip.net';\n" \
-    "###########################################################\n"
-
-/**
- * load hipd configuration files
- */
-static void load_configuration(void)
-{
-    const char *cfile = "default";
-
-    create_file_unless_exists(HIPL_CONFIG_FILE, HIPL_CONFIG_FILE_EX);
-
-    create_file_unless_exists(HIPL_HOSTS_FILE, HIPL_HOSTS_FILE_EX);
-
-    create_file_unless_exists(HIPL_NSUPDATE_CONF_FILE, HIPL_NSUPDATE_CONF_FILE_EX);
-
-    /* Load the configuration. The configuration is loaded as a sequence
-     * of hipd system calls. Assumably the user socket buffer is large
-     * enough to buffer all of the hipconf commands.. */
-
-    hip_conf_handle_load(NULL, 0, &cfile, 1, 1);
-}
-
-/**
  * initialize OS-dependent variables
  */
 static void set_os_dep_variables(void)
@@ -1145,7 +1034,11 @@
                   sizeof(daemon_addr)), -1,
              "Bind on daemon addr failed\n");
 
-    load_configuration();
+    const char *cfile = "default";
+    if (hip_conf_handle_load(NULL, 0, &cfile, 1, 1) == -1) {
+        HIP_ERROR("Loading configuration file failed.\n");
+        return -1;
+    }
 
     certerr = 0;
     certerr = init_certs();

=== added file 'hipd/nsupdate.conf'
--- hipd/nsupdate.conf	1970-01-01 00:00:00 +0000
+++ hipd/nsupdate.conf	2011-12-06 12:31:24 +0000
@@ -0,0 +1,35 @@
+##########################################################
+# configuration examples
+##########################################################
+# update records for 5.7.d.1.c.c.8.d.0.6.3.b.a.4.6.2.5.0.5.2.e.4.7.5.e.1.0.0.1.0.0.2.hit-to-ip.infrahip.net.
+# $HIT_TO_IP_ZONE = 'hit-to-ip.infrahip.net.';
+# or in some other zone
+# $HIT_TO_IP_ZONE = 'hit-to-ip.example.org.';
+
+# update is sent to SOA if server empty
+# $HIT_TO_IP_SERVER = '';
+# or you may define it 
+# $HIT_TO_IP_SERVER = 'ns.example.net.';
+
+# name of key if you configured it on the server
+# please also chown this file to nobody and chmod 400
+# $HIT_TO_IP_KEY_NAME='key.hit-to-ip';
+# $HIT_TO_IP_KEY_NAME = '';
+
+# secret of that key
+# $HIT_TO_IP_KEY_SECRET='Ousu6700S9sfYSL4UIKtvnxY4FKwYdgXrnEgDAu/rmUAoyBGFwGs0eY38KmYGLT1UbcL/O0igGFpm+NwGftdEQ==';
+# $HIT_TO_IP_KEY_SECRET = '';
+
+# TTL inserted for the records
+# $HIT_TO_IP_TTL = 1;
+###########################################################
+# domain with ORCHID prefix 
+# $REVERSE_ZONE = '1.0.0.1.0.0.2.ip6.arpa.'; 
+# 
+# $REVERSE_SERVER = 'ptr-soa-hit.infrahip.net.'; # since SOA 1.0.0.1.0.0.2.ip6.arpa. is dns1.icann.org. now
+# $REVERSE_KEY_NAME = '';
+# $REVERSE_KEY_SECRET = '';
+# $REVERSE_TTL = 86400;
+# System hostname is used if empty
+# $REVERSE_HOSTNAME = 'stargazer-hit.pc.infrahip.net';
+###########################################################

=== modified file 'packaging/hipl.spec'
--- packaging/hipl.spec	2011-12-01 21:29:13 +0000
+++ packaging/hipl.spec	2011-12-06 12:31:24 +0000
@@ -154,6 +154,9 @@
 %{_sbindir}/pisacert
 %{_sbindir}/nsupdate.pl
 %{_initddir}/hipd
+%config(noreplace) %{_sysconfdir}/hip/hipd.conf
+%config(noreplace) %{_sysconfdir}/hip/hosts
+%config(noreplace) %{_sysconfdir}/hip/nsupdate.conf
 
 %files dnsproxy
 %{_sbindir}/hipdnsproxy

=== modified file 'packaging/openwrt/hipl/Makefile.in'
--- packaging/openwrt/hipl/Makefile.in	2011-12-01 13:34:53 +0000
+++ packaging/openwrt/hipl/Makefile.in	2011-12-06 12:31:24 +0000
@@ -73,6 +73,9 @@
 	$(INSTALL_BIN) $(PKG_INSTALL_DIR)/usr/sbin/hipd $(1)/usr/sbin/
 	$(INSTALL_BIN) $(PKG_INSTALL_DIR)/usr/sbin/hipconf $(1)/usr/sbin/
 	$(INSTALL_BIN) $(PKG_INSTALL_DIR)/usr/sbin/hipdnsproxy $(1)/usr/sbin/
+	$(INSTALL_DATA) $(PKG_INSTALL_DIR)/etc/hip/hipd.conf $(1)/etc/hip/
+	$(INSTALL_DATA) $(PKG_INSTALL_DIR)/etc/hip/hosts $(1)/etc/hip/
+	$(INSTALL_DATA) $(PKG_INSTALL_DIR)/etc/hip/nsupdate.conf $(1)/etc/hip/
 endef
 
 define Package/hipl-firewall/install