gene / module-encryption-key-manager
Gene encryption key manager
Installs: 72 798
Dependents: 0
Suggesters: 0
Security: 0
Stars: 70
Watchers: 7
Forks: 14
Open Issues: 5
Type:magento2-module
Requires
- php: ^8.1||^8.2||^8.3
- magento/module-catalog: *
- magento/module-encryption-key: *
- magento/module-jwt-user-token: *
- dev-master
- v0.0.15-alpha
- v0.0.14-alpha
- v0.0.13-alpha
- v0.0.12-alpha
- v0.0.11-alpha
- v0.0.10-alpha
- v0.0.9-alpha
- v0.0.8-alpha
- v0.0.7-alpha
- v0.0.6-alpha
- v0.0.5-alpha
- v0.0.4-alpha
- v0.0.3-alpha
- v0.0.2-alpha
- v0.0.1-alpha
- dev-PHP7.4-compat
- dev-feature/get-cloud-env-keys
- dev-performance-improvements-large
- dev-performance-improvements-baseline
- dev-performance-improvements
- dev-patch-1
- dev-pull-request-25
This package is auto-updated.
Last update: 2024-11-20 08:53:28 UTC
README
This module was built to aid with https://sansec.io/research/cosmicsting-hitting-major-stores
From the sansec post
Upgrading is Insufficient As we warned in our earlier article, it is crucial for merchants to upgrade or apply the official isolated fix. At this stage however, just patching for the CosmicSting vulnerability is likely to be insufficient.
The stolen encryption key still allows attackers to generate web tokens even after upgrading. Merchants that are currently still vulnerable should consider their encryption key as compromised. Adobe offers functionality out of the box to change the encryption key while also re-encrypting existing secrets.
Important note: generating a new encryption key using this functionality does not invalidate the old key. We recommend manually updating the old key in app/etc/env.php to a new value rather than removing it.
Even with your store secured, there is the chance that a JWT was issued and may still be valid. Merchants are strongly encouraged to rotate their encryption key to be safe, and the Magento process of generating a new encryption key does not actually invalidate the old one.
This module is provided as-is without any warranty. Test this on your local instances, then staging, then production. Use at your own risk.
This module does not conflict with the new hotfix released by Adobe. Both this module and that hotfix improve security in the same way, by making SecretBasedJwksFactory
use the most recent key. This module also provides additional tooling and improvements, please read below.
Installation
composer require gene/module-encryption-key-manager
bin/magento setup:upgrade
How to Rotate your key and protect your store
This is a rough list of steps that should be followed to prevent attacks with CosmicSting. Please read all of the steps carefully to understand the features this module provides, as well as the points of risk.
Generate a new Key and prevent old ones from being used for JWT
This should be every merchant's priority! Install this module and generate a new key with:
php bin/magento gene:encryption-key-manager:generate [--key=MY_32_CHAR_CRYPT_KEY] [--skip-saved-credit-cards]
This will force the JWT factory to use the newly generated key. Other areas of the application may continue to use the old keys. This step is the absolute priority and will help prevent attacks with CosmicSting.
- Use the
--key
option to manually define the new key to use during re-encryption. If no custom key is provided, a new key will be generated. - Use the
--skip-saved-credit-cards
flag to skip re-encrypting thesales_order_payment
cc_number_enc
data. This table can be very large, and many stores will have no data saved in this column.
Fully rotate your old keys
You can take your time to do the following. You are safe from cosmicsting provided you have installed the isolated patches and used this module to generate a new encryption key.
Then you are free to decide if you wish to re-encrypt your old data, and then invalidate your old key.
- Review your database (make sure zgrep is on version 1.12) for any tables with encrypted values. Make sure your dump is
--human-readable
(magerun) or--extended-insert=FALSE
(mysqldump) so that all values are on the same line as theINSERT INTO
$ zgrep -P "VALUES\s*\(.*\d:\d:...*'" database.sql | awk '{print $3}' | uniq admin_user core_config_data customer_entity oauth_token oauth_consumer tfa_user_config admin_adobe_ims_webapi adobe_user_profile
Or to get a overview of all found tables with amount of records:
zgrep -P "VALUES\s*\(.*\d:\d:...*'" database.sql | awk '{print $3}' | sort | uniq -c
- Review your
env.php
, if you store any encrypted values there they will need to be reissued by the provider as they may have been leaked. - Review functions using
->hash(
from the encryptor class. Changing the keys will result in a different hash. - If you have custom logic to handle that, it will be something you need to work that out manually.
- Generate a new key
php bin/magento gene:encryption-key-manager:generate
- You can specify the new crypt key to use with
php bin/magento gene:encryption-key-manager:generate --key=MY_32_CHAR_CRYPT_KEY
Magento\Catalog\Model\View\Asset\Image
will continue to use the key at the0
indexMagento\JwtUserToken\Model\SecretBasedJwksFactory
will only use the most recently generated key at the highest index
- You can specify the new crypt key to use with
- Fix missing config values
php bin/magento gene:encryption-key-manager:reencrypt-unhandled-core-config-data
- Re-run to verify
php bin/magento gene:encryption-key-manager:reencrypt-unhandled-core-config-data
- Re-run to verify
- Fix 2FA data
php bin/magento gene:encryption-key-manager:reencrypt-tfa-data
- Re-run to verify
php bin/magento gene:encryption-key-manager:reencrypt-tfa-data
- Re-run to verify
- Fix up all additional identified columns like so, be careful to verify each table and column as this may not be an exhaustive list (also be aware of
entity_id
,row_id
andid
)php bin/magento gene:encryption-key-manager:reencrypt-column admin_user user_id rp_token
php bin/magento gene:encryption-key-manager:reencrypt-column customer_entity entity_id rp_token
php bin/magento gene:encryption-key-manager:reencrypt-column oauth_token entity_id secret
php bin/magento gene:encryption-key-manager:reencrypt-column oauth_consumer entity_id secret
php bin/magento gene:encryption-key-manager:reencrypt-column admin_adobe_ims_webapi id access_token
php bin/magento gene:encryption-key-manager:reencrypt-column adobe_user_profile id access_token
- Flush the cache
php bin/magento cache:flush
- At this point you should have all your data migrated to your new encryption key, to help you verify this you can do the following
php bin/magento config:set --lock-env dev/debug/gene_encryption_manager_only_log_old_decrypts 1
php bin/magento config:set --lock-env dev/debug/gene_encryption_manager_enable_decrypt_logging 1
- Monitor your logs for "gene encryption manager" to verify nothing is still using the old key
- When you are happy you can invalidate your old key
php bin/magento gene:encryption-key-manager:invalidate
Magento\Catalog\Model\View\Asset\Image
will continue to use the key at the0
index in thecrypt/invalidated_key
section
- Test, test test! Your areas of focus for testing include
- all integrations that use Magento's APIs
- your media should still be displaying with the same hash directory. If it is regenerating it would take up a large amount of disk space and runtime.
- admin user login/logout
- customer login/logout
Features
Automatically invalidates old JWTs when a new key is generated
When magento generates a new encryption key it still allows the old one to be used with JWTs. This module prevents that by updating \Magento\JwtUserToken\Model\SecretBasedJwksFactory
to only allow keys generated against the most recent encryption key.
We inject a wrapped \Gene\EncryptionKeyManager\Model\DeploymentConfig
which only returns the most recent encryption key. This means that any existing tokens are no longer usable when a new encryption key is generated.
Allows you to keep your existing media cache directories
When magento generates a new encryption key, it causes the product media cache hash to change. This causes all product media to regenerate which takes a lot of processing time which can slow down page loads for your customers, as well as consuming extra disk space. This module ensures the old hash is still used for the media gallery.
Magento stores resized product images in directories like media/catalog/product/cache/abc123/f/o/foobar.jpg
, the hash abc123
is generated utilising the encryption keys in the system.
To avoid having to regenerate all the product media when cycling the encryption key there are some changes to force it to continue using the original value.
Magento\Catalog\Model\View\Asset\Image
has the $encryptor
swapped out with Gene\EncryptionKeyManager\Service\InvalidatedKeyHasher
. Which allows you to continue to generate md5 hashes with the old key.
Prevents long running process updating order payments
This module will also fix an issue where every sales_order_payment
entry was updated during the key generation process. On large stores this could take a long time. Now only necessary entries with saved card information are updated.
Logging
This module provides a mechanism to log the source for each call to decrypt. This will produce a lot of data as the magento system configuration is encrypted so each request will trigger a log write.
It is recommended to enable this logging after you have handled the re-encryption of all data in your system, but before you invalidate the old keys. This will give you an indication that you have properly handled everything, because if you see a log written it will tell you that something has been missed and where to go to find the source of the issue.
php bin/magento config:set --lock-env dev/debug/gene_encryption_manager_only_log_old_decrypts 1 php bin/magento config:set --lock-env dev/debug/gene_encryption_manager_enable_decrypt_logging 1
The log file is located in <mage_dir>/var/log/gene_encryption_key.log
bin/magento gene:encryption-key-manager:generate
You can use php bin/magento gene:encryption-key-manager:generate
to generate a new encryption key
This CLI tool does the same tasks as \Magento\EncryptionKey\Controller\Adminhtml\Crypt\Key\Save::execute()
with a few tweaks
- Avoids unneeded manipulation of empty
sales_order_payment
cc_number_enc
values. This can he helpful on large stores with many items in this table.
$ php bin/magento gene:encryption-key-manager:generate --force Generating a new encryption key _reEncryptSystemConfigurationValues - start _reEncryptSystemConfigurationValues - end _reEncryptCreditCardNumbers - start _reEncryptCreditCardNumbers - end Cleaning cache Done
- Use the
--key
option to manually define the new key to use during re-encryption. If no custom key is provided, a new key will be generated. - Use the
--skip-saved-credit-cards
flag to skip re-encrypting thesales_order_payment
cc_number_enc
data. This table can be very large, and many stores will have no data saved in this column. - This will automatically re-encrypt any
system
values inapp/etc/env.php
bin/magento gene:encryption-key-manager:invalidate
You can use php bin/magento gene:encryption-key-manager:invalidate
to invalidate old keys
This will create a new section to store the old invalidated_key
within your env.php
as well as stub out the crypt/key
path with nonsense text, so that the numerical ordering of the keys is maintained.
Before invalidation
'crypt' => [ 'key' => '84c9d7c0b305adf9ea7e19a05478bf11 2951b41e2b7f4c26e60a8e7ee00ca17b' ],
After invalidation
'crypt' => [ 'key' => 'invalidpwecbVeGpoL3Jxa4PXEOdn1ej 2951b41e2b7f4c26e60a8e7ee00ca17b', 'invalidated_key' => '84c9d7c0b305adf9ea7e19a05478bf11' ],
bin/magento gene:encryption-key-manager:reencrypt-unhandled-core-config-data
When Magento generates a new encryption key it re-encrypts values in core_config_data
where the backend_model
is defined as Magento\Config\Model\Config\Backend\Encrypted
. It is likely some third party modules have not implemented this correctly and handled the decryption themselves. In these cases we need to force through the re-encryption process for them.
This command runs in dry run mode by default, do that as a first pass to see the changes that will be made. When you are happy run with --force
.
$ php bin/magento gene:encryption-key-manager:reencrypt-unhandled-core-config-data Run with --force to make these changes, this will run in dry-run mode by default The latest encryption key is number 14, looking for old entries ################################################################################ config_id: 1347 scope: default scope_id: 0 path: yotpo/settings/secret updated_at: 2023-08-31 12:48:27 ciphertext_old: 0:2:abc123 plaintext: some_secret_here ciphertext_new: 14:3:xyz456 Dry run mode, no changes have been made ################################################################################ Done
bin/magento gene:encryption-key-manager:reencrypt-column
This allows you to target a specific column for re-encryption. If the column contains JSON, you can target it using dot notation: column.field
.
This command runs in dry run mode by default, do that as a first pass to see the changes that will be made. When you are happy run with --force
.
You should identify all columns that need to be handled, and run them through this process.
$ bin/magento gene:encryption-key-manager:reencrypt-column customer_entity entity_id rp_token Run with --force to make these changes, this will run in dry-run mode by default The latest encryption key is number 1, looking for old entries Looking for 'rp_token' in 'customer_entity', identified by 'entity_id' ######################################################################################################################## entity_id: 9876 ciphertext_old: 0:3:54+QHWqhSwuncAa87Ueph7xF9qPL1CT6+M9Z5AWuup447J33KGVw+Q+BvVLSKR1H1umiq69phKq5NEHk plaintext: acb123 ciphertext_new: 1:3:Y52lxB2VDnKeOHa0hf7kG/d15oooib6GQOYTcAmzfuEnhfW64NAdNN4YjRrhlh2IzQBO5IbwS48JDDRh Dry run mode, no changes have been made ######################################################################################################################## Done
bin/magento gene:encryption-key-manager:reencrypt-tfa-data
This command re-encrypts the 2FA data stored in tfa_user_config
. Some of this data is doubly encrypted, which is why it needs special handling.
This command runs in dry run mode by default, do that as a first pass to see the changes that will be made. When you are happy run with --force
.
This CLI has only been tested with Google Authenticator (TOTP) and U2F (Yubikey, etc). If you use Authy or DUO you MUST verify before use.
$ bin/magento gene:encryption-key-manager:reencrypt-tfa-data Run with --force to make these changes, this will run in dry-run mode by default This CLI has only been tested with Google Authenticator (TOTP) and U2F (Yubikey, etc). If you use Authy or DUO you *MUST* verify before use. The latest encryption key is number 1, looking for old entries Looking for encoded_config in tfa_user_config, identified by 'config_id' ######################################################################################################################## config_id: 1 ciphertext_old: 0:3:rV/z9+ilmOtaPGnOoZBayZ3waBNphK1RAcyWLetipM5UONn793rTyRknO1GhWxKxXC3ooJAgWDTMJPaXGRMGdj8yOqrlrjEp9uqi8D9SFgE/UTiWkBF4RRwVvZeo4lGGnll/CxJmtzuMXWa65TS0Z/a2QLdPyIH/3OomJH7sb3FgfQ== plaintext_old: {"google":{"secret":"0:3:LKm9642Rpl0gqlBha+m3FYWnQBBtLgjdLDvjfoPo923xmxd9ykbnvX0LucKI","active":true}} plaintext_new: {"google":{"secret":"1:3:m9mScDkTkeCdn2lXpwf5oMkL7lmgLOTYJXQyKbK\/m8QwDZVDNWI3CzH+uBaq","active":true}} ciphertext_new: 1:3:Tw/5ik2meBqzL8oodrudxmksrOekA/DbZE5+KgBAygFxp6Zx/A7vbMyHt4+N1MtQhlnqW/mAXL3l2kDpFHIQVvi2L+23o9mRpii2ldBwmuZgDlpQsm+Q4Hf8a+t2aUKndGOMeoH6xcZXFCConC+TUI+uregFXx6B5LU4ohCY52m/v7w= Dry run mode, no changes have been made ######################################################################################################################## Done
bin/magento gene:encryption-key-manager:get-cloud-keys
This command to get re-encrypted cloud environments variables. This one DOESN'T update existing values, it just returns new ones in console. The Dev has to update them manually in cloud console.
# No keys example $ bin/magento gene:encryption-key-manager:get-cloud-keys There is no old encrypted environment variables found # There is some encoded $ bin/magento gene:encryption-key-manager:get-cloud-keys --show-decrypted There is no old encrypted environment variables found The CLI command doesn\'t rewrite values. You have to update them manually in cloud console! Rows count: 4 ################################################################## Name: CONFIG__DEFAULT__SOME_KEY Dectypted value: dectypted_value Old Encrypted Value: 0:3:AAA1 New Encrypted Value: 1:3:BBB1 ################################################################## Name: CONFIG__DEFAULT__SOME_KEY_2 Dectypted value: dectypted_value_2 Old Encrypted Value: 0:3:AAA2 New Encrypted Value: 1:3:BBB2
Caveats
report.WARNING: Unable to unserialize value
This is not common, it has been reported by people using this module and people using the admin controller to rotate their encryption keys. Flushing redis cache resolves the issue.
Please ensure you flush your redis cache
Now you are right to continue with the re-encryption work as stated above.
You manually replaced your encryption key
You will need to:
- Recover your old encryption key
- Prepend your old key to the new key, separated by
\n
and repeat the steps above
Other issues
Search https://github.com/genecommerce/module-encryption-key-manager/issues for other issues.