source: trunk/cgi-bin/ipdb-rpc.cgi@ 874

Last change on this file since 874 was 870, checked in by Kris Deugau, 9 years ago

/trunk

A bit of additional safety net in rpc_allocateBlock() related to r867

  • Property svn:executable set to *
  • Property svn:keywords set to Date Rev Author Id
File size: 13.4 KB
Line 
1#!/usr/bin/perl
2# XMLRPC interface to manipulate most DNS DB entities
3###
4# $Id: ipdb-rpc.cgi 870 2016-05-04 21:28:08Z kdeugau $
5###
6# Copyright (C) 2013,2014,2016 Kris Deugau <kdeugau@deepnet.cx>
7
8use strict;
9use warnings;
10
11use DBI;
12use CustIDCK;
13use NetAddr::IP;
14use FCGI;
15use Frontier::Responder;
16
17use Sys::Syslog;
18
19# don't remove! required for GNU/FHS-ish install from tarball
20##uselib##
21
22use MyIPDB;
23
24openlog "IPDB-rpc","pid","$IPDB::syslog_facility";
25
26##fixme: username source? can we leverage some other auth method?
27# we don't care except for logging here, and Frontier::Client needs
28# a patch that's not well-distributed to use HTTP AUTH.
29
30# Collect the username from HTTP auth. If undefined, we're in
31# a test environment, or called without a username.
32my $authuser;
33if (!defined($ENV{'REMOTE_USER'})) {
34 $authuser = '__temptest';
35} else {
36 $authuser = $ENV{'REMOTE_USER'};
37}
38
39# Why not a global DB handle? (And a global statement handle, as well...)
40# Use the connectDB function, otherwise we end up confusing ourselves
41my $ip_dbh;
42my $sth;
43my $errstr;
44($ip_dbh,$errstr) = connectDB_My;
45initIPDBGlobals($ip_dbh);
46
47my $methods = {
48 # Internal core IPDB subs; no value in exposing them since the DB handle can't be used by the caller
49 #'ipdb._rpc'
50 # This one could be exposed, but the globals aren't automatically
51 # inherited by the caller anyway, and we call it just above locally.
52 #'ipdb.initIPDBGlobals'
53 #'ipdb.connectDB'
54 #'ipdb.finish'
55 #'ipdb.checkDBSanity'
56 'ipdb.addMaster' => \&rpc_addMaster,
57 'ipdb.touchMaster' => \&rpc_touchMaster,
58 'ipdb.listSummary' => \&rpc_listSummary,
59 'ipdb.listSubs' => \&rpc_listSubs,
60 'ipdb.listContainers' => \&rpc_listContainers,
61 'ipdb.listAllocations' => \&rpc_listAllocations,
62 'ipdb.listFree' => \&rpc_listFree,
63 'ipdb.listPool' => \&rpc_listPool,
64 'ipdb.getMasterList' => \&rpc_getMasterList,
65 'ipdb.getTypeList' => \&rpc_getTypeList,
66 'ipdb.getPoolSelect' => \&rpc_getPoolSelect,
67 'ipdb.findAllocateFrom' => \&rpc_findAllocateFrom,
68 'ipdb.ipParent' => \&rpc_ipParent,
69 'ipdb.subParent' => \&rpc_subParent,
70 'ipdb.blockParent' => \&rpc_blockParent,
71 'ipdb.getRoutedCity' => \&rpc_getRoutedCity,
72 'ipdb.allocateBlock' => \&rpc_allocateBlock,
73 # another internal sub; mainly a sub to make allocateBlock() a lot smaller
74 #'ipdb.initPool' => \&rpc_initPool
75 'ipdb.updateBlock' => \&rpc_updateBlock,
76 'ipdb.deleteBlock' => \&rpc_deleteBlock,
77 'ipdb.getBlockData' => \&rpc_getBlockData,
78 'ipdb.getBlockRDNS' => \&rpc_getBlockRDNS,
79 'ipdb.getNodeList' => \&rpc_getNodeList,
80 'ipdb.getNodeName' => \&rpc_getNodeName,
81 'ipdb.getNodeInfo' => \&rpc_getNodeInfo,
82 'ipdb.mailNotify' => \&rpc_mailNotify,
83
84# Subs not part of the core IPDB
85 'ipdb.getDispAlloctypes' => \&rpc_getDispAlloctypes,
86 'ipdb.getListAlloctypes' => \&rpc_getListAlloctypes,
87 'ipdb.getDefCustIDs' => \&rpc_getDefCustIDs,
88 'ipdb.getCityList' => \&rpc_getCityList,
89 'ipdb.getAvailableStatics' => \&rpc_getAvailableStatics,
90 'ipdb.getBackupList' => \&rpc_getBackupList,
91};
92
93my $reqcnt = 0;
94
95# main FCGI loop.
96while (FCGI::accept >= 0) {
97 # done here to a) prevent $ENV{'REMOTE_ADDR'} from being empty and b) to collect
98 # the right user for the individual call (since we may be running with FCGI)
99 syslog "debug", "$authuser active, $ENV{'REMOTE_ADDR'}";
100
101 # don't *think* we need any of these...
102 # %disp_alloctypes, %def_custids, %list_alloctypes
103 # @citylist, @poplist
104 # @masterblocks, %allocated, %free, %bigfree, %routed (removed in /trunk)
105 # %IPDBacl
106 #initIPDBGlobals($ip_dbh);
107
108 my $res = Frontier::Responder->new(
109 methods => $methods
110 );
111
112 # "Can't do that" errors
113 if (!$ip_dbh) {
114 print "Content-type: text/xml\n\n".$res->{_decode}->encode_fault(5, $DBI::errstr);
115 } else {
116 print $res->answer;
117 }
118 last if $reqcnt++ > $IPDB::maxfcgi;
119} # while FCGI::accept
120
121exit 0;
122
123
124##
125## Private subs
126##
127
128# Check RPC ACL
129sub _aclcheck {
130 my $subsys = shift;
131 return 1 if grep /$ENV{REMOTE_ADDR}/, @{$IPDB::rpcacl{$subsys}};
132 warn "$subsys/$ENV{REMOTE_ADDR} not in ACL\n"; # a bit of logging
133 return 0;
134}
135
136sub _commoncheck {
137 my $argref = shift;
138 my $needslog = shift;
139
140 die "Missing remote system name\n" if !$argref->{rpcsystem};
141 die "Access denied\n" if !_aclcheck($argref->{rpcsystem});
142 if ($needslog) {
143 die "Missing remote username\n" if !$argref->{rpcuser};
144 }
145}
146
147# stripped-down copy from from main.cgi. should probably be moved to IPDB.pm
148sub _validateInput {
149 my $argref = shift;
150
151 if (!$argref->{block}) {
152 $argref->{block} = $argref->{cidr} if $argref->{cidr};
153 die "Block/IP is required\n" if !$argref->{block};
154 }
155
156 # Alloctype check.
157 chomp $argref->{type};
158
159 die "Invalid allocation type\n" if (!grep /$argref->{type}/, keys %disp_alloctypes);
160
161 # Arguably not quite correct, as the custID won't be checked for
162 # validity if there's a default on the type.
163 if ($def_custids{$argref->{type}} eq '') {
164 # Types without a default custID must have one passed in
165 die "Customer ID is required\n" if !$argref->{custid};
166 # Crosscheck with billing.
167 my $status = CustIDCK->custid_exist($argref->{custid});
168 die "Error verifying customer ID: $CustIDCK::ErrMsg\n" if $CustIDCK::Error;
169 die "Customer ID not valid\n" if !$status;
170 } else {
171 # Types that have a default will use it unless one is specified.
172 if ((!$argref->{custid}) || ($argref->{custid} ne 'STAFF')) {
173 $argref->{custid} = $def_custids{$argref->{type}};
174 }
175 }
176} # end validateInput()
177
178
179##
180## RPC method subs
181##
182
183# Core IPDB subs
184# Prefixed with rpc_ to not conflict with subs in IPDB.pm
185
186# These are deep internals and don't make much sense to expose, since RPC
187# by definition does not access the backing DB directly.
188#sub _rpc {}
189#sub initIPDBGlobals {}
190#sub connectDB {}
191#sub finish {}
192#sub checkDBSanity {}
193
194sub rpc_addMaster {}
195sub rpc_touchMaster {}
196sub rpc_listSummary {}
197sub rpc_listSubs {}
198sub rpc_listContainers {}
199sub rpc_listAllocations {}
200sub rpc_listFree {}
201
202
203sub rpc_listPool {
204 my %args = @_;
205
206 _commoncheck(\%args, 'y');
207
208 $args{include_desc} = 0 if !$args{include_desc};
209
210 my $pid;
211 # convert passed pool from CIDR to an ID, maybe
212 if ($args{pool} !~ /^\d+$/) {
213 die "Invalid pool argument" if $args{pool} !~ m{^\d+\.\d+\.\d+\.\d+/\d+$};
214 die "VRF is required\n" if !$args{vrf}; # VRF name may not be empty
215 ($pid) = $ip_dbh->selectrow_array("SELECT a.id FROM allocations a JOIN allocations m ON a.master_id=m.id".
216 " WHERE a.cidr = ? AND m.vrf = ?", undef, $args{pool}, $args{vrf});
217 } else {
218 $pid = $args{pool};
219 }
220
221 return listPool($ip_dbh, $pid, $args{include_desc});
222} # rpc_listPool()
223
224
225sub rpc_getMasterList {}
226sub rpc_getTypeList {}
227sub rpc_getPoolSelect {}
228sub rpc_findAllocateFrom {}
229sub rpc_ipParent {}
230sub rpc_subParent {}
231sub rpc_blockParent {}
232sub rpc_getRoutedCity {}
233
234sub rpc_allocateBlock {
235 my %args = @_;
236
237 _commoncheck(\%args, 'y');
238
239 _validateInput(\%args);
240
241 # Not required for update, delete
242 die "City is required\n" if !$args{city};
243 die "Customer ID is required\n" if !$args{custid};
244 die "Allocation type is required\n" if !$args{type};
245
246 if ($args{type} =~ /^.i$/) {
247 die "Pool ID or VRF to allocate from is required\n" if !$args{parent} && !$args{vrf};
248 } else {
249 die "Free block to allocate from is required\n" if !$args{fbid};
250 }
251
252 $args{user} = $args{rpcuser};
253 my ($code,$msg) = allocateBlock($ip_dbh, %args);
254
255 if ($code eq 'OK' || $code eq 'WARN') {
256 if ($args{type} =~ /^.i$/) {
257 $msg =~ s|/32||;
258 mailNotify($ip_dbh, "a$args{type}", "ADDED: $disp_alloctypes{$args{type}} allocation",
259 "$disp_alloctypes{$args{type}} $msg allocated to customer $args{custid}\n".
260 "Description: $args{desc}\n\nAllocated by: $args{rpcsystem}/$args{rpcuser}\n");
261 } else {
262 my $netblock = new NetAddr::IP $args{block};
263 mailNotify($ip_dbh, "a$args{type}", "ADDED: $disp_alloctypes{$args{type}} allocation",
264 "$disp_alloctypes{$args{type}} $args{block} allocated to customer $args{custid}\n".
265 "Description: $args{desc}\n\nAllocated by: $args{rpcsystem}/$args{rpcuser}\n");
266 }
267 syslog "notice", "$args{rpcsystem}/$args{rpcuser} allocated '$args{block}' to '$args{custid}' as ".
268 "'$args{type}' ($msg)";
269 } else {
270 syslog "err", "Allocation of '$args{block}' to '$args{custid}' as ".
271 "'$args{type}' by $args{rpcsystem}/$args{rpcuser} failed: '$msg'";
272 die "$msg\n";
273 }
274 return $msg;
275} # rpc_allocateBlock()
276
277# another internal sub; mainly a sub to make allocateBlock() a lot smaller
278#sub rpc_initPool {}
279
280
281sub rpc_updateBlock {
282 my %args = @_;
283
284 _commoncheck(\%args, 'y');
285
286 _validateInput(\%args);
287
288 # Allow caller to send a CIDR instead of the block ID.
289 $args{origblock} = $args{block};
290 if ($args{block} =~ m{^(?:\d+\.){3}\d+(?:/32)?$}) {
291 # updating a static IP. retrieve the IP ID based on either the parent or VRF.
292 die "Pool ID or VRF is required\n" if !$args{parent} && !$args{vrf};
293 ($args{block}) = $ip_dbh->selectrow_array(
294 "SELECT id FROM poolips WHERE ip = ? AND ".($args{parent} ? "parent_id = ?" : "vrf = ?"),
295 undef, $args{block}, ($args{parent} ? $args{parent} : $args{vrf}) );
296 }
297
298 my $binfo = getBlockData($ip_dbh, $args{block}, $args{type});
299
300 # set assignIP_on_update to simplify some calling situations. better to use allocateBlock if possible though.
301 my ($code,$msg) = updateBlock($ip_dbh, %args, assignIP_on_update => 1);
302 if ($code eq 'FAIL') {
303 syslog "err", "$args{rpcsystem}/$args{rpcuser} could not update block/IP $args{block} ($binfo->{block}): '$msg'";
304 die "$msg\n";
305 }
306 syslog "notice", "$args{rpcsystem}/$args{rpcuser} updated $args{block} ($binfo->{block})";
307
308 return $msg;
309} # rpc_updateBlock()
310
311
312sub rpc_deleteBlock {
313 my %args = @_;
314
315 _commoncheck(\%args, 'y');
316
317 if (!$args{block}) {
318 $args{block} = $args{cidr} if $args{cidr};
319 die "Block/IP is required\n" if !$args{block};
320 }
321
322 if ($args{block} =~ m{^(?:\d+\.){3}\d+(?:/32)?$}) {
323 # deleting a static IP. retrieve the IP ID based on either the parent or VRF.
324 die "Pool ID or VRF is required\n" if !$args{parent} && !$args{vrf};
325 ($args{block}) = $ip_dbh->selectrow_array(
326 "SELECT id FROM poolips WHERE ip = ? AND ".($args{parent} ? "parent_id = ?" : "vrf = ?"),
327 undef, $args{block}, ($args{parent} ? $args{parent} : $args{vrf}) );
328 warn "passed block $args{block} guessed as $args{block}\n";
329 }
330
331 # snag block info for log
332 my $blockinfo = getBlockData($ip_dbh, $args{block}, $args{type});
333 my ($code,$msg) = deleteBlock($ip_dbh, $args{block}, $args{type}, $args{delfwd}, $args{rpcuser});
334
335 my $authuser = "$args{rpcsystem}/$args{rpcuser}";
336 if ($code eq 'OK' || $code =~ /^WARN/) {
337 syslog "notice", "$authuser deallocated '$blockinfo->{type}'-type netblock ID $args{block} ".
338 "($blockinfo->{block}), $blockinfo->{custid}, $blockinfo->{city}, desc='$blockinfo->{description}'";
339 mailNotify($ip_dbh, 'da', "REMOVED: $disp_alloctypes{$blockinfo->{type}} $blockinfo->{block}",
340# $args{block} useful? do we care about the block ID here?
341 "$disp_alloctypes{$blockinfo->{type}} $blockinfo->{block} deallocated by $authuser\n".
342 "CustID: $blockinfo->{custid}\nCity: $blockinfo->{city}\n".
343 "Description: $blockinfo->{description}\n");
344 } else {
345 if ($args{type} =~ /^.i$/) {
346 syslog "err", "$authuser could not deallocate static IP ID $args{block} ($blockinfo->{block}): '$msg'";
347 } else {
348 syslog "err", "$authuser could not deallocate netblock ID $args{block} ($blockinfo->{block}): '$msg'";
349 }
350 }
351
352 return $msg;
353} # rpc_deleteBlock()
354
355
356sub rpc_getBlockData {}
357sub rpc_getBlockRDNS {}
358sub rpc_getNodeList {}
359sub rpc_getNodeName {}
360sub rpc_getNodeInfo {}
361sub rpc_mailNotify {}
362
363
364##
365## Subs not part of the core IPDB
366##
367
368# Subs to send back IPDB globals
369
370#our %disp_alloctypes;
371sub rpc_getDispAlloctypes {
372 my %args = @_;
373 _commoncheck(\%args, 'n');
374 return \%disp_alloctypes;
375}
376
377#our %list_alloctypes;
378sub rpc_getListAlloctypes {
379 my %args = @_;
380 _commoncheck(\%args, 'n');
381 return \%list_alloctypes;
382}
383
384#our %def_custids;
385sub rpc_getDefCustIDs {
386 my %args = @_;
387 _commoncheck(\%args, 'n');
388 return \%def_custids;
389}
390
391#our @citylist;
392sub rpc_getCityList {
393 my %args = @_;
394 _commoncheck(\%args, 'n');
395 return \@citylist;
396}
397
398#our @poplist;
399sub rpc_getPOPList {
400 my %args = @_;
401 _commoncheck(\%args, 'n');
402 return \@poplist;
403}
404
405# not sure how useful it is to expose this on RPC
406#our %IPDBacl;
407sub rpc_getIPDBacl {
408 my %args = @_;
409 _commoncheck(\%args, 'n');
410 return \%IPDBacl;
411}
412
413# Operations not provided directly by the core IPDB
414
415# Get a list of available static IPs of the given type
416# Not a core IPDB sub since there's little use for this format.
417sub rpc_getAvailableStatics {
418 my %args = @_;
419
420 _commoncheck(\%args, 'n');
421
422 my ($base,undef) = split //, $args{type};
423 $base .= "_";
424 my @params = ($base);
425
426 my $sql = "SELECT poolips.id,poolips.ip,poolips.parent_id,poolips.pool ".
427 "FROM poolips JOIN allocations ON poolips.parent_id=allocations.id WHERE poolips.type LIKE ?";
428 if ($base ne 'd_' && $args{city}) {
429 $sql .= " AND allocations.city=?";
430 push @params, $args{city};
431 }
432 $sql .= " AND poolips.available='y'";
433
434 my $ret = $ip_dbh->selectall_arrayref($sql, { Slice => {} }, (@params) );
435 die $ip_dbh->errstr if !$ret;
436
437 return $ret;
438} # rpc_getAvailableStatics()
439
440
441sub rpc_getBackupList {
442 my %args = @_;
443
444 _commoncheck(\%args, 'n');
445
446 # grab the whole waffle.
447 my $sql = "SELECT backup_id, bkbrand, bkmodel, bktype, bkport, bksrc, bkuser, bkvpass, bkepass, ip FROM backuplist";
448 my $result = $ip_dbh->selectall_arrayref($sql, { Slice => {} });
449 die $ip_dbh->errstr if !$result;
450
451 return $result;
452} # rpc_getBackupList()
Note: See TracBrowser for help on using the repository browser.