3 | 27 |

` in string format and a list as value. 11 | The list has to be constructed with the name of an HTML tag `` as first item 12 | and `id` or `class` as the second item. 13 | 14 | ```yaml 15 | plugins: 16 | - encryptcontent: 17 | encrypted_something: 18 | : [, <'class' or 'id'>] 19 | ``` 20 | 21 | The `` key identifies the name of a specific element of the page that will be 22 | searched by Beautiful Soup. 23 | The first value of the list (``) identifies the type of HTML tag in which the name is present. 24 | The second value of the list (`'id'` or `'class'`) specifies the type of the attribute which contains 25 | the unique name in the html tag. 26 | 27 | Prefer to use an `'id'`, however depending on the template of your theme, it is not always possible to use the id. 28 | So we can use the class attribute to define your unique name inside the html tag. 29 | Beautiful Soup will encrypt all HTML elements discovered with the class. 30 | 31 | When the feature is enabled every element is decrypted upon successfull content decryption on the page. 32 | 33 | > Use this to hide the table of contents on the page or sub pages in the menu 34 | 35 | By default **every child item** are encrypted and the encrypted elements have set 36 | `style="display:none;"` to hide their content. 37 | 38 | #### How to use it?! Examples 39 | 40 | You can use the `page.encrypted` tag to add attributes to html tags in the HTML templates of your theme 41 | or identify usable tag ids or classes that are already in the theme. 42 | 43 | Then add these elements in the format of a yaml dictionary under the variable `encrypted_something`. 44 | 45 | 1. For example, encrypt ToC in a theme where ToC is under 'div' element like this : 46 | 47 | ```jinja 48 |

49 |

{{ toc_item.title }}
{{ toc_item.title }}

53 |

54 | ``` 55 | 56 | Set your configuration like this : 57 | 58 | ```yaml 59 | plugins: 60 | - encryptcontent: 61 | encrypted_something: 62 | mkdocs-encrypted-toc: [div, id] 63 | ``` 64 | 65 | 2. Other example, with multiple targets. You are using a custom version of Material theme and 66 | want to encrypt ToC content and Footer. 67 | 68 | Material generates 2 `

` structures with the same template `toc.html`, so you need to use a `class` 69 | instead of an id for this part. 70 | The footer part, is generated by the `footer.html` template in a classic div so an `id` is sufficient 71 | 72 | After modification, your template looks like this : 73 | 74 | toc.html: 75 | ```jinja 76 | 80 | ``` 81 | footer.html: 82 | ```jinja 83 | 87 | ``` 88 | 89 | Your configuration would look like this : 90 | ```yaml 91 | plugins: 92 | - encryptcontent: 93 | encrypted_something: 94 | mkdocs-encrypted-toc: [nav, class] 95 | mkdocs-encrypted-footer: [div, id] 96 | mkdocs-encrypted-footer-meta: [div, id] 97 | ``` 98 | 99 | 3. If you are using unmodified mkdocs-material, then this example will encrypt menu, toc and footer 100 | But you'd need the Navigation pruning feature to hide the title of encrypted pages from navigation (or see 2.). 101 | 102 | ```yaml 103 | plugins: 104 | - encryptcontent: 105 | encrypted_something: 106 | md-footer__inner: [nav, class] 107 | md-nav: [nav, class] 108 | ``` 109 | 110 | ### Inject decrypt-form.tpl to theme 111 | 112 | Some themes or plugins might interfere with the way this plugin encrypts the content of a page. 113 | In this case this feature will find and encrypt a unique tag in the same way as `encrypted_something` 114 | does and additionally inject its `decrypt-form.tpl.html` in front of it. 115 | 116 | ```yaml 117 | plugins: 118 | - encryptcontent: 119 | inject: 120 | : [, <'class' or 'id'>] 121 | ``` 122 | 123 | This is an example for mkdocs-material: 124 | ```yaml 125 | plugins: 126 | - blog 127 | - encryptcontent: 128 | encrypted_something: 129 | md-footer__inner: [nav, class] #Footer 130 | md-nav: [nav, class] #Menu and toc 131 | inject: 132 | md-content: [div, class] 133 | ``` 134 | 135 | > This feature overrides the normal practice of replacing the rendered content of a page. 136 | 137 | ### Mix encrypted and normal content 138 | 139 | It is possible to only encrypt parts of the page and also to remove parts on successful decryption. 140 | 141 | First install PyMdown Extensions by entering `pip install --upgrade pymdown-extensions`, 142 | then enable them in your `mkdocs.yml`: 143 | ```yaml 144 | markdown_extensions: 145 | - pymdownx.blocks.html 146 | ``` 147 | 148 | This is an example of a mixed markdown page: 149 | 150 | ``` 151 | title: This page mixes encrypted and normal content 152 | level: secret 153 | inject_id: protected 154 | delete_id: teaser 155 | 156 | /// html | div#teaser 157 | ## Teaser 158 | 159 | You won't believe which secrets this page will unveil. 160 | Find out more after you enter the correct password... 161 | /// 162 | 163 | /// html | div#protected 164 | ## Secret 165 | 166 | Well, the princess is another castle. 167 | /// 168 | ``` 169 | 170 | The markdown extension enables us to wrap a div tag around content by `/// html | div#some-id`. 171 | It ends with `///`. The meta tag `inject_id` defines which div id we would like to encrypt 172 | (it also injects the decryption form here). And the div id found at `delete_id` will be deleted 173 | on successful decryption. 174 | -------------------------------------------------------------------------------- /documentation/docs/features/search.md: -------------------------------------------------------------------------------- 1 | ## Search encryption 2 | 3 | ### Search index encryption 4 | 5 | > **Default value is "encrypted"** 6 | 7 | Related to [issue #13](https://github.com/CoinK0in/mkdocs-encryptcontent-plugin/issues/13) 8 | 9 | > :warning: **The configuration mode "clear" of this functionality can cause DATA LEAK** 10 | > 11 | > The unencrypted content of each page is accessible through the search index. 12 | > Not encrypting the search index means completely removing the protection provided by this plugin. 13 | > You have been warned 14 | 15 | This feature allows you to control the behavior of the encryption plugin with the search index. 16 | Three configuration modes are possible: 17 | 18 | * **clear** : Search index is not encrypted. Search is possible even on protected pages. 19 | * **dynamically** : Search index is encrypted on build. Search is possible once the pages have been decrypted. 20 | * **encrypted** : Search index of encrypted pages is removed on build. Search is not possible on encrypted pages. 21 | 22 | You can set `search_index: ''` in your `mkdocs.yml` to change the search index encryption mode. Possible values are `clear`, `dynamically`, `encrypted`. The default mode is "**encrypted**". 23 | 24 | ```yaml 25 | plugins: 26 | - encryptcontent: 27 | search_index: 'dynamically' 28 | ``` 29 | 30 | This functionality modifies the search index created by the “search” plug-in. 31 | Some themes might override the default search plug-in provided by mkdocs, 32 | but so far the structure of the `search/search_index.json` file is consistent. 33 | 34 | > The modification of the search index is carried out last (if `encryptcontent` is also last in `plugins`). 35 | > But always double-check the generated index after `mkdocs build` to see if your information is protected. 36 | 37 | When the configuration mode is set to "**dynamically**", the 38 | [javascripts contribution files](https://github.com/unverbuggt/mkdocs-encryptcontent-plugin/tree/master/encryptcontent/contrib/templates/search) 39 | are used to override the default search plugin files provided by MkDocs. 40 | They include a process of decrypting and keeping the search index in a SessionStorage. 41 | 42 | ### Search index encryption for mkdocs-material 43 | 44 | [Material for MkDocs](https://squidfunk.github.io/mkdocs-material/) uses a different search plugin that 45 | cannot "easily" be overridden like the default search plugin. 46 | However this Plugin will still remove encrypted pages (`encrypted`) or encrypt the search entries (`dynamically`) 47 | for `mkdocs-material`. 48 | 49 | In order to be able to decrypt the search index (`dynamically`) `mkdocs-material` needs to be customized (patched). 50 | 51 | Patches for different versions can be found [here](https://github.com/unverbuggt/mkdocs-encryptcontent-plugin/tree/version3/patches). 52 | 53 | #### Material 8.x 54 | 55 | You'll need some [prerequisites](https://squidfunk.github.io/mkdocs-material/customization/#environment-setup) 56 | and also execute these commands: 57 | 58 | ```bash 59 | git clone https://github.com/squidfunk/mkdocs-material 60 | cd mkdocs-material 61 | pip install mkdocs-minify-plugin 62 | pip install mkdocs-redirects 63 | npm install 64 | 65 | #copy material_search_worker.patch to mkdocs-material 66 | patch -p 0 < material_search_worker8.patch 67 | 68 | pip install --force-reinstall . 69 | #pip install --force-reinstall --no-deps . #faster if mkdocs-material was already installed 70 | ``` 71 | 72 | #### Material 9.x 73 | 74 | Follow the instructions for [Theme development](https://squidfunk.github.io/mkdocs-material/customization/#theme-development) carefully. 75 | 76 | Apply the patch before [Building the theme](https://squidfunk.github.io/mkdocs-material/customization/#building-the-theme): 77 | 78 | ```bash 79 | patch -p 0 < material_browser_request9.patch # until Material 9.3 80 | patch -p 0 < material_browser_request9_4p.patch # Material 9.4+ 81 | ``` 82 | 83 | -------------------------------------------------------------------------------- /documentation/docs/features/security.md: -------------------------------------------------------------------------------- 1 | ## Security 2 | 3 | ### Crypto-js or crypto-es or webcrypto? 4 | 5 | By default the plugin uses the crypto-js library for page decryption, but using 6 | the browser's built-in webcrypto engine is also possible (set `webcrypto: true`). 7 | 8 | The main advantage of webcrypto over crypto-js is that it is much faster, allowing higher 9 | calculation difficulty for key derivation (`kdf_pow`). Also it may be easier to implement 10 | key derivation functions other than PBKDF2 with webcrypto in the future. 11 | 12 | On the other hand crypto-js is implemented in pure Javascript without any dependencies and well 13 | tested (but it probably won't receive any updates as development stalled in 2021, see [here](https://github.com/brix/crypto-js/#discontinued)) 14 | and we know nothing about how good or bad webcrypto is implemented in different browsers. 15 | 16 | There is a new variation of [crypto-js](https://github.com/brix/crypto-js), called [crypto-es](https://github.com/entronad/crypto-es). 17 | It provides the same functions, but is implemented in modern javascript and can be activated by setting `esm: true`. 18 | If `webcrypto: true` and `esm: true` is set, then webcrypto will be loaded as a 19 | javascript module (speeding up material theme with instant loading feature). 20 | 21 | > Crypto-js causes a bug when browsing through encrypted pages, 22 | > if used in `mkdocs-material` together with the `navigation.instant` feature. 23 | > It is advised to use `webcrypto: true` or crypto-es with `esm: true` in this case. 24 | 25 | #### Self-host Crypto-js or Crypto-es 26 | 27 | If you enable `selfhost` then you'll choose to upload crypto-js to your web server rather than using cloudflare CDN. 28 | The self-host location is "SITE_URL/assets/javascripts/cryptojs/". 29 | 30 | Additionally if you set `selfhost_download` then the required files will be automatically downloaded if needed. 31 | The files are checked for their MD5 hash and saved to `docs_dir` or `selfhost_dir` (relative to `mkdocs.yml`). 32 | 33 | ```yaml 34 | plugins: 35 | - encryptcontent: 36 | selfhost: True 37 | selfhost_download: False 38 | selfhost_dir: 'theme_overrides' 39 | ``` 40 | 41 | #### KDF key generation caching 42 | 43 | Either way (webcrypto or crypto-js) the [KDF](https://en.wikipedia.org/wiki/Key_derivation_function) 44 | key generation needs to be done for each credential. 45 | This may take some additional time when building the site, especially when there are many different ones. 46 | That's why these keys and salt are cached by default to a yaml file named "encryptcontent.cache". 47 | 48 | ```yaml 49 | plugins: 50 | - encryptcontent: 51 | cache_file: 'encryptcontent.cache' # change file name if needed 52 | ``` 53 | 54 | Caching can be disabled by setting `cache_file: ''`. 55 | 56 | 57 | ### File name obfuscation 58 | 59 | Imagine your pages contain many images and you labeled them "1.jpg", "2.jpg" and so on for some reason. 60 | If you'd like to encrypt one of these pages, an attacker could try guessing the image file names 61 | and would be able to download them despite not having the password to the page. 62 | 63 | This feature should make it impossible or at least way harder for an external attacker to guess the file names. 64 | Please also check and disable directory listing for that matter. 65 | Keep in mind that your hosting provider is still able to see all your images and files. 66 | 67 | To counter file name guessing you could activate the feature like this: 68 | 69 | ```yaml 70 | plugins: 71 | - encryptcontent: 72 | selfhost: true 73 | selfhost_download: false 74 | hash_filenames: 75 | extensions: 76 | - 'png' 77 | - 'jpg' 78 | - 'jpeg' 79 | - 'svg' 80 | except: 81 | - 'lilien.svg' 82 | ``` 83 | 84 | At `extensions` we define which file name extensions to obfuscate 85 | (extension is taken from the part after the last ".", 86 | so the extension of "image.jpg" is "jpg" and of "archive.tar.gz" is "gz"). 87 | 88 | You can define multiple exceptions at the `except` list. 89 | The file names that end with these strings will be skipped. 90 | You should use this if some images are used by themes or other plugins. 91 | Otherwise, you'd need to change these file names to the obfuscated ones. 92 | 93 | The file names are obfuscated in a way that the corresponding file is hashed with MD5 94 | and the hash is added to the file name 95 | (If the file content is not changed the file name remains the same), like this: 96 | 97 | some_image_1_bb80db433751833b8f8b4ad23767c0fc.jpg 98 | ("bb80db433751833b8f8b4ad23767c0fc" being the MD5 hash of said image.) 99 | 100 | > The file name obfuscation is currently applied to the whole site - not just the encrypted pages... 101 | 102 | ### Signing of generated files 103 | 104 | An attacker would most likely have a hard time brute forcing your encrypted content, given a good 105 | password entropy. It would be much easier for him to fish for passwords by modifying the 106 | generated pages, if he is able to hack your web space. 107 | 108 | This feature will sign all encrypted pages and used javascript files with Ed25519. It will also generate 109 | an example [canary script](https://en.wikipedia.org/wiki/Domestic_canary#Miner's_canary), which can be 110 | customized to alert if files were modified. 111 | 112 | > **NOTE** If Mkdocs is running with `mkdocs serve`, then signature verification of encrypted pages 113 | > will fail, because the files are modified by Mkdocs to enable live reload. 114 | 115 | ```yaml 116 | sign_files: 'signatures.json' 117 | sign_key: 'encryptcontent.key' #optional 118 | canary_template_path: '/path/to/canary.tpl.py' #optional 119 | ``` 120 | 121 | First an Ed25519 private key is generated at "encryptcontent.key" (besides `mkdocs.yml`), however you can supply an 122 | existing private key as long as it's in PEM format. 123 | 124 | After generation the signatures are saved to "signatures.json" in `site_dir`, so this file also needs to be uploaded 125 | to the web space. The canary script will download this file and compare the URLs to its own list and then download 126 | all files and verify the signatures. 127 | 128 | As long as the private key used for signing remains secret, the canary script will be able to determine 129 | if someone tampered with the files on the server. But you should run the canary script from another machine 130 | that is not related to the server, otherwise the attacker could also modify the canary script and sign with his 131 | private key instead. 132 | -------------------------------------------------------------------------------- /documentation/docs/img/logo.ico: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/unverbuggt/mkdocs-encryptcontent-plugin/3a99d7158cbf7522e83b5811b678732dbaf85cee/documentation/docs/img/logo.ico -------------------------------------------------------------------------------- /documentation/docs/img/logo.svg: -------------------------------------------------------------------------------- 1 | 2 | 61 | -------------------------------------------------------------------------------- /documentation/docs/index.md: -------------------------------------------------------------------------------- 1 | # mkdocs-encryptcontent-plugin 2 | 3 | This plugin allows you to have password protected articles and pages in MKdocs. 4 | 5 | The content is encrypted with AES-256 in Python using PyCryptodome and decrypted in the browser with Crypto-JS or Webcrypto. 6 | 7 | *It has been tested in Python Python 3.8+* 8 | 9 | **Usecase** 10 | 11 | > I want to be able to protect the content of the page with a password. 12 | > 13 | > Define a password to protect each page independently or a global password to protect them all. 14 | > 15 | > If a global password exists, all articles and pages are protected with this password. 16 | > 17 | > If a password is defined in an article or a page, it is always used even if there is a global password. 18 | > 19 | > If a password is defined as an empty character string, content encryption is disabled. 20 | > 21 | > Additionally password levels can be defined in mkdocs.yml or external yaml file with user/password credentials. 22 | 23 | ## New features (compared to version 2.5.x) 24 | 25 | * Stronger cryptography (PBKDF2 for key derivation) 26 | * Faster cryptography (Webcrypto as alternative to crypto-js) 27 | * Allow password inventory or levels in mkdocs.yml or external file for credential handling 28 | * Allow user name + password as credentials 29 | * If credential is reused in different levels it also decrypts all of their content 30 | * Optional adding of credentials to URLs for sharing 31 | * Optional tamper check by signing generated files with Ed25519 32 | * New [Documentation](https://unverbuggt.github.io/mkdocs-encryptcontent-plugin/) and [Test bench](https://unverbuggt.github.io/mkdocs-encryptcontent-plugin/testbench/) 33 | 34 | ## Upgrading from version 2.5.x 35 | 36 | The `use_secret` functionality was discontinued in the plugin configuration and as a meta tag. 37 | 38 | In order to use environment variables in user names or passwords, use the 39 | [special yaml tag](https://www.mkdocs.org/user-guide/configuration/#special-yaml-tags) `!ENV`. 40 | 41 | ## Todos for 3.1.x 42 | * outsource some functionality to separate plugins, like: 43 | * Filename obfuscation 44 | * Signing of generated files 45 | * find a better way for search decryption 46 | * add better alternative to PBKDF2 47 | * optional server side keystore (allows throtteling) 48 | * still no waterproof solution... 49 | * ...to be defined 50 | -------------------------------------------------------------------------------- /documentation/docs/installation.md: -------------------------------------------------------------------------------- 1 | 2 | 3 | # Installation 4 | 5 | Install the package with pip: 6 | 7 | ```bash 8 | pip install mkdocs-encryptcontent-plugin 9 | ``` 10 | 11 | Install the package from source with pip: 12 | 13 | ```bash 14 | cd mkdocs-encryptcontent-plugin/ 15 | python setup.py sdist bdist_wheel 16 | pip install --force-reinstall --no-deps dist/mkdocs_encryptcontent_plugin-3.0.4-py3-none-any.whl 17 | ``` 18 | 19 | Enable the plugin in your `mkdocs.yml`: 20 | 21 | ```yaml 22 | plugins: 23 | - search: {} 24 | - encryptcontent: {} 25 | ``` 26 | > **NOTE:** If you have no `plugins` entry in your configuration file yet, you'll likely also want to add the `search` plugin. 27 | > MkDocs enables it by default if there is no `plugins` entry set, but now you have to enable it explicitly. 28 | -------------------------------------------------------------------------------- /documentation/docs/testbench/anchor.md: -------------------------------------------------------------------------------- 1 | title: Anchor test 2 | level: user_and_passwords1 3 | 4 | 10 | 11 | # Anchor 1 12 | 13 | Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus. Donec quam felis, ultricies nec, pellentesque eu, pretium quis, sem. Nulla consequat massa quis enim. Donec pede justo, fringilla vel, aliquet nec, vulputate eget, arcu. In enim justo, rhoncus ut, imperdiet a, venenatis vitae, justo. Nullam dictum felis eu pede mollis pretium. Integer tincidunt. Cras dapibus. Vivamus elementum semper nisi. Aenean vulputate eleifend tellus. Aenean leo ligula, porttitor eu, consequat vitae, eleifend ac, enim. Aliquam lorem ante, dapibus in, viverra quis, feugiat a, tellus. Phasellus viverra nulla ut metus varius laoreet. Quisque rutrum. Aenean imperdiet. Etiam ultricies nisi vel augue. Curabitur ullamcorper ultricies nisi. Nam eget dui. Etiam rhoncus. Maecenas tempus, tellus eget condimentum rhoncus, sem quam semper libero, sit amet adipiscing sem neque sed ipsum. Nam quam nunc, blandit vel, luctus pulvinar, hendrerit id, lorem. Maecenas nec odio et ante tincidunt tempus. Donec vitae sapien ut libero venenatis faucibus. Nullam quis ante. Etiam sit amet orci eget eros faucibus tincidunt. Duis leo. Sed fringilla mauris sit amet nibh. Donec sodales sagittis magna. Sed consequat, leo eget bibendum sodales, augue velit cursus nunc, 14 | 15 | # Anchor 2 16 | 17 | Sed ut perspiciatis unde omnis iste natus error sit voluptatem accusantium doloremque laudantium, totam rem aperiam, eaque ipsa quae ab illo inventore veritatis et quasi architecto beatae vitae dicta sunt explicabo. Nemo enim ipsam voluptatem quia voluptas sit aspernatur aut odit aut fugit, sed quia consequuntur magni dolores eos qui ratione voluptatem sequi nesciunt. Neque porro quisquam est, qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit, sed quia non numquam eius modi tempora incidunt ut labore et dolore magnam aliquam quaerat voluptatem. Ut enim ad minima veniam, quis nostrum exercitationem ullam corporis suscipit laboriosam, nisi ut aliquid ex ea commodi consequatur? Quis autem vel eum iure reprehenderit qui in ea voluptate velit esse quam nihil molestiae consequatur, vel illum qui dolorem eum fugiat quo voluptas nulla pariatur? At vero eos et accusamus et iusto odio dignissimos ducimus qui blanditiis praesentium voluptatum deleniti atque corrupti quos dolores et quas molestias excepturi sint occaecati cupiditate non provident, similique sunt in culpa qui officia deserunt mollitia animi, id est laborum et dolorum fuga. Et harum quidem rerum facilis est et expedita distinctio. Nam libero tempore, cum soluta nobis est eligendi optio cumque nihil impedit quo minus id quod maxime placeat facere 18 | 19 | # Anchor 3 20 | 21 | But I must explain to you how all this mistaken idea of denouncing pleasure and praising pain was born and I will give you a complete account of the system, and expound the actual teachings of the great explorer of the truth, the master-builder of human happiness. No one rejects, dislikes, or avoids pleasure itself, because it is pleasure, but because those who do not know how to pursue pleasure rationally encounter consequences that are extremely painful. Nor again is there anyone who loves or pursues or desires to obtain pain of itself, because it is pain, but because occasionally circumstances occur in which toil and pain can procure him some great pleasure. To take a trivial example, which of us ever undertakes laborious physical exercise, except to obtain some advantage from it? But who has any right to find fault with a man who chooses to enjoy a pleasure that has no annoying consequences, or one who avoids a pain that produces no resultant pleasure? On the other hand, we denounce with righteous indignation and dislike men who are so beguiled and demoralized by the charms of pleasure of the moment, so blinded by desire, that they cannot foresee 22 | 23 | # Anchor 4 24 | 25 | Li Europan lingues es membres del sam familie. Lor separat existentie es un myth. Por scientie, musica, sport etc, litot Europa usa li sam vocabular. Li lingues differe solmen in li grammatica, li pronunciation e li plu commun vocabules. Omnicos directe al desirabilite de un nov lingua franca: On refusa continuar payar custosi traductores. At solmen va esser necessi far uniform grammatica, pronunciation e plu sommun paroles. Ma quande lingues coalesce, li grammatica del resultant lingue es plu simplic e regulari quam ti del coalescent lingues. Li nov lingua franca va esser plu simplic e regulari quam li existent Europan lingues. It va esser tam simplic quam Occidental in fact, it va esser Occidental. A un Angleso it va semblar un simplificat Angles, quam un skeptic Cambridge amico dit me que Occidental es.Li Europan lingues es membres del sam familie. Lor separat existentie es un myth. Por scientie, musica, sport etc, litot Europa usa li sam vocabular. Li lingues differe solmen in li grammatica, li pronunciation e li plu commun vocabules. Omnicos directe al desirabilite de un nov lingua franca: On refusa continuar payar custosi traductores. At solmen va esser necessi far uniform grammatica, pronunciation e plu sommun paroles. 26 | 27 | # Anchor 5 28 | 29 | The European languages are members of the same family. Their separate existence is a myth. For science, music, sport, etc, Europe uses the same vocabulary. The languages only differ in their grammar, their pronunciation and their most common words. Everyone realizes why a new common language would be desirable: one could refuse to pay expensive translators. To achieve this, it would be necessary to have uniform grammar, pronunciation and more common words. If several languages coalesce, the grammar of the resulting language is more simple and regular than that of the individual languages. The new common language will be more simple and regular than the existing European languages. It will be as simple as Occidental; in fact, it will be Occidental. To an English person, it will seem like simplified English, as a skeptical Cambridge friend of mine told me what Occidental is.The European languages are members of the same family. Their separate existence is a myth. For science, music, sport, etc, Europe uses the same vocabulary. The languages only differ in their grammar, their pronunciation and their most common words. Everyone realizes why a new common language would be desirable: one could refuse to pay expensive translators. To 30 | 31 | # Anchor 6 32 | 33 | Far far away, behind the word mountains, far from the countries Vokalia and Consonantia, there live the blind texts. Separated they live in Bookmarksgrove right at the coast of the Semantics, a large language ocean. A small river named Duden flows by their place and supplies it with the necessary regelialia. It is a paradisematic country, in which roasted parts of sentences fly into your mouth. Even the all-powerful Pointing has no control about the blind texts it is an almost unorthographic life One day however a small line of blind text by the name of Lorem Ipsum decided to leave for the far World of Grammar. The Big Oxmox advised her not to do so, because there were thousands of bad Commas, wild Question Marks and devious Semikoli, but the Little Blind Text didn’t listen. She packed her seven versalia, put her initial into the belt and made herself on the way. When she reached the first hills of the Italic Mountains, she had a last view back on the skyline of her hometown Bookmarksgrove, the headline of Alphabet Village and the subline of her own road, the Line Lane. Pityful a rethoric question ran over her cheek, then 34 | 35 | # Anchor 7 36 | 37 | A wonderful serenity has taken possession of my entire soul, like these sweet mornings of spring which I enjoy with my whole heart. I am alone, and feel the charm of existence in this spot, which was created for the bliss of souls like mine. I am so happy, my dear friend, so absorbed in the exquisite sense of mere tranquil existence, that I neglect my talents. I should be incapable of drawing a single stroke at the present moment; and yet I feel that I never was a greater artist than now. When, while the lovely valley teems with vapour around me, and the meridian sun strikes the upper surface of the impenetrable foliage of my trees, and but a few stray gleams steal into the inner sanctuary, I throw myself down among the tall grass by the trickling stream; and, as I lie close to the earth, a thousand unknown plants are noticed by me: when I hear the buzz of the little world among the stalks, and grow familiar with the countless indescribable forms of the insects and flies, then I feel the presence of the Almighty, who formed us in his own image, and the breath 38 | 39 | # Anchor 8 40 | 41 | One morning, when Gregor Samsa woke from troubled dreams, he found himself transformed in his bed into a horrible vermin. He lay on his armour-like back, and if he lifted his head a little he could see his brown belly, slightly domed and divided by arches into stiff sections. The bedding was hardly able to cover it and seemed ready to slide off any moment. His many legs, pitifully thin compared with the size of the rest of him, waved about helplessly as he looked. "What's happened to me?" he thought. It wasn't a dream. His room, a proper human room although a little too small, lay peacefully between its four familiar walls. A collection of textile samples lay spread out on the table - Samsa was a travelling salesman - and above it there hung a picture that he had recently cut out of an illustrated magazine and housed in a nice, gilded frame. It showed a lady fitted out with a fur hat and fur boa who sat upright, raising a heavy fur muff that covered the whole of her lower arm towards the viewer. Gregor then turned to look out the window at the dull weather. Drops 42 | 43 | # Anchor 9 44 | 45 | The quick, brown fox jumps over a lazy dog. DJs flock by when MTV ax quiz prog. Junk MTV quiz graced by fox whelps. Bawds jog, flick quartz, vex nymphs. Waltz, bad nymph, for quick jigs vex! Fox nymphs grab quick-jived waltz. Brick quiz whangs jumpy veldt fox. Bright vixens jump; dozy fowl quack. Quick wafting zephyrs vex bold Jim. Quick zephyrs blow, vexing daft Jim. Sex-charged fop blew my junk TV quiz. How quickly daft jumping zebras vex. Two driven jocks help fax my big quiz. Quick, Baz, get my woven flax jodhpurs! "Now fax quiz Jack!" my brave ghost pled. Five quacking zephyrs jolt my wax bed. Flummoxed by job, kvetching W. zaps Iraq. Cozy sphinx waves quart jug of bad milk. A very bad quack might jinx zippy fowls. Few quips galvanized the mock jury box. Quick brown dogs jump over the lazy fox. The jay, pig, fox, zebra, and my wolves quack! Blowzy red vixens fight for a quick jump. Joaquin Phoenix was gazed by MTV for luck. A wizard’s job is to vex chumps quickly in fog. Watch "Jeopardy!", Alex Trebek's fun TV quiz game. Woven silk pyjamas exchanged for blue quartz. Brawny gods just -------------------------------------------------------------------------------- /documentation/docs/testbench/hashfilenames.md: -------------------------------------------------------------------------------- 1 | title: Hash file names 2 | 3 | This test checks whether MD5 hashes are added to the filenames... 4 | 5 | /// html | div#testimg-output 6 | 7 | /// 8 | 9 | ![](../img/howitworks.svg){ #testimg} 10 | 11 | 12 | -------------------------------------------------------------------------------- /documentation/docs/testbench/index.de.md: -------------------------------------------------------------------------------- 1 | title: Testaufbau 2 | 3 | Dies ist ein Testaufbau für das MKdocs Encryptcontent Plugin. 4 | -------------------------------------------------------------------------------- /documentation/docs/testbench/index.md: -------------------------------------------------------------------------------- 1 | title: Test bench 2 | 3 | This is a generic test bench for the MKdocs encryptcontent plugin. 4 | -------------------------------------------------------------------------------- /documentation/docs/testbench/jstest.md: -------------------------------------------------------------------------------- 1 | title: Javascript test 2 | obfuscate: Crawler be gone! 3 | encryption_summary: Humans are allowed to press ENTER 4 | encryption_info_message: This page is just obfuscated to counter web crawlers. 5 | inject_id: inject 6 | 7 | These tests demonstate the correct execution of [Javascript extensions](../features/jsext.md) 8 | 9 | //// html | div#inject 10 | 11 | ## highlight.js 12 | 13 | ```bash 14 | #!/bin/bash 15 | echo "Hello World" 16 | ``` 17 | 18 | ## arithmatex 19 | 20 | \[ 21 | v_{e} = \sqrt{\frac{2GM}{d}} = \sqrt{2gd} 22 | \] 23 | 24 | ## mermaid2 25 | 26 | ```mermaid 27 | graph LR 28 | hello --> world 29 | world --> again 30 | again --> hello 31 | ``` 32 | 33 | ## encrypted javascript 34 | 35 | 76 | 77 | 78 | /// html | div#pioutput 79 | attrs: {style: 'word-wrap:break-word; font-family: monospace'} 80 | 81 | /// 82 | 83 | //// -------------------------------------------------------------------------------- /documentation/docs/testbench/obfuscate.de.md: -------------------------------------------------------------------------------- 1 | title: Verschleiern 2 | obfuscate: Kriechtier hau ab! 3 | encryption_summary: Menschen dürfen ENTER klicken 4 | encryption_info_message: Diese Seite ist nur für Webcrawler unkenntlich gemacht. 5 | 6 | 12 |

