How is the \Magento\Store\Model\Store::XML_PATH_SECURE_IN_ADMINHTML constant declared and used?

dmitry_fedyuk · May 30, 2016, 8:57pm

Declaration

magento/magento2/blob/a5fa3af3/app/code/Magento/Store/Model/Store.php#L70-L70


const XML_PATH_SECURE_IN_ADMINHTML = 'web/secure/use_in_adminhtml';

How is the web/secure/use_in_adminhtml option implemented and used?

Usages

1. \Magento\Backend\Model\AdminPathConfig::shouldBeSecure()

github.com

magento/magento2/blob/a5fa3af3/app/code/Magento/Backend/Model/AdminPathConfig.php#L59-L76


/**
 * {@inheritdoc}
 *
 * @param string $path
 * @return bool
 */
public function shouldBeSecure($path)
{
    return parse_url(
        (string)$this->coreConfig->getValue(Store::XML_PATH_UNSECURE_BASE_URL, 'default'),
        PHP_URL_SCHEME
    ) === 'https'
    || $this->backendConfig->isSetFlag(Store::XML_PATH_SECURE_IN_ADMINHTML)
    && parse_url(
        (string)$this->coreConfig->getValue(Store::XML_PATH_SECURE_BASE_URL, 'default'),
        PHP_URL_SCHEME
    ) === 'https';
}

2. \Magento\Store\Model\HeaderProvider\Hsts::canApply()

github.com

magento/magento2/blob/a5fa3af3/app/code/Magento/Store/Model/HeaderProvider/Hsts.php#L43-L51


/**
 * {@inheritdoc}
 */
public function canApply()
{
    return (bool)$this->scopeConfig->isSetFlag(Store::XML_PATH_SECURE_IN_FRONTEND)
        && $this->scopeConfig->isSetFlag(Store::XML_PATH_SECURE_IN_ADMINHTML)
        && $this->scopeConfig->isSetFlag(Store::XML_PATH_ENABLE_HSTS);
}

3. \Magento\Store\Model\HeaderProvider\UpgradeInsecure::canApply()

github.com

magento/magento2/blob/a5fa3af3/app/code/Magento/Store/Model/HeaderProvider/UpgradeInsecure.php#L43-L51


/**
 * {@inheritdoc}
 */
public function canApply()
{
    return (bool)$this->scopeConfig->isSetFlag(Store::XML_PATH_SECURE_IN_FRONTEND)
        && $this->scopeConfig->isSetFlag(Store::XML_PATH_SECURE_IN_ADMINHTML)
        && $this->scopeConfig->isSetFlag(Store::XML_PATH_ENABLE_UPGRADE_INSECURE);
}

4. \Magento\Setup\Model\StoreConfigurationDataMapper::$pathDataMap

github.com

magento/magento2/blob/a5fa3af3/setup/src/Magento/Setup/Model/StoreConfigurationDataMapper.php#L38-L56


/**
 * Map of configuration paths to data keys
 *
 * @var array
 */
private $pathDataMap = [
    Store::XML_PATH_USE_REWRITES => self::KEY_USE_SEF_URL,
    Store::XML_PATH_UNSECURE_BASE_URL => self::KEY_BASE_URL,
    Store::XML_PATH_SECURE_BASE_URL => self::KEY_BASE_URL_SECURE,
    Data::XML_PATH_DEFAULT_LOCALE => self::KEY_LANGUAGE,
    Store::XML_PATH_SECURE_IN_FRONTEND  => self::KEY_IS_SECURE,
    Store::XML_PATH_SECURE_IN_ADMINHTML => self::KEY_IS_SECURE_ADMIN,
    Data::XML_PATH_DEFAULT_TIMEZONE => self::KEY_TIMEZONE,
    Currency::XML_PATH_CURRENCY_BASE => self::KEY_CURRENCY,
    Currency::XML_PATH_CURRENCY_DEFAULT => self::KEY_CURRENCY,
    Currency::XML_PATH_CURRENCY_ALLOW => self::KEY_CURRENCY,
    Url::XML_PATH_USE_SECURE_KEY => self::KEY_ADMIN_USE_SECURITY_KEY,
    UiConfig::XML_PATH_LOGGING => self::KEY_JS_LOGGING
];

dmitry_fedyuk · May 31, 2016, 6:47am