├── .gitignore
├── LICENSE
├── Makefile
├── README.md
├── docs
    ├── index.md
    └── mkdocs.md
├── mkdocs.yml
├── requirements.txt
└── theme_addons
    ├── base.html
    ├── basic_auth.inc
    ├── basic_auth.php
    └── do_php_thing.sh


/.gitignore:
--------------------------------------------------------------------------------
1 | site/*
2 | .pyenv/*
3 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
 1 | BSD 3-Clause License
 2 | 
 3 | Copyright (c) 2020, Osvaldo
 4 | All rights reserved.
 5 | 
 6 | Redistribution and use in source and binary forms, with or without
 7 | modification, are permitted provided that the following conditions are met:
 8 | 
 9 | 1. Redistributions of source code must retain the above copyright notice, this
10 |    list of conditions and the following disclaimer.
11 | 
12 | 2. Redistributions in binary form must reproduce the above copyright notice,
13 |    this list of conditions and the following disclaimer in the documentation
14 |    and/or other materials provided with the distribution.
15 | 
16 | 3. Neither the name of the copyright holder nor the names of its
17 |    contributors may be used to endorse or promote products derived from
18 |    this software without specific prior written permission.
19 | 
20 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 | AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
23 | DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
24 | FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
25 | DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
26 | SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
27 | CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
28 | OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29 | OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30 | 


--------------------------------------------------------------------------------
/Makefile:
--------------------------------------------------------------------------------
 1 | .PHONY: build
 2 | 
 3 | all: help
 4 | 
 5 | full: clean build serve
 6 | 
 7 | clean: ## rm site/
 8 | 	rm -fr site/
 9 | 	mkdir site
10 | 
11 | build: ## build files
12 | 	mkdocs build --clean
13 | 	theme_addons/do_php_thing.sh
14 | 
15 | serve: ## publish site on :8080
16 | 	#mkdocs serve 
17 | 	cd site && php -S 0:8080
18 | 
19 | gpush: ## git push HEAD to origin
20 | 	@git push -u origin HEAD
21 | gpushf: ##git force push HEAD to origin
22 | 	@git push -u origin HEAD -f
23 | gupdate: ## update local branch from master
24 | 	@git fetch origin master; git rebase origin/master
25 | gam: ## add new changes to previous commit
26 | 	@git commit -a --amend
27 | 
28 | .PHONY: help
29 | help:
30 | 	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
31 | 
32 | 
33 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # mkdocs basic authentication
 2 | 
 3 | An static site generador like [mkdocs](http://www.mkdocs.org/) is great for writing documentation.  Sometimes the information is not secret but we don't want it available to general public. Here's a workaround for such scenarios.
 4 | 
 5 | This solution adds basic authentication the pages generated by mkdocs. It renames static html files as php files and adds php code which provides the basic authentication functionality.
 6 | 
 7 | # tl;dr
 8 | 
 9 | * setup credentials in the `mkdocs.yml` file.
10 | * add php code to `base.html` template file (if other than the readthedocs theme).
11 | * write some docs.
12 | * run `make full` and check the results.
13 | 
14 | # configuration
15 | 
16 | Mkdocs allows for customizing the current theme by using the `custom_dir` variable in the `mkdocs.yml` configuration file. 
17 | 
18 | > The `theme.custom_dir` configuration value is used in combination with an existing theme, the `theme.custom_dir` can be used to replace only specific parts of a built-in theme. 
19 | 
20 | From the [docs](https://www.mkdocs.org/user-guide/custom-themes/).
21 | 
22 | ```
23 | theme: 
24 |   name: readthedocs
25 |   custom_dir: 'theme_addons/'
26 | ```
27 | 
28 | The user/password credentials are also defined in the `mkdocs.yml` file.
29 | 
30 | ```
31 | extra:
32 |   username: "admin"
33 |   password: "secret"
34 | ```
35 | 
36 | # usage
37 | 
38 | ```
39 | git clone git@github.com:otsuarez/mkdocs_auth.git
40 | cd mkdocs_auth
41 | pip install -r requirements.txt
42 | make full
43 | ```
44 | 
45 | ## using virtualenv
46 | 
47 | ```
48 | # install virtualenv
49 | git clone git@github.com:otsuarez/mkdocs_auth.git
50 | cd mkdocs_auth
51 | virtualenv --python=/usr/bin/python2.7 .pyenv
52 | source .pyenv/bin/activate
53 | pip install -r requirements.txt
54 | make full
55 | ```
56 | 
57 | Open in your browser [http://localhost:8080/](http://localhost:8080/).
58 | 
59 | ## using a container
60 | 
61 | ```
62 | docker run -p 8080:8080 --rm -it ubuntu:bionic bin/bash
63 | apt update -y
64 | apt install -y git  build-essential python-pip php
65 | cd root
66 | git clone https://github.com/otsuarez/mkdocs_auth.git
67 | cd mkdocs_auth
68 | pip install -r requirements.txt
69 | make full
70 | ```
71 | 
72 | # other themes
73 | 
74 | The `readthedocs` theme is being used, for another theme, make sure to have the right `base.html` template file with the php code added.
75 | 
76 | ```
77 | cp $(theme="$(egrep "^theme" mkdocs.yml| cut -f2 -d:)" ; locate base.html | grep $theme) theme_addons/
78 | ```
79 | 
80 | If using a virtualenv:
81 | 
82 | ```
83 | cp $(theme="$(egrep "^theme" mkdocs.yml| cut -f2 -d:)" ; find .pyenv -name  base.html  | grep $theme) theme_addons/
84 | ```
85 | 
86 | Then add the php code to the `base.html` file.
87 | 
88 | ```
89 | tmp="$(mktemp)" && cat theme_addons/basic_auth.inc theme_addons/base.html >"$tmp" && mv "$tmp" theme_addons/base.html 
90 | ```
91 | 
92 | Check the `Makefile` file for reference on the actual commands and scripts being executed.
93 | 
94 | 
95 | 


--------------------------------------------------------------------------------
/docs/index.md:
--------------------------------------------------------------------------------
1 | # demo
2 | 
3 | empty home page
4 | 


--------------------------------------------------------------------------------
/docs/mkdocs.md:
--------------------------------------------------------------------------------
 1 | # Welcome to MkDocs
 2 | 
 3 | For full documentation visit [mkdocs.org](http://mkdocs.org).
 4 | 
 5 | ## Commands
 6 | 
 7 | * `mkdocs new [dir-name]` - Create a new project.
 8 | * `mkdocs serve` - Start the live-reloading docs server.
 9 | * `mkdocs build` - Build the documentation site.
10 | * `mkdocs help` - Print this help message.
11 | 
12 | ## Project layout
13 | 
14 |     mkdocs.yml    # The configuration file.
15 |     docs/
16 |         index.md  # The documentation homepage.
17 |         ...       # Other markdown pages, images and other files.
18 | 


--------------------------------------------------------------------------------
/mkdocs.yml:
--------------------------------------------------------------------------------
 1 | # Project information
 2 | site_name: Mkdocs_Auth
 3 | site_description: mkdocs basic authentication example
 4 | site_author: ACME
 5 | 
 6 | # Documentation and theme
 7 | theme: 
 8 |   name: readthedocs
 9 |   custom_dir: 'theme_addons/'
10 | 
11 | # Page tree
12 | pages:
13 |   - Home: index.md
14 |   - Mkdocs: mkdocs.md
15 | 
16 | extra:
17 |   username: "admin"
18 |   password: "secret"
19 | 
20 | 


--------------------------------------------------------------------------------
/requirements.txt:
--------------------------------------------------------------------------------
 1 | backports-abc==0.5
 2 | click==6.7
 3 | futures==3.2.0
 4 | Jinja2>=2.10.1
 5 | livereload==2.5.2
 6 | Markdown==2.6.11
 7 | MarkupSafe==1.0
 8 | mkdocs==1.0
 9 | PyYAML==4.2b1
10 | singledispatch==3.4.0.3
11 | six==1.11.0
12 | tornado==5.1
13 | 


--------------------------------------------------------------------------------
/theme_addons/base.html:
--------------------------------------------------------------------------------
  1 | <?php
  2 | $users = array('{{ config.extra.username }}' => '{{ config.extra.password }}');
  3 | require_once('{{ base_url }}/basic_auth.php');
  4 | ?>
  5 | <!DOCTYPE html>
  6 | <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
  7 | <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
  8 | <head>
  9 |   {%- block site_meta %}
 10 |   <meta charset="utf-8">
 11 |   <meta http-equiv="X-UA-Compatible" content="IE=edge">
 12 |   <meta name="viewport" content="width=device-width, initial-scale=1.0">
 13 |   {% if page and page.is_homepage %}<meta name="description" content="{{ config.site_description }}">{% endif %}
 14 |   {% if config.site_author %}<meta name="author" content="{{ config.site_author }}">{% endif %}
 15 |   {% if config.site_favicon %}<link rel="shortcut icon" href="{{ config.site_favicon|url }}">
 16 |   {% else %}<link rel="shortcut icon" href="{{ 'img/favicon.ico'|url }}">{% endif %}
 17 |   {%- endblock %}
 18 | 
 19 |   {%- block htmltitle %}
 20 |   <title>{% if page and page.title and not page.is_hompage %}{{ page.title }} - {% endif %}{{ config.site_name }}</title>
 21 |   {%- endblock %}
 22 | 
 23 |   {%- block styles %}
 24 |   <link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
 25 | 
 26 |   <link rel="stylesheet" href="{{ 'css/theme.css'|url }}" type="text/css" />
 27 |   <link rel="stylesheet" href="{{ 'css/theme_extra.css'|url }}" type="text/css" />
 28 |   {%- if config.theme.highlightjs %}
 29 |   <link rel="stylesheet" href="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/styles/github.min.css">
 30 |   {%- endif %}
 31 |   {%- for path in config['extra_css'] %}
 32 |   <link href="{{ path|url }}" rel="stylesheet">
 33 |   {%- endfor %}
 34 |   {%- endblock %}
 35 | 
 36 |   {%- block libs %}
 37 |   {% if page %}
 38 |   <script>
 39 |     // Current page data
 40 |     var mkdocs_page_name = {{ page.title|tojson|safe }};
 41 |     var mkdocs_page_input_path = {{ page.file.src_path|string|tojson|safe }};
 42 |     var mkdocs_page_url = {{ page.abs_url|tojson|safe }};
 43 |   </script>
 44 |   {% endif %}
 45 |   <script src="{{ 'js/jquery-2.1.1.min.js'|url }}" defer></script>
 46 |   <script src="{{ 'js/modernizr-2.8.3.min.js'|url }}" defer></script>
 47 |   {%- if config.theme.highlightjs %}
 48 |   <script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/highlight.min.js"></script>
 49 |   {%- for lang in config.theme.hljs_languages %}
 50 |   <script src="//cdnjs.cloudflare.com/ajax/libs/highlight.js/9.12.0/languages/{{lang}}.min.js"></script>
 51 |   {%- endfor %}
 52 |   <script>hljs.initHighlightingOnLoad();</script>
 53 |   {%- endif %}
 54 |   {%- endblock %}
 55 | 
 56 |   {%- block extrahead %} {% endblock %}
 57 | 
 58 |   {%- block analytics %}
 59 |   {% if config.google_analytics %}
 60 |   <script>
 61 |       (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
 62 |       (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
 63 |       m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
 64 |       })(window,document,'script','https://www.google-analytics.com/analytics.js','ga');
 65 | 
 66 |       ga('create', '{{ config.google_analytics[0] }}', '{{ config.google_analytics[1] }}');
 67 |       ga('send', 'pageview');
 68 |   </script>
 69 |   {% endif %}
 70 |   {%- endblock %}
 71 | </head>
 72 | 
 73 | <body class="wy-body-for-nav" role="document">
 74 | 
 75 |   <div class="wy-grid-for-nav">
 76 | 
 77 |     {# SIDE NAV, TOGGLES ON MOBILE #}
 78 |     <nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
 79 |       <div class="wy-side-nav-search">
 80 |     {%- block site_name %}
 81 |         <a href="{{ nav.homepage.url|url }}" class="icon icon-home"> {{ config.site_name }}</a>
 82 | 	  {%- endblock %}
 83 | 	  {%- block search_button %}
 84 |         {% if 'search' in config['plugins'] %}{% include "searchbox.html" %}{% endif %}
 85 | 	  {%- endblock %}
 86 |       </div>
 87 | 
 88 |       <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
 89 |         {%- block site_nav %}
 90 | 	<ul class="current">
 91 | 	  {% set navlevel = 1 %}
 92 |           {% for nav_item in nav %}
 93 |             <li class="toctree-l{{ navlevel }}{% if nav_item.active and not nav_item.children %} current{%endif%}">
 94 | 		{% include 'nav.html' %}
 95 | 	    </li>
 96 |           {% endfor %}
 97 |         </ul>
 98 |     {%- endblock %}
 99 |       </div>
100 |       &nbsp;
101 |     </nav>
102 | 
103 |     <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
104 | 
105 |       {# MOBILE NAV, TRIGGLES SIDE NAV ON TOGGLE #}
106 |       <nav class="wy-nav-top" role="navigation" aria-label="top navigation">
107 |         <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
108 |         <a href="{{ nav.homepage.url|url }}">{{ config.site_name }}</a>
109 |       </nav>
110 | 
111 |       {# PAGE CONTENT #}
112 |       <div class="wy-nav-content">
113 |         <div class="rst-content">
114 |           {% include "breadcrumbs.html" %}
115 |           <div role="main">
116 |             <div class="section">
117 |               {% block content %}
118 |                 {{ page.content }}
119 |               {% endblock %}
120 |             </div>
121 |           </div>
122 |       {%- block footer %}
123 |           {% include "footer.html" %}
124 |       {% endblock %}
125 |         </div>
126 |       </div>
127 | 
128 |     </section>
129 | 
130 |   </div>
131 | 
132 |   {% include "versions.html" %}
133 | 
134 |   {%- block scripts %}
135 |     <script>var base_url = '{{ base_url }}';</script>
136 |     <script src="{{ 'js/theme.js'|url }}" defer></script>
137 |     {%- for path in config['extra_javascript'] %}
138 |       <script src="{{ path|url }}" defer></script>
139 |     {%- endfor %}
140 |   {%- endblock %}
141 | 
142 | </body>
143 | </html>
144 | {% if page and page.is_homepage %}
145 | <!--
146 | MkDocs version : {{ mkdocs_version }}
147 | Build Date UTC : {{ build_date_utc }}
148 | -->
149 | {% endif %}
150 | 


--------------------------------------------------------------------------------
/theme_addons/basic_auth.inc:
--------------------------------------------------------------------------------
1 | <?php
2 | $users = array('{{ config.extra.username }}' => '{{ config.extra.password }}');
3 | require_once('{{ base_url }}/basic_auth.php');
4 | ?>
5 | 


--------------------------------------------------------------------------------
/theme_addons/basic_auth.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /*
 3 |  * http://php.net/manual/es/features.http-auth.php
 4 |  */
 5 | 
 6 | $dominio = 'Authorization required';
 7 | 
 8 | if (empty($_SERVER['PHP_AUTH_DIGEST'])) {
 9 |     header('HTTP/1.1 401 Unauthorized');
10 |     header('WWW-Authenticate: Digest realm="'.$dominio.
11 |            '",qop="auth",nonce="'.uniqid().'",opaque="'.md5($dominio).'"');
12 |     die('You click on the Cancel button.');
13 | }
14 | 
15 | 
16 | // Analizar la variable PHP_AUTH_DIGEST
17 | if (!($datos = analizar_http_digest($_SERVER['PHP_AUTH_DIGEST'])) ||
18 |     !isset($users[$datos['username']]))
19 |     die('Incorrect credentials');
20 | 
21 | 
22 | // Generate a valid reply
23 | $A1 = md5($datos['username'] . ':' . $dominio . ':' . $users[$datos['username']]);
24 | $A2 = md5($_SERVER['REQUEST_METHOD'].':'.$datos['uri']);
25 | $valid_reply = md5($A1.':'.$datos['nonce'].':'.$datos['nc'].':'.$datos['cnonce'].':'.$datos['qop'].':'.$A2);
26 | 
27 | if ($datos['response'] != $valid_reply)
28 | {
29 |     //die('Credenciales incorrectas');
30 |     header('HTTP/1.1 401 Unauthorized');
31 |     header('WWW-Authenticate: Digest realm="'.$dominio.
32 |            '",qop="auth",nonce="'.uniqid().'",opaque="'.md5($dominio).'"');
33 | 		die('You click on the Cancel button');
34 | }
35 | function analizar_http_digest($txt)
36 | {
37 |     // Avod missing data
38 |     $partes_necesarias = array('nonce'=>1, 'nc'=>1, 'cnonce'=>1, 'qop'=>1, 'username'=>1, 'uri'=>1, 'response'=>1);
39 |     $datos = array();
40 |     $claves = implode('|', array_keys($partes_necesarias));
41 | 
42 |     preg_match_all('@(' . $claves . ')=(?:([\'"])([^\2]+?)\2|([^\s,]+))@', $txt, $coincidencias, PREG_SET_ORDER);
43 | 
44 |     foreach ($coincidencias as $c) {
45 |         $datos[$c[1]] = $c[3] ? $c[3] : $c[4];
46 |         unset($partes_necesarias[$c[1]]);
47 |     }
48 |     return $partes_necesarias ? false : $datos;
49 | }
50 | 


