1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
<?php
/**
* Encrypted config field backend model
*
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
namespace Magento\Config\Model\Config\Backend;
/**
* @api
* @since 100.0.2
*/
class Encrypted extends \Magento\Framework\App\Config\Value implements
\Magento\Framework\App\Config\Data\ProcessorInterface
{
/**
* @var \Magento\Framework\Encryption\EncryptorInterface
*/
protected $_encryptor;
/**
* @param \Magento\Framework\Model\Context $context
* @param \Magento\Framework\Registry $registry
* @param \Magento\Framework\App\Config\ScopeConfigInterface $config
* @param \Magento\Framework\App\Cache\TypeListInterface $cacheTypeList
* @param \Magento\Framework\Encryption\EncryptorInterface $encryptor
* @param \Magento\Framework\Model\ResourceModel\AbstractResource $resource
* @param \Magento\Framework\Data\Collection\AbstractDb $resourceCollection
* @param array $data
*/
public function __construct(
\Magento\Framework\Model\Context $context,
\Magento\Framework\Registry $registry,
\Magento\Framework\App\Config\ScopeConfigInterface $config,
\Magento\Framework\App\Cache\TypeListInterface $cacheTypeList,
\Magento\Framework\Encryption\EncryptorInterface $encryptor,
\Magento\Framework\Model\ResourceModel\AbstractResource $resource = null,
\Magento\Framework\Data\Collection\AbstractDb $resourceCollection = null,
array $data = []
) {
$this->_encryptor = $encryptor;
parent::__construct($context, $registry, $config, $cacheTypeList, $resource, $resourceCollection, $data);
}
/**
* Magic method called during class serialization
*
* @return string[]
*/
public function __sleep()
{
$properties = parent::__sleep();
return array_diff($properties, ['_encryptor']);
}
/**
* Magic method called during class un-serialization
*
* @return void
*/
public function __wakeup()
{
parent::__wakeup();
$this->_encryptor = \Magento\Framework\App\ObjectManager::getInstance()->get(
\Magento\Framework\Encryption\EncryptorInterface::class
);
}
/**
* Decrypt value after loading
*
* @return void
*/
protected function _afterLoad()
{
$value = (string)$this->getValue();
if (!empty($value) && ($decrypted = $this->_encryptor->decrypt($value))) {
$this->setValue($decrypted);
}
}
/**
* Encrypt value before saving
*
* @return void
*/
public function beforeSave()
{
$this->_dataSaveAllowed = false;
$value = (string)$this->getValue();
// don't save value, if an obscured value was received. This indicates that data was not changed.
if (!preg_match('/^\*+$/', $value) && !empty($value)) {
$this->_dataSaveAllowed = true;
$encrypted = $this->_encryptor->encrypt($value);
$this->setValue($encrypted);
} elseif (empty($value)) {
$this->_dataSaveAllowed = true;
}
}
/**
* Process config value
*
* @param string $value
* @return string
*/
public function processValue($value)
{
return $this->_encryptor->decrypt($value);
}
}