374 lines
13 KiB
HTML
374 lines
13 KiB
HTML
<!DOCTYPE html>
|
|
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
|
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
|
|
<link rel="shortcut icon" href="../img/favicon.ico">
|
|
<title>Security - Shaarli Documentation</title>
|
|
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
|
|
|
|
<link rel="stylesheet" href="../css/theme.css" type="text/css" />
|
|
<link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
|
|
<link rel="stylesheet" href="../css/highlight.css">
|
|
<link href="../github-markdown.css" rel="stylesheet">
|
|
|
|
<script>
|
|
// Current page data
|
|
var mkdocs_page_name = "Security";
|
|
var mkdocs_page_input_path = "Security.md";
|
|
var mkdocs_page_url = "/Security/";
|
|
</script>
|
|
|
|
<script src="../js/jquery-2.1.1.min.js"></script>
|
|
<script src="../js/modernizr-2.8.3.min.js"></script>
|
|
<script type="text/javascript" src="../js/highlight.pack.js"></script>
|
|
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav" role="document">
|
|
|
|
<div class="wy-grid-for-nav">
|
|
|
|
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
|
<div class="wy-side-nav-search">
|
|
<a href=".." class="icon icon-home"> Shaarli Documentation</a>
|
|
<div role="search">
|
|
<form id ="rtd-search-form" class="wy-form" action="../search.html" method="get">
|
|
<input type="text" name="q" placeholder="Search docs" />
|
|
</form>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|
<ul class="current">
|
|
|
|
|
|
<li class="toctree-l1">
|
|
|
|
<a class="" href="..">Home</a>
|
|
</li>
|
|
|
|
<li class="toctree-l1">
|
|
|
|
<span class="caption-text">Setup</span>
|
|
<ul class="subnav">
|
|
<li class="">
|
|
|
|
<a class="" href="../Download-and-Installation/">Download and Installation</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Upgrade-and-migration/">Upgrade and migration</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Server-requirements/">Server requirements</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Server-configuration/">Server configuration</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Server-security/">Server security</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Shaarli-configuration/">Shaarli configuration</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Plugins/">Plugins</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="toctree-l1">
|
|
|
|
<span class="caption-text">Docker</span>
|
|
<ul class="subnav">
|
|
<li class="">
|
|
|
|
<a class="" href="../Docker-101/">Docker 101</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Shaarli-images/">Shaarli images</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Reverse-proxy-configuration/">Reverse proxy configuration</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Docker-resources/">Docker resources</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="toctree-l1">
|
|
|
|
<span class="caption-text">Usage</span>
|
|
<ul class="subnav">
|
|
<li class="">
|
|
|
|
<a class="" href="../Features/">Features</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Bookmarklet/">Bookmarklet</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Browsing-and-searching/">Browsing and searching</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Firefox-share/">Firefox share</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../RSS-feeds/">RSS feeds</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../REST-API/">REST API</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="toctree-l1">
|
|
|
|
<span class="caption-text">How To</span>
|
|
<ul class="subnav">
|
|
<li class="">
|
|
|
|
<a class="" href="../Backup,-restore,-import-and-export/">Backup, restore, import and export</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Various-hacks/">Various hacks</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="toctree-l1">
|
|
|
|
<a class="" href="../Troubleshooting/">Troubleshooting</a>
|
|
</li>
|
|
|
|
<li class="toctree-l1">
|
|
|
|
<span class="caption-text">Development</span>
|
|
<ul class="subnav">
|
|
<li class="">
|
|
|
|
<a class="" href="../Development-guidelines/">Development guidelines</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Continuous-integration-tools/">Continuous integration tools</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../GnuPG-signature/">GnuPG signature</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Coding-guidelines/">Coding guidelines</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Directory-structure/">Directory structure</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../3rd-party-libraries/">3rd party libraries</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Plugin-System/">Plugin System</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Release-Shaarli/">Release Shaarli</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Versioning-and-Branches/">Versioning and Branches</a>
|
|
</li>
|
|
<li class=" current">
|
|
|
|
<a class="current" href="./">Security</a>
|
|
<ul class="subnav">
|
|
|
|
<li class="toctree-l3"><a href="#client-browser">Client browser</a></li>
|
|
|
|
|
|
<li class="toctree-l3"><a href="#php">PHP</a></li>
|
|
|
|
|
|
<li class="toctree-l3"><a href="#server-and-sessions">Server and sessions</a></li>
|
|
|
|
|
|
<li class="toctree-l3"><a href="#shaarli-datastore-and-configuration">Shaarli datastore and configuration</a></li>
|
|
|
|
|
|
</ul>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Static-analysis/">Static analysis</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Theming/">Theming</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Unit-tests/">Unit tests</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
|
|
<li class="toctree-l1">
|
|
|
|
<span class="caption-text">About</span>
|
|
<ul class="subnav">
|
|
<li class="">
|
|
|
|
<a class="" href="../FAQ/">FAQ</a>
|
|
</li>
|
|
<li class="">
|
|
|
|
<a class="" href="../Community-&-Related-software/">Community & Related software</a>
|
|
</li>
|
|
</ul>
|
|
</li>
|
|
|
|
</ul>
|
|
</div>
|
|
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
|
|
|
|
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
|
|
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
|
|
<a href="..">Shaarli Documentation</a>
|
|
</nav>
|
|
|
|
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content">
|
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href="..">Docs</a> »</li>
|
|
|
|
|
|
|
|
<li>Development »</li>
|
|
|
|
|
|
|
|
<li>Security</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
<a href="https://github.com/shaarli/Shaarli/edit/master/docs/Security.md"
|
|
class="icon icon-github"> Edit on GitHub</a>
|
|
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main">
|
|
<div class="section">
|
|
|
|
<h2 id="client-browser">Client browser</h2>
|
|
<ul>
|
|
<li>Shaarli relies on <code>HTTP_REFERER</code> for some functions (like redirects and clicking on tags). If you have disabled or masqueraded <code>HTTP_REFERER</code> in your browser, some features of Shaarli may not work</li>
|
|
</ul>
|
|
<h2 id="php">PHP</h2>
|
|
<ul>
|
|
<li><code>magic_quotes</code> 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 <code>magic_quotes</code> on, so you should not be bothered even on crappy hosts.</li>
|
|
</ul>
|
|
<h2 id="server-and-sessions">Server and sessions</h2>
|
|
<ul>
|
|
<li>Directories are protected using <code>.htaccess</code> files</li>
|
|
<li>Forms are protected against XSRF (Cross-site requests forgery):</li>
|
|
<li>Forms which act on data (save,delete…) contain a token generated by the server.</li>
|
|
<li>Any posted form which does not contain a valid token is rejected.</li>
|
|
<li>Any token can only be used once.</li>
|
|
<li>Tokens are attached to the session and cannot be reused in another session.</li>
|
|
<li>Sessions automatically expire after 60 minutes.</li>
|
|
<li>Sessions are protected against hijacking: the session ID cannot be used from a different IP address.</li>
|
|
</ul>
|
|
<h2 id="shaarli-datastore-and-configuration">Shaarli datastore and configuration</h2>
|
|
<ul>
|
|
<li>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.</li>
|
|
<li>Links are stored as an associative array which is serialized, compressed (with deflate), base64-encoded and saved as a comment in a <code>.php</code> file.</li>
|
|
<li>Even if the server does not support <code>.htaccess</code> files, the data file will still not be readable by URL.</li>
|
|
<li>The database looks like this:</li>
|
|
</ul>
|
|
<pre><code class="php"><?php /* zP1ZjxxJtiYIvvevEPJ2lDOaLrZv7o...
|
|
...ka7gaco/Z+TFXM2i7BlfMf8qxpaSSYfKlvqv/x8= */ ?>
|
|
</code></pre>
|
|
|
|
<ul>
|
|
<li>Small hashes are used to make a link to an entry in Shaarli. They are unique. In fact, the date of the items (eg. <code>20110923_150523</code>) is hashed with CRC32, then converted to base64 and some characters are replaced. They are always 6 characters longs and use only <code>A-Z a-z 0-9 - _</code> and <code>@</code>.</li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|
|
|
<a href="../Static-analysis/" class="btn btn-neutral float-right" title="Static analysis">Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
|
|
|
|
<a href="../Versioning-and-Branches/" class="btn btn-neutral" title="Versioning and Branches"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
|
|
</div>
|
|
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<!-- Copyright etc -->
|
|
|
|
</div>
|
|
|
|
Built with <a href="http://www.mkdocs.org">MkDocs</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
<div class="rst-versions" role="note" style="cursor: pointer">
|
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
|
|
|
<a href="https://github.com/shaarli/Shaarli" class="fa fa-github" style="float: left; color: #fcfcfc"> GitHub</a>
|
|
|
|
|
|
<span><a href="../Versioning-and-Branches/" style="color: #fcfcfc;">« Previous</a></span>
|
|
|
|
|
|
<span style="margin-left: 15px"><a href="../Static-analysis/" style="color: #fcfcfc">Next »</a></span>
|
|
|
|
</span>
|
|
</div>
|
|
<script src="../js/theme.js"></script>
|
|
|
|
</body>
|
|
</html>
|