HOME

<?php

/**
 * @file classes/security/AccessKeyManager.php
 *
 * Copyright (c) 2014-2021 Simon Fraser University
 * Copyright (c) 2000-2021 John Willinsky
 * Distributed under the GNU GPL v3. For full terms see the file docs/COPYING.
 *
 * @class AccessKeyManager
 *
 * @ingroup security
 *
 * @see AccessKey
 *
 * @brief Class defining operations for AccessKey management.
 */

namespace PKP\security;

use PKP\core\Core;
use PKP\db\DAORegistry;

class AccessKeyManager
{
    /** @var AccessKeyDAO */
    public $accessKeyDao;

    /**
     * Constructor.
     * Create a manager for access keys.
     */
    public function __construct()
    {
        $this->accessKeyDao = DAORegistry::getDAO('AccessKeyDAO');
        $this->_performPeriodicCleanup();
    }

    /**
     * Generate a key hash from a key.
     *
     * @param string $key
     *
     * @return string
     */
    public function generateKeyHash($key)
    {
        return md5($key);
    }

    /**
     * Validate an access key based on the supplied credentials.
     * If $assocId is specified, it must match the associated ID of the
     * key exactly.
     *
     * @param string $context The context of the access key
     * @param int $userId
     * @param string $keyHash The access key "passcode"
     * @param string $assocId optional assoc ID to check against the keys in the database
     *
     * @return AccessKey
     */
    public function validateKey($context, $userId, $keyHash, $assocId = null)
    {
        return $this->accessKeyDao->getAccessKeyByKeyHash($context, $userId, $keyHash, $assocId);
    }

    /**
     * Create an access key with the given information.
     *
     * @param string $context The context of the access key
     * @param int $userId The ID of the effective user for this access key
     * @param ?int $assocId The associated ID of the key
     * @param int $expiryDays The number of days before this key expires
     *
     * @return string The generated passkey
     */
    public function createKey($context, $userId, $assocId, $expiryDays)
    {
        $accessKey = new AccessKey();
        $accessKey->setContext($context);
        $accessKey->setUserId($userId);
        $accessKey->setAssocId($assocId);
        $accessKey->setExpiryDate(Core::getCurrentDate(time() + (60 * 60 * 24 * $expiryDays)));

        $key = Validation::generatePassword();
        $accessKey->setKeyHash($this->generateKeyHash($key));

        $this->accessKeyDao->insertObject($accessKey);

        return $key;
    }

    /**
     * Periodically clean up expired keys.
     */
    public function _performPeriodicCleanup()
    {
        if (time() % 100 == 0) {
            $accessKeyDao = DAORegistry::getDAO('AccessKeyDAO'); /** @var AccessKeyDAO $accessKeyDao */
            $accessKeyDao->deleteExpiredKeys();
        }
    }
}

if (!PKP_STRICT_MODE) {
    class_alias('\PKP\security\AccessKeyManager', '\AccessKeyManager');
}