From f1b68658d400a64c8dd32b3b0e9796242a07cff0 Mon Sep 17 00:00:00 2001
From: Takashi Kajinami <kajinamit@oss.nttdata.com>
Date: Wed, 8 Nov 2023 01:19:45 +0900
Subject: [PATCH] Deprecate Symantec certificate plugin

This plugin has never been updated for 7 years. This plugin requires
the symantecssl library but the library can't be found in the Internet
and is not generally available. We have never tested it in upstream
CI because of lack of that dependent library.

Change-Id: I26493c2b0130f3cb86d866bd08fa5bbacbcc4725
---
 barbican/plugin/symantec.py                        | 14 ++++++++++++++
 ...deprecate-symantec-plugin-c14da58692f8d881.yaml |  7 +++++++
 2 files changed, 21 insertions(+)
 create mode 100644 releasenotes/notes/deprecate-symantec-plugin-c14da58692f8d881.yaml

diff --git a/barbican/plugin/symantec.py b/barbican/plugin/symantec.py
index 7b753b3d8..cbac58513 100644
--- a/barbican/plugin/symantec.py
+++ b/barbican/plugin/symantec.py
@@ -22,21 +22,32 @@ from symantecssl.core import Symantec
 from symantecssl import exceptions as symantec_exceptions
 
 from barbican.common import config
+from barbican.common import utils
 from barbican import i18n as u
 from barbican.plugin.interface import certificate_manager as cert
 
 CONF = config.new_config()
+LOG = utils.getLogger(__name__)
 
 symantec_plugin_group = cfg.OptGroup(name='symantec_plugin',
                                      title='Symantec Plugin Options')
 
 symantec_plugin_opts = [
     cfg.StrOpt('username',
+               deprecated_for_removal=True,
+               deprecated_reason=('Symantec certificate plugin has been '
+                                  'deprecated'),
                help=u._('Symantec username for authentication')),
     cfg.StrOpt('password',
+               deprecated_for_removal=True,
+               deprecated_reason=('Symantec certificate plugin has been '
+                                  'deprecated'),
                help=u._('Symantec password for authentication'),
                secret=True),
     cfg.StrOpt('url',
+               deprecated_for_removal=True,
+               deprecated_reason=('Symantec certificate plugin has been '
+                                  'deprecated'),
                help=u._('Domain of Symantec API'))
 ]
 
@@ -62,6 +73,9 @@ class SymantecCertificatePlugin(cert.CertificatePluginBase):
         if self.url is None:
             raise ValueError(u._("url is required"))
 
+        LOG.warning('Symantec certificate plugin has been deprecated and '
+                    'will be removed in a future release.')
+
     def get_default_ca_name(self):
         return "Symantec CA"
 
diff --git a/releasenotes/notes/deprecate-symantec-plugin-c14da58692f8d881.yaml b/releasenotes/notes/deprecate-symantec-plugin-c14da58692f8d881.yaml
new file mode 100644
index 000000000..011df9625
--- /dev/null
+++ b/releasenotes/notes/deprecate-symantec-plugin-c14da58692f8d881.yaml
@@ -0,0 +1,7 @@
+---
+deprecations:
+  - |
+    The Symantec certificate plugin has been deprecated, because lack of
+    maintenance activity of the plugin. Also the symantecssl python library
+    is not generally available and the plugin has never been tested in
+    upstream.