Seite entschlüsselt

-------------------------------------------------------------------------------- /documentation/docs/testbench/obfuscate.md: -------------------------------------------------------------------------------- 1 | title: Obfuscate 2 | obfuscate: Crawler be gone! 3 | encryption_summary: Humans are allowed to press ENTER 4 | encryption_info_message: This page is just obfuscated to counter web crawlers. 5 | sharelink: true 6 | 7 | 13 |

Page decrypted

Seite entschlüsselt

Page decrypted

Seite entschlüsselt

25 | 26 | Eines dieser Passwörter **wurde** verwendet um diese Seite zu entschlüsseln: 27 | 28 | - moist:W00l:kept:royal 29 | - SpotChestOilCycle22 30 | - m00dy#augmented#Arsonist 31 | - Hatless,hertz,C4lzone 32 | 33 | Nun kann auch [Nur Passwörter 1](onlypasswords1.md) entschlüsselt werden. 34 | Falls das Passwort "Hatless,hertz,C4lzone" verwendet wurde, dann ist auch [Nur Passwörter 3](onlypasswords3.md) entschlüsselt. 35 | 36 | > **Hinweis:** Es hat mit dem Passwort "Hatless,hertz,C4lzone" länger gedauert, 37 | > weil es vorher siebenmal an den anderen Proben gescheitert ist. 38 | 39 | 45 | /// -------------------------------------------------------------------------------- /documentation/docs/testbench/onlypasswords2.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Only passwords 2 3 | level: onlypasswords2 4 | inject_id: protected 5 | delete_id: teaser 6 | --- 7 | 8 | /// html | div#teaser 9 | 10 | The following passwords are valid to decrypt this page: 11 | 12 | - moist:W00l:kept:royal 13 | - SpotChestOilCycle22 14 | - m00dy#augmented#Arsonist 15 | - **Hatless,hertz,C4lzone** 16 | 17 | If you use one of these passwords, you'd also be able to decrypt [only passwords 1](onlypasswords1.md). 18 | If you use the password "Hatless,hertz,C4lzone", you'd also be able to decrypt [only passwords 3](onlypasswords3.md). 19 | 20 | > **Note:** It will take some time if you use the password "Hatless,hertz,C4lzone" 21 | > because it has to be tried on seven challenges before it works. 22 | 23 | /// 24 | /// html | div#protected 25 | 26 |

