ryan
/
wirenix
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

improved documentation

Browse Source
release
Matthew Salerno 1 year ago
parent 0a3ebc78df
commit 695a65b8d0
7 changed files with 289 additions and 12 deletions
Show Stats Download Patch File Download Diff File

2
readme.md → README.md
Unescape Escape View File

@ -97,6 +97,8 @@ type peer = {
ipAddresses?: str[]; ipAddresses?: str[];
extraArgs?: any; extraArgs?: any;
}; };
publicKey: string;
privateKeyFile: string;
groups?: str[]; groups?: str[];
endpoints?: endpoint[]; endpoints?: endpoint[];
extraArgs?: any; extraArgs?: any;

74
examples/fullMesh/acl.nix
Unescape Escape View File

@ -0,0 +1,74 @@
{
version = "v1";
subnets = [
{
name = "myMesh";
endpoints = [
{
# No match mean match any
port = 51820;
}
];
}
];
groups = [
# groups field is expected, but can be empty
];
peers = [
{
name = "peer1";
subnets = {
myMesh = {
listenPort = 51820;
# empty ipAddresses will auto generate an IPv6 address
};
};
publicKey = "t2kmvyJbDle433HCUlP48HxGlLdd8HyiRi2y8aYvTV8=";
privateKeyFile = "/path/to/private/key"; # path is relative to the machine
endpoints = [
{
# no match can be any
ip = "192.168.1.11";
}
];
}
{
name = "peer2";
subnets = {
myMesh = {
listenPort = 51820;
};
};
publicKey = "xTiftEK/lzqxJYtbH8tt8yINEnSq7tTEN46hXTr9X2M=";
privateKeyFile = "/path/to/private/key";
endpoints = [
{
# no match can be any
ip = "192.168.1.12";
}
];
}
{
name = "peer3";
subnets = {
myMesh = {
listenPort = 51820;
};
};
endpoints = [
{
# no match can be any
ip = "192.168.1.13";
}
];
publicKey = "jSp9uutNwpNHn1XjeQb9ixCixBSjvsRi2uYIiM2LORE=";
privateKeyFile = "/path/to/private/key";
}
];
connections = [
{
a = [{type= "subnet"; rule = "is"; value = "myMesh";}];
b = [{type= "subnet"; rule = "is"; value = "myMesh";}];
}
];
}

106
examples/ring/acl.nix
Unescape Escape View File

@ -0,0 +1,106 @@
{
version = "v1";
subnets = [
{
name = "myRing";
endpoints = [
{
# No match means match any
port = 51820;
}
];
}
];
groups = [
# groups field is expected, but can be empty
];
peers = [
{
name = "peer1";
subnets = {
myRing = {
listenPort = 51820;
# empty ipAddresses will auto generate an IPv6 address
};
};
publicKey = "2CMNhw0CU2iFwKZvKT3dnqviBTKbJtuq5SNZvQpXCDY=";
privateKeyFile = "/path/to/private/key"; # path is relative to the machine
endpoints = [
{
# no match can be any
ip = "192.168.1.11";
}
];
}
{
name = "peer2";
subnets = {
myRing = {
listenPort = 51820;
};
};
publicKey = "nU97PJin1r+g/jk4Jm9+xd0ibZKErESNeav4VjOQKlc=";
privateKeyFile = "/path/to/private/key";
endpoints = [
{
# no match can be any
ip = "192.168.1.12";
}
];
}
{
name = "peer3";
subnets = {
myRing = {
listenPort = 51820;
};
};
endpoints = [
{
# no match can be any
ip = "192.168.1.13";
}
];
publicKey = "FNdLup5glVp5dlynS4ker75i+fIIJPs4ri5vQ+9sGnE=";
privateKeyFile = "/path/to/private/key";
}
{
name = "peer4";
subnets = {
myRing = {
listenPort = 51820;
};
};
publicKey = "Xa+AhcRbAdOufv5mEwR8V5GDkJ+AiRMxTjtAwmWBCVI=";
privateKeyFile = "/path/to/private/key";
endpoints = [
{
# no match can be any
ip = "192.168.1.14";
}
];
}
];
connections = [
{
# Connections go both ways, no need to do a = peer2 and b = peer1
a = [{type= "peer"; rule = "is"; value = "peer1";}];
b = [{type= "peer"; rule = "is"; value = "peer2";}];
}
{
# Connections go both ways, no need to do a = peer2 and b = peer1
a = [{type= "peer"; rule = "is"; value = "peer2";}];
b = [{type= "peer"; rule = "is"; value = "peer3";}];
}
{
# Connections go both ways, no need to do a = peer2 and b = peer1
a = [{type= "peer"; rule = "is"; value = "peer3";}];
b = [{type= "peer"; rule = "is"; value = "peer4";}];
}
{
# Connections go both ways, no need to do a = peer2 and b = peer1
a = [{type= "peer"; rule = "is"; value = "peer4";}];
b = [{type= "peer"; rule = "is"; value = "peer1";}];
}
];
}

90
examples/spoke/acl.nix
Unescape Escape View File

