mfarif / kneecap Goto Github PK

Kneecap enables you to generate network packets from a high-level logical spec such as this example:

eth.constrain <@ ethernet.source_address = ethernet.mac_address "[1-5,10]:34:56:78:90:*" &&
                     ethernet.ethertype = ethernet.ethertype_ipv4 @>
    <== ip.constrain <@@ ipv4.version = 4 &&
                         ipv4.source_address = ipv4.ipv4_address "10.10.10.[55-60]" &&
                         ipv4.source_address = ipv4.destination_address &&
                         ipv4.internet_header_length = 5 &&
                         ipv4.total_length = 170 &&
                         ipv4.TTL = 5 &&
                         ipv4.protocol = ipv4.protocol_ip_in_ip
                         (*ipv4.source_address < ipv4.destination_address*)
                      @@>

This example describes an IPv4 packet encapsulated inside an Ethernet frame, and specifies constraints on both layers. This spec is translated into bitvector constraints that are given to an SMT solver. Solutions returned by the solver correspond to network packets. You can find out more by reading the paper.

Kneecap provides an API for generating packets. It comes with a sample program that generates packets using Kneecap and then saves them in the pcap file format. You can view these files' contents using tools like Wireshark or various others. This section contains example output files from this sample program.

• ethernet_64_1.pcap
• ethernet_64_2.pcap
• ethernet_64_3.pcap
• ethernet_64_4.pcap

• ethernet_584_1.pcap
• ethernet_584_2.pcap
• ethernet_584_3.pcap
• ethernet_584_4.pcap

• stack_6_1000.pcap

• Z3 (version 4.x). Download the source from Z3's release archive.
• Mono runtime and F# compiler.

I ran this on Ubuntu 14 (using Mono 3.2.8) and OSX 10.10.5 (using Mono 3.8.0), but the process should be similar on other systems.

Let $KNEECAP_DIR be the path of your Kneecap repo clone.

1. Get a Z3 release from https://github.com/Z3Prover/z3/releases and build it.

# go to directory where you've untarred Z3.
export Z3_DIR=`pwd`
./configure
cd build; make

Note: On OSX I gave the --x86 command-line flag to ./configure, since for some reason the version of Mono I'm using expected Z3's DLL to be compiled for 32.bit

2. Build the managed wrapper to Z3.

cd ../src/api/dotnet
msbuild Microsoft.Z3.csproj

3. We will use Z3 to build Kneecap. Copy files over.

cp ${Z3_DIR}/src/api/dotnet/obj/Debug/Microsoft.Z3.dll ${KNEECAP_DIR}

4. Build Kneecap

cd ${KNEECAP_DIR}
msbuild kneecap.sln

$ MONO_PATH=${MONO_PATH}:${KNEECAP_DIR}/kneecap/ mono ${KNEECAP_DIR}/kneet/bin/Debug/kneet.exe

You should see a list of numbers counting up to a thousand, at the end of which the program will terminate. Each of the numbers corresponded to a packet being generated, which was recorded in a .pcap file in your directory.

Mono might complain that it cannot find certain files. Sometimes such error messages can be misleading: Mono can find the files, but they don't contain what it expected to find. Set MONO_LOG_LEVEL=debug in your environment to have Mono tell you more.