Page decrypted

Seite entschlüsselt

21 | 22 | Folgendes Passwort **wurde** verwendet um diese Seite zu entschlüsseln: 23 | 24 | - Hatless,hertz,C4lzone 25 | 26 | Nun kann auch [Nur Passwörter 1](onlypasswords1.md) und [Nur Passwörter 2](onlypasswords2.md) entschlüsselt werden. 27 | 28 | > **Hinweis:** Es hat mit dem Passwort "Hatless,hertz,C4lzone" länger gedauert, 29 | > weil es vorher siebenmal an den anderen Proben gescheitert ist. 30 | 31 | 37 | /// -------------------------------------------------------------------------------- /documentation/docs/testbench/onlypasswords3.md: -------------------------------------------------------------------------------- 1 | title: Only passwords 3 2 | password: Hatless,hertz,C4lzone 3 | inject_id: protected 4 | delete_id: teaser 5 | 6 | /// html | div#teaser 7 | 8 | The following passwords are valid to decrypt this page: 9 | 10 | - Hatless,hertz,C4lzone 11 | 12 | If you use one of these passwords, you'd also be able to decrypt [only passwords 1](onlypasswords1.md) and [only passwords 2](onlypasswords2.md). 13 | 14 | > **Note:** It will take some time if you use the password "Hatless,hertz,C4lzone" 15 | > because it has to be tried on seven challenges before it works. 16 | 17 | /// 18 | /// html | div#protected 19 | 20 |

Page decrypted

21 | 22 | The following password **was** used to decrypt this page: 23 | 24 | - Hatless,hertz,C4lzone 25 | 26 | You're also able to decrypt [only passwords 1](onlypasswords1.md) and [only passwords 2](onlypasswords2.md). 27 | 28 | > **Note:** It took some time if you used the password "Hatless,hertz,C4lzone" 29 | > because it had to be tried on seven challenges before it worked. 30 | 31 | 37 | /// -------------------------------------------------------------------------------- /documentation/docs/testbench/search.md: -------------------------------------------------------------------------------- 1 | title: Search encryption 2 | 3 | This test checks whether there exist encrypted search entries... 4 | 5 | First line is an entry in the search_index.json and second is the encryptcontent-index from sessionStorage. 6 | 7 | If nothing was decrypted, yet, they must match (otherwise open a new tab). 8 | 9 | Now decrypt pages and check if the search_index decrypted the entries. 10 | 11 | /// html | div#searchtest-output 12 | attrs: {class: 'w3-responsive'} 13 | 14 | empty 15 | 16 | /// 17 | 18 | -------------------------------------------------------------------------------- /documentation/docs/testbench/share.de.md: -------------------------------------------------------------------------------- 1 | title: Encode share link 2 | 3 | # Various tests 4 | 5 | [Test1a (user: dave)](userpass1.md#IWRhdmU6bnVDbGVhcl9sdWxsYWJ5X3VudmVpbGVkX2c0cmxpYw)\ 6 | [Test1b (user: dave)](userpass1.md#!dave:nuClear_lullaby_unveiled_g4rlic) 7 | 8 | [Test2a (user: dave, go to anchor-6)](anchor.md#IWRhdmU6bnVDbGVhcl9sdWxsYWJ5X3VudmVpbGVkX2c0cmxpYw#anchor-6)\ 9 | [Test2b (user: dave, go to anchor-6)](anchor.md#!dave:nuClear_lullaby_unveiled_g4rlic#anchor-6) 10 | 11 | [Test3a (password: m00dy#augmented#Arsonist)](onlypasswords2.md#ITptMDBkeSNhdWdtZW50ZWQjQXJzb25pc3Q)\ 12 | [Test3b (password: SpotChestOilCycle22)](onlypasswords2.md#!SpotChestOilCycle22) 13 | 14 | [Test4a (obfuscate: Kriechtier hau ab!)](obfuscate.md#ITpLcmllY2h0aWVyIGhhdSBhYiE)\ 15 | [Test4b (obfuscate: Kriechtier hau ab!)](obfuscate.md#!Kriechtier%20hau%20ab!) 16 | 17 | # Create share link 18 | 19 |

20 |

21 | username 22 | 23 |

24 |

25 | password 26 | 27 |

28 |

29 | 30 |

31 |

32 | output 33 | 34 |

35 |

36 |

37 | 38 |

39 |

40 | decoded 41 | 42 |

43 |

44 |

45 | 46 | 103 | 104 | # Sharelinks output 105 | 106 | sharelinks.txt 107 | 108 | ``` 109 | {% include "../../sharelinks.txt" %} 110 | ``` 111 | -------------------------------------------------------------------------------- /documentation/docs/testbench/share.md: -------------------------------------------------------------------------------- 1 | title: Encode share link 2 | 3 | # Various tests 4 | 5 | [Test1a (user: dave)](userpass1.md#IWRhdmU6bnVDbGVhcl9sdWxsYWJ5X3VudmVpbGVkX2c0cmxpYw)\ 6 | [Test1b (user: dave)](userpass1.md#!dave:nuClear_lullaby_unveiled_g4rlic) 7 | 8 | [Test2a (user: dave, go to anchor-6)](anchor.md#IWRhdmU6bnVDbGVhcl9sdWxsYWJ5X3VudmVpbGVkX2c0cmxpYw#anchor-6)\ 9 | [Test2b (user: dave, go to anchor-6)](anchor.md#!dave:nuClear_lullaby_unveiled_g4rlic#anchor-6) 10 | 11 | [Test3a (password: m00dy#augmented#Arsonist)](onlypasswords2.md#ITptMDBkeSNhdWdtZW50ZWQjQXJzb25pc3Q)\ 12 | [Test3b (password: SpotChestOilCycle22)](onlypasswords2.md#!SpotChestOilCycle22) 13 | 14 | [Test4a (obfuscate: Crawler be gone!)](obfuscate.md#ITpDcmF3bGVyIGJlIGdvbmUh)\ 15 | [Test4b (obfuscate: Crawler be gone!)](obfuscate.md#!Crawler%20be%20gone!) 16 | 17 | # Create share link 18 | 19 |

20 |

21 | username 22 | 23 |

24 |

25 | password 26 | 27 |

28 |

29 | 30 |

31 |

32 | output 33 | 34 |

35 |

36 |

37 | 38 |

39 |

40 | decoded 41 | 42 |

43 |

44 |

Page decrypted

-------------------------------------------------------------------------------- /documentation/docs/testbench/test2.md: -------------------------------------------------------------------------------- 1 | title: Test2 2 | level: test2 3 | sharelink: true 4 | 5 | 11 |

Page decrypted

-------------------------------------------------------------------------------- /documentation/docs/testbench/test3.md: -------------------------------------------------------------------------------- 1 | title: Test3 2 | level: test3 3 | sharelink: true 4 | 5 | 11 |

Page decrypted

-------------------------------------------------------------------------------- /documentation/docs/testbench/test4.md: -------------------------------------------------------------------------------- 1 | title: Test4 2 | level: test4 3 | sharelink: true 4 | 5 | 11 |

Page decrypted

-------------------------------------------------------------------------------- /documentation/docs/testbench/test5.md: -------------------------------------------------------------------------------- 1 | title: Test5 2 | level: test5 3 | sharelink: true 4 | 5 | 11 |

Page decrypted

Seite entschlüsselt

Page decrypted

Seite entschlüsselt

Page decrypted

