Version 2.2.0

CoinK0in · CoinK0in · commit 68383b82eb06 · 2022-06-22T19:32:23.000+02:00
diff --git a/README.md b/README.md
@@ -24,7 +24,7 @@ The content is encrypted with AES-256 in Python using PyCryptodome, and decrypte
   * [Installation](#installation)
   * [Usage](#usage)
     * [Global password protection](#global-password-protection)
-    * [Github secret](#github-secret)
+    * [Secret from environment](#secret-from-environment)
     * [Customization](#extra-vars-customization)
   * [Features](#features)
     * [HighlightJS support](#highlightjs-support) *(default)*
@@ -52,7 +52,7 @@ Install the package from source with pip:
 ```bash
 cd mkdocs-encryptcontent-plugin/
 python3 setup.py sdist bdist_wheel
-pip3 install dist/mkdocs_encryptcontent_plugin-2.1.0-py3-none-any.whl
+pip3 install dist/mkdocs_encryptcontent_plugin-2.2.0-py3-none-any.whl
 ```
 
 Enable the plugin in your `mkdocs.yml`:
@@ -85,21 +85,25 @@ If a password is defined in an article, it will **ALWAYS** overwrite the global
 > **NOTE** Keep in mind that if the `password:` tag exists without value in an article, it will **not be protected** !
 
 
-### Github secret
+### Secret from environment
 
-Instead of specifying a password in the mkdocs.yml file, you can use a Github secret coupled to a CI/CD pipeline. This process is in two steps:
+Instead of specifying a password in the mkdocs.yml file, you can use an environment variable to load your secret. 
 
-1. First, you need to make an environment variable containing your password accessible at runtime (through any CI/CD pipeline). 
+This process is in two steps:
 
+1. First, you need to make an environment variable with your global password accessible at runtime (via any CI/CD pipeline or by setting it yourself in your environment).
 
-4. Finally, in the mkdocs.yml file, instead of specifying a global password, simply set the `use_secret` field to the name of your environment variable, e.g. in the case where my secret is stored in the $PASSWORD` variable:
 
-```yaml
+2. Then in the mkdocs.yml file, instead of specifying a global password, just set the `use_secret` field with your environment variable name, e.g. in case my secret is stored in the `ENCRYPTCONTENT_PASSWORD` variable:
+
+``` yaml
 plugins:
     - encryptcontent:
-        use_secret: 'PASSWORD'
+        use_secret: 'ENCRYPTCONTENT_PASSWORD'
 ```
 
+> **NOTE** Keep in mind that if the `use_secret:` configuration is set, it will always be used even if you have also set a global password with the `global_password` variable.
+
 
 ### Extra vars customization
 
diff --git a/encryptcontent/plugin.py b/encryptcontent/plugin.py
@@ -57,12 +57,9 @@ class encryptContentPlugin(BasePlugin):
         ('title_prefix', config_options.Type(string_types, default=str(SETTINGS['title_prefix']))),
         ('summary', config_options.Type(string_types, default=str(SETTINGS['summary']))),
         ('placeholder', config_options.Type(string_types, default=str(SETTINGS['placeholder']))),
-        ('decryption_failure_message',
-         config_options.Type(string_types, default=str(SETTINGS['decryption_failure_message']))),
-        ('encryption_info_message',
-         config_options.Type(string_types, default=str(SETTINGS['encryption_info_message']))),
-        ('password_button_text',
-         config_options.Type(string_types, default=str(SETTINGS['password_button_text']))),
+        ('decryption_failure_message', config_options.Type(string_types, default=str(SETTINGS['decryption_failure_message']))),
+        ('encryption_info_message', config_options.Type(string_types, default=str(SETTINGS['encryption_info_message']))),
+        ('password_button_text', config_options.Type(string_types, default=str(SETTINGS['password_button_text']))),
         ('global_password', config_options.Type(string_types, default=None)),
         ('password', config_options.Type(string_types, default=None)),
         ('arithmatex', config_options.Type(bool, default=True)),
@@ -73,8 +70,7 @@ class encryptContentPlugin(BasePlugin):
         ('tag_encrypted_page', config_options.Type(bool, default=True)),
         ('password_button', config_options.Type(bool, default=False)),
         ('encrypted_something', config_options.Type(dict, default={})),
-        ('search_index',
-         config_options.Choice(('clear', 'dynamically', 'encrypted'), default='encrypted')),
+        ('search_index', config_options.Choice(('clear', 'dynamically', 'encrypted'), default='encrypted')),
         ('reload_scripts', config_options.Type(list, default=[])),
         ('experimental', config_options.Type(bool, default=False)),
         # legacy features, doesn't exist anymore
@@ -157,64 +153,56 @@ def on_config(self, config, **kwargs):
             if os.environ.get(str(self.config['use_secret'])):
                 self.config['global_password'] = os.environ.get(str(self.config['use_secret']))
             else:
-                logger.error(('Cannot get global password from environment variable: '),
-                             (f"{str(self.config['use_secret'])}. Abort !"))
+                logger.error('Cannot get global password from environment variable: {var}. Abort !'.format(
+                    var=str(self.config['use_secret']))
+                )
                 os._exit(1)
         # Set global password as default password for each page
         self.config['password'] = self.config['global_password']
         # Check if hljs feature need to be enabled, based on theme configuration
         if ('highlightjs' in config['theme']._vars
                 and config['theme']._vars['highlightjs']    # noqa: W503
                     and self.config['hljs'] is not False):  # noqa: W503, E127
-            logger.debug(('"highlightjs" value detected on theme config,'),
-                         ('enable rendering after decryption.'))
+            logger.debug('"highlightjs" value detected on theme config, enable rendering after decryption.')
             self.config['hljs'] = config['theme']._vars['highlightjs']
         else:
             logger.info('"highlightjs" feature is disabled in your plugin configuration.')
             self.config['hljs'] = False
-        # Check if pymdownx.arithmatex feature need to be enabled, based on markdown_extensions
-        # configuration
+        # Check if pymdownx.arithmatex feature need to be enabled, based on markdown_extensions configuration
         if ('pymdownx.arithmatex' in config['markdown_extensions']
                 and self.config['arithmatex'] is not False):  # noqa: W503
-            logger.debug(('"arithmatex" value detected on extensions config,'),
-                         ('enable rendering after decryption.'))
+            logger.debug('"arithmatex" value detected on extensions config, enable rendering after decryption.')
             self.config['arithmatex'] = True
         else:
             logger.info('"arithmatex" feature is disabled in your plugin configuration.')
             self.config['arithmatex'] = False
         # Check if mermaid feature need to be enabled, based on plugin configuration
         if config['plugins'].get('mermaid2') and self.config['mermaid2'] is not False:
-            logger.debug(('"mermaid2" value detected on extensions config,'),
-                         ('enable rendering after decryption.'))
+            logger.debug('"mermaid2" value detected on extensions config, enable rendering after decryption.')
             self.config['mermaid2'] = True
         else:
             logger.info('"mermaid2" feature is disabled in your plugin configuration.')
             self.config['mermaid2'] = False
         # Warn about deprecated features on Vervion 2.0.0
         deprecated_options_detected = False
         if self.config.get('disable_cookie_protection'):
-            logger.warning(('DEPRECATED: Feature "disable_cookie_protection" is no longer '),
-                           ('supported. Can by remove.'))
+            logger.warning('DEPRECATED: Feature "disable_cookie_protection" is no longer supported. Can by remove.')
             deprecated_options_detected = True
         if self.config.get('decrypt_search'):
-            logger.warning(('DEPRECATED: Feature "decrypt_search" is no longer supported.'),
-                           ('Use search_index on "clear" mode instead.'))
+            logger.warning('DEPRECATED: Feature "decrypt_search" is no longer supported. Use search_index on "clear" mode instead.')
             deprecated_options_detected = True
             logger.info('Fallback "decrypt_search" configuraiton to "search_index" mode clear.')
             self.config['search_index'] = 'clear'
         if deprecated_options_detected:
-            logger.warning(('DEPRECATED: '),
-                           ('Features marked as deprecated will be remove in next minor version !'))
+            logger.warning('DEPRECATED: Features marked as deprecated will be remove in next minor version !')
         # Re order plugins to be sure search-index are not encrypted
         if self.config['search_index'] == 'clear':
-            logger.debug(('Reordering plugins loading and put search and encryptcontent'),
-                         ('at the end of the event pipe.'))
+            logger.debug('Reordering plugins loading and put search and encryptcontent at the end of the event pipe.')
             config['plugins'].move_to_end('search')
             config['plugins'].move_to_end('encryptcontent')
         # Enable experimental code .. :popcorn:
         if self.config['search_index'] == 'dynamically':
-            logger.info(('EXPERIMENTAL MODE ENABLE. '),
-                        ('Only work with default SearchPlugin, not Material.'))
+            logger.info('EXPERIMENTAL MODE ENABLE. Only work with default SearchPlugin, not Material.')
             self.config['experimental'] = True
 
     def on_pre_build(self, config, **kwargs):
@@ -252,28 +240,26 @@ def _add_entry_from_context(self, page):
                     if not self.config.get('indexing') or self.config['indexing'] == 'full':
                         text = parser.stripped_html.rstrip('\n')
                     if (hasattr(page, 'encrypted') and hasattr(page, 'password')
-                            and page.password is not None):  # noqa: W503
+                            and page.password is not None):                             # noqa: W503
                         plugin = config['plugins']['encryptcontent']
                         code = plugin.__encrypt_text_aes__(text, str(page.password))
                         text = b';'.join(code).decode('ascii')
                     self._add_entry(title=page.title, text=text, loc=url)
                     if (self.config.get('indexing')
-                            and self.config['indexing'] in ['full', 'sections']):  # noqa: W503
+                            and self.config['indexing'] in ['full', 'sections']):       # noqa: W503
                         for section in parser.data:
                             if (hasattr(page, 'encrypted')
-                                    and hasattr(page, 'password')         # noqa: W503
-                                        and page.password is not None):   # noqa: W503, E127
+                                    and hasattr(page, 'password')                       # noqa: W503
+                                        and page.password is not None):                 # noqa: W503, E127
                                 self.create_entry_for_section(section, page.toc, url, page.password)
                             else:
                                 self.create_entry_for_section(section, page.toc, url)
                 SearchIndex.add_entry_from_context = _add_entry_from_context
             if self.config['experimental'] is True:
                 if config['theme'].name == 'material':
-                    logger.error(("UNSUPPORTED Material theme "),
-                                 ("with experimantal feature search_index=dynamically !"))
+                    logger.error("UNSUPPORTED Material theme with experimantal feature search_index=dynamically !")
                     exit("UNSUPPORTED Material theme: use search_index: [clear|encrypted] instead.")
-                # Overwrite search/*.js files from templates/search with encryptcontent contrib
-                # search assets
+                # Overwrite search/*.js files from templates/search with encryptcontent contrib search assets
                 config['theme'].dirs = [
                     e for e in config['theme'].dirs
                     if not re.compile(r".*/contrib/search/templates$").match(e)
@@ -330,8 +316,7 @@ def on_page_content(self, html, page, config, **kwargs):
             base_path = page.abs_url.replace(page.url, '') if page.abs_url is not None else '/'
             # Set password attributes on page for other mkdocs events
             setattr(page, 'password', str(self.config['password']))
-            # Keep encrypted html as temporary variable on page cause we need clear html for search
-            # plugin
+            # Keep encrypted html as temporary variable on page cause we need clear html for search plugin
             setattr(page, 'html_encrypted', self.__encrypt_content__(html, base_path))
         return html
 
diff --git a/setup.py b/setup.py
@@ -11,7 +11,7 @@ def read(fname):
 
 setup(
     name='mkdocs-encryptcontent-plugin',
-    version='2.1.0',
+    version='2.2.0',
     author='CoinK0in',
     author_email='12155947+CoinK0in@users.noreply.github.com',
     description='A MkDocs plugin that encrypt/decrypt markdown content with AES',
@@ -37,7 +37,8 @@ def read(fname):
         'Programming Language :: Python :: 3.6',
         'Programming Language :: Python :: 3.7',
         'Programming Language :: Python :: 3.8',
-        'Programming Language :: Python :: 3.9'
+        'Programming Language :: Python :: 3.9',
+        'Programming Language :: Python :: 3.10'
     ],
     packages=find_packages(exclude=['*.tests']),
     entry_points={
