diff --git a/dbee.install b/dbee.install index 58b6238..8026738 100644 --- a/dbee.install +++ b/dbee.install @@ -8,6 +8,7 @@ use Drupal\Core\Site\Settings; use Drupal\key\Entity\Key; use Drupal\encrypt\Entity\EncryptionProfile; +use Drupal\dbee\DbeeConstants; /** * Implements hook_install(). @@ -24,7 +25,7 @@ function dbee_install($is_syncing) { // Add configuration data for the dbee module. // Check if a key already exists. - if (_dbee_create_encryption_key(DBEE_DEFAULT_KEY_NAME, DBEE_DEFAULT_KEY_BYTES, DBEE_DEFAULT_KEY_FILENAME, $is_syncing) && _dbee_create_encryt_profile(DBEE_ENCRYPT_NAME, DBEE_DEFAULT_KEY_NAME, DBEE_DEFAULT_ENCRYPTION_METHOD, $is_syncing)) { + if (_dbee_create_encryption_key(DbeeConstants::DBEE_DEFAULT_KEY_NAME, DbeeConstants::DBEE_DEFAULT_KEY_BYTES, DbeeConstants::DBEE_DEFAULT_KEY_FILENAME, $is_syncing) && _dbee_create_encryt_profile(DbeeConstants::DBEE_ENCRYPT_NAME, DbeeConstants::DBEE_DEFAULT_KEY_NAME, DbeeConstants::DBEE_DEFAULT_ENCRYPTION_METHOD, $is_syncing)) { // Dbee Key and encryption profile exist or have just been created. // Edit mail and init storage length. // Parameters. diff --git a/dbee.module b/dbee.module index e6b4104..69062cb 100644 --- a/dbee.module +++ b/dbee.module @@ -15,14 +15,7 @@ use Drupal\encrypt\Entity\EncryptionProfile; use Drupal\encrypt\Exception\EncryptException; use Drupal\Core\Access\AccessResult; use Drupal\Core\Routing\RouteMatchInterface; - -define('DBEE_ENCRYPT_NAME', 'dbee'); -define('DBEE_PREV_ENCRYPT_NAME', 'dbee_prev'); -define('DBEE_DEFAULT_KEY_NAME', 'dbee'); -define('DBEE_PREV_KEY_NAME', 'dbee_prev'); -define('DBEE_DEFAULT_ENCRYPTION_METHOD', 'real_aes'); -define('DBEE_DEFAULT_KEY_FILENAME', 'dbee.key'); -define('DBEE_DEFAULT_KEY_BYTES', 32); +use Drupal\dbee\DbeeConstants; /** * Tests whether the email address value needs to be altered. @@ -64,7 +57,7 @@ function dbee_email_to_alter($email) { function dbee_encrypt($string) { if (dbee_email_to_alter($string)) { // The email address is valid. - $encryption_profile = EncryptionProfile::load(DBEE_ENCRYPT_NAME); + $encryption_profile = EncryptionProfile::load(DbeeConstants::DBEE_ENCRYPT_NAME); try { $encrypted = utf8_encode(\Drupal::service('encryption')->encrypt($string, $encryption_profile)); // Ensure the encrypted value is correct. @@ -105,7 +98,7 @@ function dbee_encrypt($string) { function dbee_decrypt($string, $prev_encrypt = FALSE) { if (!empty($string) && !dbee_email_to_alter($string)) { // The email address is not valid. - $encrypt_profile = (!$prev_encrypt) ? DBEE_ENCRYPT_NAME : DBEE_PREV_ENCRYPT_NAME; + $encrypt_profile = (!$prev_encrypt) ? DbeeConstants::DBEE_ENCRYPT_NAME : DbeeConstants::DBEE_PREV_ENCRYPT_NAME; $encryption_profile = EncryptionProfile::load($encrypt_profile); try { $uncrypted_mail = utf8_encode(\Drupal::service('encryption')->decrypt(utf8_decode($string), $encryption_profile)); @@ -324,19 +317,19 @@ function dbee_entity_presave(EntityInterface $entity) { } } } - elseif (!$entity->isNew() && (($type == 'key' && $entity->getOriginalId() == dbee_current_key_id()) || ($type == 'encryption_profile' && $entity->getOriginalId() == DBEE_ENCRYPT_NAME)) && dbee_entity_change($entity)) { + elseif (!$entity->isNew() && (($type == 'key' && $entity->getOriginalId() == dbee_current_key_id()) || ($type == 'encryption_profile' && $entity->getOriginalId() == DbeeConstants::DBEE_ENCRYPT_NAME)) && dbee_entity_change($entity)) { // The encryption parameters will change. $set_prev_encrypt = FALSE; $set_prev_key = FALSE; $reencrypt_all = FALSE; if ($type == 'key' && $entity->getOriginalId() == dbee_current_key_id()) { - if (!\Drupal::service('key.repository')->getKey(DBEE_PREV_KEY_NAME)) { + if (!\Drupal::service('key.repository')->getKey(DbeeConstants::DBEE_PREV_KEY_NAME)) { $copy = $entity->original->createDuplicate(); - $copy->set('name', DBEE_PREV_KEY_NAME); - $copy->set('id', DBEE_PREV_KEY_NAME); + $copy->set('name', DbeeConstants::DBEE_PREV_KEY_NAME); + $copy->set('id', DbeeConstants::DBEE_PREV_KEY_NAME); $copy->set('label', 'Previous DataBase Email Encryption key'); $copy->set('description', 'Previous Dbee key for decrypting users email addresses.'); - if ($copy->save() && \Drupal::service('key.repository')->getKey(DBEE_PREV_KEY_NAME)) { + if ($copy->save() && \Drupal::service('key.repository')->getKey(DbeeConstants::DBEE_PREV_KEY_NAME)) { \Drupal::logger('dbee')->info('Dbee key is going to change, previous key is saved.'); $set_prev_encrypt = $set_prev_key = TRUE; } @@ -348,22 +341,22 @@ function dbee_entity_presave(EntityInterface $entity) { $set_prev_encrypt = TRUE; } } - elseif ($type == 'encryption_profile' && $entity->getOriginalId() == DBEE_ENCRYPT_NAME) { + elseif ($type == 'encryption_profile' && $entity->getOriginalId() == DbeeConstants::DBEE_ENCRYPT_NAME) { $set_prev_encrypt = TRUE; } if ($set_prev_encrypt) { - $dbee_encrypt = ($type != 'encryption_profile') ? EncryptionProfile::load(DBEE_ENCRYPT_NAME) : $entity->original; - $prev_encrypt_profile = EncryptionProfile::load(DBEE_PREV_ENCRYPT_NAME); + $dbee_encrypt = ($type != 'encryption_profile') ? EncryptionProfile::load(DbeeConstants::DBEE_ENCRYPT_NAME) : $entity->original; + $prev_encrypt_profile = EncryptionProfile::load(DbeeConstants::DBEE_PREV_ENCRYPT_NAME); if ($dbee_encrypt && !$prev_encrypt_profile) { $copy = $dbee_encrypt->createDuplicate(); - $copy->set('name', DBEE_PREV_ENCRYPT_NAME); - $copy->set('id', DBEE_PREV_ENCRYPT_NAME); + $copy->set('name', DbeeConstants::DBEE_PREV_ENCRYPT_NAME); + $copy->set('id', DbeeConstants::DBEE_PREV_ENCRYPT_NAME); $copy->set('label', "Previous Dbee {$dbee_encrypt->getEncryptionMethodId()}"); if ($set_prev_key) { - $copy->set('encryption_key', DBEE_PREV_KEY_NAME); + $copy->set('encryption_key', DbeeConstants::DBEE_PREV_KEY_NAME); } - if ($copy->save() && EncryptionProfile::load(DBEE_PREV_ENCRYPT_NAME)) { + if ($copy->save() && EncryptionProfile::load(DbeeConstants::DBEE_PREV_ENCRYPT_NAME)) { \Drupal::logger('dbee')->info('Dbee key is going to change, encrypt profile saved with prev key values.'); // Save the new settings. // Next, decrypt all user email addresses. @@ -1102,8 +1095,14 @@ function _dbee_db_functions_value(array $db_funct, array $user) { function dbee_entity_access(EntityInterface $entity, $operation, AccountInterface $account) { if (in_array($entity->getEntityTypeId(), ['encryption_profile', 'key'])) { $id = $entity->getOriginalId(); - $protected_encrypt_ids = [DBEE_ENCRYPT_NAME, DBEE_PREV_ENCRYPT_NAME]; - $protected_key_ids = [DBEE_DEFAULT_KEY_NAME, DBEE_PREV_KEY_NAME]; + $protected_encrypt_ids = [ + DbeeConstants::DBEE_ENCRYPT_NAME, + DbeeConstants::DBEE_PREV_ENCRYPT_NAME, + ]; + $protected_key_ids = [ + DbeeConstants::DBEE_DEFAULT_KEY_NAME, + DbeeConstants::DBEE_PREV_KEY_NAME, + ]; $dbee_current_key_id = dbee_current_key_id(); if (!in_array($dbee_current_key_id, $protected_key_ids)) { $protected_key_ids[] = $dbee_current_key_id; @@ -1117,7 +1116,10 @@ function dbee_entity_access(EntityInterface $entity, $operation, AccountInterfac return AccessResult::allowedIfHasPermission($account, 'administer dbee'); case 'update': - return in_array($id, [DBEE_PREV_KEY_NAME, DBEE_PREV_KEY_NAME]) ? AccessResult::forbidden() : AccessResult::allowedIfHasPermission($account, 'administer dbee'); + return in_array($id, [ + DbeeConstants::DBEE_PREV_KEY_NAME, + DbeeConstants::DBEE_PREV_KEY_NAME, + ]) ? AccessResult::forbidden() : AccessResult::allowedIfHasPermission($account, 'administer dbee'); } } } @@ -1131,7 +1133,7 @@ function dbee_entity_access(EntityInterface $entity, $operation, AccountInterfac */ function dbee_current_key_id() { $dbee_current_key_id = FALSE; - if ($dbee_encrypt = EncryptionProfile::load(DBEE_ENCRYPT_NAME)) { + if ($dbee_encrypt = EncryptionProfile::load(DbeeConstants::DBEE_ENCRYPT_NAME)) { if (!empty($dbee_encrypt->getEncryptionKeyId()) && \Drupal::service('key.repository')->getKey($dbee_encrypt->getEncryptionKeyId())) { $dbee_current_key_id = $dbee_encrypt->getEncryptionKeyId(); } diff --git a/dbee.users.inc b/dbee.users.inc index 7a160bb..477de07 100644 --- a/dbee.users.inc +++ b/dbee.users.inc @@ -7,8 +7,7 @@ use Drupal\Core\Messenger\MessengerInterface; use Drupal\encrypt\Entity\EncryptionProfile; - -define('DBEE_ALL_USERS_CRYPT_LIMIT', 15); +use Drupal\dbee\DbeeConstants; /** * Encrypts or decrypts all user email addresses. @@ -43,7 +42,7 @@ function dbee_update_crypt_all($action, $dbee_context = FALSE, $force_batch = FA } // Force batch operation execution for decrypting emails on encrypt changes. - if (!$force_batch && $n_users <= DBEE_ALL_USERS_CRYPT_LIMIT) { + if (!$force_batch && $n_users <= DbeeConstants::DBEE_ALL_USERS_CRYPT_LIMIT) { // Only 15 users to encrypt. No batch operation. $context = []; dbee_update_crypt_users_all_batch_proceed($action, $dbee_context, $context); @@ -112,7 +111,7 @@ function dbee_update_crypt_users_all_batch_proceed($action, $dbee_context, &$con $context['results']['dbee_action'] = $action; $context['results']['dbee_context'] = $dbee_context; } - $limit = DBEE_ALL_USERS_CRYPT_LIMIT; + $limit = DbeeConstants::DBEE_ALL_USERS_CRYPT_LIMIT; $db_users = dbee_stored_users(NULL, $context['sandbox']['progress'], $limit); foreach ($db_users as $uid => $db_values) { // Change database encryption for this user. @@ -177,7 +176,7 @@ function dbee_update_crypt_users_all_batch_finished($success, $results, $operati // addresses after the dbee module has been disabled. require_once \Drupal::service('extension.list.module')->getPath('dbee') . '/dbee.module'; } - $key_id = Drupal::service('key.repository')->getKey(DBEE_DEFAULT_KEY_NAME)->getOriginalId(); + $key_id = Drupal::service('key.repository')->getKey(DbeeConstants::DBEE_DEFAULT_KEY_NAME)->getOriginalId(); if ($key_id) { // Only admins can delete. The key may be used for other encryption // stuff. @@ -212,10 +211,10 @@ function dbee_update_crypt_users_all_batch_finished($success, $results, $operati case 'change': // Delete prev parameters. if ($real_success) { - $encrypt_profile = EncryptionProfile::load(DBEE_PREV_ENCRYPT_NAME); + $encrypt_profile = EncryptionProfile::load(DbeeConstants::DBEE_PREV_ENCRYPT_NAME); if ($encrypt_profile) { if ($encrypt_profile->delete()) { - $key = Drupal::service('key.repository')->getKey(DBEE_PREV_KEY_NAME); + $key = Drupal::service('key.repository')->getKey(DbeeConstants::DBEE_PREV_KEY_NAME); if ($key) { $key->delete(); } diff --git a/src/DbeeConstants.php b/src/DbeeConstants.php new file mode 100644 index 0000000..37130d7 --- /dev/null +++ b/src/DbeeConstants.php @@ -0,0 +1,19 @@ +