Beta feature encrypted toc

Author: CoinK0in

README.md

@@ -34,7 +34,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-0.0.10-py3-none-any.whl
+pip3 install dist/mkdocs_encryptcontent_plugin-0.0.11-py3-none-any.whl
 ```
 
 Enable the plugin in your `mkdocs.yml`:
@@ -188,6 +188,47 @@ plugins:
         password_button_text: 'custome_text_button'
 ```
 
+### Encrypt Table Of Content
+
+Related to [issue #9](https://github.com/CoinK0in/mkdocs-encryptcontent-plugin/issues/9)
+
+You can add `encrypted_toc: True` in plugin config variable, to encrypt the table of contents.
+
+You **have to** enable [feature tag encrypt page](https://github.com/CoinK0in/mkdocs-encryptcontent-plugin#tag-encrypted-page) 
+for this feature to work properly, cause HTML generation of the Table Of Content is done after the rendering process.
+
+When this feature is enabled, we search for your table of content based on `id=mkdocs-encrypted-toc` and encrypt all HTML content.
+
+```yaml
+plugins:
+    - encryptcontent:
+        tag_encrypted_page: True  
+        encrypted_toc: True`
+```
+
+Adding `id=mkdocs-encrypted-toc` in the parent element of your table of content, so that the child html contained to be encrypted.
+It possible to use conditional tag `page.encrypted` to add or not the id. 
+
+```jinja
+{%- if page.toc|count > 0 %}
+<div class=".." {% if page.encrypted %}id="mkdocs-encrypted-toc"{% endif %}>
+    <ul class="..">
+    {%- for toc_item in page.toc %}
+        <li class=".."><a href="{{ toc_item.url }}">{{ toc_item.title }}</a></li>
+        {%- for toc_item in toc_item.children %}
+            <li><a href="{{ toc_item.url }}">{{ toc_item.title }}</a></li>
+        {%- endfor %}
+    {%- endfor %}
+    </ul>
+</div>
+{%- endif %}
+```
+
+When the feature is enabled and you use any methods *(password, button, cookie)* to decrypt the page, the table of contents will also be decrypted.
+
+By default the encrypted ToC have `style=display:none` to hide encrypted content. 
+
+
 ## Contributing
 
 From reporting a bug to submitting a pull request: every contribution is appreciated and welcome.

encryptcontent/decrypt-form.tpl.html

@@ -85,10 +85,34 @@ <h1>{{ summary }}</h1>
                 {% if password_button %}
                 decrypt_button = document.getElementById("mkdocs-decrypt-button"),
                 {% endif %}
+                {% if encrypted_toc %}
+                encrypted_toc = document.getElementById('mkdocs-encrypted-toc'),
+                {% endif %}
                 decrypt_form = document.getElementById('mkdocs-decrypt-form');
             // Adjust password field width to placeholder length
             let input = document.getElementById("mkdocs-content-password");
             input.setAttribute('size', input.getAttribute('placeholder').length);
+            {% if encrypted_toc %}
+            // Decrypt Table Of Content
+            var decrypt_toc = function() {
+                // grab the cipher ToC bundle
+                var parts = encrypted_toc.innerHTML.split(';');
+                // decrypt it
+                var content = decrypt_content(
+                    password_input.value,
+                    parts[0],
+                    parts[1],
+                    parts[2]
+                );
+                if (content) {
+                    // success; display the decrypted ToC
+                    encrypted_toc.innerHTML = content;
+                    encrypted_toc.style.display = null;
+                    // any post processing on the decrypted toc should be done here
+                 }
+            }
+            {% endif %}
+            // Decrypt content
             var decrypt_action = function() {
                 // grab the ciphertext bundle
                 var parts = encrypted_content.innerHTML.split(';');
@@ -109,9 +133,6 @@ <h1>{{ summary }}</h1>
                         hljs.highlightBlock(block);
                     });
                     {% endif %}
-                    //{% if save_password_in_local_storage %}
-                    //localStorage.setItem('password', password_input.value);
-                    //{% endif %}
                 } else {
                     // create HTML element for the inform message
                     var decrypt_msg = document.createElement('p');
@@ -134,13 +155,19 @@ <h1>{{ summary }}</h1>
             if (password_cookie) {
                 password_input.value = password_cookie
                 decrypt_action();
+                {% if encrypted_toc %}
+                decrypt_toc();
+                {% endif %}
             }
             {% endif %}
             {% if password_button %}
             if (decrypt_button) {
                 decrypt_button.onclick = function(event) {
                     event.preventDefault();
                     decrypt_action();
+                    {% if encrypted_toc %}
+                    decrypt_toc();
+                    {% endif %}
                 };
             }
             {% endif %}
@@ -158,7 +185,10 @@ <h1>{{ summary }}</h1>
                     }
                     {% endif %}
                     event.preventDefault();
-                    decrypt_action()
+                    decrypt_action();
+                    {% if encrypted_toc %}
+                    decrypt_toc();
+                    {% endif %}
                 }
             });
         };

encryptcontent/plugin.py

@@ -7,6 +7,7 @@
 from Crypto import Random
 from jinja2 import Template
 from Crypto.Cipher import AES
+from bs4 import BeautifulSoup
 from mkdocs.plugins import BasePlugin
 
 try:
@@ -56,6 +57,7 @@ class encryptContentPlugin(BasePlugin):
         ('tag_encrypted_page', mkdocs.config.config_options.Type(bool, default=False)),
         ('password_button', mkdocs.config.config_options.Type(bool, default=False)),
         ('password_button_text', mkdocs.config.config_options.Type(string_types, default=str(settings['password_button_text']))),
+        ('encrypted_toc', mkdocs.config.config_options.Type(bool, default=False)),
     )
 
     def __hash_md5__(self, text):
@@ -100,6 +102,7 @@ def __encrypt_content__(self, content):
             'hljs': self.hljs,
             'remember_password': self.remember_password,
             'disable_cookie_protection': self.disable_cookie_protection,
+            'encrypted_toc': self.encrypted_toc,
         })
         return decrypt_form
 
@@ -164,6 +167,12 @@ def on_pre_build(self, config):
             if 'password_button_text' in plugin_config.keys():
                 password_button_text = plugin_config.get('password_button_text')
                 setattr(self, 'password_button_text', password_button_text)
+        # Check if encrypted_toc feature is enable: encrypt table of content (PoC)
+        setattr(self, 'encrypted_toc', False)
+        if 'encrypted_toc' in plugin_config.keys():
+            encrypted_toc = self.config.get('encrypted_toc')
+            setattr(self, 'encrypted_toc', encrypted_toc)
+
 
     def on_page_markdown(self, markdown, page, config, **kwargs):
         """
@@ -212,5 +221,39 @@ def on_page_content(self, html, page, config, **kwargs):
             if self.tag_encrypted_page:
                 # Set attribute on page to identify encrypted page on template rendering
                 setattr(page, 'encrypted', True)
+            if self.encrypted_toc:
+                # Set attributes on page to retrieve password on POST context
+                setattr(page, 'password', self.password)
             html = self.__encrypt_content__(html)
         return html
+
+    def on_post_page(self, output_content, page, config, **kwargs):
+        """
+        The post_page event is called after the template is rendered,
+        but before it is written to disc and can be used to alter the output of the page.
+        If an empty string is returned, the page is skipped and nothing is written to disc.
+        :param output_content: output of rendered template as string
+        :param page: mkdocs.nav.Page instance
+        :param config:  global configuration object
+        :return: output of rendered template as string
+        """
+        # limit this process only if encrypted_toc feature is enable *(speedup x4)*
+        if self.encrypted_toc and hasattr(page, 'encrypted'):
+            soup = BeautifulSoup(output_content, 'html.parser')
+            toc_search = soup.find("div", { "id" : "mkdocs-encrypted-toc" })
+            if toc_search is not None and len(toc_search.contents) > 0:
+                # Remove '\n', ' ' useless content generated by bs4 parsing...
+                toc_search.contents = [content for content in toc_search.contents if not content in ['\n', ' ']]
+                # Select childs items on tags div and encrypt all content with page password
+                ciphertoc_bundle = self.__encrypt_text_aes__(toc_search.contents[0], page.password)
+                encrypted_toc = b';'.join(ciphertoc_bundle).decode('ascii')
+                toc_search.contents[0].replaceWith(encrypted_toc)
+                if toc_search.has_attr('style'):
+                    if isinstance(toc_search['style'], list):
+                        toc_search['style'].append("display:none")
+                    else:
+                        toc_search['style'] = toc_search['class'] + "display:none"
+                else:
+                    toc_search['style'] = "display:none"
+                output_content = str(soup)
+        return output_content

setup.py

@@ -11,7 +11,7 @@ def read(fname):
 
 setup(
     name='mkdocs-encryptcontent-plugin',
-    version='0.0.10',
+    version='0.0.11',
     author='CoinK0in',
     author_email='[email protected]',
     description='A MkDocs plugin that encrypt/decrypt markdown content with AES',
@@ -25,6 +25,7 @@ def read(fname):
         'mkdocs',
         'pyyaml',
         'pycryptodome',
+        'beautifulsoup4',
     ],
     classifiers=[
         'Development Status :: 5 - Production/Stable',