switch-ztp/www/swreg/callhome.php

<?php
//-
// Copyright (c) 2011-2019 Joe Clarke <jclarke@cisco.com>
// All rights reserved.

// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions
// are met:
// 1. Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
// 2. Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.

// THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
// ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
// FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
// DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
// OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
// HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
// LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
// OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
// SUCH DAMAGE.

include_once '../db.inc.php';
include_once 'swreg.inc.php';
include_once '../swreg_creds.inc.php';
require_once '../functions.php';
require_once 'Log.php';

$dsn = "$db_driver:host=$db_host;dbname=$db_name";

$options = [
    PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION,
    PDO::ATTR_DEFAULT_FETCH_MODE => PDO::FETCH_ASSOC,
    PDO::ATTR_EMULATE_PREPARES => false,
];

try {
    $dbh = new PDO($dsn, $db_user, $db_pass, $options);
} catch (PDOException $e) {
    die($e->getMessage());
}

$logger = Log::singleton('file', LOGFILE, TOOL_NAME . ' : Switch Callhome Endpoint');
if ($logger === false) {
    die("Failed to open logfile.\n");
}
$mask = Log::MAX(LOG_LEVEL);
$logger->setMask($mask);

list($pid, $sn) = explode('/', trim($_SERVER['PATH_INFO'], '/'));

// Right now, we will just check if the switch should be re-ZTP'd

$sql = 'SELECT should_re_ztp FROM DEVICE_MAP WHERE serial_number=?';
try {
    $sth = $dbh->prepare($sql);
    $res = $sth->execute(array($sn));
} catch (PDOException $e) {
    header('Content-type: text/plain');
    echo "! ERROR: Failed to get switch for SN {$sn}: " . $e->getMessage() . "\r\n";
    $logger->crit("Failed to get switch for SN {$sn}: " . $e->getMessage());
    exit(1);
}

$row = $sth->fetch();
$sth->closeCursor();

// Only handle re-ZTP for now.
if ($row['should_re_ztp'] == 2) {
    // This hack is needed to support IOS trying to copy the file twice.
    $sql = 'UPDATE DEVICE_MAP SET should_re_ztp=? WHERE serial_number=?';
    $logger->info("Saw 'taste' copy from switch ${sn}");
    try {
        $sth = $dbh->prepare($sql);
        $res = $sth->execute(array(1, $sn));
    } catch (PDOException $e) {
        $logger->crit("Failed to set the post-taste re-ZTP bit for {$sn}: {$e->getMessage()}");
    }
    exit(0);
} elseif ($row['should_re_ztp'] == 1) {
    header('Content-type: text/plain');
    echo "! RE-ZTP\r\n";
    $logger->info("Sending RE-ZTP message for switch {$sn}");

    $sql = 'UPDATE DEVICE_MAP SET should_re_ztp=?, provisioned_status=?, device_status=? WHERE serial_number=?';
    try {
        $sth = $dbh->prepare($sql);
        $res = $sth->execute(array(0, PROVISION_UNKNOWN, REACHABILITY_NEVER_REACHABLE, $sn));
    } catch (PDOException $e) {
        $logger->crit("Failed to reset re-ZTP bit for {$sn}: {$e->getMessage()}");
    }
    exit(0);
}

// Send a 404 to prevent unnecessarily writing to flash
http_response_code(404);
exit(0);