mirror of
https://github.com/lingble/chatwoot.git
synced 2025-10-29 10:12:34 +00:00
38f16ba677
## Changelog
- Added conditional Active Record encryption to every external
credential we store (SMTP/IMAP passwords, Twilio tokens,
Slack/OpenAI hook tokens, Facebook/Instagram tokens, LINE/Telegram keys,
Twitter secrets) so new writes are encrypted
whenever Chatwoot.encryption_configured? is true; legacy installs still
receive plaintext until their secrets are
updated.
- Tuned encryption settings in config/application.rb to allow legacy
reads (support_unencrypted_data) and to extend
deterministic queries so lookups continue to match plaintext rows during
the rollout; added TODOs to retire the
fallback once encryption becomes mandatory.
- Introduced an MFA-pipeline test suite
(spec/models/external_credentials_encryption_spec.rb) plus shared
examples to
verify each attribute encrypts at rest and that plaintext records
re-encrypt on update, with a dedicated Telegram case.
The existing MFA GitHub workflow now runs these tests using the
preconfigured encryption keys.
fixes:
https://linear.app/chatwoot/issue/CW-5453/encrypt-sensitive-credentials-stored-in-plain-text-in-database
## Testing Instructions
1. Instance without encryption keys
- Unset ACTIVE_RECORD_ENCRYPTION_* vars (or run in an environment where
they’re absent).
- Create at least one credentialed channel (e.g., Email SMTP).
- Confirm workflows still function (send/receive mail or a similar
sanity check).
- In the DB you should still see plaintext values—this confirms the
guard prevents encryption when keys are missing.
2. Instance with encryption keys
- Configure the three encryption env vars and restart.
- Pick a couple of representative integrations (e.g., Email SMTP +
Twilio SMS).
- Legacy channel check:
- Use existing records created before enabling keys. Trigger their
workflow (send an email / SMS, or hit the
webhook) to ensure they still authenticate.
- Inspect the raw column—value remains plaintext until changed.
- Update legacy channel:
- Edit one legacy channel’s credential (e.g., change SMTP password).
- Verify the operation still works and the stored value is now encrypted
(raw column differs, accessor returns
original).
- New channel creation:
- Create a new channel of the same type; confirm functionality and that
the stored credential is encrypted from
the start.
---------
Co-authored-by: Muhsin Keloth <muhsinkeramam@gmail.com>
69 lines
2.3 KiB
Ruby
69 lines
2.3 KiB
Ruby
# == Schema Information
|
|
#
|
|
# Table name: channel_twitter_profiles
|
|
#
|
|
# id :bigint not null, primary key
|
|
# tweets_enabled :boolean default(TRUE)
|
|
# twitter_access_token :string not null
|
|
# twitter_access_token_secret :string not null
|
|
# created_at :datetime not null
|
|
# updated_at :datetime not null
|
|
# account_id :integer not null
|
|
# profile_id :string not null
|
|
#
|
|
# Indexes
|
|
#
|
|
# index_channel_twitter_profiles_on_account_id_and_profile_id (account_id,profile_id) UNIQUE
|
|
#
|
|
|
|
class Channel::TwitterProfile < ApplicationRecord
|
|
include Channelable
|
|
|
|
# TODO: Remove guard once encryption keys become mandatory (target 3-4 releases out).
|
|
if Chatwoot.encryption_configured?
|
|
encrypts :twitter_access_token
|
|
encrypts :twitter_access_token_secret
|
|
end
|
|
|
|
self.table_name = 'channel_twitter_profiles'
|
|
|
|
validates :profile_id, uniqueness: { scope: :account_id }
|
|
|
|
before_destroy :unsubscribe
|
|
|
|
EDITABLE_ATTRS = [:tweets_enabled].freeze
|
|
|
|
def name
|
|
'Twitter'
|
|
end
|
|
|
|
def create_contact_inbox(profile_id, name, additional_attributes)
|
|
::ContactInboxWithContactBuilder.new({
|
|
source_id: profile_id,
|
|
inbox: inbox,
|
|
contact_attributes: { name: name, additional_attributes: additional_attributes }
|
|
}).perform
|
|
end
|
|
|
|
def twitter_client
|
|
Twitty::Facade.new do |config|
|
|
config.consumer_key = ENV.fetch('TWITTER_CONSUMER_KEY', nil)
|
|
config.consumer_secret = ENV.fetch('TWITTER_CONSUMER_SECRET', nil)
|
|
config.access_token = twitter_access_token
|
|
config.access_token_secret = twitter_access_token_secret
|
|
config.base_url = 'https://api.twitter.com'
|
|
config.environment = ENV.fetch('TWITTER_ENVIRONMENT', '')
|
|
end
|
|
end
|
|
|
|
private
|
|
|
|
def unsubscribe
|
|
### Fix unsubscription with new endpoint
|
|
unsubscribe_response = twitter_client.remove_subscription(user_id: profile_id)
|
|
Rails.logger.info "TWITTER_UNSUBSCRIBE: #{unsubscribe_response.body}"
|
|
rescue StandardError => e
|
|
Rails.logger.error e
|
|
end
|
|
end
|