RackTables git mirrors - racktables/blob - inc/gateways.php

   1 <?php
   2 /*
   3 *
   4 *  This file contains gateway functions for RackTables.
   5 *  A gateway is an external executable, which provides
   6 *  read-only or read-write access to some external entities.
   7 *  Each gateway accepts its own list of command-line args
   8 *  and then reads its stdin for requests. Each request consists
   9 *  of one line and results in exactly one line of reply.
  10 *  The replies must have the following syntax:
  11 *  OK<space>any text up to the end of the line
  12 *  ERR<space>any text up to the end of the line
  13 *
  14 */
  15
  16
  17 // This function launches specified gateway with specified
  18 // command-line arguments and feeds it with the commands stored
  19 // in the second arg as array.
  20 // The answers are stored in another array, which is returned
  21 // by this function. In the case when a gateway cannot be found,
  22 // finishes prematurely or exits with non-zero return code,
  23 // a single-item array is returned with the only "ERR" record,
  24 // which explains the reason.
  25 function queryGateway ($gwname, $questions)
  26 {
  27         $execpath = "./gateways/{$gwname}/main";
  28         $dspec = array
  29         (
  30                 0 => array ("pipe", "r"),
  31                 1 => array ("pipe", "w"),
  32                 2 => array ("file", "/dev/null", "a")
  33         );
  34         $pipes = array();
  35         $gateway = proc_open ($execpath, $dspec, $pipes);
  36         if (!is_resource ($gateway))
  37                 return array ('ERR proc_open() failed in ' . __FUNCTION__);
  38
  39 // Dialogue starts. Send all questions.
  40         foreach ($questions as $q)
  41                 fwrite ($pipes[0], "$q\n");
  42         fclose ($pipes[0]);
  43
  44 // Fetch replies.
  45         $answers = array ();
  46         while (!feof($pipes[1]))
  47         {
  48                 $a = fgets ($pipes[1]);
  49                 if (empty ($a))
  50                         continue;
  51                 // Somehow I got a space appended at the end. Kick it.
  52                 $answers[] = trim ($a);
  53         }
  54         fclose($pipes[1]);
  55
  56         $retval = proc_close ($gateway);
  57         if ($retval != 0)
  58                 return array ("ERR gateway '${gwname}' returned ${retval}");
  59         return $answers;
  60 }
  61
  62 // This functions returns an array for VLAN list, and an array for port list (both
  63 // form another array themselves) and another one with MAC address list.
  64 // The ports in the latter array are marked with either VLAN ID or 'trunk'.
  65 // We don't sort the port list, as the gateway is believed to have done this already
  66 // (or at least the underlying switch software ought to). This is important, as the
  67 // port info is transferred to/from form not by names, but by numbers.
  68 function getSwitchVLANs ($object_id = 0)
  69 {
  70         global $remote_username;
  71         if ($object_id <= 0)
  72         {
  73                 showError ('Invalid object_id', __FUNCTION__);
  74                 return;
  75         }
  76         $objectInfo = getObjectInfo ($object_id);
  77         $endpoints = findAllEndpoints ($object_id, $objectInfo['name']);
  78         if (count ($endpoints) == 0)
  79         {
  80                 showError ('Can\'t find any mean to reach current object. Please either set FQDN attribute or assign an IP address to the object.', __FUNCTION__);
  81                 return NULL;
  82         }
  83         if (count ($endpoints) > 1)
  84         {
  85                 showError ('More than one IP address is assigned to this object, please configure FQDN attribute.', __FUNCTION__);
  86                 return NULL;
  87         }
  88         $hwtype = $swtype = 'unknown';
  89         foreach (getAttrValues ($object_id, TRUE) as $record)
  90         {
  91                 if ($record['name'] == 'SW type' && !empty ($record['value']))
  92                         $swtype = str_replace (' ', '+', $record['value']);
  93                 if ($record['name'] == 'HW type' && !empty ($record['value']))
  94                         $hwtype = str_replace (' ', '+', $record['value']);
  95         }
  96         $endpoint = str_replace (' ', '+', $endpoints[0]);
  97         $commands = array
  98         (
  99                 "connect ${endpoint} ${hwtype} ${swtype} ${remote_username}",
 100                 'listvlans',
 101                 'listports',
 102                 'listmacs'
 103         );
 104         $data = queryGateway ('switchvlans', $commands);
 105         if ($data == NULL)
 106         {
 107                 showError ('Failed to get any response from queryGateway() or the gateway died', __FUNCTION__);
 108                 return NULL;
 109         }
 110         if (strpos ($data[0], 'OK!') !== 0)
 111         {
 112                 showError ("Gateway failure: ${data[0]}.", __FUNCTION__);
 113                 return NULL;
 114         }
 115         if (count ($data) != count ($commands))
 116         {
 117                 showError ("Gateway failure: malformed reply.", __FUNCTION__);
 118                 return NULL;
 119         }
 120         // Now we have VLAN list in $data[1] and port list in $data[2]. Let's sort this out.
 121         $tmp = array_unique (explode (';', substr ($data[1], strlen ('OK!'))));
 122         if (count ($tmp) == 0)
 123         {
 124                 showError ("Gateway succeeded, but returned no VLAN records.", __FUNCTION__);
 125                 return NULL;
 126         }
 127         $vlanlist = array();
 128         foreach ($tmp as $record)
 129         {
 130                 list ($vlanid, $vlandescr) = explode ('=', $record);
 131                 $vlanlist[$vlanid] = $vlandescr;
 132         }
 133         $portlist = array();
 134         foreach (explode (';', substr ($data[2], strlen ('OK!'))) as $pair)
 135         {
 136                 list ($portname, $pair2) = explode ('=', $pair);
 137                 list ($status, $vlanid) = explode (',', $pair2);
 138                 $portlist[] = array ('portname' => $portname, 'status' => $status, 'vlanid' => $vlanid);
 139         }
 140         if (count ($portlist) == 0)
 141         {
 142                 showError ("Gateway succeeded, but returned no port records.", __FUNCTION__);
 143                 return NULL;
 144         }
 145         $maclist = array();
 146         foreach (explode (';', substr ($data[3], strlen ('OK!'))) as $pair)
 147         {
 148                 list ($macaddr, $pair2) = explode ('=', $pair);
 149                 if (empty ($pair2))
 150                         continue;
 151                 list ($vlanid, $ifname) = explode ('@', $pair2);
 152                 $maclist[$ifname][$vlanid][] = $macaddr;
 153         }
 154         return array ($vlanlist, $portlist, $maclist);
 155 }
 156
 157 function setSwitchVLANs ($object_id = 0, $setcmd)
 158 {
 159         global $remote_username;
 160         if ($object_id <= 0)
 161                 return oneLiner (160); // invalid arguments
 162         $objectInfo = getObjectInfo ($object_id);
 163         $endpoints = findAllEndpoints ($object_id, $objectInfo['name']);
 164         if (count ($endpoints) == 0)
 165                 return oneLiner (161); // endpoint not found
 166         if (count ($endpoints) > 1)
 167                 return oneLiner (162); // can't pick an address
 168         $hwtype = $swtype = 'unknown';
 169         foreach (getAttrValues ($object_id, TRUE) as $record)
 170         {
 171                 if ($record['name'] == 'SW type' && !empty ($record['value']))
 172                         $swtype = strtr ($record['value'], ' ', '+');
 173                 if ($record['name'] == 'HW type' && !empty ($record['value']))
 174                         $hwtype = strtr ($record['value'], ' ', '+');
 175         }
 176         $endpoint = str_replace (' ', '+', $endpoints[0]);
 177         $data = queryGateway
 178         (
 179                 'switchvlans',
 180                 array ("connect ${endpoint} ${hwtype} ${swtype} ${remote_username}", $setcmd)
 181         );
 182         if ($data == NULL)
 183                 return oneLiner (163); // unknown gateway failure
 184         if (strpos ($data[0], 'OK!') !== 0)
 185                 return oneLiner (164, array ($data[0])); // gateway failure
 186         if (count ($data) != 2)
 187                 return oneLiner (165); // protocol violation
 188         // Finally we can parse the response into message array.
 189         $log_m = array();
 190         foreach (split (';', substr ($data[1], strlen ('OK!'))) as $text)
 191         {
 192                 if (strpos ($text, 'C!') === 0)
 193                 {
 194                         $tmp = split ('!', $text);
 195                         array_shift ($tmp);
 196                         $code = array_shift ($tmp);
 197                         $log_m[] = count ($tmp) ? array ('c' => $code, 'a' => $tmp) : array ('c' => $code); // gateway-encoded message
 198                 }
 199                 elseif (strpos ($text, 'I!') === 0)
 200                         $log_m[] = array ('c' => 62, 'a' => array (substr ($text, 2))); // generic gateway success
 201                 elseif (strpos ($text, 'W!') === 0)
 202                         $log_m[] = array ('c' => 202, 'a' => array (substr ($text, 2))); // generic gateway warning
 203                 else // All improperly formatted messages must be treated as error conditions.
 204                         $log_m[] = array ('c' => 166, 'a' => array (substr ($text, 2))); // generic gateway error
 205         }
 206         return $log_m;
 207 }
 208
 209 // Drop a file off RackTables platform. The gateway will catch the file and pass it to the given
 210 // installer script.
 211 // Return a
 212 function gwSendFile ($endpoint, $handlername, $filetext = '')
 213 {
 214         global $remote_username;
 215         $tmpfilename = tempnam ('', 'RackTables-sendfile-');
 216         $tmpfile = fopen ($tmpfilename, 'wb');
 217         fwrite ($tmpfile, $filetext);
 218         fclose ($tmpfile);
 219         $endpoint = str_replace (' ', '\ ', $endpoint); // the gateway dispatcher uses read (1) to assign arguments
 220         $outputlines = queryGateway
 221         (
 222                 'sendfile',
 223                 array ("submit ${remote_username} ${endpoint} ${handlername} ${tmpfilename}")
 224         );
 225         unlink ($tmpfilename);
 226         if ($outputlines == NULL)
 227                 return oneLiner (163); // unknown gateway failure
 228         if (count ($outputlines) != 1)
 229                 return oneLiner (165); // protocol violation
 230         if (strpos ($outputlines[0], 'OK!') !== 0)
 231                 return oneLiner (164, array ($outputlines[0])); // gateway failure
 232         // Being here means having 'OK!' in the response.
 233         return oneLiner (66, array ($handlername)); // ignore provided "Ok" text
 234 }
 235
 236 // Query something through a gateway and get some text in return. Return that text.
 237 function gwRecvFile ($endpoint, $handlername, &$output)
 238 {
 239         global $remote_username;
 240         $tmpfilename = tempnam ('', 'RackTables-sendfile-');
 241         $endpoint = str_replace (' ', '\ ', $endpoint); // the gateway dispatcher uses read (1) to assign arguments
 242         $outputlines = queryGateway
 243         (
 244                 'sendfile',
 245                 array ("submit ${remote_username} ${endpoint} ${handlername} ${tmpfilename}")
 246         );
 247         $output = file_get_contents ($tmpfilename);
 248         unlink ($tmpfilename);
 249         if ($outputlines == NULL)
 250                 return oneLiner (163); // unknown gateway failure
 251         if (count ($outputlines) != 1)
 252                 return oneLiner (165); // protocol violation
 253         if (strpos ($outputlines[0], 'OK!') !== 0)
 254                 return oneLiner (164, array ($outputlines[0])); // gateway failure
 255         // Being here means having 'OK!' in the response.
 256         return oneLiner (66, array ($handlername)); // ignore provided "Ok" text
 257 }
 258
 259 function gwSendFileToObject ($object_id = 0, $handlername, $filetext = '')
 260 {
 261         global $remote_username;
 262         if ($object_id <= 0 or empty ($handlername))
 263                 return oneLiner (160); // invalid arguments
 264         $objectInfo = getObjectInfo ($object_id);
 265         $endpoints = findAllEndpoints ($object_id, $objectInfo['name']);
 266         if (count ($endpoints) == 0)
 267                 return oneLiner (161); // endpoint not found
 268         if (count ($endpoints) > 1)
 269                 return oneLiner (162); // can't pick an address
 270         $endpoint = str_replace (' ', '+', $endpoints[0]);
 271         return gwSendFile ($endpoint, $handlername, $filetext);
 272 }
 273
 274 function gwRecvFileFromObject ($object_id = 0, $handlername, &$output)
 275 {
 276         global $remote_username;
 277         if ($object_id <= 0 or empty ($handlername))
 278                 return oneLiner (160); // invalid arguments
 279         $objectInfo = getObjectInfo ($object_id);
 280         $endpoints = findAllEndpoints ($object_id, $objectInfo['name']);
 281         if (count ($endpoints) == 0)
 282                 return oneLiner (161); // endpoint not found
 283         if (count ($endpoints) > 1)
 284                 return oneLiner (162); // can't pick an address
 285         $endpoint = str_replace (' ', '+', $endpoints[0]);
 286         return gwRecvFile ($endpoint, $handlername, $output);
 287 }
 288
 289 ?>