mirror of
https://github.com/lingble/chatwoot.git
synced 2025-10-29 02:02:27 +00:00
## 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>
163 lines
5.1 KiB
Ruby
163 lines
5.1 KiB
Ruby
# == Schema Information
|
|
#
|
|
# Table name: channel_telegram
|
|
#
|
|
# id :bigint not null, primary key
|
|
# bot_name :string
|
|
# bot_token :string not null
|
|
# created_at :datetime not null
|
|
# updated_at :datetime not null
|
|
# account_id :integer not null
|
|
#
|
|
# Indexes
|
|
#
|
|
# index_channel_telegram_on_bot_token (bot_token) UNIQUE
|
|
#
|
|
|
|
class Channel::Telegram < ApplicationRecord
|
|
include Channelable
|
|
|
|
# TODO: Remove guard once encryption keys become mandatory (target 3-4 releases out).
|
|
encrypts :bot_token, deterministic: true if Chatwoot.encryption_configured?
|
|
|
|
self.table_name = 'channel_telegram'
|
|
EDITABLE_ATTRS = [:bot_token].freeze
|
|
|
|
before_validation :ensure_valid_bot_token, on: :create
|
|
validates :bot_token, presence: true, uniqueness: true
|
|
before_save :setup_telegram_webhook
|
|
|
|
def name
|
|
'Telegram'
|
|
end
|
|
|
|
def telegram_api_url
|
|
"https://api.telegram.org/bot#{bot_token}"
|
|
end
|
|
|
|
def send_message_on_telegram(message)
|
|
message_id = send_message(message) if message.outgoing_content.present?
|
|
message_id = Telegram::SendAttachmentsService.new(message: message).perform if message.attachments.present?
|
|
message_id
|
|
end
|
|
|
|
def get_telegram_profile_image(user_id)
|
|
# get profile image from telegram
|
|
response = HTTParty.get("#{telegram_api_url}/getUserProfilePhotos", query: { user_id: user_id })
|
|
return nil unless response.success?
|
|
|
|
photos = response.parsed_response.dig('result', 'photos')
|
|
return if photos.blank?
|
|
|
|
get_telegram_file_path(photos.first.last['file_id'])
|
|
end
|
|
|
|
def get_telegram_file_path(file_id)
|
|
response = HTTParty.get("#{telegram_api_url}/getFile", query: { file_id: file_id })
|
|
return nil unless response.success?
|
|
|
|
"https://api.telegram.org/file/bot#{bot_token}/#{response.parsed_response['result']['file_path']}"
|
|
end
|
|
|
|
def process_error(message, response)
|
|
return unless response.parsed_response['ok'] == false
|
|
|
|
# https://github.com/TelegramBotAPI/errors/tree/master/json
|
|
message.external_error = "#{response.parsed_response['error_code']}, #{response.parsed_response['description']}"
|
|
message.status = :failed
|
|
message.save!
|
|
end
|
|
|
|
def chat_id(message)
|
|
message.conversation[:additional_attributes]['chat_id']
|
|
end
|
|
|
|
def business_connection_id(message)
|
|
message.conversation[:additional_attributes]['business_connection_id']
|
|
end
|
|
|
|
def reply_to_message_id(message)
|
|
message.content_attributes['in_reply_to_external_id']
|
|
end
|
|
|
|
private
|
|
|
|
def ensure_valid_bot_token
|
|
response = HTTParty.get("#{telegram_api_url}/getMe")
|
|
unless response.success?
|
|
errors.add(:bot_token, 'invalid token')
|
|
return
|
|
end
|
|
|
|
self.bot_name = response.parsed_response['result']['username']
|
|
end
|
|
|
|
def setup_telegram_webhook
|
|
HTTParty.post("#{telegram_api_url}/deleteWebhook")
|
|
response = HTTParty.post("#{telegram_api_url}/setWebhook",
|
|
body: {
|
|
url: "#{ENV.fetch('FRONTEND_URL', nil)}/webhooks/telegram/#{bot_token}"
|
|
})
|
|
errors.add(:bot_token, 'error setting up the webook') unless response.success?
|
|
end
|
|
|
|
def send_message(message)
|
|
response = message_request(
|
|
chat_id(message),
|
|
message.outgoing_content,
|
|
reply_markup(message),
|
|
reply_to_message_id(message),
|
|
business_connection_id: business_connection_id(message)
|
|
)
|
|
process_error(message, response)
|
|
response.parsed_response['result']['message_id'] if response.success?
|
|
end
|
|
|
|
def reply_markup(message)
|
|
return unless message.content_type == 'input_select'
|
|
|
|
{
|
|
one_time_keyboard: true,
|
|
inline_keyboard: message.content_attributes['items'].map do |item|
|
|
[{
|
|
text: item['title'],
|
|
callback_data: item['value']
|
|
}]
|
|
end
|
|
}.to_json
|
|
end
|
|
|
|
def convert_markdown_to_telegram_html(text)
|
|
# ref: https://core.telegram.org/bots/api#html-style
|
|
|
|
# escape html tags in text. We are subbing \n to <br> since commonmark will strip exta '\n'
|
|
text = CGI.escapeHTML(text.gsub("\n", '<br>'))
|
|
|
|
# convert markdown to html
|
|
html = CommonMarker.render_html(text).strip
|
|
|
|
# remove all html tags except b, strong, i, em, u, ins, s, strike, del, a, code, pre, blockquote
|
|
stripped_html = Rails::HTML5::SafeListSanitizer.new.sanitize(html, tags: %w[b strong i em u ins s strike del a code pre blockquote],
|
|
attributes: %w[href])
|
|
|
|
# converted escaped br tags to \n
|
|
stripped_html.gsub('<br>', "\n")
|
|
end
|
|
|
|
def message_request(chat_id, text, reply_markup = nil, reply_to_message_id = nil, business_connection_id: nil)
|
|
text_payload = convert_markdown_to_telegram_html(text)
|
|
|
|
business_body = {}
|
|
business_body[:business_connection_id] = business_connection_id if business_connection_id
|
|
|
|
HTTParty.post("#{telegram_api_url}/sendMessage",
|
|
body: {
|
|
chat_id: chat_id,
|
|
text: text_payload,
|
|
reply_markup: reply_markup,
|
|
parse_mode: 'HTML',
|
|
reply_to_message_id: reply_to_message_id
|
|
}.merge(business_body))
|
|
end
|
|
end
|