From 9b5eb98c5924201a3aae8e98c62b20b63284eb24 Mon Sep 17 00:00:00 2001
From: "Aswin Dev P.S" <aswindevps@gmail.com>
Date: Mon, 11 Apr 2022 15:43:05 +0530
Subject: [PATCH] feat: Support additional authentication mechanisms for SMTP
 (#4431)

* Support additional authentication mechanisms for SMTP
---
 app/helpers/api/v1/inboxes_helper.rb          |  6 +++-
 .../dashboard/i18n/locale/en/inboxMgmt.json   |  3 +-
 .../dashboard/settings/inbox/SmtpSettings.vue | 23 +++++++++++++++
 app/models/channel/email.rb                   |  2 +-
 app/views/api/v1/models/_inbox.json.jbuilder  |  1 +
 .../v1/accounts/inboxes_controller_spec.rb    | 28 +++++++++++++++++++
 6 files changed, 60 insertions(+), 3 deletions(-)

diff --git a/app/helpers/api/v1/inboxes_helper.rb b/app/helpers/api/v1/inboxes_helper.rb
index 8cdf8d987..7f3b68953 100644
--- a/app/helpers/api/v1/inboxes_helper.rb
+++ b/app/helpers/api/v1/inboxes_helper.rb
@@ -29,8 +29,12 @@ module Api::V1::InboxesHelper
     smtp = Net::SMTP.new(channel_data[:smtp_address], channel_data[:smtp_port])
 
     set_smtp_encryption(channel_data, smtp)
+    check_smtp_connection(channel_data, smtp)
+  end
 
-    smtp.start(channel_data[:smtp_domain], channel_data[:smtp_email], channel_data[:smtp_password], :login)
+  def check_smtp_connection(channel_data, smtp)
+    smtp.start(channel_data[:smtp_domain], channel_data[:smtp_email], channel_data[:smtp_password],
+               channel_data[:smtp_authentication]&.to_sym || :login)
     smtp.finish unless smtp&.nil?
   end
 
diff --git a/app/javascript/dashboard/i18n/locale/en/inboxMgmt.json b/app/javascript/dashboard/i18n/locale/en/inboxMgmt.json
index bf2652e09..b2a054ebc 100644
--- a/app/javascript/dashboard/i18n/locale/en/inboxMgmt.json
+++ b/app/javascript/dashboard/i18n/locale/en/inboxMgmt.json
@@ -529,7 +529,8 @@
       "ENCRYPTION": "Encryption",
       "SSL_TLS": "SSL/TLS",
       "START_TLS": "STARTTLS",
-      "OPEN_SSL_VERIFY_MODE": "Open SSL Verify Mode"
+      "OPEN_SSL_VERIFY_MODE": "Open SSL Verify Mode",
+      "AUTH_MECHANISM": "Authentication"
     },
     "NOTE": "Note: "
   }
diff --git a/app/javascript/dashboard/routes/dashboard/settings/inbox/SmtpSettings.vue b/app/javascript/dashboard/routes/dashboard/settings/inbox/SmtpSettings.vue
index 21a8955ef..92b9a5446 100644
--- a/app/javascript/dashboard/routes/dashboard/settings/inbox/SmtpSettings.vue
+++ b/app/javascript/dashboard/routes/dashboard/settings/inbox/SmtpSettings.vue
@@ -69,6 +69,13 @@
             :options="openSSLVerifyModes"
             :action="handleSSLModeChange"
           />
+          <single-select-dropdown
+            class="medium-9 columns"
+            :label="$t('INBOX_MGMT.SMTP.AUTH_MECHANISM')"
+            :selected="authMechanism"
+            :options="authMechanisms"
+            :action="handleAuthMechanismChange"
+          />
         </div>
         <woot-submit-button
           :button-text="$t('INBOX_MGMT.SMTP.UPDATE')"
