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

Last change on this file since 668 was 668, checked in by Kris Deugau, 8 years ago

/trunk

Stub out all core IPDB subs for RPC. Fill in a few quick global-retrieval
subs. See #40.

  • Property svn:executable set to *
  • Property svn:keywords set to Date Rev Author Id
File size: 9.4 KB
Line 
1#!/usr/bin/perl
2# XMLRPC interface to manipulate most DNS DB entities
3###
4# $Id: ipdb-rpc.cgi 668 2014-12-31 16:39:14Z kdeugau $
5###
6# Copyright (C) 2013 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};
91
92my $reqcnt = 0;
93
94# main FCGI loop.
95while (FCGI::accept >= 0) {
96  # done here to a) prevent $ENV{'REMOTE_ADDR'} from being empty and b) to collect
97  # the right user for the individual call (since we may be running with FCGI)
98  syslog "debug", "$authuser active, $ENV{'REMOTE_ADDR'}";
99
100  # don't *think* we need any of these...
101  # %disp_alloctypes, %def_custids, %list_alloctypes
102  # @citylist, @poplist
103  # @masterblocks, %allocated, %free, %bigfree, %routed  (removed in /trunk)
104  # %IPDBacl
105  #initIPDBGlobals($ip_dbh);
106
107  my $res = Frontier::Responder->new(
108        methods => $methods
109        );
110
111  # "Can't do that" errors
112  if (!$ip_dbh) {
113    print "Content-type: text/xml\n\n".$res->{_decode}->encode_fault(5, $DBI::errstr);
114  } else {
115    print $res->answer;
116  }
117  last if $reqcnt++ > $IPDB::maxfcgi;
118} # while FCGI::accept
119
120exit 0;
121
122
123##
124## Private subs
125##
126
127# Check RPC ACL
128sub _aclcheck {
129  my $subsys = shift;
130  return 1 if grep /$ENV{REMOTE_ADDR}/, @{$IPDB::rpcacl{$subsys}};
131  warn "$subsys/$ENV{REMOTE_ADDR} not in ACL\n";        # a bit of logging
132  return 0;
133}
134
135sub _commoncheck {
136  my $argref = shift;
137  my $needslog = shift;
138
139  die "Missing remote system name\n" if !$argref->{rpcsystem};
140  die "Access denied\n" if !_aclcheck($argref->{rpcsystem});
141  if ($needslog) {
142    die "Missing remote username\n" if !$argref->{rpcuser};
143  }
144}
145
146# stripped-down copy from from main.cgi.  should probably be moved to IPDB.pm
147sub _validateInput {
148  my $argref = shift;
149
150  die "Block/IP is required\n" if !$argref->{block};
151
152  # Alloctype check.
153  chomp $argref->{alloctype};
154
155  die "Invalid allocation type\n" if (!grep /$argref->{alloctype}/, keys %disp_alloctypes);
156
157  # Arguably not quite correct, as the custID won't be checked for
158  # validity if there's a default on the type.
159  if ($def_custids{$argref->{alloctype}} eq '') {
160    # Types without a default custID must have one passed in
161    die "Customer ID is required\n" if !$argref->{custid};
162    # Crosscheck with billing.
163    my $status = CustIDCK->custid_exist($argref->{custid});
164    die "Error verifying customer ID: $CustIDCK::ErrMsg\n" if $CustIDCK::Error;
165    die "Customer ID not valid\n" if !$status;
166  } else {
167    # Types that have a default will use it unless one is specified.
168    if ((!$argref->{custid}) || ($argref->{custid} ne 'STAFF')) {
169      $argref->{custid} = $def_custids{$argref->{alloctype}};
170    }
171  }
172} # end validateInput()
173
174
175##
176## RPC method subs
177##
178
179# Core IPDB subs
180# Prefixed with rpc_ to not conflict with subs in IPDB.pm
181
182# These are deep internals and don't make much sense to expose, since RPC
183# by definition does not access the backing DB directly.
184#sub _rpc {}
185#sub initIPDBGlobals {}
186#sub connectDB {}
187#sub finish {}
188#sub checkDBSanity {}
189
190sub rpc_addMaster {}
191sub rpc_touchMaster {}
192sub rpc_listSummary {}
193sub rpc_listSubs {}
194sub rpc_listContainers {}
195sub rpc_listAllocations {}
196sub rpc_listFree {}
197sub rpc_listPool {}
198sub rpc_getMasterList {}
199sub rpc_getTypeList {}
200sub rpc_getPoolSelect {}
201sub rpc_findAllocateFrom {}
202sub rpc_ipParent {}
203sub rpc_subParent {}
204sub rpc_blockParent {}
205sub rpc_getRoutedCity {}
206
207sub rpc_allocateBlock {
208  my %args = @_;
209
210  _commoncheck(\%args, 'y');
211
212  _validateInput(\%args);
213
214  # Not required for update, delete
215  die "City is required\n" if !$args{city};
216  die "Block/pool to allocate from is required\n" if !$args{alloc_from};
217
218  # Desc, notes, circid, privdata, node, and vrf are all optional and handled in allocateBlock()
219  my ($code,$msg) = allocateBlock($ip_dbh, $args{block}, $args{alloc_from},
220        $args{custid}, $args{alloctype}, $args{city}, $args{desc}, $args{notes},
221        $args{circid}, $args{privdata}, $args{node}, $args{vrf});
222
223  if ($code eq 'OK' || $code eq 'WARN') {
224    if ($args{alloctype} =~ /^.i$/) {
225      $msg =~ s|/32||;
226      mailNotify($ip_dbh, "a$args{alloctype}", "ADDED: $disp_alloctypes{$args{alloctype}} allocation",
227        "$disp_alloctypes{$args{alloctype}} $msg allocated to customer $args{custid}\n".
228        "Description: $args{desc}\n\nAllocated by: $args{rpcsystem}/$args{rpcuser}\n");
229    } else {
230      my $netblock = new NetAddr::IP $args{block};
231      mailNotify($ip_dbh, "a$args{alloctype}", "ADDED: $disp_alloctypes{$args{alloctype}} allocation",
232        "$disp_alloctypes{$args{alloctype}} $args{block} allocated to customer $args{custid}\n".
233        "Description: $args{desc}\n\nAllocated by: $args{rpcsystem}/$args{rpcuser}\n");
234    }
235    syslog "notice", "$args{rpcsystem}/$args{rpcuser} allocated '$args{block}' to '$args{custid}' as ".
236        "'$args{alloctype}' ($msg)";
237  } else {
238    syslog "err", "Allocation of '$args{block}' to '$args{custid}' as ".
239        "'$args{alloctype}' by $args{rpcsystem}/$args{rpcuser} failed: '$msg'";
240    die "$msg\n";
241  }
242  return $msg;
243} # rpc_allocateBlock()
244
245# another internal sub;  mainly a sub to make allocateBlock() a lot smaller
246#sub rpc_initPool {}
247sub rpc_updateBlock {}
248sub rpc_deleteBlock {}
249sub rpc_getBlockData {}
250sub rpc_getBlockRDNS {}
251sub rpc_getNodeList {}
252sub rpc_getNodeName {}
253sub rpc_getNodeInfo {}
254sub rpc_mailNotify {}
255
256
257##
258## Subs not part of the core IPDB
259##
260
261# Subs to send back IPDB globals
262
263#our %disp_alloctypes;
264sub rpc_getDispAlloctypes {
265  my %args = @_;
266  _commoncheck(\%args, 'n');
267  return \%disp_alloctypes;
268}
269
270#our %list_alloctypes;
271sub rpc_getListAlloctypes {
272  my %args = @_;
273  _commoncheck(\%args, 'n');
274  return \%list_alloctypes;
275}
276
277#our %def_custids;
278sub rpc_getDefCustIDs {
279  my %args = @_;
280  _commoncheck(\%args, 'n');
281  return \%def_custids;
282}
283
284#our @citylist;
285sub rpc_getCityList {
286  my %args = @_;
287  _commoncheck(\%args, 'n');
288  return \@citylist;
289}
290
291#our @poplist;
292sub rpc_getPOPList {
293  my %args = @_;
294  _commoncheck(\%args, 'n');
295  return \@poplist;
296}
297
298# not sure how useful it is to expose this on RPC
299#our %IPDBacl;
300sub rpc_getIPDBacl {
301  my %args = @_;
302  _commoncheck(\%args, 'n');
303  return \%IPDBacl;
304}
305
306# Operations not provided directly by the core IPDB
307
308# Get a list of available static IPs of the given type
309# Not a core IPDB sub since there's little use for this format.
310sub rpc_getAvailableStatics {
311  my %args = @_;
312
313  _commoncheck(\%args, 'n');
314
315  my ($base,undef) = split //, $args{type};
316  $base .= "_";
317  my @params = ($base);
318
319  my $sql = "SELECT poolips.id,poolips.ip,poolips.parent_id,poolips.pool ".
320        "FROM poolips JOIN allocations ON poolips.parent_id=allocations.id WHERE poolips.type LIKE ?";
321  if ($base ne 'd_' && $args{city}) {
322    $sql .= " AND allocations.city=?";
323    push @params, $args{city};
324  }
325  $sql .= " AND poolips.available='y'";
326
327  my $ret = $ip_dbh->selectall_arrayref($sql, { Slice => {} }, (@params) );
328  die $ip_dbh->errstr if !$ret;
329
330  return $ret;
331} # rpc_getAvailableStatics()
Note: See TracBrowser for help on using the repository browser.