@ -0,0 +1,90 @@
{
version = "v1";
subnets = [
{
name = "mySpoke";
endpoints = [
{
# No match means match any
port = 51820;
}
];
}
];
groups = [
# groups field is expected, but can be empty
];
peers = [
{
name = "central";
subnets = {
mySpoke = {
listenPort = 51820;
# empty ipAddresses will auto generate an IPv6 address
};
};
publicKey = "whST3RRJziiQTIizeQW6z8fCtoiBfHK559WCY2RS4GQ=";
privateKeyFile = "/path/to/private/key"; # path is relative to the machine
endpoints = [
{
# no match can be any
ip = "192.168.1.11";
}
];
}
{
name = "leaf1";
subnets = {
mySpoke = {
listenPort = 51820;
};
};
publicKey = "AgsXp89XUz545KRZiNzCYw1Jr6WC5zIfKZnq5M+UUkM=";
privateKeyFile = "/path/to/private/key";
endpoints = [
{
# no match can be any
ip = "192.168.1.12";
}
];
}
{
name = "leaf2";
subnets = {
mySpoke = {
listenPort = 51820;
};
};
endpoints = [
{
# no match can be any
ip = "192.168.1.13";
}
];
publicKey = "1fn/kD11tWPc5VFAZn30PDM4nPoZoGPBEoVFnQdx62o=";
privateKeyFile = "/path/to/private/key";
}
{
name = "leaf3";
subnets = {
mySpoke = {
listenPort = 51820;
};
};
publicKey = "z5IfD9joAexurf2TyoKd49LrRFRN4JyCCPBAOJXqlGc=";
privateKeyFile = "/path/to/private/key";
endpoints = [
{
# no match can be any
ip = "192.168.1.14";
}
];
}
];
connections = [
{
a = [{type= "subnet"; rule = "is"; value = "mySpoke";}];
b = [{type= "peer"; rule = "is"; value = "central";}];
}
];
}

4
flake.nix
Unescape Escape View File

@ -3,7 +3,7 @@
outputs = { self, ... }: outputs = { self, ... }:
{ {
lib = import ./lib.nix; wirenix.lib = import ./lib.nix;
nixosModules.myModule = import ./wire.nix; nixosModules.default = import ./wire.nix;
}; };
} }

13
lib.nix
Unescape Escape View File

@ -3,6 +3,17 @@ with builtins;
ACL independent functions that can be used in parsers. ACL independent functions that can be used in parsers.
*/ */
rec { rec {
/** Builtin Parsers */
defaultParsers = {
v1 = import ./parsers/v1.nix;
};
/** Builtin configurers */
defaultConfigurers = rec {
auto = static; # TODO: make smart
static = import ./configurers/static.nix;
networkd = import ./configurers/networkd.nix;
networkmanager = import ./configurers/networkmanager.nix;
};
/** listOfSetsToSetByKey :: string -> list -> attrSet /** listOfSetsToSetByKey :: string -> list -> attrSet
* Example: * Example:
* listOfSetsToSetByKey "primary" [ {primary = "foo"; secondary = 1; tertiary = "one"} {primary = "bar"; secondary = 2; tertiary = "two"} ] * listOfSetsToSetByKey "primary" [ {primary = "foo"; secondary = 1; tertiary = "one"} {primary = "bar"; secondary = 2; tertiary = "two"} ]
@ -15,7 +26,7 @@ rec {
value = removeAttrs item [ key ]; value = removeAttrs item [ key ];
}) list }) list
); );
/** */ /** Like listOfSetsToSetByKey, but also performs a map before dropping the key */
mapListOfSetsToSetByKey = key: function: list: mapListOfSetsToSetByKey = key: function: list:
mapAttrs (name: value: removeAttrs (function value) [key]) ( mapAttrs (name: value: removeAttrs (function value) [key]) (
listToAttrs ( listToAttrs (

12
wire.nix
Unescape Escape View File

@ -1,5 +1,6 @@
{ config, lib, ... }@inputs: { config, lib, ... }@inputs:
with lib; with lib;
with import ./lib.nix;
{ {
options = { options = {
wirenix = { wirenix = {
@ -58,15 +59,8 @@ with lib;
config = config =
let let
configurers = rec { configurers = defaultConfigurers // config.modules.wirenix.additionalConfigurers;
auto = static; parsers = defaultParsers // config.modules.wirenix.additionalParsers;
static = import ./configurers/static.nix;
networkd = import ./configurers/networkd.nix;
networkmanager = import ./configurers/networkmanager.nix;
} // config.modules.wirenix.additionalConfigurers;
parsers = {
v1 = import ./parsers/v1.nix;
} // config.modules.wirenix.additionalParsers;
acl = config.modules.wirenix.aclConfig; acl = config.modules.wirenix.aclConfig;
parser = parsers."${acl.version}" inputs; parser = parsers."${acl.version}" inputs;
configurer = configurers."${config.modules.wirenix.configurer}" inputs; configurer = configurers."${config.modules.wirenix.configurer}" inputs;

Write Preview
Loading…
Cancel
Save