oxopeniddb.php

Go to the documentation of this file.

<?php

require_once 'Auth/OpenID/Interface.php';
require_once 'Auth/OpenID/Nonce.php';

class oxOpenIdDb extends Auth_OpenID_OpenIDStore
{
    protected $_sAssociationsTable = null;

    protected $_sNoncesTable = null;

    protected $_oDB = null;

    protected $_iMaxNonceAge = null;

    public function __construct()
    {
        $this->_sAssociationsTable = "oxoidassociations";
        $this->_sNoncesTable       = "oxoidnonces";
        $this->_oDB = oxDb::getDb();
        $this->_iMaxNonceAge = 6 * 60 * 60;
    }

    public function storeAssociation($sServerUrl, $oAssociation)
    {
        $sSql  = "REPLACE INTO " . $this->_sAssociationsTable . " (server_url,handle,secret,issued,lifetime,assoc_type)";
        $sSql .= " VALUES (".$this->_oDB->quote( $sServerUrl ).",".$this->_oDB->quote( $oAssociation->handle ).",'";
        $sSql .= $this->blobEncode($oAssociation->secret)."', ".$this->_oDB->quote( $oAssociation->issued ).", ";
        $sSql .= $this->_oDB->quote( $oAssociation->lifetime ).", ".$this->_oDB->quote( $oAssociation->assoc_type ).")";

        $this->_oDB->execute($sSql);
    }

    public function removeAssociation($sServerUrl, $sHandle)
    {
        $aRes = $this->_getAssoc($sServerUrl, $sHandle);
        if ( !$aRes ) {
            return false;
        }

        $sSql  = "DELETE FROM ".$this->_sAssociationsTable;
        $sSql .= " WHERE server_url = ".$this->_oDB->quote( $sServerUrl )." AND handle = ".$this->_oDB->quote( $sHandle );
        $this->_oDB->execute($sSql);

        return true;
    }

    public function getAssociation($sServerUrl, $sHandle = null)
    {
        $aAssociations = array();
        if ($sHandle !== null) {
            $aRes = $this->_getAssoc($sServerUrl, $sHandle);

            $aAssocs = array();
            if ( $aRes->recordCount() > 0 ) {
                $aAssocRow = $aRes->fields;
                $oAssoc = new Auth_OpenID_Association($aAssocRow['0'],
                                                 $aAssocRow['1'],
                                                 $aAssocRow['2'],
                                                 $aAssocRow['3'],
                                                 $aAssocRow['4']);
                $oAssoc->secret = $this->blobDecode($oAssoc->secret);

                if ($oAssoc->getExpiresIn() == 0) {
                    $this->removeAssociation($sServerUrl, $oAssoc->handle);
                } else {
                    $aAssociations[] = array($oAssoc->issued, $oAssoc);
                }
            } else {
                return null;
            }
        } else {
            $aAssocs = $this->_getAssocs($sServerUrl);
            if ( !$aAssocs || ( $aAssocs->recordCount() == 0 ) ) {
                return null;
            }
            $aAssocRow = $aAssocs->fields;
            $oAssoc = new Auth_OpenID_Association($aAssocRow['0'],
                                             $aAssocRow['1'],
                                             $aAssocRow['2'],
                                             $aAssocRow['3'],
                                             $aAssocRow['4']);
            $oAssoc->secret = $this->blobDecode($oAssoc->secret);
            if ($oAssoc->getExpiresIn() == 0) {
                $this->removeAssociation($sServerUrl, $oAssoc->handle);
            } else {
                $aAssociations[] = array($oAssoc->issued, $oAssoc);
            }
        }

        if ($aAssociations) {
            $aIssued = array();
            $aAssocs = array();
            foreach ($aAssociations as $key => $assoc) {
                $aIssued[$key] = $assoc[0];
                $aAssocs[$key] = $assoc[1];
            }

            array_multisort($aIssued, SORT_DESC, $aAssocs, SORT_DESC, $aAssociations);

            // return the most recently issued one.
            list($aIssued, $oAssoc) = $aAssociations[0];
            return $oAssoc;
        } else {
            return null;
        }

    }

