# Netkit SDK

![Build Status](https://github.com/radams15/netkit-sdk/actions/workflows/build-package.yaml/badge.svg)

A more verbose yet more understandable way to create netkit machines using code.

Written in Perl, with few dependencies.

Generates a standalone netkit lab from a selection of configurable objects.

Allows configurations of:

- LANs
- Interface attachments
- Static Routes
- Firewall rules
- NAT rules

Other elements of startup files can be added using the Machine extra field.

## Example Lab

Place machine data folders in the ./data directory, run `perl main.pl`, and a lab folder appears in the ./res directory.

```perl
#!/usr/bin/perl

use strict;
use warnings;

use Machine;
use Lan;
use Lab;
use Interface;
use Route;
use Attachment;

my $lab = Lab->new(
	name => 'TestLab',
	out_dir => 'res',
	data_dir => 'data',
);


my $ext_www_lan = Lan->new('ExtWWW');
my $dmz_lan = Lan->new('Dmz');
my $staff_lan = Lan->new('Staff');

my $r2 = Machine->new(
	name => 'r2',
	interfaces => [
		Interface->new(
			eth => 0,
			ip => '192.168.0.3/24',
			mac => 'a8:20:66:2d:30:bf',
		),
		Interface->new(
			eth => 1,
			ip => '10.0.0.1/20',
			mac => 'a8:20:66:3e:42:cf',
		),
	],
	routes => [
		Route->new(
			dst => 'default',
			via => '192.168.0.1'
		),
		Route->new(
			dst => '172.16.0.0/24',
			via => '192.168.0.2'
		),
	],
	attachments => [
		Attachment->new(
			lan => $dmz_lan,
			eth => 0
		),
		Attachment->new(
			lan => $staff_lan,
			eth => 1
		),
	],
	rules => [
		Rule->new(
			policy => 'FORWARD DROP',
		),
	],
);

my $gw = Machine->new(
	name => 'gw',
	interfaces => [
		Interface->new(
			eth => 0,
			ip => '80.64.157.254',
		),
		Interface->new(
			eth => 1,
			ip => '192.168.0.1/24',
		),
	],
	routes => [
		Route->new(
			dst => '172.16.0.0/24',
			via => '192.168.0.2'
		),
		Route->new(
			dst => '10.0.0.0/20',
			via => '192.168.0.3'
		),
	],
	attachments => [
		Attachment->new(
			lan => $ext_www_lan,
			eth => 0
		),
		Attachment->new(
			lan => $dmz_lan,
			eth => 1
		),
	],
	rules => [
		Rule->new(
			policy => 'FORWARD DROP',
		)
	],
);

my $staff_1 = Machine->new(
	name => 'Staff-1',
	interfaces => [
		Interface->new(
			eth => 0,
			ip => '10.0.0.5/20',
			mac => 'a8:30:67:3f:42:cf',
		),
	],
	routes => [
		Route->new(
			dst => 'default',
			via => '10.0.0.1'
		),
	],
	attachments => [
		Attachment->new(
			lan => $staff_lan,
			eth => 0,
		),
	],
);

for my $port (25, 587, 993) {
	$gw->rule(
		Rule->new(
			chain => 'FORWARD',
			stateful => 1,
			proto => 'tcp',
			dst => '172.16.0.6',
			dport => $port,
			action => 'ACCEPT',
		)
	);
	
	$gw->rule(
		Rule->new(
				table => 'nat',
				chain => 'PREROUTING',
				proto => 'tcp',
				to_dst => '172.16.0.6',
				dport => $port,
				action => 'DNAT',
		)
	);
}

$lab->dump($staff_1, $r2, $gw);
```