This is the port of OpenBSD's iked to Darwin/OS X and other operating systems (see "Supported Platforms").

This fork/branch is for developing the portable version. It has recently been updated and is now based on an up-to-date version of OpenBSD's native iked. It has been tested on recent versions of NetBSD and works on NetBSD with some limitations (see "Caveats, bugs and limitations").

iked is a lean Internet Key Exchange (IKEv2) daemon which performs mutual authentication and which establishes and maintains IPsec VPN flows and security associations (SAs) between the two peers. The IKEv2 protocol is defined in RFC 5996, which combines and updates the previous standards: ISAKMP/Oakley (RFC 2408), IKE (RFC 2409), and the Internet DOI (RFC 2407). iked only supports the IKEv2 protocol; support for ISAKMP/Oakley and IKEv1 is provided by OpenBSD's isakmpd(8) or other implementations on non-OpenBSD platforms.

iked supports mutual authentication using RSA public keys and X.509 certificates, it also support responder/server-side authentication of clients using the EAP-MSCHAPv2 protocol over IKEv2. It interconnects with other IKEv2 implementations like the native IKEv2 implementation of Windows 7 or newer (aka Agile VPN) or strongSwan.

The main development of iked is being done for OpenBSD and the source tree is found in OpenBSD's CVS repository. This port adds replacements for OpenBSD-specific library functions and portability code for other platforms. Like most of the projects from the OpenBSD repository, the original source code does not include any portability glue (#ifdefs) and is specifically developed for OpenBSD. This external repository adds all the portable extensions to run it on other supported platforms.

The main development tree is found in the src/sbin/iked and src/usr.sbin/ikectl directories of the OpenBSD CVS repository:

• https://www.openbsd.org/cgi-bin/cvsweb/src/sbin/iked/
• https://www.openbsd.org/cgi-bin/cvsweb/src/usr.sbin/ikectl/
• See also: https://www.openiked.org/

The portable version of OpenIKED uses the GNU autoconf environment to build and install from the sources. As usual, follow these basic steps to install OpenIKED:

1. Requirements:
   • Make sure that the external libraries OpenSSL (version 1.0 or newer) and libevent (version 1.4 or newer) with their header files are installed.
   • If you're checking out the sources from the Git repository, you will also need GNU automake, autoconf (version 2.69 or newer) and libtool.
2. Enter the top directory of the extracted sources.
3. If you checked out the sources from the Git repository, run sh bootstrap to generate the required build files.
4. Run ./configure in this directory to generate the Makefiles.
   • ./configure --help will show you some available build options.
   • For example, you can run the following when building on Apple OSX with MacPorts:

    ./configure --with-ssl-dir=/opt/local/
        --with-libevent-dir=/opt/local/lib/libevent1/
        --prefix=/opt/local/

5. Type make to build all parts of OpenIKED including iked and ikectl.

6. Type make install to install OpenIKED, or sudo make install if you didn't compile OpenIKED as root.

7. Run something like the following to create iked's unprivileged system user and environment. Note that the command syntax and user name might vary on different platforms - use "iked" instead of "_iked" on Linux.

	# mkdir /var/empty
	# chown root:sys /var/empty
	# chmod 755 /var/empty
	# groupadd _iked
	# useradd -g _iked -c 'iked privsep' -d /var/empty -s /sbin/nologin _iked

8. On FreeBSD, NetBSD and maybe other BSD-variants IPsec is not enabled in the default GENERIC kernel. You have to compile a custom kernel and enable options like IPSEC. Please refer to the individual documentation for details, for example:

• https://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/ipsec.html
• https://www.netbsd.org/docs/network/ipsec/#config_kernel

Original version:

• OpenBSD 4.8 or newer

Portable version:

• Darwin (Apple OS X Mountain Lion 10.8)
• Linux (Ubuntu 12.10 GNU/Linux 3.5.0-19-generic)
• FreeBSD (FreeBSD 9.0-RELEASE with IPSEC kernel)
• NetBSD (NetBSD 9 or later)
• TODO: other BSDs and PFKEYv2/KAME-based platforms.

The source tree of OpenIKED contains the following directories:

• openiked/: Build scripts for automake/autoconf and README files.
• openiked/ikectl/: The control and status utility for iked.
• openiked/iked/: The IKEv2 daemon itself and some files that are shared with ikectl.
• openiked/openbsd-compat/: Portability glue and API functions for non-OpenBSD platforms.

You can checkout the portable code from GitHub:

$ git clone git:https://github.com/reyk/openiked.git

And compare the contents of the iked and ikectl directories in the git repository with the original sources in OpenBSD's (Anon)CVS repository by running the cvs diff command in these subdirectories. This will show you the differences between the portable version and the unpatched OpenBSD version:

$ cd openiked/iked/
$ cvs diff -Nup | tee ../iked.diff
$ cd ../ikectl/
$ cvs diff -Nup | tee ../ikectl.diff

Before you continue with looking at the code or writing any diffs, you should study OpenBSD's source style guide; or the "KNF". You can find it in OpenBSD's style(9) manpage or online at: https://www.openbsd.org/cgi-bin/man.cgi?query=style&sektion=9. Please also note that each line should be at most 80 characters long.

• Reyk Floeter [email protected]
• Mike Belopuhov [email protected]

See LICENSE.md for information about copyright and licensing.

This is work in progress! OpenIKED is not yet finished and is missing some important security features. It should not yet be used in production networks.

OpenIKED might have a few limitations on operating systems other than the most recent versions of OpenBSD. A major difference between OpenBSD and other systems is the API and availability of the IPsec PFKEYv2 flow implementation (SADB) and message passing between kernel and iked. Current known limitations are:

• IPv6 and MOBIKE support: Features dependent on OpenBSD's native pfkey implementation may not work. Recently, support for IPv6 flows has been added for NetBSD. MOBIKE support has been added to the native OpenBSD version but has not yet been tested in this portable version.

• NAT-T: NAT-T is only supported on OpenBSD, Darwin (OS X), and NetBSD. The NAT-T API is not standardized in PFKEYv2, not even on a semi-level, and differs in most operating systems, if supported at all.

• Integration with OpenBSD specific components: Support for integration with the OpenBSD enc device and the OpenBSD packet filter tagging feature is not available on systems lacking these components.

• Crypto algorithms: Some of the crypto algorithms are either not supported on other systems or not implemented correctly. For example, Linux still uses the broken pre-standard version of hmac-sha2-256 by default that was specified with 96 bit truncation instead of the standard 128 bit truncation. The common workaround that allows to specify the truncation length would be to use Linux' non-standard XFRM kernel API instead of PFKEYv2.

Reyk