    public function useNonce($sServerUrl, $sTimestamp, $sSalt)
    {
        if ( abs($sTimestamp - time()) > $this->_iMaxNonceAge ) {
            return false;
        }
        $sSql = "INSERT INTO " . $this->_sNoncesTable . " (server_url, timestamp, salt) ";
        $sSql.= "VALUES (".$this->_oDB->quote( $sServerUrl ).", ".$this->_oDB->quote( $sTimestamp ).", ".$this->_oDB->quote( $sSalt ).")";
        $this->_oDB->execute($sSql);
        return true;
    }

    public function cleanupNonces()
    {
        $v = time() - $this->_iMaxNonceAge;

        $sSql = "DELETE FROM " . $this->_sNoncesTable . " WHERE timestamp < " . $v;
        $this->_oDB->execute($sSql);
    }

    public function cleanupAssociations()
    {
        $sSql = "DELETE FROM " . $this->_sAssociationsTable . " WHERE issued + lifetime <" . time();
        $this->_oDB->execute($sSql);
    }

    public function reset()
    {
        $this->_oDB->execute("DELETE FROM " . $this->_sAssociationsTable);
        $this->_oDB->execute("DELETE FROM " . $this->_sNoncesTable);
    }

    public function createTables()
    {
        $oRet = $this->_oDB->execute("show tables like '".$this->_sNoncesTable."'" );
        if ( $oRet->recordCount() == 0 ) {
            $sSqlNonces = "CREATE TABLE IF NOT EXISTS ".$this->_sNoncesTable." (";
            $sSqlNonces.= "server_url VARCHAR(2047) NOT NULL,";
            $sSqlNonces.= "timestamp INTEGER NOT NULL,";
            $sSqlNonces.= "salt CHAR(40) NOT NULL,";
            $sSqlNonces.= "UNIQUE (server_url(255), timestamp, salt)";
            $sSqlNonces.= ") ENGINE=InnoDB";
            $this->_oDB->execute($sSqlNonces);
        }
        $oRet = $this->_oDB->execute("show tables like '".$this->_sAssociationsTable."'" );
        if ( $oRet->recordCount() == 0 ) {
            $sSqlAssoc = "CREATE TABLE IF NOT EXISTS ".$this->_sAssociationsTable." (";
            $sSqlAssoc.= "server_url BLOB NOT NULL,";
            $sSqlAssoc.= "handle VARCHAR(255) NOT NULL,";
            $sSqlAssoc.= "secret CHAR(255) NOT NULL,";
            $sSqlAssoc.= "issued INTEGER NOT NULL,";
            $sSqlAssoc.= "lifetime INTEGER NOT NULL,";
            $sSqlAssoc.= "assoc_type VARCHAR(64) NOT NULL,";
            $sSqlAssoc.= "PRIMARY KEY (server_url(255), handle)";
            $sSqlAssoc.= ") ENGINE=InnoDB";
            $this->_oDB->execute($sSqlAssoc);
        }
    }

    protected function _getAssoc($sServerUrl, $sHandle)
    {
        $sSql  = "SELECT handle, secret, issued, lifetime, assoc_type FROM ".$this->_sAssociationsTable;
        $sSql .= " WHERE server_url = ".$this->_oDB->quote( $sServerUrl )." AND handle = ".$this->_oDB->quote( $sHandle );
        $aRes = $this->_oDB->execute($sSql);
        if ($aRes) {
            return $aRes;
        } else {
            return false;
        }
    }

    protected function _getAssocs($sServerUrl)
    {
        $sSql  = "SELECT handle, secret, issued, lifetime, assoc_type FROM ".$this->_sAssociationsTable;
        $sSql .= " WHERE server_url = ".$this->_oDB->quote( $sServerUrl );
        $aRes = $this->_oDB->execute($sSql);
        if ($aRes) {
            return $aRes;
        } else {
            return false;
        }
    }

    public function blobEncode($sSecret)
    {
        return base64_encode($sSecret);
    }

    public function blobDecode($sSecret)
    {
        return base64_decode($sSecret);
    }

}