21 | 22 | One of the following passwords **were** used to decrypt this page: 23 | 24 | - charlie: gear.code.blonde.at0ll 25 | - dan: oxidize,croissant,ClubHouse5 26 | - dave: nuClear_lullaby_unveiled_g4rlic 27 | - david: establishRelishBlushV3nus 28 | 29 | You're also able to decrypt [User/Password 1](userpass1.md). 30 | 31 | 37 | /// -------------------------------------------------------------------------------- /documentation/docs/usage.md: -------------------------------------------------------------------------------- 1 | # Usage 2 | 3 | Add a tag like `password: secret password` to your pages [Meta-Data](https://www.mkdocs.org/user-guide/writing-your-docs/#yaml-style-meta-data) to protect them. 4 | 5 | Alternatively add a meta tag like `level: secret` to use one or more secrets defined at the 6 | plugin's `password_inventory` or `password_file` in your "mkdocs.yml" (see below). 7 | 8 | 9 | ## Password inventory 10 | 11 | With the `password_inventory` you can define protection levels (assigned with the meta tag `level` in markdown files). 12 | 13 | ```yaml 14 | plugins: 15 | - encryptcontent: 16 | password_inventory: 17 | classified: 'password1' 18 | confidential: 19 | - 'password2' 20 | - 'password3' 21 | secret: 22 | user4: 'password4' 23 | user5: 'password5' 24 | ``` 25 | 26 | These levels may be only one password (f.ex. classified), a list of multiple passwords (f.ex. confidential) 27 | or multiple username/password pairs (f.ex. secret). 28 | It is possible to reuse credentials at different levels. 29 | 30 | >Note that a "list of multiple passwords" comes with a downside: All entries may be tested because unlike "user/password pairs" 31 | >there is no hint to determine the distinct entry to try 32 | >(At least I found no hint that wouldn't make it easier for a brute force attacker). 33 | >This means, that a high `kdf_pow` could cause long waiting time even if the right password was entered. 34 | 35 | The plugin will generate one secret key for each level, which is then used to encrypt the assigned sites. 36 | 37 | To indicate that your Markdown file should be encrypted for level "secret", add the following metadata at the beginning of the file: 38 | 39 | ```markdown 40 | --- 41 | level: secret 42 | --- 43 | This is the first paragraph of the document. 44 | ``` 45 | 46 | 47 | ### Password inventory in external file 48 | 49 | You can define password levels in an external yaml file and link it with `password_file`. 50 | The intention is to separate sensitive information from configuration options. 51 | 52 | ```yaml 53 | plugins: 54 | - encryptcontent: 55 | password_file: 'passwords.yml' 56 | ``` 57 | 58 | passwords.yml: 59 | ```yaml 60 | classified: 'password1' 61 | confidential: 62 | - 'password2' 63 | - 'password3' 64 | secret: 65 | user4: 'password4' 66 | user5: 'password5' 67 | ``` 68 | 69 | ## Global password protection 70 | 71 | Add `global_password: your_password` in plugin configuration variable, to protect all pages with this password by default 72 | 73 | ```yaml 74 | plugins: 75 | - encryptcontent: 76 | global_password: 'your_password' 77 | ``` 78 | 79 | If the password meta tag is defined in a markdown file, it will **ALWAYS** override the global password. 80 | 81 | > **NOTE** Keep in mind that if the `password:` tag exists without value in a page, it will **not be protected** ! 82 | > Use this to **disable** `global_password` on specific pages. 83 | 84 | ### Global passwords in inventory 85 | 86 | You can add the special level `_global`, which will be applied globally on all sites like this: 87 | 88 | ```yaml 89 | plugins: 90 | - encryptcontent: 91 | password_inventory: 92 | _global: 'either define one password' 93 | _global: 94 | - 'or define' 95 | - 'multiple passwords' 96 | _global: 97 | user1: 'or use user' 98 | user2: 'and password pairs' 99 | ``` 100 | 101 | > **NOTE** Add the meta tag `level:` (without a value) to pages which should be excluded from global password level. 102 | > Also note that it is always possible to set the page to a different level than the global one with the `level` meta tag. 103 | 104 | ## Secret from environment 105 | 106 | It is possible to read values from environment variable 107 | (as discribed [here](https://www.mkdocs.org/user-guide/configuration/#environment-variables)). 108 | This replaces the deprecated `use_secret` option from previous versions. 109 | 110 | ```yaml 111 | plugins: 112 | - encryptcontent: 113 | password_inventory: 114 | secret: 115 | user1: !ENV PASSWORD1_FROM_ENV 116 | user2: !ENV [PASSWORD2_FROM_ENV, 'Password if PASSWORD2_FROM_ENV undefined or empty'] 117 | user3: !ENV [PASSWORD3_FROM_ENV, FALLBACK_PASSWORD3_FROM_ENV, 'Password if neither PASSWORD3_FROM_ENV nor FALLBACK_PASSWORD3_FROM_ENV defined'] 118 | ``` 119 | 120 | ## Default vars customization 121 | 122 | Optionally you can use some extra variables in plugin configuration to customize default strings. 123 | 124 | ```yaml 125 | plugins: 126 | - encryptcontent: 127 | title_prefix: '[LOCK]' 128 | summary: 'another informational message to encrypted content' 129 | placeholder: 'another password placeholder' 130 | decryption_failure_message: 'another informational message when decryption fails' 131 | encryption_info_message: "another information message when you don't have access !" 132 | input_class: 'md-search__form md-search__input' 133 | button_class: 'md-search__icon' 134 | ``` 135 | 136 | Default prefix title is `[Protected]`. 137 | 138 | Default summary message is `This content is protected with AES encryption.`. 139 | 140 | Default password palceholder is `Provide password and press ENTER`. 141 | 142 | Default decryption failure message is `Invalid password.`. 143 | 144 | Defaut encryption information message is `Contact your administrator for access to this page.`. 145 | 146 | > **NOTE** Adding a prefix to the title does not change the default navigation path ! 147 | 148 | ## Translations 149 | 150 | If the plugin is used in conjunction with the [static-i18n](https://ultrabug.github.io/mkdocs-static-i18n/) 151 | plugin you can provide `translations` for the used `i18n_page_locale`. 152 | 153 | ```yaml 154 | - encryptcontent: 155 | #... 156 | translations: 157 | de: 158 | title_prefix: '[Verschlüsselt] ' 159 | summary: 'Der Inhalt dieser Seite ist mit AES verschlüsselt. ' 160 | placeholder: 'Mit Strg+Enter wird das Passwort global gesetzt' 161 | password_button_text: 'Entschlüsseln' 162 | decryption_failure_message: 'Falsches passwort.' 163 | encryption_info_message: 'Bitte wenden Sie sich an den Systemadministrator um auf diese Seite zuzugreifen.' 164 | ``` 165 | 166 | ### Custom per-page strings 167 | 168 | You can set the meta tag `encryption_summary` to customize `summary` and `encryption_info_message` on every page. 169 | 170 | ## Obfuscate pages 171 | 172 | If you want to make it harder for search engines to scrape you pages content, 173 | you can set `obfuscate: SomeNotSoSecretPassword` meta tag in markdown. 174 | 175 | The page then will display `summary` and `encryption_info_message` together with a button labeled with 176 | `password_button_text`. In order to view the pages content one hast to press the button first. 177 | 178 | If a `password` or `level` is set, then the `obfuscate` feature will be disabled. 179 | If you want to use `obfuscate` in a configuration where `global_password` or `_global` level is defined, 180 | you'll need to set the `password:` or rather `level:` meta tag (with no password/level defined) to undefine the password on this page. 181 | 182 | The keys to all obfuscated pages are also saved in every keystore, so they are decrypted if someone entered 183 | correct credentials. 184 | 185 | 186 | ## Example plugin configuration 187 | 188 | ```yaml 189 | plugins: 190 | - encryptcontent: 191 | title_prefix: '' 192 | summary: '' 193 | placeholder: 'Password' 194 | placeholder_user: User 195 | password_button_text: 'ENTER' 196 | decryption_failure_message: 'Wrong user name or password.' 197 | encryption_info_message: 'Legitimation required.' 198 | translations: 199 | de: 200 | title_prefix: '' 201 | summary: '' 202 | placeholder: 'Passwort' 203 | placeholder_user: Benutzer 204 | password_button_text: 'ENTER' 205 | decryption_failure_message: 'Falscher Benutzer oder Passwort.' 206 | encryption_info_message: 'Legitimation erforderlich.' 207 | html_template_path: "decrypt-form.tpl.html" # override default html template 208 | password_button: True 209 | input_class: 'w3-input' # CSS class used for input username and password 210 | button_class: 'w3-button w3-theme-l1 w3-hover-theme' # CSS class for password_button 211 | hljs: False 212 | arithmatex: False 213 | mermaid2: False 214 | remember_keys: true # keys from keystore will temporarily saved to sessionStorage 215 | remember_password: false # the entered credentials are not saved 216 | remember_prefix: encryptcontent_plugin_ # use different prefixes if other sites are running on the same domain 217 | encrypted_something: # additionally encrypt some html elements 218 | #myNav: [div, id] 219 | myToc: [div, id] 220 | myTocButton: [div, id] 221 | search_index: 'dynamically' # dynamically encrypt mkdocs search index 222 | webcrypto: true # use browsers webcrypto support 223 | #selfhost: true # use self-hosted crypto-js 224 | #selfhost_download: true # download crypt-js for self-hosting 225 | #selfhost_dir: 'theme_override' # where to download crypto-js 226 | #reload_scripts: 227 | # - '#theme' 228 | password_file: 'passwords.yml' # file with password inventory 229 | threshold_warning_min_entropy: 100 # warn if password entropy is below this value 230 | #kdf_pow: 4 # default for crypto-js: 4, default for webcrypto: 5 231 | sign_files: 'encryptcontent-plugin.json' # save ed25519 signatures here 232 | #hash_filenames: # add hash to file names of assets (to make them impossible to guess 233 | # extensions: 234 | # - 'png' 235 | # - 'jpg' 236 | # - 'jpeg' 237 | # - 'svg' 238 | # except: 239 | # - 'logo.svg' 240 | ``` 241 | -------------------------------------------------------------------------------- /documentation/encryptcontent.cache: -------------------------------------------------------------------------------- 1 | kdf_iterations: 100000 2 | obfuscate: 3 | Crawler be gone!: 0f55b28d6b4c41b39ab02050244006b6935cae92f202aebf9ef7087bfeec8817;ac4e84ab4d80c19ab10fa1c8ffa91d48;1d33d92c9a0575adc758448318661831aca40e21d6a2df25289dd7ec6c8eaff9 4 | Kriechtier hau ab!: 530113ac1dfb0546568a826dd154cc0cb32614f81e9be57d7da2023e4c7c564b;514751d957e2dcd6d823c4eac76277ee;742046b038ee3ac691c570072da792e27c2cd4e4559cd12e6fc789062b55f5ba 5 | password: 6 | C4bbage Profile blinking: e44c04c01fbaa072b8e894d618d05db73f724eabd367904ea4c1848057563aa6;a126c0c006a7e2630967cb760a5abd32;94f412a70a4d3b4706ba1430bde980bb64d181547ff74c9d42f4520d807c0cdb 7 | Clique.Shampoo.Ve55el: b14e82fac7d5e71a688b8ee693441092b1f986090816b50825942da75000704e;91075dcb83380e9eb57735b253d0e602;71f79f20ed1ff827531bb581334583168f3cb66f6afec2ac5a329b88d396aae9 8 | Hatless,hertz,C4lzone: 4f867fda2a55bdcea4c9282a0f9500c8d242a7e546dced53fcaa01f6ea88d478;b5bba1e47841d4c1f92d48b1c7a568cc;f0aabe443c278b157d7c6e34eb67a9273e33acd4d9324dcf14a5fcdd32af2883 9 | Head32_Sculpture_bovine_: c91429da7625f5bbadfdde1a04355dc487ac4493042e795f3deb5f1ba14554be;4c13f011fffd76c221a97b11a37adf1d;41e11778e2f2d5c1551392aba6f96dbd580426b109a3cea1f2b62cc323d43563 10 | Negotiator-leftover-567: 4fdc5a958d58b91dffaf6b1afef75906d7e6d63fd4cef79f92970042a768db0d;5a262dd04653138f921e4c795a27433d;a774c2d2cbba8e60ed37cc32846a18b8149698e2c5a3a2ec55f722b5b5385947 11 | Password if PASSWORD2_FROM_ENV undefined or empty: afc8dfdd42daff85b4366b8565115158fa8f34e24eca87e93d14a2e4e13effbf;f0d7ce859b19e2ae581619c92e8f6bbb;25beb0c687ad6c69c82f76951ba4e4f739465a55944ce66d903788e44ed3af27 12 | SpotChestOilCycle22: f024872a4c3269d9ee6bb0431bf2f84f45a47c1cb0c0a6809a03e65ad82c833e;a166b70a2586223ec774c83840f570fb;6f166999fdb5968851efd563c9231546c349da41281db994ec67cc1eeef05c5e 13 | "TeGhD9aq\xDFQnHujmLdsa": 8ced5f4c26a9caaeb64859a16ec30dd08c79671bf3b9a4b3fdc49d0e52a66ef4;f07bfe75cae510567e6e2f24de6ae5d6;46ac08a4fdc9e7dcfd21bc4645e036d42bcf8c7c497a13d5e95f38aa67e29e1a 14 | "WOgh0\xDCwyKHoc*I_das": 1dfe7d872b9513006d38ce247b210adecab11f80e4fbee41841a3a348dc2cfd5;1aa18d82558e29e1b3d925aacf572644;2a9afc1fa2f32b7eb75c9052cc0c9978c4808763118afdb6e1baa2e1f365f04d 15 | "gncku\xE4shfliglkffhbvrG:Wurst": e4ad279aaf87fe509700885c2ada1712dffbf2820d270488b4e12cb3628ccf5c;da1c57514adbe32cf97f55f4ec95a061;ccda65e51e9b4643dc381fae28c25dc882989da4fdcbdeb0807479a7b7b25231 16 | m00dy#augmented#Arsonist: 1d0f4bc6e0522616f994e809c46a88de67137e2d8a6fc37d87d909931a1f2000;e616e156db08731855be61ae2e357f9b;afe95398efc93acd6e37c1bb185e6b07d7ab944aea5a60c6187c717db8673bd5 17 | moist:W00l:kept:royal: 969f2196c178a40693bb76372a9d5ab44f231f68e88e62eb28eb605be9ade5b1;e25064beb6674d563e6a2bfc29a0cdeb;4bb6ed11fa82cb2f1c9b3ad5dd092e740adfa356fb49102793979fdb7181d1ac 18 | "yDAHKmYjmCsA\xE9kUChasd": 887dd96ab192b6d83acf853b75ca50a8997bd808f0dbf999c2b552ce5f3a05a5;2e062e42b03f6885fdd20302cfb802c6;0859304b34a323dd4388e6a7ff248f51dd8ca88d49804cb05dca84d92d2383dd 19 | userpass: 20 | alice: d934e4ffff5ba9153fb2132e0612e712115222de4f5a0ea442189e1e6165d9ec;3318753822f08e506977bce9ba45f390;b9dda5ae9d522ebb921baeb5fc18bf42f12434142dd804cb51e413f4d77d84af 21 | bob: 2cb3b98f0c0b262ba69b965d1fc5e5ab20f3b13a31d8cca7b863f52ae1a4f6cc;50af439e7b290e1a87da35ff89d11d15;464aff500cbc51a343d40df2149e129977ca1f0ee720dd8398afc29e5b8add38 22 | carlos: b981c3831e7084fabe33490f905ea3f9f5f67c7b28e02c05810c4e49167255c5;19c354bccce0cf18d9b7897912833cb2;71b18753ecb8bf45fe26216dab5a42c7354248c4e104f1bedfaac0cb7aa6ce7d 23 | carol: b71e9d5a770523349868e086f64e85ca455463170cb8cb8a6f42fa6e8e48d024;05205ff527bbcf6652c82be90182fc5a;d0f332a563327a57ef77b27e2124d9b11498236bd44e294319aefe7340d3008c 24 | charlie: 8824950905311b88794df61725a67c96bba87f0dde6b5f17be5fd18d07d262e9;071fd5779282a6d4fa24f93a0d65ca2b;e388b4f36f17490de9024db442ce3e5fb8519d04f9f58823daeeac4d78fe66d9 25 | dan: 226e4489b942f11aa38c9588b08a7cfe11d3dd1df05ad4b73d26af7d81c4ffda;2fd34f0ca35e7fe3ef1b61b524e44342;4e33dad99f63fb404b605fbab332fc7509f552485bc529a7a828d7701f009d86 26 | dave: 115cd1e4cdd11d8151980275cb16bbbd6b10edbb8dd917740842cc192ce97644;0e30d05a90516da78bf21ec555beb442;c572a4ecf47faa2ee942580faf9f50d8ac73b0e91752967c874cbf92d3e3f27d 27 | david: 03cfb3b44b73ecffbb225d7c4faa71cdd6bb0d3f255d43b9d5bba6f0296a5613;7b24d77abf9a4e890c92d3e2fd9e47dc;03018e5dd1050f072a9295c874f8b5f55ce559f1518541320768941f30d90ec9 28 | -------------------------------------------------------------------------------- /documentation/extra_css/stackoverflow-dark.min.css: -------------------------------------------------------------------------------- 1 | pre code.hljs{display:block;overflow-x:auto;padding:1em}code.hljs{padding:3px 5px}/*! 2 | Theme: StackOverflow Dark 3 | Description: Dark theme as used on stackoverflow.com 4 | Author: stackoverflow.com 5 | Maintainer: @Hirse 6 | Website: https://github.com/StackExchange/Stacks 7 | License: MIT 8 | Updated: 2021-05-15 9 | 10 | Updated for @stackoverflow/stacks v0.64.0 11 | Code Blocks: /blob/v0.64.0/lib/css/components/_stacks-code-blocks.less 12 | Colors: /blob/v0.64.0/lib/css/exports/_stacks-constants-colors.less 13 | */.hljs{color:#fff}.hljs-subst{color:#fff}.hljs-comment{color:#999}.hljs-attr,.hljs-doctag,.hljs-keyword,.hljs-meta .hljs-keyword,.hljs-section,.hljs-selector-tag{color:#88aece}.hljs-attribute{color:#c59bc1}.hljs-name,.hljs-number,.hljs-quote,.hljs-selector-id,.hljs-template-tag,.hljs-type{color:#f08d49}.hljs-selector-class{color:#88aece}.hljs-link,.hljs-regexp,.hljs-selector-attr,.hljs-string,.hljs-symbol,.hljs-template-variable,.hljs-variable{color:#b5bd68}.hljs-meta,.hljs-selector-pseudo{color:#88aece}.hljs-built_in,.hljs-literal,.hljs-title{color:#f08d49}.hljs-bullet,.hljs-code{color:#ccc}.hljs-meta .hljs-string{color:#b5bd68}.hljs-deletion{color:#de7176}.hljs-addition{color:#76c490}.hljs-emphasis{font-style:italic}.hljs-strong{font-weight:700} -------------------------------------------------------------------------------- /documentation/extra_css/stackoverflow-light.min.css: -------------------------------------------------------------------------------- 1 | pre code.hljs{display:block;overflow-x:auto;padding:1em}code.hljs{padding:3px 5px}/*! 2 | Theme: StackOverflow Light 3 | Description: Light theme as used on stackoverflow.com 4 | Author: stackoverflow.com 5 | Maintainer: @Hirse 6 | Website: https://github.com/StackExchange/Stacks 7 | License: MIT 8 | Updated: 2021-05-15 9 | 10 | Updated for @stackoverflow/stacks v0.64.0 11 | Code Blocks: /blob/v0.64.0/lib/css/components/_stacks-code-blocks.less 12 | Colors: /blob/v0.64.0/lib/css/exports/_stacks-constants-colors.less 13 | */.hljs{color:#2f3337}.hljs-subst{color:#2f3337}.hljs-comment{color:#656e77}.hljs-attr,.hljs-doctag,.hljs-keyword,.hljs-meta .hljs-keyword,.hljs-section,.hljs-selector-tag{color:#015692}.hljs-attribute{color:#803378}.hljs-name,.hljs-number,.hljs-quote,.hljs-selector-id,.hljs-template-tag,.hljs-type{color:#b75501}.hljs-selector-class{color:#015692}.hljs-link,.hljs-regexp,.hljs-selector-attr,.hljs-string,.hljs-symbol,.hljs-template-variable,.hljs-variable{color:#54790d}.hljs-meta,.hljs-selector-pseudo{color:#015692}.hljs-built_in,.hljs-literal,.hljs-title{color:#b75501}.hljs-bullet,.hljs-code{color:#535a60}.hljs-meta .hljs-string{color:#54790d}.hljs-deletion{color:#c02d2e}.hljs-addition{color:#2f6f44}.hljs-emphasis{font-style:italic}.hljs-strong{font-weight:700} -------------------------------------------------------------------------------- /documentation/hooks.py: -------------------------------------------------------------------------------- 1 | import os 2 | import logging 3 | import hashlib 4 | import sys 5 | from urllib.request import urlopen 6 | from os.path import exists 7 | from pathlib import Path 8 | 9 | from unittest.mock import patch 10 | 11 | def md5(fname): 12 | hash_md5 = hashlib.md5() 13 | with open(fname, "rb") as f: 14 | for chunk in iter(lambda: f.read(4096), b""): 15 | hash_md5.update(chunk) 16 | return hash_md5.hexdigest() 17 | 18 | def download_and_check(filename, url, hash): 19 | hash_md5 = hashlib.md5() 20 | logger = logging.getLogger("mkdocs.download_and_check") 21 | cur_dir = os.path.dirname(os.path.realpath(__file__)) 22 | if not exists(filename): 23 | Path(cur_dir + '/' + filename.rsplit('/',1)[0]).mkdir(parents=True, exist_ok=True) 24 | with urlopen(url) as response: 25 | filecontent = response.read() 26 | hash_md5.update(filecontent) 27 | hash_check = hash_md5.hexdigest() 28 | if hash == hash_check: 29 | with open(Path(cur_dir + '/' + filename), 'wb') as file: 30 | file.write(filecontent) 31 | logger.info('downloaded external asset "' + filename + '"') 32 | else: 33 | logger.error('error downloading asset "' + filename + '" hash mismatch!') 34 | os._exit(1) 35 | 36 | def get_external_assets(config, **kwargs): 37 | download_and_check('theme_override/assets/javascripts/highlight.min.js', 38 | 'https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/highlight.min.js', 39 | '02d5118842743b5d6d73bba11e8dd63a') 40 | download_and_check('theme_override/assets/javascripts/languages/django.min.js', 41 | 'https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.8.0/languages/django.min.js', 42 | '09fe95df12981e92e1cf678a0029a0f7') 43 | download_and_check('theme_override/assets/javascripts/tex-chtml.js', 44 | 'https://cdn.jsdelivr.net/npm/mathjax@3.2.2/es5/tex-chtml.js', 45 | '1d4e370eb01c3768d4304e3245b0afa6') 46 | download_and_check('theme_override/assets/javascripts/output/svg.js', 47 | 'https://cdn.jsdelivr.net/npm/mathjax@3.2.2/es5/output/svg.js', 48 | '4f55967d16197ebb01b86356d8ab179a') 49 | download_and_check('theme_override/assets/javascripts/output/svg/fonts/tex.js', 50 | 'https://cdn.jsdelivr.net/npm/mathjax@3.2.2/es5/output/svg/fonts/tex.js', 51 | '6eab785a3788ea805bd2b552d1f0aab8') 52 | download_and_check('theme_override/assets/javascripts/output/chtml/fonts/woff-v2/MathJax_Zero.woff', 53 | 'https://cdn.jsdelivr.net/npm/mathjax@3.2.2/es5/output/chtml/fonts/woff-v2/MathJax_Zero.woff', 54 | 'b26f96047d1cb466c83e9b27bf353c1f') 55 | download_and_check('theme_override/assets/javascripts/output/chtml/fonts/woff-v2/MathJax_Math-Italic.woff', 56 | 'https://cdn.jsdelivr.net/npm/mathjax@3.2.2/es5/output/chtml/fonts/woff-v2/MathJax_Math-Italic.woff', 57 | '5589d1a8fc62be6613020ef2fa13e410') 58 | download_and_check('theme_override/assets/javascripts/output/chtml/fonts/woff-v2/MathJax_Main-Regular.woff', 59 | 'https://cdn.jsdelivr.net/npm/mathjax@3.2.2/es5/output/chtml/fonts/woff-v2/MathJax_Main-Regular.woff', 60 | '9995de4787f908d8237dba7007f6c3fe') 61 | download_and_check('theme_override/assets/javascripts/output/chtml/fonts/woff-v2/MathJax_Size3-Regular.woff', 62 | 'https://cdn.jsdelivr.net/npm/mathjax@3.2.2/es5/output/chtml/fonts/woff-v2/MathJax_Size3-Regular.woff', 63 | 'a7860eaf63c39f2603165893ce61a878') 64 | download_and_check('theme_override/assets/javascripts/output/chtml/fonts/woff-v2/MathJax_Size1-Regular.woff', 65 | 'https://cdn.jsdelivr.net/npm/mathjax@3.2.2/es5/output/chtml/fonts/woff-v2/MathJax_Size1-Regular.woff', 66 | '7ee67b5348ee634dd16b968d281cb882') 67 | 68 | download_and_check('theme_override/assets/javascripts/mermaid.min.js', 69 | 'https://cdnjs.cloudflare.com/ajax/libs/mermaid/9.4.3/mermaid.min.js', 70 | 'e1bdcac49c3a6464a9aa3c6082b1833e') 71 | 72 | def create_readme(config, **kwargs): 73 | logger = logging.getLogger("mkdocs.create_readme") 74 | cur_dir = Path(os.path.dirname(os.path.realpath(__file__))) 75 | pypi_md = """[![PyPI Version](https://img.shields.io/pypi/v/mkdocs-encryptcontent-plugin.svg)](https://pypi.org/project/mkdocs-encryptcontent-plugin/) 76 | [![PyPI downloads](https://img.shields.io/pypi/dm/mkdocs-encryptcontent-plugin.svg)](https://pypi.org/project/mkdocs-encryptcontent-plugin/) 77 | [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) 78 | 79 | """ 80 | readme_file = cur_dir / Path('../README.md') 81 | 82 | with open(cur_dir / Path('docs/index.md'), "r") as f: 83 | index_md = f.read() 84 | readme_md = '' 85 | with open(cur_dir / Path('docs/installation.md'), "r") as f: 86 | readme_md = readme_md + f.read() + '\n' 87 | with open(cur_dir / Path('docs/usage.md'), "r") as f: 88 | readme_md = readme_md + f.read() + '\n' 89 | with open(cur_dir / Path('docs/features/index.md'), "r") as f: 90 | readme_md = readme_md + f.read() + '\n' 91 | with open(cur_dir / Path('docs/features/modifypages.md'), "r") as f: 92 | readme_md = readme_md + f.read() + '\n' 93 | with open(cur_dir / Path('docs/features/search.md'), "r") as f: 94 | readme_md = readme_md + f.read() + '\n' 95 | with open(cur_dir / Path('docs/features/jsext.md'), "r") as f: 96 | readme_md = readme_md + f.read() + '\n' 97 | with open(cur_dir / Path('docs/features/security.md'), "r") as f: 98 | readme_md = readme_md + f.read() + '\n' 99 | 100 | with open(readme_file, "w") as f: 101 | f.write(readme_md) 102 | logger.info('wrote README.md') 103 | try: 104 | with patch('sys.argv', ['','../README.md']): 105 | import markdowntoc 106 | markdowntoc.main() 107 | except: 108 | logger.error('Please run "pip install markdown-toc"') 109 | 110 | with open(readme_file, "r") as f: 111 | readme_md = f.read() 112 | with open(readme_file, "w") as f: 113 | f.write(pypi_md + index_md + readme_md) 114 | -------------------------------------------------------------------------------- /documentation/img/howitworks.odg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/unverbuggt/mkdocs-encryptcontent-plugin/3a99d7158cbf7522e83b5811b678732dbaf85cee/documentation/img/howitworks.odg -------------------------------------------------------------------------------- /documentation/mkdocs.yml: -------------------------------------------------------------------------------- 1 | site_name: MkDocs encryptcontent plugin V3 2 | site_url: https://unverbuggt.github.io/mkdocs-encryptcontent-plugin/ 3 | site_author: René Rüthlein 4 | 5 | theme: 6 | name: risonia 7 | custom_dir: theme_override 8 | logo: img/logo.svg 9 | favicon: img/logo.ico 10 | extlink: True 11 | extblank: True 12 | zoom_img: True 13 | no_imprint: True 14 | 15 | extra_javascript: 16 | - 'assets/javascripts/highlight.min.js' 17 | - 'assets/javascripts/languages/django.min.js' 18 | - 'assets/javascripts/tex-chtml.js' 19 | - 'assets/javascripts/mermaid.min.js' 20 | 21 | nav: 22 | - Encryptcontent plugin V3: 'index.md' 23 | - 'installation.md' 24 | - 'usage.md' 25 | - Features: 26 | - 'features/index.md' 27 | - Modify pages: 'features/modifypages.md' 28 | - Search encryption: 'features/search.md' 29 | - Javascript extensions: 'features/jsext.md' 30 | - Security: 'features/security.md' 31 | - How does it work?: 'explanations.md' 32 | - Test bench: 33 | - 'testbench/index.md' 34 | - Passwords: 35 | - Test1: 'testbench/onlypasswords1.md' 36 | - Test2: 'testbench/onlypasswords2.md' 37 | - Test3: 'testbench/onlypasswords3.md' 38 | - User/Password: 39 | - Test1: 'testbench/userpass1.md' 40 | - Test2: 'testbench/userpass2.md' 41 | - Anchors: 'testbench/anchor.md' 42 | - Obfuscate: 'testbench/obfuscate.md' 43 | - JS test: 'testbench/jstest.md' 44 | - Search encryption: 'testbench/search.md' 45 | - Share Link: 'testbench/share.md' 46 | - Hash files: 'testbench/hashfilenames.md' 47 | 48 | plugins: 49 | - mkdocs-simple-hooks: 50 | hooks: 51 | on_pre_build: "hooks:get_external_assets" 52 | on_post_build: "hooks:create_readme" 53 | 54 | - include-markdown: {} 55 | 56 | - search: 57 | lang: en 58 | 59 | - mermaid2: 60 | version: 9.4.3 61 | 62 | - i18n: 63 | docs_structure: suffix 64 | fallback_to_default: true 65 | languages: 66 | - build: true 67 | default: true 68 | locale: en 69 | name: English 70 | - build: true 71 | default: false 72 | locale: de 73 | name: Deutsch 74 | nav_translations: 75 | Obfuscate: Verschleiern 76 | Passwords: Passwörter 77 | Test bench: Testaufbau 78 | User/Password: Benutzername/Passwort 79 | Encryptcontent plugin V3: Encryptcontent Plugin V3 80 | site_name: MkDocs Encryptcontent Plugin V3 81 | reconfigure_material: false 82 | reconfigure_search: true 83 | 84 | - color-theme: 85 | theme_color: '#bb4447' 86 | secondary_color: 'complementary' 87 | extra_css_light: 88 | - 'extra_css/stackoverflow-light.min.css' 89 | extra_css_dark: 90 | - 'extra_css/stackoverflow-dark.min.css' 91 | additional: 92 | - theme_color: '#44bb4f' 93 | secondary_color: 'mono' 94 | 95 | - w3css-classes: {} 96 | 97 | - encryptcontent: 98 | html_template_path: "decrypt-form.tpl.html" 99 | title_prefix: '' 100 | summary: '' 101 | placeholder: 'Password' 102 | placeholder_user: User 103 | password_button_text: 'ENTER' 104 | decryption_failure_message: 'Wrong user name or password.' 105 | encryption_info_message: 'Legitimation required.' 106 | translations: 107 | de: 108 | title_prefix: '' 109 | summary: '' 110 | placeholder: 'Passwort' 111 | placeholder_user: Benutzer 112 | password_button_text: 'ENTER' 113 | decryption_failure_message: 'Falscher Benutzer oder Passwort.' 114 | encryption_info_message: 'Legitimation erforderlich.' 115 | 116 | input_class: 'w3-input' 117 | button_class: 'w3-button w3-theme-l1 w3-hover-theme' 118 | hljs: true 119 | arithmatex: true 120 | mermaid2: true 121 | remember_keys: true 122 | remember_password: true 123 | remember_prefix: encryptcontent_plugin_ 124 | #local_storage: true 125 | encrypted_something: 126 | #myNav: [div, id] 127 | myToc: [div, id] 128 | myTocButton: [div, id] 129 | search_index: 'dynamically' #dynamically 130 | password_button: true 131 | selfhost: true 132 | selfhost_download: true 133 | selfhost_dir: 'theme_override' 134 | reload_scripts: 135 | - '#theme' 136 | - '#autostart' 137 | password_file: 'passwords.yml' 138 | additional_storage_file: 'additional_storage.yaml' 139 | sharelinks: true 140 | sharelinks_incomplete: true 141 | #kdf_pow: 4 142 | webcrypto: true 143 | esm: true 144 | sign_files: 'encryptcontent-plugin.json' 145 | cache_file: 'encryptcontent.cache' 146 | sharelinks_output: 'sharelinks.txt' 147 | hash_filenames: 148 | extensions: 149 | - 'png' 150 | - 'jpg' 151 | - 'jpeg' 152 | - 'svg' 153 | except: 154 | - 'logo.svg' 155 | insecure_test: !ENV [MKDOCS_ENCRYPTCONTENT_INSECURE_TEST, false] 156 | 157 | repo_url: https://github.com/unverbuggt/mkdocs-encryptcontent-plugin 158 | 159 | markdown_extensions: 160 | - attr_list 161 | - pymdownx.escapeall: 162 | hardbreak: true 163 | - pymdownx.blocks.html 164 | - pymdownx.tilde 165 | - pymdownx.arithmatex: 166 | generic: true 167 | -------------------------------------------------------------------------------- /documentation/mkdocs_material.yml: -------------------------------------------------------------------------------- 1 | site_name: MkDocs encryptcontent plugin V3 2 | site_url: https://unverbuggt.github.io/mkdocs-encryptcontent-plugin/ 3 | site_author: René Rüthlein 4 | 5 | theme: 6 | name: material 7 | language: en 8 | logo: img/logo.svg 9 | favicon: img/logo.ico 10 | font: false 11 | palette: 12 | # Palette toggle for dark mode 13 | - media: "(prefers-color-scheme: dark)" 14 | scheme: slate 15 | primary: blue grey 16 | accent: indigo 17 | toggle: 18 | icon: material/brightness-4 19 | name: Hell 20 | 21 | # Palette toggle for light mode 22 | - media: "(prefers-color-scheme: light)" 23 | scheme: default 24 | primary: blue grey 25 | accent: indigo 26 | toggle: 27 | icon: material/brightness-7 28 | name: Dunkel 29 | features: 30 | - navigation.indexes 31 | - navigation.tracking 32 | #- navigation.sections 33 | #- navigation.expand 34 | - navigation.top 35 | #- navigation.prune 36 | - content.code.copy 37 | 38 | #extra_javascript: 39 | # - 'assets/javascripts/highlight.min.js' 40 | # - 'assets/javascripts/tex-mml-chtml.js' 41 | # - 'assets/javascripts/mermaid.min.js' 42 | 43 | nav: 44 | - 'index.md' 45 | - 'installation.md' 46 | - 'usage.md' 47 | - Features: 48 | - 'features/index.md' 49 | - 'features/modifypages.md' 50 | - 'features/search.md' 51 | - 'features/jsext.md' 52 | - 'features/security.md' 53 | - How does it work?: 'explanations.md' 54 | - Test bench: 55 | - 'testbench/index.md' 56 | - Passwords: 57 | - Test1: 'testbench/onlypasswords1.md' 58 | - Test2: 'testbench/onlypasswords2.md' 59 | - Test3: 'testbench/onlypasswords3.md' 60 | - User/Password: 61 | - Test1: 'testbench/userpass1.md' 62 | - Test2: 'testbench/userpass2.md' 63 | - Anchors: 'testbench/anchor.md' 64 | - Obfuscate: 'testbench/obfuscate.md' 65 | - JS test: 'testbench/jstest.md' 66 | - Search encryption: 'testbench/search.md' 67 | - Share Link: 'testbench/share.md' 68 | - Hash files: 'testbench/hashfilenames.md' 69 | 70 | plugins: 71 | - include-markdown: {} 72 | 73 | - search: 74 | lang: en 75 | 76 | - mermaid2: 77 | version: 9.4.3 78 | 79 | - i18n: 80 | docs_structure: suffix 81 | fallback_to_default: true 82 | languages: 83 | - build: true 84 | default: true 85 | locale: en 86 | name: English 87 | - build: true 88 | default: false 89 | locale: de 90 | name: Deutsch 91 | nav_translations: 92 | Obfuscate: Verschleiern 93 | Passwords: Passwörter 94 | Test bench: Testaufbau 95 | User/Password: Benutzername/Passwort 96 | site_name: MkDocs Encryptcontent Plugin V3 97 | reconfigure_material: true 98 | reconfigure_search: true 99 | 100 | - encryptcontent: 101 | #html_template_path: "decrypt-form.tpl.html" 102 | title_prefix: '' 103 | summary: '' 104 | placeholder: 'Password' 105 | placeholder_user: User 106 | password_button_text: 'ENTER' 107 | decryption_failure_message: 'Wrong user name or password.' 108 | encryption_info_message: 'Legitimation required.' 109 | translations: 110 | de: 111 | title_prefix: '' 112 | summary: '' 113 | placeholder: 'Passwort' 114 | placeholder_user: Benutzer 115 | password_button_text: 'ENTER' 116 | decryption_failure_message: 'Falscher Benutzer oder Passwort.' 117 | encryption_info_message: 'Legitimation erforderlich.' 118 | 119 | #input_class: 'w3-input' 120 | #button_class: 'w3-button w3-theme-l1 w3-hover-theme' 121 | #hljs: true 122 | #arithmatex: true 123 | #mermaid2: true 124 | remember_keys: true 125 | remember_password: true 126 | remember_prefix: encryptcontent_plugin_ 127 | encrypted_something: 128 | md-footer__inner: [nav, class] #Footer 129 | #md-nav: [nav, class] #Menu and toc 130 | inject: 131 | md-content: [div, class] 132 | search_index: 'dynamically' #dynamically 133 | password_button: True 134 | selfhost: true 135 | selfhost_download: true 136 | selfhost_dir: 'theme_override' 137 | reload_scripts: 138 | - '#autostart' 139 | password_file: 'passwords.yml' 140 | sharelinks: true 141 | #kdf_pow: 4 142 | webcrypto: true 143 | sign_files: 'encryptcontent-plugin.json' 144 | hash_filenames: 145 | extensions: 146 | - 'png' 147 | - 'jpg' 148 | - 'jpeg' 149 | - 'svg' 150 | except: 151 | - 'logo.svg' 152 | 153 | repo_url: https://github.com/unverbuggt/mkdocs-encryptcontent-plugin 154 | 155 | markdown_extensions: 156 | - attr_list 157 | - pymdownx.escapeall: 158 | hardbreak: true 159 | - pymdownx.blocks.html 160 | - pymdownx.tilde 161 | - pymdownx.arithmatex: 162 | generic: true 163 | - pymdownx.highlight: 164 | anchor_linenums: true 165 | line_spans: __span 166 | pygments_lang_class: true 167 | - pymdownx.inlinehilite 168 | - pymdownx.snippets 169 | - pymdownx.superfences -------------------------------------------------------------------------------- /documentation/mkdocs_mkdocs.yml: -------------------------------------------------------------------------------- 1 | site_name: MkDocs encryptcontent plugin V3 2 | site_url: https://unverbuggt.github.io/mkdocs-encryptcontent-plugin/ 3 | site_author: René Rüthlein 4 | 5 | theme: 6 | name: mkdocs 7 | #custom_dir: theme_override/ 8 | logo: img/logo.svg 9 | favicon: img/logo.ico 10 | highlightjs: True 11 | hljs_languages: 12 | - bash 13 | - django 14 | - yaml 15 | nav_style: dark 16 | locale: en 17 | 18 | #extra_javascript: 19 | # - 'assets/javascripts/highlight.min.js' 20 | # - 'assets/javascripts/tex-mml-chtml.js' 21 | # - 'assets/javascripts/mermaid.min.js' 22 | 23 | nav: 24 | - 'index.md' 25 | - 'installation.md' 26 | - 'usage.md' 27 | - Features: 28 | - 'features/index.md' 29 | - 'features/modifypages.md' 30 | - 'features/search.md' 31 | - 'features/jsext.md' 32 | - 'features/security.md' 33 | - How does it work?: 'explanations.md' 34 | - Test bench: 35 | - 'testbench/index.md' 36 | - Passwords: 37 | - Test1: 'testbench/onlypasswords1.md' 38 | - Test2: 'testbench/onlypasswords2.md' 39 | - Test3: 'testbench/onlypasswords3.md' 40 | - User/Password: 41 | - Test1: 'testbench/userpass1.md' 42 | - Test2: 'testbench/userpass2.md' 43 | - Anchors: 'testbench/anchor.md' 44 | - Obfuscate: 'testbench/obfuscate.md' 45 | - JS test: 'testbench/jstest.md' 46 | - Search encryption: 'testbench/search.md' 47 | - Share Link: 'testbench/share.md' 48 | - Hash files: 'testbench/hashfilenames.md' 49 | 50 | plugins: 51 | - include-markdown: {} 52 | 53 | - search: 54 | lang: en 55 | 56 | - mermaid2: 57 | version: 9.4.3 58 | 59 | - i18n: 60 | docs_structure: suffix 61 | fallback_to_default: true 62 | languages: 63 | - build: true 64 | default: true 65 | locale: en 66 | name: English 67 | - build: true 68 | default: false 69 | locale: de 70 | name: Deutsch 71 | nav_translations: 72 | Obfuscate: Verschleiern 73 | Passwords: Passwörter 74 | Test bench: Testaufbau 75 | User/Password: Benutzername/Passwort 76 | site_name: MkDocs Encryptcontent Plugin V3 77 | reconfigure_material: false 78 | reconfigure_search: true 79 | 80 | - encryptcontent: 81 | #html_template_path: "decrypt-form.tpl.html" 82 | title_prefix: '' 83 | summary: '' 84 | placeholder: 'Password' 85 | placeholder_user: User 86 | password_button_text: 'ENTER' 87 | decryption_failure_message: 'Wrong user name or password.' 88 | encryption_info_message: 'Legitimation required.' 89 | translations: 90 | de: 91 | title_prefix: '' 92 | summary: '' 93 | placeholder: 'Passwort' 94 | placeholder_user: Benutzer 95 | password_button_text: 'ENTER' 96 | decryption_failure_message: 'Falscher Benutzer oder Passwort.' 97 | encryption_info_message: 'Legitimation erforderlich.' 98 | 99 | #input_class: 'w3-input' 100 | #button_class: 'w3-button w3-theme-l1 w3-hover-theme' 101 | #hljs: true 102 | #arithmatex: true 103 | #mermaid2: true 104 | remember_keys: true 105 | remember_password: true 106 | remember_prefix: encryptcontent_plugin_ 107 | #local_storage: true 108 | encrypted_something: 109 | navbar-light: [div, class] 110 | #myNav: [div, id] 111 | #myToc: [div, id] 112 | #myTocButton: [div, id] 113 | search_index: 'dynamically' #dynamically 114 | password_button: True 115 | selfhost: true 116 | selfhost_download: true 117 | selfhost_dir: 'theme_override' 118 | reload_scripts: 119 | - '#autostart' 120 | password_file: 'passwords.yml' 121 | sharelinks: true 122 | #kdf_pow: 4 123 | webcrypto: true 124 | sign_files: 'encryptcontent-plugin.json' 125 | hash_filenames: 126 | extensions: 127 | - 'png' 128 | - 'jpg' 129 | - 'jpeg' 130 | - 'svg' 131 | except: 132 | - 'logo.svg' 133 | 134 | repo_url: https://github.com/unverbuggt/mkdocs-encryptcontent-plugin 135 | 136 | markdown_extensions: 137 | - attr_list 138 | - pymdownx.escapeall: 139 | hardbreak: true 140 | - pymdownx.blocks.html 141 | - pymdownx.tilde 142 | - pymdownx.arithmatex: 143 | generic: true 144 | -------------------------------------------------------------------------------- /documentation/passwords.yml: -------------------------------------------------------------------------------- 1 | onlypasswords1: 2 | - 'Clique.Shampoo.Ve55el' 3 | - 'C4bbage Profile blinking' 4 | - 'Head32_Sculpture_bovine_' 5 | - 'Negotiator-leftover-567' 6 | - 'moist:W00l:kept:royal' 7 | - 'SpotChestOilCycle22' 8 | - 'm00dy#augmented#Arsonist' 9 | - 'Hatless,hertz,C4lzone' 10 | - !ENV [PASSWORD2_FROM_ENV, 'Password if PASSWORD2_FROM_ENV undefined or empty'] 11 | 12 | onlypasswords2: 13 | - 'moist:W00l:kept:royal' 14 | - 'SpotChestOilCycle22' 15 | - 'm00dy#augmented#Arsonist' 16 | - 'Hatless,hertz,C4lzone' 17 | 18 | user_and_passwords1: 19 | alice: 'Racoon Superstore obnoxious23' 20 | bob: 'AbidingScooterRuinedCC:Cactus' 21 | carol: 'Worry-Bony-Glide-Mace!' 22 | carlos: 'Arre5tConfused Pentagon' 23 | charlie: 'gear.code.blonde.at0ll' 24 | dan: 'oxidize,croissant,ClubHouse5' 25 | dave: 'nuClear_lullaby_unveiled_g4rlic' 26 | david: 'establishRelishBlushV3nus' 27 | 28 | user_and_passwords2: 29 | charlie: 'gear.code.blonde.at0ll' 30 | dan: 'oxidize,croissant,ClubHouse5' 31 | dave: 'nuClear_lullaby_unveiled_g4rlic' 32 | david: 'establishRelishBlushV3nus' 33 | 34 | test1: 35 | bob: 'AbidingScooterRuinedCC:Cactus' 36 | test2: 'gnckuäshfliglkffhbvrG:Wurst' 37 | test3: 'yDAHKmYjmCsAékUChasd' 38 | test4: 'TeGhD9aqßQnHujmLdsa' 39 | test5: 'WOgh0ÜwyKHoc*I_das' -------------------------------------------------------------------------------- /documentation/sharelinks.txt: -------------------------------------------------------------------------------- 1 | https://unverbuggt.github.io/mkdocs-encryptcontent-plugin/testbench/obfuscate/#ITpDcmF3bGVyIGJlIGdvbmUh 2 | https://unverbuggt.github.io/mkdocs-encryptcontent-plugin/testbench/onlypasswords1/#ITpDbGlxdWUuU2hhbXBvby5WZTU1ZWw 3 | https://unverbuggt.github.io/mkdocs-encryptcontent-plugin/testbench/test1/#IWJvYjpBYmlkaW5nU2Nvb3RlclJ1aW5lZENDOg 4 | https://unverbuggt.github.io/mkdocs-encryptcontent-plugin/testbench/test2/#ITpnbmNrdcOkc2hmbGlnbGtmZmhidnJHOg 5 | https://unverbuggt.github.io/mkdocs-encryptcontent-plugin/testbench/test3/#ITp5REFIS21Zam1Dc0HDqWtVQ2hhc2Q 6 | https://unverbuggt.github.io/mkdocs-encryptcontent-plugin/testbench/test4/#ITpUZUdoRDlhccOfUW5IdWptTGRzYQ 7 | https://unverbuggt.github.io/mkdocs-encryptcontent-plugin/testbench/test5/#ITpXT2doMMOcd3lLSG9jKklfZGFz 8 | https://unverbuggt.github.io/mkdocs-encryptcontent-plugin/de/testbench/test1/#IWJvYjpBYmlkaW5nU2Nvb3RlclJ1aW5lZENDOg 9 | https://unverbuggt.github.io/mkdocs-encryptcontent-plugin/de/testbench/test2/#ITpnbmNrdcOkc2hmbGlnbGtmZmhidnJHOg 10 | https://unverbuggt.github.io/mkdocs-encryptcontent-plugin/de/testbench/test3/#ITp5REFIS21Zam1Dc0HDqWtVQ2hhc2Q 11 | https://unverbuggt.github.io/mkdocs-encryptcontent-plugin/de/testbench/test4/#ITpUZUdoRDlhccOfUW5IdWptTGRzYQ 12 | https://unverbuggt.github.io/mkdocs-encryptcontent-plugin/de/testbench/test5/#ITpXT2doMMOcd3lLSG9jKklfZGFz 13 | https://unverbuggt.github.io/mkdocs-encryptcontent-plugin/de/testbench/userpass1/#IWFsaWNlOlJhY29vbiBTdXBlcnN0b3JlIG9ibm94aW91czIz -------------------------------------------------------------------------------- /documentation/theme_override/main.html: -------------------------------------------------------------------------------- 1 | {% extends "base.html" %} 2 | 3 | {% block exec_script %} 4 | 7 | 23 | 29 | {% endblock %} 30 | 31 | {%- block footer_ext %} 32 |

