Generate HTML documentation using MkDocs (WIP)

MkDocs is a static site generator geared towards building project documentation.
Documentation source files are written in Markdown, and configured with a single YAML file.

 * http://www.mkdocs.org/
 * http://www.mkdocs.org/user-guide/configuration/

Ref. #312

* remove pandoc-generated HTML documentation
* move markdown doc to doc/md/,
* mkdocs.yml:
  * generate HTML doc in doc/html
  * add pages TOC/ordering
  * use index.md as index page
* Makefile: remove execute permissions from generated files
* Makefile: rewrite htmlpages GFM to markdown conversion using sed:
   awk expression aslo matched '][' which causes invalid output on complex links with images or code blocks
* Add mkdocs.yml to .gitattributes, exclude this file from release archives
* Makefile: rename: htmldoc -> doc_html target
* run make doc: pull latest markdown documentation from wiki
* run make htmlpages: update html documentation

1 files changed, 27 insertions, 0 deletions

diff --git a/doc/md/Security.md b/doc/md/Security.md
new file mode 100644
index 00000000..aec37fa0
--- /dev/null
+++ b/doc/md/Security.md
@@ -0,0 +1,27 @@
+## Client browser
+* Shaarli relies on `HTTP_REFERER` for some functions (like redirects and clicking on tags). If you have disabled or masqueraded `HTTP_REFERER` in your browser, some features of Shaarli may not work
+
+## PHP
+* `magic_quotes` is an horrible option of PHP which is often activated on servers. No serious developer should rely on this horror to secure their code against SQL injections. You should disable it (and Shaarli expects this option to be disabled). Nevertheless, I have added code to cope with `magic_quotes` on, so you should not be bothered even on crappy hosts.
+
+## Server and sessions
+* Directories are protected using `.htaccess` files
+* Forms are protected against XSRF (Cross-site requests forgery):
+ * Forms which act on data (save,delete…) contain a token generated by the server.
+ * Any posted form which does not contain a valid token is rejected.
+ * Any token can only be used once.
+ * Tokens are attached to the session and cannot be reused in another session.
+* Sessions automatically expire after 60 minutes.
+* Sessions are protected against hijacking: the session ID cannot be used from a different IP address.
+
+## Shaarli datastore and configuration
+* The password is salted, hashed and stored in the data subdirectory, in a PHP file, and protected by htaccess. Even if the webserver does not support htaccess, the hash is not readable by URL. Even if the .php file is stolen, the password cannot deduced from the hash. The salt prevents rainbow-tables attacks.
+* Links are stored as an associative array which is serialized, compressed (with deflate), base64-encoded and saved as a comment in a `.php` file.
+* Even if the server does not support `.htaccess` files, the data file will still not be readable by URL.
+* The database looks like this:
+```php
+<?php /* zP1ZjxxJtiYIvvevEPJ2lDOaLrZv7o...
+...ka7gaco/Z+TFXM2i7BlfMf8qxpaSSYfKlvqv/x8= */ ?>
+```
+
+* Small hashes are used to make a link to an entry in Shaarli. They are unique. In fact, the date of the items (eg. `20110923_150523`) is hashed with CRC32, then converted to base64 and some characters are replaced. They are always 6 characters longs and use only `A-Z a-z 0-9 - _` and `@`.