Skip to content
Snippets Groups Projects
api.inc.php 2.93 KiB
Newer Older
  • Learn to ignore specific revisions
  • Jared Hancock's avatar
    Jared Hancock committed
    <?php
    /*********************************************************************
        api.inc.php
    
        File included on every API page...handles security and abuse issues
    
        Peter Rotich <peter@osticket.com>
        Copyright (c)  2006-2012 osTicket
        http://www.osticket.com
    
        Released under the GNU General Public License WITHOUT ANY WARRANTY.
        See LICENSE.TXT for details.
    
        vim: expandtab sw=4 ts=4 sts=4:
    **********************************************************************/
    //postfix exit codes see /usr/include/sysexits.h 
    define('EX_DATAERR', 65);       /* data format error */
    define('EX_NOINPUT', 66);       /* cannot open input */
    define('EX_UNAVAILABLE', 69);   /* service unavailable */
    define('EX_IOERR', 74);         /* input/output error */
    define('EX_TEMPFAIL',75);       /* temp failure; user is invited to retry */
    define('EX_NOPERM',  77);       /* permission denied */
    define('EX_CONFIG',  78);       /* configuration error */
    
    define('EX_SUCCESS',0);         /* success baby */
    
    if(!file_exists('../main.inc.php')) exit(EX_CONFIG);
    require_once('../main.inc.php');
    if(!defined('INCLUDE_DIR')) exit(EX_CONFIG);
    
    require_once(INCLUDE_DIR.'class.http.php');
    require_once(INCLUDE_DIR.'class.api.php');
    
    define('OSTAPIINC',TRUE); // Define tag that included files can check
    
    $remotehost=(isset($_SERVER['HTTP_HOST']) || isset($_SERVER['REMOTE_ADDR']))?TRUE:FALSE;
    /* API exit helper */
    function api_exit($code,$msg='') {
    
    Jared Hancock's avatar
    Jared Hancock committed
        
        if($code!=EX_SUCCESS) {
            //Error occured...
            $_SESSION['api']['errors']+=1;
            $_SESSION['api']['time']=time();
    
            $ost->logWarning("API error - code #$code",$msg);
    
    Jared Hancock's avatar
    Jared Hancock committed
            //echo "API Error:.$msg";
        }
        if($remotehost){
            switch($code) {
            case EX_SUCCESS:
                Http::response(200,$code,'text/plain');
                break;
            case EX_UNAVAILABLE:
                Http::response(405,$code,'text/plain');
                break;
            case EX_NOPERM:
                Http::response(403,$code,'text/plain');
                break;
            case EX_DATAERR:
            case EX_NOINPUT:
            default:
                Http::response(416,$code,'text/plain');
            }
        }
        exit($code);
    }
    
    //Remote hosts need authorization.
    if($remotehost) {
    
        $ip=$_SERVER['REMOTE_ADDR'];
        $key=$_SERVER['HTTP_USER_AGENT']; //pulling all tricks.
        //Upto 10 consecutive errors allowed...before a 5 minute timeout.
        //One more error during timeout and timeout starts a new clock
        if($_SESSION['api']['errors']>10 && (time()-$_SESSION['api']['time'])<=5*60) { // timeout!
            api_exit(EX_NOPERM,"Remote host [$ip] in timeout - error #".$_SESSION['api']['errors']);
        }
        //Check API key & ip
        if(!Validator::is_ip($ip) || !Api::validate($key,$ip)) { 
            api_exit(EX_NOPERM,'Unknown remote host ['.$ip.'] or invalid API key ['.$key.']');
        }
        //At this point we know the remote host/IP is allowed.
        $_SESSION['api']['errors']=0; //clear errors for the session.
    }
    ?>