33 | 34 | {%- if not config.theme.no_imprint %} 35 | {%- if i18n_config and i18n_page_locale == "en" %} 36 | Imprint 37 | {%- else %} 38 | Impressum 39 | {%- endif %} 40 | {%- endif %} 41 |

42 | {%- endblock %} 43 | 44 | {%- block top_buttons %} 45 | </> 46 | {%- endblock %} 47 | -------------------------------------------------------------------------------- /encryptcontent/__init__.py: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/unverbuggt/mkdocs-encryptcontent-plugin/3a99d7158cbf7522e83b5811b678732dbaf85cee/encryptcontent/__init__.py -------------------------------------------------------------------------------- /encryptcontent/canary.tpl.py: -------------------------------------------------------------------------------- 1 | import json 2 | import base64 3 | from Crypto.Hash import SHA512 4 | from Crypto.PublicKey import ECC 5 | from Crypto.Signature import eddsa 6 | from urllib.request import urlopen 7 | 8 | publickey = """{{ public_key }}""" 9 | 10 | signature_url = '{{ signature_url }}' 11 | 12 | urls_to_verify = {{ urls_to_verify }} 13 | 14 | def __verify_url__(url, signature, verifier): 15 | h = SHA512.new() 16 | with urlopen(url) as response: 17 | h.update(response.read()) 18 | try: 19 | verifier.verify(h, signature) 20 | return True 21 | except ValueError: 22 | return False 23 | 24 | verifier = eddsa.new(ECC.import_key(publickey), 'rfc8032') 25 | 26 | print("NOTE: Checking of generated pages while 'mkdocs serve' will fail, because they are modified with the livereload script") 27 | 28 | try: 29 | with urlopen(signature_url) as response: 30 | signatures = json.loads(response.read()) 31 | for url in urls_to_verify: 32 | if url not in signatures.keys(): 33 | print(url + ": MISSING!") # signature_url modified or just need to recreate canary script? 34 | else: 35 | if __verify_url__(url, base64.b64decode(signatures[url]), verifier): 36 | print(url + ": ok") 37 | else: 38 | print(url + ": FAILED!") # file modified! 39 | except: 40 | print("Couldn't download signatures!") -------------------------------------------------------------------------------- /encryptcontent/contrib/templates/search/main.js: -------------------------------------------------------------------------------- 1 | /* encryptcontent/contrib/templates/search/main.js */ 2 | 3 | function getSearchTermFromLocation() { 4 | var sPageURL = window.location.search.substring(1); 5 | var sURLVariables = sPageURL.split('&'); 6 | for (var i = 0; i < sURLVariables.length; i++) { 7 | var sParameterName = sURLVariables[i].split('='); 8 | if (sParameterName[0] == 'q') { 9 | return decodeURIComponent(sParameterName[1].replace(/\+/g, '%20')); 10 | } 11 | } 12 | } 13 | 14 | function joinUrl (base, path) { 15 | if (path.substring(0, 1) === "/") { 16 | // path starts with `/`. Thus it is absolute. 17 | return path; 18 | } 19 | if (base.substring(base.length-1) === "/") { 20 | // base ends with `/` 21 | return base + path; 22 | } 23 | return base + "/" + path; 24 | } 25 | 26 | function escapeHtml (value) { 27 | return value.replace(/&/g, '&') 28 | .replace(/"/g, '"') 29 | .replace(//g, '>'); 31 | } 32 | 33 | function formatResult (location, title, summary) { 34 | return '