--------------------------------------------------------------------------------
/theme_addons/do_php_thing.sh:
--------------------------------------------------------------------------------
 1 | #!/bin/bash 
 2 | 
 3 | 
 4 | # Mac OS X `sed` differs from GNU sed.
 5 | [[ $(uname) = "Darwin" ]] && sedreplace='sed -i.old ' || sedreplace='sed -i '
 6 | 
 7 | 
 8 | # store in a variable all `.html` files
 9 | files=$(find site -name \*html -print0 | xargs -0 -n1  basename | sort -u)
10 | 
11 | # update all links to .html files to .php files.
12 | for i in $files ; do  find site -name \*html -exec ${sedreplace} "s/$i\.html/$i\.php/g" {} \; ; done
13 | 
14 | # rename all .html files to .php files.
15 | find site -name \*.html -exec sh -c 'x={}; mv "$x"  "$(dirname $x)/$(basename $x html)php"'  \;
16 | 
17 | # just in case we are using mac os x
18 | find site -name \*.old -delete
19 | 
20 | # insert php code for basic auth if required
21 | if ! fgrep -q '<?php' theme_addons/base.html;
22 | then
23 |   tmp="$(mktemp)" && cat theme_addons/basic_auth.inc theme_addons/base.html >"$tmp" && mv "$tmp" theme_addons/base.html 
24 | fi
25 | 


--------------------------------------------------------------------------------