diff options
| author | kka | 2018-08-09 11:16:46 +0200 |
|---|---|---|
| committer | kka | 2018-08-09 11:17:07 +0200 |
| commit | 14010de608d59cfaf4a25587582fb512403b9c49 (patch) | |
| tree | 39a5cd9a51046f89711937d92fcbb1b16746113e /doc/source | |
| parent | 69b95a117957ceaab16f5dfb68a41500a7958ba9 (diff) | |
Improve the cookie encryption documentation
Diffstat (limited to 'doc/source')
| -rw-r--r-- | doc/source/encryption.rst | 11 |
1 files changed, 8 insertions, 3 deletions
diff --git a/doc/source/encryption.rst b/doc/source/encryption.rst index 5309c46..c617fe3 100644 --- a/doc/source/encryption.rst +++ b/doc/source/encryption.rst | |||
| @@ -64,14 +64,17 @@ The key is derived from multiple sources, such as : | |||
| 64 | If the simulation mode isn’t specified in the configuration, snuffleupagus will drop any request that it was unable to decrypt. | 64 | If the simulation mode isn’t specified in the configuration, snuffleupagus will drop any request that it was unable to decrypt. |
| 65 | 65 | ||
| 66 | Since PHP doesn't handle session cookie and non-session cookie in the same way, | 66 | Since PHP doesn't handle session cookie and non-session cookie in the same way, |
| 67 | thus we are providing two different options: | 67 | thus we are providing two different ways. |
| 68 | 68 | ||
| 69 | * For the session cookie, the encryption happens server-side: The cookie's value isn't encrypted, only the session content is. | ||
| 70 | * For the non-session cookie, the value is encrypted. | ||
| 71 | 69 | ||
| 72 | Session cookie | 70 | Session cookie |
| 73 | .............. | 71 | .............. |
| 74 | 72 | ||
| 73 | For the session cookie, the encryption happens server-side: Nothing is | ||
| 74 | encrypted in the cookie: neither the cookie's name (usually ``PHPSESSID``) nor | ||
| 75 | its content (the session's name). What is in fact encrypted, is the session's | ||
| 76 | content, on the server (usually stored in ``/tmp/sess_<XXXX>`` files). | ||
| 77 | |||
| 75 | :ref:`Session encryption <cookie-encryption-feature>`, disabled by default, will activate transparent session encryption. | 78 | :ref:`Session encryption <cookie-encryption-feature>`, disabled by default, will activate transparent session encryption. |
| 76 | It can either be ``enabled`` or ``disabled`` and can be used in ``simulation`` mode. | 79 | It can either be ``enabled`` or ``disabled`` and can be used in ``simulation`` mode. |
| 77 | 80 | ||
| @@ -84,6 +87,8 @@ It can either be ``enabled`` or ``disabled`` and can be used in ``simulation`` m | |||
| 84 | Non-session cookie | 87 | Non-session cookie |
| 85 | .................. | 88 | .................. |
| 86 | 89 | ||
| 90 | For the non-session cookie, the cookie's name is left untouched, only its value is encrypted. | ||
| 91 | |||
| 87 | :ref:`Cookie encryption <cookie-encryption-feature>`, disabled by default, will activate transparent encryption of specific cookies. | 92 | :ref:`Cookie encryption <cookie-encryption-feature>`, disabled by default, will activate transparent encryption of specific cookies. |
| 88 | 93 | ||
| 89 | It can either be ``enabled`` or ``disabled`` and can be used in ``simulation`` mode. | 94 | It can either be ``enabled`` or ``disabled`` and can be used in ``simulation`` mode. |