'+ escapeHtml(title) + '

' + escapeHtml(summary) +'

'; 35 | } 36 | 37 | function displayResults (results) { 38 | var search_results = document.getElementById("mkdocs-search-results"); 39 | while (search_results.firstChild) { 40 | search_results.removeChild(search_results.firstChild); 41 | } 42 | if (results.length > 0){ 43 | for (var i=0; i < results.length; i++){ 44 | var result = results[i]; 45 | var html = formatResult(result.location, result.title, result.summary); 46 | search_results.insertAdjacentHTML('beforeend', html); 47 | } 48 | } else { 49 | var noResultsText = search_results.getAttribute('data-no-results-text'); 50 | if (!noResultsText) { 51 | noResultsText = "No results found"; 52 | } 53 | search_results.insertAdjacentHTML('beforeend', '

' + noResultsText + '

'); 54 | } 55 | } 56 | 57 | function doSearch () { 58 | var query = document.getElementById('mkdocs-search-query').value; 59 | if (query.length > min_search_length) { 60 | if (!window.Worker) { 61 | displayResults(search(query)); 62 | } else { 63 | searchWorker.postMessage({query: query}); 64 | } 65 | } else { 66 | // Clear results for short queries 67 | displayResults([]); 68 | } 69 | } 70 | 71 | function initSearch () { 72 | var search_input = document.getElementById('mkdocs-search-query'); 73 | if (search_input) { 74 | search_input.addEventListener("keyup", doSearch); 75 | } 76 | var term = getSearchTermFromLocation(); 77 | if (term) { 78 | search_input.value = term; 79 | doSearch(); 80 | } 81 | } 82 | 83 | function onWorkerMessage (e) { 84 | if (e.data.allowSearch) { 85 | initSearch(); 86 | } else if (e.data.results) { 87 | var results = e.data.results; 88 | displayResults(results); 89 | } else if (e.data.config) { 90 | min_search_length = e.data.config.min_search_length-1; 91 | } else if (e.data.saveIndex) { 92 | var saveIndex = e.data.saveIndex; 93 | sessionStorage.setItem('encryptcontent-index', saveIndex) 94 | } 95 | } 96 | 97 | if (!window.Worker) { 98 | console.log('Web Worker API not supported'); 99 | // load index in main thread 100 | $.getScript(joinUrl(base_url, "search/worker.js")).done(function () { 101 | console.log('Loaded worker'); 102 | // reload index from session Storage if exist 103 | var sessionIndex = sessionStorage.getItem('encryptcontent-index') 104 | init(sessionIndex); 105 | window.postMessage = function (msg) { 106 | onWorkerMessage({data: msg}); 107 | }; 108 | }).fail(function (jqxhr, settings, exception) { 109 | console.error('Could not load worker.js'); 110 | }); 111 | } else { 112 | // Wrap search in a web worker 113 | var searchWorker = new Worker(joinUrl(base_url, "search/worker.js")); 114 | // reload index from session Storage if exist 115 | var sessionIndex = sessionStorage.getItem('encryptcontent-index') 116 | searchWorker.postMessage({init: true, sessionIndex: sessionIndex}); 117 | searchWorker.onmessage = onWorkerMessage; 118 | } 119 | -------------------------------------------------------------------------------- /encryptcontent/contrib/templates/search/worker.js: -------------------------------------------------------------------------------- 1 | /* encryptcontent/contrib/templates/search/worker.js */ 2 | 3 | var base_path = 'function' === typeof importScripts ? '.' : '/search/'; 4 | var allowSearch = false; 5 | var index; 6 | var documents = {}; 7 | var lang = ['en']; 8 | var data; 9 | var session = false; 10 | 11 | function getScript(script, callback) { 12 | console.log('Loading script: ' + script); 13 | $.getScript(base_path + script).done(function () { 14 | callback(); 15 | }).fail(function (jqxhr, settings, exception) { 16 | console.log('Error: ' + exception); 17 | }); 18 | } 19 | 20 | function getScriptsInOrder(scripts, callback) { 21 | if (scripts.length === 0) { 22 | callback(); 23 | return; 24 | } 25 | getScript(scripts[0], function() { 26 | getScriptsInOrder(scripts.slice(1), callback); 27 | }); 28 | } 29 | 30 | function loadScripts(urls, callback) { 31 | if( 'function' === typeof importScripts ) { 32 | importScripts.apply(null, urls); 33 | callback(); 34 | } else { 35 | getScriptsInOrder(urls, callback); 36 | } 37 | } 38 | 39 | function onJSONLoaded () { 40 | if (!data) { 41 | data = JSON.parse(this.responseText); 42 | } 43 | var scriptsToLoad = ['lunr.js']; 44 | if (data.config && data.config.lang && data.config.lang.length) { 45 | lang = data.config.lang; 46 | } 47 | if (lang.length > 1 || lang[0] !== "en") { 48 | scriptsToLoad.push('lunr.stemmer.support.js'); 49 | if (lang.length > 1) { 50 | scriptsToLoad.push('lunr.multi.js'); 51 | } 52 | if (lang.includes("ja") || lang.includes("jp")) { 53 | scriptsToLoad.push('tinyseg.js'); 54 | } 55 | for (var i=0; i < lang.length; i++) { 56 | if (lang[i] != 'en') { 57 | scriptsToLoad.push(['lunr', lang[i], 'js'].join('.')); 58 | } 59 | } 60 | } 61 | loadScripts(scriptsToLoad, onScriptsLoaded); 62 | } 63 | 64 | function onScriptsLoaded () { 65 | console.log('All search scripts loaded, building Lunr index...'); 66 | if (data.config && data.config.separator && data.config.separator.length) { 67 | lunr.tokenizer.separator = new RegExp(data.config.separator); 68 | } 69 | 70 | if (data.index) { 71 | index = lunr.Index.load(data.index); 72 | data.docs.forEach(function (doc) { 73 | documents[doc.location] = doc; 74 | }); 75 | console.log('Lunr pre-built index loaded, search ready'); 76 | } else { 77 | index = lunr(function () { 78 | if (lang.length === 1 && lang[0] !== "en" && lunr[lang[0]]) { 79 | this.use(lunr[lang[0]]); 80 | } else if (lang.length > 1) { 81 | this.use(lunr.multiLanguage.apply(null, lang)); // spread operator not supported in all browsers: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Spread_operator#Browser_compatibility 82 | } 83 | this.field('title'); 84 | this.field('text'); 85 | this.ref('location'); 86 | 87 | for (var i=0; i < data.docs.length; i++) { 88 | var doc = data.docs[i]; 89 | this.add(doc); 90 | documents[doc.location] = doc; 91 | } 92 | }); 93 | console.log('Lunr index built, search ready'); 94 | } 95 | allowSearch = true; 96 | postMessage({config: data.config}); 97 | postMessage({allowSearch: allowSearch}); 98 | // Skip data return if searchIndex exist on sessionStorage 99 | if (!session) { 100 | postMessage({saveIndex: JSON.stringify(data)}); 101 | } 102 | } 103 | 104 | function init (sessionIndex) { 105 | if (!session) { 106 | var oReq = new XMLHttpRequest(); 107 | oReq.addEventListener("load", onJSONLoaded); 108 | var index_path = base_path + '/search_index.json'; 109 | if ( 'function' === typeof importScripts ) { 110 | index_path = 'search_index.json'; 111 | } 112 | oReq.open("GET", index_path); 113 | oReq.send(); 114 | } else { 115 | data = JSON.parse(sessionIndex); 116 | onJSONLoaded(); 117 | } 118 | } 119 | 120 | function search (query) { 121 | if (!allowSearch) { 122 | console.error('Assets for search still loading'); 123 | return; 124 | } 125 | 126 | var resultDocuments = []; 127 | var results = index.search(query); 128 | for (var i=0; i < results.length; i++){ 129 | var result = results[i]; 130 | doc = documents[result.ref]; 131 | doc.summary = doc.text.substring(0, 200); 132 | resultDocuments.push(doc); 133 | } 134 | return resultDocuments; 135 | } 136 | 137 | if( 'function' === typeof importScripts ) { 138 | onmessage = function (e) { 139 | if (e.data.init) { 140 | if (e.data.sessionIndex) { 141 | session = true; 142 | init(e.data.sessionIndex); 143 | } else { 144 | init(); 145 | } 146 | } else if (e.data.query) { 147 | postMessage({ results: search(e.data.query) }); 148 | } else { 149 | console.error("Worker - Unrecognized message: " + e); 150 | } 151 | }; 152 | } 153 | -------------------------------------------------------------------------------- /encryptcontent/decrypt-contents.tpl.js: -------------------------------------------------------------------------------- 1 | /* encryptcontent/decrypt-contents.tpl.js */ 2 | {%- if webcrypto %} 3 | // https://stackoverflow.com/a/50868276 4 | function fromHex(hexString) { 5 | return new Uint8Array(hexString.match(/.{1,2}/g).map(byte => parseInt(byte, 16))); 6 | } 7 | // https://stackoverflow.com/a/41106346 8 | function fromBase64(base64String) { 9 | return Uint8Array.from(atob(base64String), c => c.charCodeAt(0)); 10 | } 11 | 12 | async function digestSHA256toBase64(message) { 13 | const data = new TextEncoder().encode(message); 14 | const hashBuffer = await crypto.subtle.digest("SHA-256", data); 15 | const hashArray = new Uint8Array(hashBuffer); 16 | const hashString = String.fromCharCode.apply(null, hashArray); 17 | return btoa(hashString); 18 | }; 19 | {%- endif %} 20 | 21 | function base64url_decode(input) { 22 | try { 23 | const binString = atob(input.replace(/-/g, '+').replace(/_/g, '/')); 24 | const binArray = Uint8Array.from(binString, (m) => m.codePointAt(0)); 25 | return new TextDecoder().decode(binArray); 26 | } 27 | catch (err) { 28 | return false; 29 | } 30 | } 31 | 32 | /* Decrypts the key from the key bundle. */ 33 | {% if webcrypto %}async {% endif %}function decrypt_key(pass, iv_b64, ciphertext_b64, salt_b64) { 34 | {%- if webcrypto %} 35 | const salt = fromBase64(salt_b64); 36 | const encPassword = new TextEncoder().encode(pass); 37 | const kdfkey = await window.crypto.subtle.importKey( 38 | "raw", 39 | encPassword, 40 | "PBKDF2", 41 | false, 42 | ["deriveKey"], 43 | ); 44 | const wckey = await window.crypto.subtle.deriveKey( 45 | { 46 | name: "PBKDF2", 47 | salt, 48 | iterations: encryptcontent_obfuscate ? 1 : {{ kdf_iterations }}, 49 | hash: "SHA-256", 50 | }, 51 | kdfkey, 52 | { name: "AES-CBC", length: 256 }, 53 | true, 54 | ["decrypt"], 55 | ); 56 | const ciphertext = fromBase64(ciphertext_b64); 57 | const iv = fromBase64(iv_b64); 58 | try { 59 | const decrypted = await window.crypto.subtle.decrypt( 60 | { 61 | name: "AES-CBC", 62 | iv: iv 63 | }, 64 | wckey, 65 | ciphertext 66 | ); 67 | const keystore = JSON.parse(new TextDecoder().decode(decrypted)); 68 | if (encryptcontent_id in keystore) { 69 | return keystore; 70 | } else { 71 | //id not found in keystore 72 | return false; 73 | } 74 | } 75 | catch (err) { 76 | // encoding failed; wrong key 77 | return false; 78 | } 79 | {%- else %} 80 | let salt = CryptoJS.enc.Base64.parse(salt_b64), 81 | kdfcfg = {keySize: 256 / 32,hasher: CryptoJS.algo.SHA256,iterations: encryptcontent_obfuscate ? 1 : {{ kdf_iterations }}}; 82 | let kdfkey = CryptoJS.PBKDF2(pass, salt,kdfcfg); 83 | let iv = CryptoJS.enc.Base64.parse(iv_b64), 84 | ciphertext = CryptoJS.enc.Base64.parse(ciphertext_b64); 85 | let encrypted = {ciphertext: ciphertext}, 86 | cfg = {iv: iv, mode: CryptoJS.mode.CBC, padding: CryptoJS.pad.Pkcs7}; 87 | let key = CryptoJS.AES.decrypt(encrypted, kdfkey, cfg); 88 | 89 | try { 90 | let keystore = JSON.parse(key.toString(CryptoJS.enc.Utf8)); 91 | if (encryptcontent_id in keystore) { 92 | return keystore; 93 | } else { 94 | //id not found in keystore 95 | return false; 96 | } 97 | } catch (err) { 98 | // encoding failed; wrong password 99 | return false; 100 | } 101 | {%- endif %} 102 | }; 103 | 104 | /* Split key bundle and try to decrypt it */ 105 | {% if webcrypto %}async {% endif %}function decrypt_key_from_bundle(password, ciphertext_bundle, username) { 106 | // grab the ciphertext bundle and try to decrypt it 107 | let user, pass; 108 | let parts, keys, userhash; 109 | if (ciphertext_bundle) { 110 | if (username) { 111 | user = encodeURIComponent(username.toLowerCase()); 112 | {%- if webcrypto %} 113 | userhash = await digestSHA256toBase64(user); 114 | {%- else %} 115 | userhash = CryptoJS.SHA256(user).toString(CryptoJS.enc.Base64); 116 | {%- endif %} 117 | } 118 | for (let i = 0; i < ciphertext_bundle.length; i++) { 119 | pass = encodeURIComponent(password); 120 | parts = ciphertext_bundle[i].split(';'); 121 | if (parts.length == 3) { 122 | keys = {% if webcrypto %}await {% endif %}decrypt_key(pass, parts[0], parts[1], parts[2]); 123 | if (keys) { 124 | {% if remember_password %}setCredentials(null, pass);{% endif %} 125 | return keys; 126 | } 127 | } else if (parts.length == 4 && username) { 128 | if (parts[3] == userhash) { 129 | keys = {% if webcrypto %}await {% endif %}decrypt_key(pass, parts[0], parts[1], parts[2]); 130 | if (keys) { 131 | {% if remember_password %}setCredentials(user, pass);{% endif %} 132 | return keys; 133 | } 134 | } 135 | } 136 | } 137 | } 138 | return false; 139 | }; 140 | 141 | /* Decrypts the content from the ciphertext bundle. */ 142 | {% if webcrypto %}async {% endif %}function decrypt_content(key, iv_b64, ciphertext_b64) { 143 | {%- if webcrypto %} 144 | const rawKey = fromHex(key); 145 | const iv = fromBase64(iv_b64); 146 | const ciphertext = fromBase64(ciphertext_b64); 147 | try { 148 | const wckey = await window.crypto.subtle.importKey( 149 | "raw", 150 | rawKey, 151 | "AES-CBC", 152 | true, 153 | ["decrypt"] 154 | ); 155 | const decrypted = await window.crypto.subtle.decrypt( 156 | { 157 | name: "AES-CBC", 158 | iv: iv 159 | }, 160 | wckey, 161 | ciphertext 162 | ); 163 | const decoder = new TextDecoder(); 164 | return decoder.decode(decrypted); 165 | } 166 | catch (err) { 167 | // encoding failed; wrong key 168 | return false; 169 | } 170 | {%- else %} 171 | let iv = CryptoJS.enc.Base64.parse(iv_b64), 172 | ciphertext = CryptoJS.enc.Base64.parse(ciphertext_b64); 173 | let encrypted = {ciphertext: ciphertext}, 174 | cfg = {iv: iv, mode: CryptoJS.mode.CBC, padding: CryptoJS.pad.Pkcs7}; 175 | let plaintext = CryptoJS.AES.decrypt(encrypted, CryptoJS.enc.Hex.parse(key), cfg); 176 | if(plaintext.sigBytes >= 0) { 177 | try { 178 | return plaintext.toString(CryptoJS.enc.Utf8) 179 | } catch (err) { 180 | // encoding failed; wrong key 181 | return false; 182 | } 183 | } else { 184 | // negative sigBytes; wrong key 185 | return false; 186 | } 187 | {%- endif %} 188 | }; 189 | 190 | /* Split cyphertext bundle and try to decrypt it */ 191 | {% if webcrypto %}async {% endif %}function decrypt_content_from_bundle(key, ciphertext_bundle) { 192 | // grab the ciphertext bundle and try to decrypt it 193 | if (ciphertext_bundle) { 194 | let parts = ciphertext_bundle.split(';'); 195 | if (parts.length == 2) { 196 | return {% if webcrypto %}await {% endif %}decrypt_content(key, parts[0], parts[1]); 197 | } 198 | } 199 | return false; 200 | }; 201 | 202 | {% if- remember_keys -%} 203 | /* Save decrypted keystore to sessionStorage */ 204 | {% if webcrypto %}async {% endif %}function setKeys(keys_from_keystore) { 205 | for (const id in keys_from_keystore) { 206 | sessionStorage.setItem(id, keys_from_keystore[id]); 207 | } 208 | }; 209 | 210 | /* Delete key with specific name in sessionStorage */ 211 | {% if webcrypto %}async {% endif %}function delItemName(key) { 212 | sessionStorage.removeItem(key); 213 | }; 214 | 215 | {% if webcrypto %}async {% endif %}function getItemName(key) { 216 | return sessionStorage.getItem(key); 217 | }; 218 | {%- endif %} 219 | {%- if remember_password %} 220 | /* save username/password to sessionStorage/localStorage */ 221 | {% if webcrypto %}async {% endif %}function setCredentials(username, password) { 222 | {%- if session_storage %} 223 | sessionStorage.setItem('{{ remember_prefix }}credentials', JSON.stringify({'user': username, 'password': password})); 224 | {%- else %} 225 | localStorage.setItem('{{ remember_prefix }}credentials', JSON.stringify({'user': username, 'password': password})); 226 | {%- endif %} 227 | } 228 | 229 | /* try to get username/password from sessionStorage/localStorage */ 230 | {% if webcrypto %}async {% endif %}function getCredentials(username_input, password_input) { 231 | {%- if session_storage %} 232 | const credentials = JSON.parse(sessionStorage.getItem('{{ remember_prefix }}credentials')); 233 | {%- else %} 234 | const credentials = JSON.parse(localStorage.getItem('{{ remember_prefix }}credentials')); 235 | {%- endif %} 236 | if (credentials && !encryptcontent_obfuscate) { 237 | if (credentials['user'] && username_input) { 238 | username_input.value = decodeURIComponent(credentials['user']); 239 | } 240 | if (credentials['password']) { 241 | password_input.value = decodeURIComponent(credentials['password']); 242 | } 243 | return true; 244 | } else { 245 | return false; 246 | } 247 | } 248 | 249 | /*remove username/password from localStorage */ 250 | {% if webcrypto %}async {% endif %}function delCredentials() { 251 | {%- if session_storage %} 252 | sessionStorage.removeItem('{{ remember_prefix }}credentials'); 253 | {%- else %} 254 | localStorage.removeItem('{{ remember_prefix }}credentials'); 255 | {%- endif %} 256 | } 257 | {%- endif %} 258 | 259 | /* Reload scripts src after decryption process */ 260 | {% if webcrypto %}async {% endif %}function reload_js(src) { 261 | let script_src, script_tag, new_script_tag; 262 | let head = document.getElementsByTagName('head')[0]; 263 | 264 | if (src.startsWith('#')) { 265 | script_tag = document.getElementById(src.substr(1)); 266 | if (script_tag) { 267 | script_tag.remove(); 268 | new_script_tag = document.createElement('script'); 269 | if (script_tag.innerHTML) { 270 | new_script_tag.innerHTML = script_tag.innerHTML; 271 | } 272 | if (script_tag.src) { 273 | new_script_tag.src = script_tag.src; 274 | } 275 | if (script_tag.type) { 276 | new_script_tag.type = script_tag.type; 277 | } 278 | head.appendChild(new_script_tag); 279 | } 280 | } else { 281 | if (base_url == '.') { 282 | script_src = src; 283 | } else { 284 | script_src = base_url + '/' + src; 285 | } 286 | 287 | script_tag = document.querySelector('script[src="' + script_src + '"]'); 288 | if (script_tag) { 289 | script_tag.remove(); 290 | new_script_tag = document.createElement('script'); 291 | new_script_tag.src = script_src; 292 | head.appendChild(new_script_tag); 293 | } 294 | } 295 | }; 296 | 297 | {% if experimental -%} 298 | /* Decrypt part of the search index and refresh it for search engine */ 299 | {% if webcrypto %}async {% endif %}function decrypt_search(keys, retry=true) { 300 | let sessionIndex = sessionStorage.getItem('encryptcontent-index'); 301 | let could_decrypt = false; 302 | if (sessionIndex) { 303 | sessionIndex = JSON.parse(sessionIndex); 304 | for (let i = 0; i < sessionIndex.docs.length; i++) { 305 | let doc = sessionIndex.docs[i]; 306 | let location_sep = doc.location.indexOf(';'); 307 | if (location_sep !== -1) { 308 | let location_id = doc.location.substring(0,location_sep); 309 | let location_bundle = doc.location.substring(location_sep+1); 310 | if (location_id in keys) { 311 | let key = keys[location_id]; 312 | let location_decrypted = {% if webcrypto %}await {% endif %}decrypt_content_from_bundle(key, location_bundle); 313 | if (location_decrypted) { 314 | doc.location = location_decrypted; 315 | doc.text = {% if webcrypto %}await {% endif %}decrypt_content_from_bundle(key, doc.text); 316 | doc.title = {% if webcrypto %}await {% endif %}decrypt_content_from_bundle(key, doc.title); 317 | could_decrypt = true; 318 | } 319 | } 320 | } 321 | } 322 | if (could_decrypt) { 323 | //save decrypted index 324 | sessionIndex = JSON.stringify(sessionIndex); 325 | sessionStorage.setItem('encryptcontent-index', sessionIndex); 326 | // force search index reloading on Worker 327 | if (typeof searchWorker !== 'undefined') { 328 | searchWorker.postMessage({init: true, sessionIndex: sessionIndex}); 329 | } else { //not default search plugin: reload whole page 330 | window.location.reload(); 331 | } 332 | } 333 | } else if (retry) { 334 | setTimeout(() => { //retry after one second if 'encryptcontent-index' not available yet 335 | decrypt_search(keys, false); 336 | }, 1000); 337 | } 338 | }; 339 | {%- endif %} 340 | 341 | /* Decrypt speficique html entry from mkdocs configuration */ 342 | {% if webcrypto %}async {% endif %}function decrypt_somethings(key, encrypted_something) { 343 | var html_item = ''; 344 | for (const [name, tag] of Object.entries(encrypted_something)) { 345 | if (tag[1] == 'id') { 346 | html_item = [document.getElementById(name)]; 347 | } else if (tag[1] == 'class') { 348 | html_item = document.getElementsByClassName(name); 349 | } else { 350 | console.log('WARNING: Unknow tag html found, check "encrypted_something" configuration.'); 351 | } 352 | if (html_item[0]) { 353 | for (let i = 0; i < html_item.length; i++) { 354 | // grab the cipher bundle if something exist 355 | if (html_item[i].style.display == "none") { 356 | let content = {% if webcrypto %}await {% endif %}decrypt_content_from_bundle(key, html_item[i].innerHTML); 357 | if (content !== false) { 358 | // success; display the decrypted content 359 | html_item[i].innerHTML = content; 360 | html_item[i].style.display = null; 361 | // any post processing on the decrypted content should be done here 362 | } 363 | } 364 | } 365 | } 366 | } 367 | return html_item[0]; 368 | }; 369 | 370 | /* Decrypt content of a page */ 371 | {% if webcrypto %}async {% endif %}function decrypt_action(username_input, password_input, encrypted_content, decrypted_content, key_from_storage=false) { 372 | let key=false; 373 | let keys_from_keystore=false; 374 | 375 | let user=false; 376 | if (username_input) { 377 | user = username_input.value; 378 | } 379 | 380 | if (key_from_storage !== false) { 381 | key = key_from_storage; 382 | } else { 383 | keys_from_keystore = {% if webcrypto %}await {% endif %}decrypt_key_from_bundle(password_input.value, encryptcontent_keystore, user); 384 | if (keys_from_keystore) { 385 | key = keys_from_keystore[encryptcontent_id]; 386 | } 387 | } 388 | 389 | let content = false; 390 | if (key) { 391 | content = {% if webcrypto %}await {% endif %}decrypt_content_from_bundle(key, encrypted_content.innerHTML); 392 | } 393 | if (content !== false) { 394 | // success; display the decrypted content 395 | decrypted_content.innerHTML = content; 396 | encrypted_content.parentNode.removeChild(encrypted_content); 397 | 398 | if (keys_from_keystore !== false) { 399 | return keys_from_keystore 400 | } else { 401 | return key 402 | } 403 | } else { 404 | return false 405 | } 406 | }; 407 | 408 | {% if webcrypto %}async {% endif %}function decryptor_reaction(key_or_keys, password_input, decrypted_content, fallback_used=false) { 409 | if (key_or_keys) { 410 | let key; 411 | if (typeof key_or_keys === "object") { 412 | key = key_or_keys[encryptcontent_id]; 413 | {% if remember_keys -%} 414 | setKeys(key_or_keys); 415 | {%- endif %} 416 | {% if experimental -%} 417 | decrypt_search(key_or_keys); 418 | {%- endif %} 419 | } else { 420 | key = key_or_keys; 421 | } 422 | 423 | // continue to decrypt others parts 424 | {% if encrypted_something -%} 425 | let encrypted_something = {{ encrypted_something }}; 426 | decrypt_somethings(key, encrypted_something); 427 | {%- endif %} 428 | if (typeof inject_something !== 'undefined') { 429 | decrypted_content = {% if webcrypto %}await {% endif %}decrypt_somethings(key, inject_something); 430 | } 431 | if (typeof delete_something !== 'undefined') { 432 | let el = document.getElementById(delete_something) 433 | if (el) { 434 | el.remove(); 435 | } 436 | } 437 | // any post processing on the decrypted content should be done here 438 | {%- if material %} 439 | document$.next(document); 440 | {%- else %} 441 | {% if arithmatex -%} 442 | if (typeof MathJax === 'object') { MathJax.typesetPromise();}; 443 | {%- endif %} 444 | {% if mermaid2 -%} 445 | if (typeof mermaid === 'object') { mermaid.contentLoaded();}; 446 | {%- endif %} 447 | {% if hljs -%} 448 | decrypted_content.querySelectorAll('pre code').forEach((block) => { 449 | hljs.highlightElement(block); 450 | }); 451 | {%- endif %} 452 | {%- endif %} 453 | {% if reload_scripts | length > 0 -%} 454 | let reload_scripts = {{ reload_scripts }}; 455 | for (let i = 0; i < reload_scripts.length; i++) { 456 | {% if webcrypto %}await {% endif %}reload_js(reload_scripts[i]); 457 | } 458 | {%- endif %} 459 | if (typeof theme_run_after_decryption !== 'undefined') { 460 | theme_run_after_decryption(); 461 | } 462 | if (window.location.hash) { //jump to anchor if hash given after decryption 463 | window.location.href = window.location.hash; 464 | } 465 | } else { 466 | // remove item on sessionStorage if decryption process fail (Invalid item) 467 | if (!fallback_used) { 468 | if (!encryptcontent_obfuscate) { 469 | // create HTML element for the inform message 470 | let mkdocs_decrypt_msg = document.getElementById('mkdocs-decrypt-msg'); 471 | mkdocs_decrypt_msg.textContent = decryption_failure_message; 472 | password_input.value = ''; 473 | password_input.focus(); 474 | } 475 | } 476 | {% if remember_keys -%} 477 | delItemName(encryptcontent_id); 478 | {%- endif %} 479 | } 480 | } 481 | 482 | /* Trigger decryption process */ 483 | {% if webcrypto %}async {% endif %}function init_decryptor() { 484 | let username_input = document.getElementById('mkdocs-content-user'); 485 | let password_input = document.getElementById('mkdocs-content-password'); 486 | // adjust password field width to placeholder length 487 | //if (password_input.hasAttribute('placeholder')) { 488 | // password_input.setAttribute('size', password_input.getAttribute('placeholder').length); 489 | //} 490 | let encrypted_content = document.getElementById('mkdocs-encrypted-content'); 491 | let decrypted_content = document.getElementById('mkdocs-decrypted-content'); 492 | let content_decrypted; 493 | {% if remember_keys -%} 494 | /* If remember_keys is set, try to use sessionStorage item to decrypt content when page is loaded */ 495 | let key_from_storage = {% if webcrypto %}await {% endif %}getItemName(encryptcontent_id); 496 | if (key_from_storage) { 497 | content_decrypted = {% if webcrypto %}await {% endif %}decrypt_action( 498 | username_input, password_input, encrypted_content, decrypted_content, key_from_storage 499 | ); 500 | {% if remember_password -%} 501 | /* try to get username/password from sessionStorage */ 502 | if (content_decrypted === false) { 503 | let got_credentials = {% if webcrypto %}await {% endif %}getCredentials(username_input, password_input); 504 | if (got_credentials) { 505 | content_decrypted = {% if webcrypto %}await {% endif %}decrypt_action( 506 | username_input, password_input, encrypted_content, decrypted_content 507 | ); 508 | } 509 | } 510 | {%- endif %} 511 | decryptor_reaction(content_decrypted, password_input, decrypted_content, true); 512 | } 513 | {% if remember_password -%} 514 | else { 515 | let got_credentials = {% if webcrypto %}await {% endif %}getCredentials(username_input, password_input); 516 | if (got_credentials) { 517 | content_decrypted = {% if webcrypto %}await {% endif %}decrypt_action( 518 | username_input, password_input, encrypted_content, decrypted_content 519 | ); 520 | decryptor_reaction(content_decrypted, password_input, decrypted_content, true); 521 | } 522 | } 523 | {%- endif %} 524 | {%- endif %} 525 | {%- if sharelinks %} 526 | if (window.location.hash) { 527 | let location_hash = window.location.hash.substring(1) 528 | let anchor_hash = location_hash.search('#') 529 | if (anchor_hash != -1) { //check additional anchor 530 | window.location.hash = location_hash.substring(anchor_hash); 531 | location_hash = location_hash.substring(0,anchor_hash); 532 | } 533 | if (!content_decrypted) { 534 | let sharestring; 535 | if (location_hash.startsWith('!')) { 536 | sharestring=decodeURIComponent(location_hash); 537 | } else { 538 | let b64u_check = base64url_decode(location_hash); 539 | if (b64u_check !== false) { 540 | if (b64u_check.startsWith('!') && b64u_check.includes(":")) { 541 | sharestring=b64u_check; 542 | } 543 | } 544 | } 545 | if (sharestring) { 546 | sharestring = sharestring.substring(1); 547 | let pass_sep = sharestring.search(":"); 548 | if (username_input) { 549 | username_input.value = sharestring.substring(0,pass_sep); 550 | } 551 | password_input.value = sharestring.substring(pass_sep+1); 552 | {%- if sharelinks_incomplete %} 553 | if (password_input.value.endsWith(':')) { 554 | if (username_input) { 555 | username_input.style.display = "none"; 556 | } 557 | let password_input_sharelink = password_input.cloneNode() 558 | password_input_sharelink.id = "mkdocs-content-password-sharelink"; 559 | password_input_sharelink.style.display = "none"; 560 | password_input_sharelink.value = password_input.value; 561 | password_input.value = ""; 562 | password_input.insertAdjacentElement('beforebegin', password_input_sharelink); 563 | } else { 564 | content_decrypted = {% if webcrypto %}await {% endif %}decrypt_action( 565 | username_input, password_input, encrypted_content, decrypted_content 566 | ); 567 | decryptor_reaction(content_decrypted, password_input, decrypted_content); 568 | } 569 | {%- else %} 570 | content_decrypted = {% if webcrypto %}await {% endif %}decrypt_action( 571 | username_input, password_input, encrypted_content, decrypted_content 572 | ); 573 | decryptor_reaction(content_decrypted, password_input, decrypted_content); 574 | {%- endif %} 575 | } 576 | } 577 | } 578 | {%- endif %} 579 | {% if password_button -%} 580 | /* If password_button is set, try decrypt content when button is press */ 581 | let decrypt_button = document.getElementById("mkdocs-decrypt-button"); 582 | if (decrypt_button) { 583 | decrypt_button.onclick = {% if webcrypto %}async {% endif %}function(event) { 584 | event.preventDefault(); 585 | {%- if sharelinks_incomplete %} 586 | let password_input_sharelink = document.getElementById('mkdocs-content-password-sharelink'); 587 | if (password_input_sharelink) { 588 | password_input.value = password_input_sharelink.value + password_input.value; 589 | } 590 | {%- endif %} 591 | content_decrypted = {% if webcrypto %}await {% endif %}decrypt_action( 592 | username_input, password_input, encrypted_content, decrypted_content 593 | ); 594 | decryptor_reaction(content_decrypted, password_input, decrypted_content); 595 | }; 596 | } 597 | {%- endif %} 598 | /* Default, try decrypt content when key enter is press */ 599 | password_input.addEventListener('keypress', {% if webcrypto %}async {% endif %}function(event) { 600 | if (event.key === "Enter") { 601 | event.preventDefault(); 602 | {%- if sharelinks_incomplete %} 603 | let password_input_sharelink = document.getElementById('mkdocs-content-password-sharelink'); 604 | if (password_input_sharelink) { 605 | password_input.value = password_input_sharelink.value + password_input.value; 606 | } 607 | {%- endif %} 608 | content_decrypted = {% if webcrypto %}await {% endif %}decrypt_action( 609 | username_input, password_input, encrypted_content, decrypted_content 610 | ); 611 | decryptor_reaction(content_decrypted, password_input, decrypted_content); 612 | } 613 | }); 614 | } 615 | 616 | {%- if material %} 617 | if (typeof base_url === 'undefined') { 618 | var base_url = JSON.parse(document.getElementById('__config').textContent).base; 619 | } 620 | {%- endif %} 621 | if (document.readyState === "loading") { 622 | // Loading hasn't finished yet 623 | document.addEventListener("DOMContentLoaded", init_decryptor); 624 | } else { 625 | // `DOMContentLoaded` has already fired 626 | init_decryptor(); 627 | } 628 | window["init_decryptor"] = init_decryptor; -------------------------------------------------------------------------------- /encryptcontent/decrypt-form.tpl.html: -------------------------------------------------------------------------------- 1 | 2 |

