Remove yevaud from DNS
[dns.git] / bin / mkgeo
1 #!/usr/bin/perl
2
3 use strict;
4 use warnings;
5
6 use IO::File;
7 use Math::Trig qw(deg2rad pip2 great_circle_distance);
8 use JSON::XS;
9 use LWP::UserAgent;
10 use YAML;
11
12 my $originfile = shift @ARGV;
13 my $clusterfile = shift @ARGV;
14 my $zone = shift @ARGV;
15 my $targetoriginfile = shift @ARGV;
16 my $origins = YAML::LoadFile($originfile);
17 my $clusters = YAML::LoadFile($clusterfile);
18 my $gdnsname = shift @ARGV;
19 my @servers;
20
21 # Initialise cluster details
22 while (my($name,$cluster) = each %$clusters)
23 {
24     if ($cluster->{servers})
25     {
26         $cluster->{bandwidth} = 0;
27
28         foreach my $server (@{$cluster->{servers}})
29         {
30             $server->{cluster} = $cluster;
31             $cluster->{bandwidth} = $cluster->{bandwidth} + $server->{bandwidth};
32
33             push @servers, $server;
34         }
35     }
36     else
37     {
38         my $server = {
39             cluster => $cluster,
40             statuscake => $cluster->{statuscake},
41             bandwidth => $cluster->{bandwidth},
42             ipv4 => $cluster->{ipv4},
43             ipv6 => $cluster->{ipv6}
44         };
45
46         $cluster->{servers} = [ $server ];
47
48         push @servers, $server;
49     }
50
51     $cluster->{name} = $name;
52     $cluster->{status} = "down";
53 }
54
55 # Initialise server details
56 foreach my $server (@servers)
57 {
58     $server->{status} = "up";
59 }
60
61 # If statuscake support is enabled then check which servers are up
62 if ($ENV{STATUSCAKE_USERNAME} && $ENV{STATUSCAKE_APIKEY})
63 {
64     my $ua = LWP::UserAgent->new;
65     my $cache;
66
67     $ua->agent("mkgeo/1.0");
68     $ua->default_header("Username", $ENV{STATUSCAKE_USERNAME});
69     $ua->default_header("API", $ENV{STATUSCAKE_APIKEY});
70
71     if (-f "statuscake.yml")
72     {
73         $cache = YAML::LoadFile("statuscake.yml");
74     }
75     else
76     {
77         $cache = {};
78     }
79
80     my $response = $ua->get("https://app.statuscake.com/API/Tests/");
81
82     if ($response->is_success)
83     {
84         my $tests = decode_json($response->content);
85
86         foreach my $test (@$tests)
87         {
88             my $testid = $test->{TestID};
89
90             if ($test->{Status} eq "Up" && !$test->{Paused})
91             {
92                 $cache->{$testid} = "up";
93             }
94             else
95             {
96                 $cache->{$testid} = "down";
97             }
98         }
99     }
100
101     foreach my $server (@servers)
102     {
103         if (my $testids = $server->{statuscake})
104         {
105             $server->{status} = "up";
106
107             for my $testid (@$testids)
108             {
109                 my $testresult = $cache->{$testid} || "down";
110
111                 $server->{status} = "down" if $testresult eq "down";
112             }
113         }
114         else
115         {
116             $server->{status} = "down";
117         }
118     }
119
120     YAML::DumpFile("statuscake.yml", $cache);
121 }
122
123 # Mark a cluster as up if any servers are up
124 foreach my $server (@servers)
125 {
126     if ($server->{status} eq "up")
127     {
128         $server->{cluster}->{status} = "up";
129     }
130     else
131     {
132         $server->{cluster}->{bandwidth} = $server->{cluster}->{bandwidth} - $server->{bandwidth};
133     }
134 }
135
136 # Create target origins object
137 my $targetorigins = {};
138
139 # Initialise cluster details
140 while (my($name,$cluster) = each %$clusters)
141 {
142     $cluster->{bandwidth_limit} = $cluster->{bandwidth} * 1024 * 1024;
143     $cluster->{bandwidth_used} = 0;
144
145     $targetorigins->{$cluster->{name}} = {
146         code => $cluster->{name},
147         name => $cluster->{name},
148         lat => $cluster->{lat},
149         lon => $cluster->{lon},
150         bandwidth => 0
151     };
152 }
153
154 my @mappings = ();
155
156 # Scan origins and work out which clusters each can use
157 foreach my $origin (values %$origins)
158 {
159     foreach my $cluster (values %$clusters)
160     {
161         my $match = match_origin($cluster, $origin);
162
163         if ($cluster->{status} eq "up" && $match ne "denied")
164         {
165             my $priority = $match eq "preferred" ? 20 : 10;
166             my $distance = distance($origin->{lat}, $origin->{lon}, $cluster->{lat}, $cluster->{lon});
167
168             push @mappings, {
169                 origin => $origin, cluster => $cluster,
170                 priority => $priority, distance => $distance
171             };
172         }
173     }
174 }
175
176 # Allocate each country to a cluster
177 allocate_clusters(@mappings);
178
179 # If we failed to allocate every origin then loop, increasing
180 # the bandwidth for each cluster by a little and retrying until
181 # we manage to allocate everything
182 while (grep { !exists($_->{cluster}) } values %$origins)
183 {
184     # Clear any existing mappings of countries to clusters
185     foreach my $origin (values %$origins)
186     {
187         delete $origin->{cluster};
188     }
189
190     # Reset bandwidth usage for clusters and increase limits by 10%
191     foreach my $cluster (values %$clusters)
192     {
193         $cluster->{bandwidth_used} = 0;
194         $cluster->{bandwidth_limit} = $cluster->{bandwidth_limit} * 1.1;
195     }
196
197     # Try the allocate again
198     allocate_clusters(@mappings);
199 }
200
201 # Create JSON collection object
202 my @json;
203
204 # Open output files
205 my $zonefile = IO::File->new("> data/${zone}") || die "$!";
206 my $jsonfile = IO::File->new("> json/${zone}.json") || die "$!";
207
208 # Output details for each country
209 foreach my $origin (sort { $a->{name} cmp $b->{name} } values %$origins)
210 {
211     my $cluster = $origin->{cluster};
212     my $clon = $origin->{lon};
213     my $clat = $origin->{lat};
214     my $slon = $cluster->{lon};
215     my $slat = $cluster->{lat};
216
217     if ($clon > 0 && $slon < 0 && 360 + $slon - $clon < $clon - $slon)
218     {
219         $slon = $slon + 360;
220     }
221     elsif ($slon > 0 && $clon < 0 && 360 + $clon - $slon < $slon - $clon)
222     {
223         $clon = $clon + 360;
224     }
225
226     $zonefile->print("# $origin->{name}\n");
227     $zonefile->print("C\L$origin->{code}\E.${zone}:$cluster->{name}.${zone}:600\n");
228
229     push @json, {
230         type => "Feature",
231         geometry => {
232             type => "LineString",
233             coordinates => [ [ $clon, $clat ], [ $slon, $slat ] ]
234         },
235         properties => {
236             origin => $origin->{name},
237             server => $cluster->{name},
238             colour => $cluster->{colour}
239         }
240     };
241
242     $targetorigins->{$cluster->{name}}->{bandwidth} += $origin->{bandwidth};
243 }
244
245 # Header for default records
246 $zonefile->print("# Unknown origins\n");
247
248 # Output default records for IPs that can't be mapped to a country
249 foreach my $cluster (sort { $a->{name} cmp $b->{name} } values %$clusters)
250 {
251     my $name = $cluster->{name};
252
253     if (my $default = $cluster->{default})
254     {
255         output_server($zonefile, "${default}.${zone}", $cluster);
256     }
257     elsif (exists($cluster->{default}))
258     {
259         output_server($zonefile, "${zone}", $cluster);
260     }
261 }
262
263 # Header for underlying servers
264 $zonefile->print("# Servers\n");
265
266 # Output A records for each cluster
267 foreach my $cluster (sort { $a->{name} cmp $b->{name} } values %$clusters)
268 {
269     my $name = $cluster->{name};
270
271     output_server($zonefile, "${name}.${zone}", $cluster);
272 }
273
274 # Output the GeoJSON text
275 $jsonfile->print(encode_json(\@json));
276
277 # Close the output files
278 $jsonfile->close();
279 $zonefile->close();
280
281 # Output gdnsd configuration
282 if (defined($gdnsname))
283 {
284     my $gdnsmapfile = IO::File->new("> gdns/${gdnsname}.map") || die "$!";
285     my $gdnsresourcefile = IO::File->new("> gdns/${gdnsname}.resource") || die "$!";
286     my $continent = "";
287
288     $gdnsmapfile->print("${gdnsname} => {\n");
289     $gdnsmapfile->print("  geoip2_db => /var/lib/GeoIP/GeoLite2-Country.mmdb\n");
290     $gdnsmapfile->print("  datacenters => [" . join(",", sort(keys(%$clusters))) . "]\n");
291     $gdnsmapfile->print("  map => {\n");
292     $gdnsmapfile->print("    default => [" . join(",", sort(map { $_->{name} } grep { $_->{default} } values(%$clusters))) . "]\n");
293
294     foreach my $origin (sort { $a->{continent} cmp $b->{continent} || $a->{code} cmp $b->{code} } values %$origins)
295     {
296         my $code = $origin->{code};
297         my $cluster = $origin->{cluster}->{name};
298
299         next if $code eq "XK";
300
301         if ($continent ne $origin->{continent})
302         {
303             $gdnsmapfile->print("    }\n") if $continent;
304
305             $continent = $origin->{continent};
306
307             $gdnsmapfile->print("    ${continent} => {\n");
308         }
309
310         $gdnsmapfile->print("      ${code} => [${cluster}]\n");
311     }
312
313     $gdnsmapfile->print("    }\n") if $continent;
314
315     $gdnsmapfile->print("  }\n");
316     $gdnsmapfile->print("}\n");
317
318     $gdnsresourcefile->print("${gdnsname} => {\n");
319     $gdnsresourcefile->print("  map => ${gdnsname}\n");
320     $gdnsresourcefile->print("  dcmap => {\n");
321
322     foreach my $cluster (sort { $a->{name} cmp $b->{name} } values %$clusters)
323     {
324         my $name = $cluster->{name};
325
326         $gdnsresourcefile->print("    ${name} => ${name}.tile.openstreetmap.org.\n");
327     }
328
329     $gdnsresourcefile->print("  }\n");
330     $gdnsresourcefile->print("}\n");
331
332     $gdnsresourcefile->close();
333     $gdnsmapfile->close();
334 }
335
336 # Output the target details in origin format if required
337 YAML::DumpFile($targetoriginfile, $targetorigins) if $targetoriginfile;
338
339 exit 0;
340
341 #
342 # Match an origin against a cluster
343 #
344 sub match_origin
345 {
346     my $cluster = shift;
347     my $origin = shift;
348     my $match;
349
350     if ($cluster->{preferred} &&
351         $cluster->{preferred}->{origins} &&
352         grep { $_ eq $origin->{name} } @{$cluster->{preferred}->{origins}})
353     {
354         $match = "preferred";
355     }
356     elsif ($cluster->{allowed} &&
357            $cluster->{allowed}->{origins} &&
358            grep { $_ eq $origin->{name} } @{$cluster->{allowed}->{origins}})
359     {
360         $match = "allowed";
361     }
362     elsif ($cluster->{preferred} &&
363            $cluster->{preferred}->{countries} &&
364            grep { $_ eq $origin->{country} } @{$cluster->{preferred}->{countries}})
365     {
366         $match = "preferred";
367     }
368     elsif ($cluster->{allowed} &&
369            $cluster->{allowed}->{countries} &&
370            grep { $_ eq $origin->{country} } @{$cluster->{allowed}->{countries}})
371     {
372         $match = "allowed";
373     }
374     elsif ($cluster->{denied} &&
375            $cluster->{denied}->{countries} &&
376            grep { $_ eq $origin->{country} } @{$cluster->{denied}->{countries}})
377     {
378         $match = "denied";
379     }
380     elsif ($cluster->{preferred} &&
381            $cluster->{preferred}->{continents} &&
382            grep { $_ eq $origin->{continent} } @{$cluster->{preferred}->{continents}})
383     {
384         $match = "preferred";
385     }
386     elsif ($cluster->{allowed} &&
387            $cluster->{allowed}->{continents} &&
388            grep { $_ eq $origin->{continent} } @{$cluster->{allowed}->{continents}})
389     {
390         $match = "allowed";
391     }
392     elsif ($cluster->{denied} &&
393            $cluster->{denied}->{continents} &&
394            grep { $_ eq $origin->{continent} } @{$cluster->{denied}->{continents}})
395     {
396         $match = "denied";
397     }
398     elsif ($cluster->{allowed})
399     {
400         $match = "denied";
401     }
402     else
403     {
404         $match = "allowed";
405     }
406
407     return $match;
408 }
409
410 #
411 # Compute the great circle distance between two points
412 #
413 sub distance
414 {
415     my $lat1 = deg2rad(shift);
416     my $lon1 = deg2rad(shift);
417     my $lat2 = deg2rad(shift);
418     my $lon2 = deg2rad(shift);
419
420     return great_circle_distance($lon1, pip2 - $lat1, $lon2, pip2 - $lat2);
421 }
422
423 #
424 # Allocate each origin to a cluster
425 #
426 sub allocate_clusters
427 {
428     my @mappings = sort { compare_mappings($a, $b) } @_;
429
430     # Loop over the mappings, trying to assign each origin to the
431     # nearest cluster, but subject to the bandwidth limits
432     while (my $mapping = shift @mappings)
433     {
434         my @group;
435
436         push @group, $mapping;
437
438         while (@mappings && compare_mappings($mapping, $mappings[0]) == 0)
439         {
440             push @group, shift @mappings;
441         }
442
443         for my $mapping (sort compare_bandwidth @group)
444         {
445             my $origin = $mapping->{origin};
446             my $cluster = $mapping->{cluster};
447
448             if (!exists($origin->{cluster}) &&
449                 $cluster->{bandwidth_used} + $origin->{bandwidth} <= $cluster->{bandwidth_limit})
450             {
451                 $origin->{cluster} = $cluster;
452                 $cluster->{bandwidth_used} = $cluster->{bandwidth_used} + $origin->{bandwidth};
453             }
454         }
455     }
456
457     return;
458 }
459
460 #
461 # Compare two mappings to decide which to use
462 #
463 sub compare_mappings
464 {
465     my $a = shift;
466     my $b = shift;
467
468     return $b->{priority} <=> $a->{priority} ||
469            $a->{distance} <=> $b->{distance};
470 }
471
472 #
473 # Compare two mappings to decide which to try first
474 #
475 sub compare_bandwidth
476 {
477     my $a_used = ( $a->{cluster}->{bandwidth_used} * 100.0 ) / ( $a->{cluster}->{bandwidth_limit} * 1.0 );
478     my $b_used = ( $b->{cluster}->{bandwidth_used} * 100.0 ) / ( $b->{cluster}->{bandwidth_limit} * 1.0 );
479
480     return $a_used <=> $b_used;
481 }
482
483 #
484 # Output DNS records for a server
485 #
486 sub output_server
487 {
488     my $zonefile = shift;
489     my $name = shift;
490     my $cluster = shift;
491
492     foreach my $server (@{$cluster->{servers}})
493     {
494         if ($server->{status} eq "up")
495         {
496             $zonefile->print("+${name}:$server->{ipv4}:600\n");
497
498             if ($server->{ipv6})
499             {
500 #                $zonefile->print("3${name}:$server->{ipv6}:600\n");
501             }
502         }
503     }
504
505     return;
506 }