@@ -112,6 +119,7 @@ export default {
       ssl: false,
       starttls: true,
       openSSLVerifyMode: 'none',
+      authMechanism: 'login',
       encryptionProtocols: [
         { id: 'ssl', title: 'SSL/TLS', checked: false },
         { id: 'starttls', title: 'STARTTLS', checked: true },
@@ -122,6 +130,15 @@ export default {
         { key: 3, value: 'client_once' },
         { key: 4, value: 'fail_if_no_peer_cert' },
       ],
+      authMechanisms: [
+        { key: 1, value: 'plain' },
+        { key: 2, value: 'login' },
+        { key: 3, value: 'cram-md5' },
+        { key: 4, value: 'xoauth' },
+        { key: 5, value: 'xoauth2' },
+        { key: 6, value: 'ntlm' },
+        { key: 7, value: 'gssapi' },
+      ],
     };
   },
   validations: {
@@ -157,6 +174,7 @@ export default {
         smtp_enable_starttls_auto,
         smtp_enable_ssl_tls,
         smtp_openssl_verify_mode,
+        smtp_authentication,
       } = this.inbox;
       this.isSMTPEnabled = smtp_enabled;
       this.address = smtp_address;
@@ -167,6 +185,7 @@ export default {
       this.starttls = smtp_enable_starttls_auto;
       this.ssl = smtp_enable_ssl_tls;
       this.openSSLVerifyMode = smtp_openssl_verify_mode;
+      this.authMechanism = smtp_authentication;
 
       this.encryptionProtocols = [
         { id: 'ssl', title: 'SSL/TLS', checked: smtp_enable_ssl_tls },
@@ -189,6 +208,9 @@ export default {
     handleSSLModeChange(mode) {
       this.openSSLVerifyMode = mode;
     },
+    handleAuthMechanismChange(mode) {
+      this.authMechanism = mode;
+    },
     async updateInbox() {
       try {
         const payload = {
@@ -204,6 +226,7 @@ export default {
             smtp_enable_ssl_tls: this.ssl,
             smtp_enable_starttls_auto: this.starttls,
             smtp_openssl_verify_mode: this.openSSLVerifyMode,
+            smtp_authentication: this.authMechanism,
           },
         };
         await this.$store.dispatch('inboxes/updateInboxSMTP', payload);
diff --git a/app/models/channel/email.rb b/app/models/channel/email.rb
index c101bc8c1..1c7f534a4 100644
--- a/app/models/channel/email.rb
+++ b/app/models/channel/email.rb
@@ -39,7 +39,7 @@ class Channel::Email < ApplicationRecord
   self.table_name = 'channel_email'
   EDITABLE_ATTRS = [:email, :imap_enabled, :imap_email, :imap_password, :imap_address, :imap_port, :imap_enable_ssl, :imap_inbox_synced_at,
                     :smtp_enabled, :smtp_email, :smtp_password, :smtp_address, :smtp_port, :smtp_domain, :smtp_enable_starttls_auto,
-                    :smtp_enable_ssl_tls, :smtp_openssl_verify_mode].freeze
+                    :smtp_enable_ssl_tls, :smtp_openssl_verify_mode, :smtp_authentication].freeze
 
   validates :email, uniqueness: true
   validates :forward_to_email, uniqueness: true
diff --git a/app/views/api/v1/models/_inbox.json.jbuilder b/app/views/api/v1/models/_inbox.json.jbuilder
index 671d52072..dded0ec0d 100644
--- a/app/views/api/v1/models/_inbox.json.jbuilder
+++ b/app/views/api/v1/models/_inbox.json.jbuilder
@@ -70,6 +70,7 @@ if resource.email?
   json.smtp_enable_ssl_tls resource.channel.try(:smtp_enable_ssl_tls)
   json.smtp_enable_starttls_auto resource.channel.try(:smtp_enable_starttls_auto)
   json.smtp_openssl_verify_mode resource.channel.try(:smtp_openssl_verify_mode)
+  json.smtp_authentication resource.channel.try(:smtp_authentication)
 end
 
 ## API Channel Attributes
diff --git a/spec/controllers/api/v1/accounts/inboxes_controller_spec.rb b/spec/controllers/api/v1/accounts/inboxes_controller_spec.rb
index 7ebe8434a..420a94835 100644
--- a/spec/controllers/api/v1/accounts/inboxes_controller_spec.rb
+++ b/spec/controllers/api/v1/accounts/inboxes_controller_spec.rb
@@ -540,6 +540,34 @@ RSpec.describe 'Inboxes API', type: :request do
         expect(email_channel.reload.smtp_enable_ssl_tls).to be true
         expect(email_channel.reload.smtp_openssl_verify_mode).to eq('none')
       end
+
+      it 'updates smtp configuration with authentication mechanism' do
+        smtp_connection = double
+        allow(smtp_connection).to receive(:start).and_return(true)
+        allow(smtp_connection).to receive(:finish).and_return(true)
+        allow(smtp_connection).to receive(:respond_to?).and_return(true)
+        allow(smtp_connection).to receive(:enable_starttls_auto).and_return(true)
+        allow(Net::SMTP).to receive(:new).and_return(smtp_connection)
+
+        patch "/api/v1/accounts/#{account.id}/inboxes/#{email_inbox.id}",
+              headers: admin.create_new_auth_token,
+              params: {
+                channel: {
+                  smtp_enabled: true,
+                  smtp_address: 'smtp.gmail.com',
+                  smtp_port: 587,
+                  smtp_email: 'smtptest@gmail.com',
+                  smtp_authentication: 'plain'
+                }
+              },
+              as: :json
+
+        expect(response).to have_http_status(:success)
+        expect(email_channel.reload.smtp_enabled).to be true
+        expect(email_channel.reload.smtp_address).to eq('smtp.gmail.com')
+        expect(email_channel.reload.smtp_port).to eq(587)
+        expect(email_channel.reload.smtp_authentication).to eq('plain')
+      end
     end
   end