3 |

18 | 19 | 28 | {%- if esm %} 29 | 43 | {%- else %} 44 | {%- for library in js_libraries %} 45 | 46 | {%- endfor %} 47 | 48 | {%- endif %} 49 | -------------------------------------------------------------------------------- /patches/material_browser_request9.patch: -------------------------------------------------------------------------------- 1 | --- src/assets/javascripts/browser/request/index.ts Mon Sep 11 18:23:52 2023 2 | +++ src/assets/javascripts/browser/request/index-encryptcontent.ts Mon Sep 18 20:57:06 2023 3 | @@ -26,6 +26,7 @@ 4 | catchError, 5 | from, 6 | map, 7 | + tap, 8 | of, 9 | shareReplay, 10 | switchMap, 11 | @@ -75,11 +76,38 @@ 12 | export function requestJSON( 13 | url: URL | string, options?: RequestInit 14 | ): Observable { 15 | - return request(url, options) 16 | - .pipe( 17 | - switchMap(res => res.json()), 18 | - shareReplay(1) 19 | - ) 20 | + /* Hack to enable search Index decryption */ 21 | + if (url.href.endsWith('/search_index.json')) { 22 | + const encryptcontentIndexKey = 'encryptcontent-index'; 23 | + const encryptcontentIndex = sessionStorage.getItem(encryptcontentIndexKey); 24 | + 25 | + if (encryptcontentIndex) { 26 | + // if already available in sessionStorage return Observable JSON data 27 | + try { 28 | + const parsedData = JSON.parse(encryptcontentIndex) as T; 29 | + return of(parsedData); 30 | + } catch (error) { 31 | + console.error('Error parsing encryptcontent-index:', error); 32 | + return throwError(error); 33 | + } 34 | + } else { 35 | + // if not yet available in sessionStorage request JSON data 36 | + return request(url, options).pipe( 37 | + switchMap((res) => res.json()), 38 | + tap((jsonData) => { 39 | + // and save them to sessionstorage 40 | + sessionStorage.setItem(encryptcontentIndexKey, JSON.stringify(jsonData)); 41 | + }), 42 | + shareReplay(1) 43 | + ); 44 | + } 45 | + } else { 46 | + return request(url, options) 47 | + .pipe( 48 | + switchMap(res => res.json()), 49 | + shareReplay(1) 50 | + ) 51 | + } 52 | } 53 | 54 | /** 55 | -------------------------------------------------------------------------------- /patches/material_browser_request9_4p.patch: -------------------------------------------------------------------------------- 1 | --- src/templates/assets/javascripts/browser/request/index.ts 2 | +++ src/templates/assets/javascripts/browser/request/index.ts 3 | @@ -24,6 +24,9 @@ import { 4 | Observable, 5 | Subject, 6 | map, 7 | + tap, 8 | + of, 9 | + throwError, 10 | shareReplay, 11 | switchMap 12 | } from "rxjs" 13 | @@ -117,12 +120,40 @@ export function request( 14 | export function requestJSON( 15 | url: URL | string, options?: Options 16 | ): Observable { 17 | - return request(url, options) 18 | - .pipe( 19 | - switchMap(res => res.text()), 20 | - map(body => JSON.parse(body) as T), 21 | - shareReplay(1) 22 | - ) 23 | + /* Hack to enable search Index decryption */ 24 | + if (url.href.endsWith('/search_index.json')) { 25 | + const encryptcontentIndexKey = 'encryptcontent-index'; 26 | + const encryptcontentIndex = sessionStorage.getItem(encryptcontentIndexKey); 27 | + 28 | + if (encryptcontentIndex) { 29 | + // if already available in sessionStorage return Observable JSON data 30 | + try { 31 | + const parsedData = JSON.parse(encryptcontentIndex) as T; 32 | + return of(parsedData); 33 | + } catch (error) { 34 | + console.error('Error parsing encryptcontent-index:', error); 35 | + return throwError(error); 36 | + } 37 | + } else { 38 | + // if not yet available in sessionStorage request JSON data 39 | + return request(url, options).pipe( 40 | + switchMap(res => res.text()), 41 | + map(body => JSON.parse(body) as T), 42 | + tap((jsonData) => { 43 | + // and save them to sessionstorage 44 | + sessionStorage.setItem(encryptcontentIndexKey, JSON.stringify(jsonData)); 45 | + }), 46 | + shareReplay(1) 47 | + ); 48 | + } 49 | + } else { 50 | + return request(url, options) 51 | + .pipe( 52 | + switchMap(res => res.text()), 53 | + map(body => JSON.parse(body) as T), 54 | + shareReplay(1) 55 | + ) 56 | + } 57 | } 58 | 59 | /** 60 | -------------------------------------------------------------------------------- /patches/material_search_worker8.patch: -------------------------------------------------------------------------------- 1 | --- src/assets/javascripts/integrations/search/worker/_/index.ts 2022-11-11 18:49:20.000000000 +0100 2 | +++ "src/assets/javascripts/integrations/search/worker/_/index - encryptcontent.ts" 2022-11-13 20:24:57.313110700 +0100 3 | @@ -86,6 +86,19 @@ 4 | suggestions: feature("search.suggest") 5 | } 6 | 7 | + /* Hack to enable search Index decryption */ 8 | + let sessionIndex = sessionStorage.getItem('encryptcontent-index') 9 | + let saveIndex = {} 10 | + if (!sessionIndex) { 11 | + saveIndex['config'] = config 12 | + saveIndex['docs'] = docs 13 | + sessionStorage.setItem('encryptcontent-index', JSON.stringify(saveIndex)) 14 | + } else { 15 | + saveIndex = JSON.parse(sessionIndex) 16 | + config = saveIndex['config'] 17 | + docs = saveIndex['docs'] 18 | + } 19 | + 20 | /* Return search index after defaulting */ 21 | return { config, docs, options } 22 | } 23 | -------------------------------------------------------------------------------- /setup.py: -------------------------------------------------------------------------------- 1 | import os 2 | from setuptools import setup, find_packages 3 | 4 | 5 | def read(fname): 6 | file_path = os.path.join(os.path.dirname(__file__), fname) 7 | with open(file_path) as file: 8 | content = file.read() 9 | return content if content else 'no content read' 10 | 11 | 12 | setup( 13 | name='mkdocs-encryptcontent-plugin', 14 | version='3.0.4', 15 | author='unverbuggt', 16 | author_email='unverbuggt@xn--rthlein-n2a.de', 17 | description='A MkDocs plugin that encrypt/decrypt markdown content with AES', 18 | long_description=read('README.md'), 19 | long_description_content_type='text/markdown', 20 | keywords='mkdocs python markdown encrypt decrypt content', 21 | url='https://unverbuggt.github.io/mkdocs-encryptcontent-plugin/', 22 | license='MIT', 23 | python_requires='>=3.5', 24 | install_requires=[ 25 | 'mkdocs', 26 | 'pyyaml', 27 | 'pycryptodome', 28 | 'beautifulsoup4', 29 | ], 30 | classifiers=[ 31 | 'Development Status :: 5 - Production/Stable', 32 | 'Intended Audience :: Developers', 33 | 'Intended Audience :: Information Technology', 34 | 'License :: OSI Approved :: MIT License', 35 | 'Programming Language :: Python', 36 | 'Programming Language :: Python :: 3.5', 37 | 'Programming Language :: Python :: 3.6', 38 | 'Programming Language :: Python :: 3.7', 39 | 'Programming Language :: Python :: 3.8', 40 | 'Programming Language :: Python :: 3.9', 41 | 'Programming Language :: Python :: 3.10' 42 | ], 43 | packages=find_packages(exclude=['*.tests']), 44 | entry_points={ 45 | 'mkdocs.plugins': [ 46 | 'encryptcontent = encryptcontent.plugin:encryptContentPlugin' 47 | ] 48 | }, 49 | package_data={'encryptcontent': [ 50 | '*.tpl.js', 51 | '*.tpl.html', 52 | '*.tpl.py', 53 | 'contrib/templates/search/*.js' 54 | ]}, 55 | include_package_data=True 56 | ) 57 | --------------------------------------------------------------------------------

{{ summary }}

{{ extra.my_extra }}