summaryrefslogtreecommitdiff
path: root/doc/source
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source')
-rw-r--r--doc/source/config.rst8
-rw-r--r--doc/source/debug.rst4
-rw-r--r--doc/source/download.rst8
-rw-r--r--doc/source/faq.rst53
-rw-r--r--doc/source/installation.rst4
5 files changed, 22 insertions, 55 deletions
diff --git a/doc/source/config.rst b/doc/source/config.rst
index 4be8db7..7691f89 100644
--- a/doc/source/config.rst
+++ b/doc/source/config.rst
@@ -199,8 +199,8 @@ argument and various information about it in the environment:
199 199
200This feature can be used, for example, to check if an uploaded file contains php 200This feature can be used, for example, to check if an uploaded file contains php
201code, using `vld <https://derickrethans.nl/projects.html#vld>`_, 201code, using `vld <https://derickrethans.nl/projects.html#vld>`_,
202via `a python script <https://github.com/nbs-system/snuffleupagus/tree/master/scripts/upload_validation.py>`__, 202via `a python script <https://github.com/jvoisin/snuffleupagus/tree/master/scripts/upload_validation.py>`__,
203or `a php one <https://github.com/nbs-system/snuffleupagus/tree/master/scripts/upload_validation.php>`__. 203or `a php one <https://github.com/jvoisin/snuffleupagus/tree/master/scripts/upload_validation.php>`__.
204 204
205The upload will be **allowed** if the script returns the value ``0``. Every other 205The upload will be **allowed** if the script returns the value ``0``. Every other
206value will prevent the file from being uploaded. 206value will prevent the file from being uploaded.
@@ -342,7 +342,7 @@ For clarity, the presence of the ``allow`` or ``drop`` action is **mandatory**.
342 because it'll match the deny first. 342 because it'll match the deny first.
343 343
344If you're paranoid, we're providing a `php script 344If you're paranoid, we're providing a `php script
345<https://github.com/nbs-system/snuffleupagus/blob/master/scripts/generate_rules.php>`__ 345<https://github.com/jvoisin/snuffleupagus/blob/master/scripts/generate_rules.php>`__
346to automatically generate hash of files containing dangerous functions, and 346to automatically generate hash of files containing dangerous functions, and
347blacklisting them everywhere else. 347blacklisting them everywhere else.
348 348
@@ -358,7 +358,7 @@ It's currently not possible to:
358 things like this, odds are that you're doing something wrong anyway. 358 things like this, odds are that you're doing something wrong anyway.
359- Hooks on ``echo`` and on ``print`` are equivalent: there is no way to hook one 359- Hooks on ``echo`` and on ``print`` are equivalent: there is no way to hook one
360 without hooking the other, at least 360 without hooking the other, at least
361 `for now <https://github.com/nbs-system/snuffleupagus/issues/190>`__). 361 `for now <https://github.com/jvoisin/snuffleupagus/issues/190>`__).
362 This is why hooked ``print`` will be displayed as ``echo`` in the logs. 362 This is why hooked ``print`` will be displayed as ``echo`` in the logs.
363- Hook `strlen`, since in latest PHP versions, this function is usually 363- Hook `strlen`, since in latest PHP versions, this function is usually
364 optimized away by the compiled. 364 optimized away by the compiled.
diff --git a/doc/source/debug.rst b/doc/source/debug.rst
index b339366..b2a1f28 100644
--- a/doc/source/debug.rst
+++ b/doc/source/debug.rst
@@ -18,7 +18,7 @@ We're using `php qa <https://qa.php.net/>`__ tests format for our testsuite,
18it is automatically run when you're building snuffleupagus. 18it is automatically run when you're building snuffleupagus.
19 19
20If it happens to have unexpected failures (Since we're using `TDD <https://en.wikipedia.org/wiki/Test-driven_development>`__ as much 20If it happens to have unexpected failures (Since we're using `TDD <https://en.wikipedia.org/wiki/Test-driven_development>`__ as much
21as we can, we do have some expected failures), please do `open an issue <https://github.com/nbs-system/snuffleupagus/issues/new>`__ 21as we can, we do have some expected failures), please do `open an issue <https://github.com/jvoisin/snuffleupagus/issues/new>`__
22on our bugtracker, and attach the generated ``.diff`` and ``.out`` files to it, 22on our bugtracker, and attach the generated ``.diff`` and ``.out`` files to it,
23so we can see what's happening. 23so we can see what's happening.
24 24
@@ -27,7 +27,7 @@ Snuffleupagus is crashing
27 27
28While we do our very best to make snuffleupagus solid as possible, we're humans, 28While we do our very best to make snuffleupagus solid as possible, we're humans,
29and computers are hard, so crashes can happen. If you're encountering one in production, 29and computers are hard, so crashes can happen. If you're encountering one in production,
30please try to launch the `testsuite <https://github.com/nbs-system/snuffleupagus/blob/master/CONTRIBUTING.md#3-get-the-test-suite-running>`__ 30please try to launch the `testsuite <https://github.com/jvoisin/snuffleupagus/blob/master/CONTRIBUTING.md#3-get-the-test-suite-running>`__
31to see if it's failing. If it does, please :ref:`tell us <testsuite_fail>`. 31to see if it's failing. If it does, please :ref:`tell us <testsuite_fail>`.
32 32
33If the testsuite is passing, odds are that you're encountering an issue tied to your php code, 33If the testsuite is passing, odds are that you're encountering an issue tied to your php code,
diff --git a/doc/source/download.rst b/doc/source/download.rst
index dfe4768..fd61099 100644
--- a/doc/source/download.rst
+++ b/doc/source/download.rst
@@ -4,20 +4,20 @@ Download
4Arch Linux 4Arch Linux
5---------- 5----------
6 6
7We're providing a `PKGBUILD <https://github.com/nbs-system/snuffleupagus/blob/master/PKGBUILD>`__, 7We're providing a `PKGBUILD <https://github.com/jvoisin/snuffleupagus/blob/master/PKGBUILD>`__,
8so you can build a package yourself. 8so you can build a package yourself.
9 9
10Alpine Linux 10Alpine Linux
11------------ 11------------
12 12
13We're providing a `APKBUILD <https://github.com/nbs-system/snuffleupagus/blob/master/APKBUILD>`__, 13We're providing a `APKBUILD <https://github.com/jvoisin/snuffleupagus/blob/master/APKBUILD>`__,
14so you can build a package yourself. 14so you can build a package yourself.
15 15
16Debian and Ubuntu 16Debian and Ubuntu
17----------------- 17-----------------
18 18
19We're currently not providing a Debian/Ubuntu repository, 19We're currently not providing a Debian/Ubuntu repository,
20but you can grab the latest release on `github <https://github.com/nbs-system/snuffleupagus/releases>`__, 20but you can grab the latest release on `github <https://github.com/jvoisin/snuffleupagus/releases>`__,
21or build your own package by cloning the source code and typing ``make debian``. 21or build your own package by cloning the source code and typing ``make debian``.
22 22
23Fedora 23Fedora
@@ -39,4 +39,4 @@ We're currently using *github* as public code repository.
39 39
40:: 40::
41 41
42 git clone https://github.com/nbs-system/snuffleupagus 42 git clone https://github.com/jvoisin/snuffleupagus
diff --git a/doc/source/faq.rst b/doc/source/faq.rst
index 4974c70..285f0c8 100644
--- a/doc/source/faq.rst
+++ b/doc/source/faq.rst
@@ -46,6 +46,8 @@ with a strong focus on security. We do have several layers of hardening
46`IDS <https://en.wikipedia.org/wiki/Intrusion_detection_system>`_, etc), 46`IDS <https://en.wikipedia.org/wiki/Intrusion_detection_system>`_, etc),
47but we had nothing for PHP7. 47but we had nothing for PHP7.
48 48
49Nowadays, Snuffleupagus is maintained by Julien (jvoisin) Voisin.
50
49 51
50Why not Suhosin? 52Why not Suhosin?
51"""""""""""""""" 53""""""""""""""""
@@ -70,7 +72,8 @@ What license is Snuffleupagus released under and why?
70""""""""""""""""""""""""""""""""""""""""""""""""""""" 72"""""""""""""""""""""""""""""""""""""""""""""""""""""
71 73
72Snuffleupagus is licensed under the `LGPL <https://www.gnu.org/copyleft/lesser.html>`_ 74Snuffleupagus is licensed under the `LGPL <https://www.gnu.org/copyleft/lesser.html>`_
73and is developed by the fine people from `NBS System <https://nbs-system.com/>`__. 75was developed by the fine people from `NBS System <https://nbs-system.com/>`__,
76and is maintained by Julien (jvoisin) Voisin.
74 77
75We chose the LGPL because we don't care that much how you're using Snuffleupagus, 78We chose the LGPL because we don't care that much how you're using Snuffleupagus,
76but we'd like to force people to make their improvements/contributions 79but we'd like to force people to make their improvements/contributions
@@ -171,7 +174,7 @@ By checking the logs; Snuffleupagus systematically prefix them with ``[snuffleup
171 174
172Does Snuffleupagus run on Windows? 175Does Snuffleupagus run on Windows?
173"""""""""""""""""""""""""""""""""" 176""""""""""""""""""""""""""""""""""
174No idea, feel free to `try <https://github.com/nbs-system/snuffleupagus/issues/2>`_. 177No idea, feel free to `try <https://github.com/jvoisin/snuffleupagus/issues/2>`_.
175 178
176 179
177Does Snuggleupagus run on `HHVM <http://hhvm.com/>`_? 180Does Snuggleupagus run on `HHVM <http://hhvm.com/>`_?
@@ -204,46 +207,13 @@ discuss potential impact of the vulnerability,
204reference applicable patches or workarounds, 207reference applicable patches or workarounds,
205and credit the discoverer. 208and credit the discoverer.
206 209
207Please send it us a mail to the ``security`` user, 210Please do send a mail to [Julien (jvoisin) Voisin](https://dustri.org) should
208on ``nbs-system.com``, using the gpg key 211you find a security issue.
209``498C46FF087EDC36E7EAF9D445414A82A9B22D78``:
210
211::
212
213 -----BEGIN PGP PUBLIC KEY BLOCK-----
214 212
215 mQENBFnKHhoBCADaOa0MKEqRy0h2ohIzczblzkMQCbU9oD1HwJ1VkYnn7TGW2iKi
216 NISxisExIXpy2Bn/pA27GiV0V/Do3NL6D9r0oOCrGR27muGM0N/dk9UMv7MWw8zv
217 K8cO+Sa28s0cAv7r2ogUJj5YOo8D4wHEpE8424TE89V9+Qg/SaFCxKoELFP0c7wu
218 mtsm0PnL65piZ1EB7lQo2gxg+8AV45MD1Y2rREMKUoZE23X+nXKsmEh9BFEPaU5M
219 7WQp0NasqeMNoGhwfw9ttVAeLhkEkaTjW1PkNRIb7vrtV9KVb5uKucflfbOnDlzu
220 tQ9U3tYto0mcSCRchAClfEmoSi/0mKyb5N6ZABEBAAG0NVNlY3VyaXR5IHRlYW0g
221 b2YgTkJTIFN5c3RlbSA8c2VjdXJpdHlAbmJzLXN5c3RlbS5jb20+iQE3BBMBCAAh
222 BQJZyh4aAhsDBQsJCAcCBhUICQoLAgQWAgMBAh4BAheAAAoJEEVBSoKpsi14jy0H
223 /1/XB9THhvmG0ow81sld2Zx8qhnNed8VvYDS6mEjpDWNVPxENwDbnakEjisq1Hrb
224 2UQPYCyQ5dekPNFVwQHIGXkX0eb1Ank+4esBJuEpQ2985tgNhJy5ZX+Imb5C8nZC
225 90uYSN1UUg559nUsFeElOXSEH6tIXK/TvjsvMYoi2Ukl6lb7PbIU2fjLY9Iqv3QY
226 32p8/Bl1fVKWbXOk0HDgJ6zA3Kr56QhZOLBkxjOa2XAnnIE76jZxUJ9qPCwWd1vW
227 GFxtx1Y+eZriqHiC9CPe6aBWcIHaTXSu1WBbXrFu8/eCWw243Rxm8l9wgA/a7VWq
228 WBfO45IhJUwh95naRpw8/4a5AQ0EWcoeGgEIAJtzSyyzfn2RX+BsyoRFANUpIgrV
229 /9eohYQVNqK3AFthmq7Kjmt4+hszF5+0wCFmWwYqGnqk1/dsWmqpkXsJldEn6oPJ
230 Bng+Dc67Yki2dR3TroAf95UmI08fhyM7TMXp8m46BPRRMzPNwalEeEm49Oclmfxb
231 JsWWCChWVLWGz2xgPEAv3fPHqus7Rwz/WIl53l/qy1Wf0ewmjRpVEfnEMKBExtBK
232 4kRxQ40LzUZ1SfpyGc3nMbswhevT7/klqrdJdCnlu67Y/IfRGxGZuNj1n1Dib3Hx
233 zTBHo3Y2R3BB93Ix8dkbLaxLqFbOYVdijCgJklqUWhx7btpQ2xnZyzyCMuUAEQEA
234 AYkBHwQYAQgACQUCWcoeGgIbDAAKCRBFQUqCqbIteFRvB/9u3Mae8n8ELrJKOn+P
235 PEbWjutObIuTplvY4QcbnNb9dsgsKryamp4CFJsA5XuitPpC31GDMXBZO5/LLOuH
236 HoMaXFJdic0NToL/3REhu+aZkNIU6S/iaPRNVhkSV4lwQsvncz+nBaiDUJjyfJm2
237 kEjVcRTM8yqzcNo/9Gn0ts+XCUqRj7+S1M4Bj3NySoO/w2n+7OLbIAj+wQZcj3Gf
238 5QhBYaY4YaFxrJE0IZxyXGHw8xhKR6AN+u4TO7LRCW+cWV/sHWir1MXieJoEG8+R
239 W/BhrB0Rz5uxOXMoGCCD2TUiHq7zpuHGnYFVmAnHQZaaQxXve4VrcmznxgpV8lpW
240 mZug
241 =+eIv
242 -----END PGP PUBLIC KEY BLOCK-----
243 213
244I found a bug. How can I report it? 214I found a bug. How can I report it?
245""""""""""""""""""""""""""""""""""" 215"""""""""""""""""""""""""""""""""""
246We do have an issue tracker on `Github <https://github.com/nbs-system/snuffleupagus/issues>`_. 216We do have an issue tracker on `Github <https://github.com/jvoisin/snuffleupagus/issues>`_.
247Please make sure to include as much information as possible when reporting your issue, 217Please make sure to include as much information as possible when reporting your issue,
248such as your operating system, your version of PHP 7, your version of Snuffleupagus, 218such as your operating system, your version of PHP 7, your version of Snuffleupagus,
249your logs, the problematic php code, the request, a brief description, … long story short, 219your logs, the problematic php code, the request, a brief description, … long story short,
@@ -255,12 +225,9 @@ it's not that hard.
255Where can I find even more help? 225Where can I find even more help?
256"""""""""""""""""""""""""""""""" 226""""""""""""""""""""""""""""""""
257The :doc:`configuration page <config>` might be what you're looking for. 227The :doc:`configuration page <config>` might be what you're looking for.
258If you're adventurous, you can also check the `issue tracker <https://github.com/nbs-system/snuffleupagus/issues/?q=is%3Aissue>`_ 228If you're adventurous, you can also check the `issue tracker <https://github.com/jvoisin/snuffleupagus/issues/?q=is%3Aissue>`_
259(make sure to check the `closed issues <https://github.com/nbs-system/snuffleupagus/issues?q=is%3Aissue+is%3Aclosed>`_ too). 229(make sure to check the `closed issues <https://github.com/jvoisin/snuffleupagus/issues?q=is%3Aissue+is%3Aclosed>`_ too).
260 230
261I need professional support for my company.
262"""""""""""""""""""""""""""""""""""""""""""
263Contact `NBS System <https://nbs-system.com>`_.
264 231
265Unimplemented mitigations and abandoned ideas 232Unimplemented mitigations and abandoned ideas
266--------------------------------------------- 233---------------------------------------------
diff --git a/doc/source/installation.rst b/doc/source/installation.rst
index 74d5d4f..a6b0ff8 100644
--- a/doc/source/installation.rst
+++ b/doc/source/installation.rst
@@ -1,7 +1,7 @@
1Installation 1Installation
2============ 2============
3 3
4Snuffleupagus is tested against `various PHP 7+ versions <https://travis-ci.org/nbs-system/snuffleupagus/>`_. 4Snuffleupagus is tested against `various PHP 7+ versions <https://travis-ci.org/jvoisin/snuffleupagus/>`_.
5 5
6Manual installation 6Manual installation
7------------------- 7-------------------
@@ -21,7 +21,7 @@ Quickstart
21 21
22:: 22::
23 23
24 git clone https://github.com/nbs-system/snuffleupagus 24 git clone https://github.com/jvoisin/snuffleupagus
25 cd snuffleupagus/src 25 cd snuffleupagus/src
26 phpize 26 phpize
27 ./configure --enable-snuffleupagus 27 ./configure --enable-snuffleupagus