X-Git-Url: https://granicus.if.org/sourcecode?a=blobdiff_plain;f=docs%2Fmanual%2Fmod%2Fmod_session_crypto.html.en;h=5925ebb791addf39428c9c2477b1c98d5d8e1eb5;hb=0ae5b1af6b6bf3048d2a124e84905f63d6507dea;hp=2d4cdd0ea0ace372dab0a14a50b427ac70e6dbd5;hpb=a83284e10365f9baf39331e545dde65ecdc99ef1;p=apache diff --git a/docs/manual/mod/mod_session_crypto.html.en b/docs/manual/mod/mod_session_crypto.html.en index 2d4cdd0ea0..5925ebb791 100644 --- a/docs/manual/mod/mod_session_crypto.html.en +++ b/docs/manual/mod/mod_session_crypto.html.en @@ -1,23 +1,28 @@ -
-Apache HTTP Server Version 2.3
-Apache HTTP Server Version 2.5
+mod_session
module.
To create a simple encrypted session and store it in a cookie called session, configure the session as follows:
-
- Session On
- SessionCookieName session path=/
- SessionCryptoPassphrase secret
-
Session On +SessionCookieName session path=/ +SessionCryptoPassphrase secret+
The session will be encrypted with the given key. Different servers can be configured to share sessions by ensuring the same encryption key is used @@ -89,6 +95,27 @@
Description: | The crypto cipher to be used to encrypt the session |
---|---|
Syntax: | SessionCryptoCipher name |
Default: | aes256 |
Context: | server config, virtual host, directory, .htaccess |
Status: | Experimental |
Module: | mod_session_crypto |
Compatibility: | Available in Apache 2.3.0 and later |
The SessionCryptoCipher
directive allows the cipher to
+ be used during encryption. If not specified, the cipher defaults to
+ aes256
.
Possible values depend on the crypto driver in use, and could be one of:
+ +Description: | The crypto driver to be used to encrypt the session |
---|
Description: | The key used to encrypt the session |
---|---|
Syntax: | SessionCryptoPassphrase secret |
Syntax: | SessionCryptoPassphrase secret [ secret ... ] |
Default: | none |
Context: | server config, virtual host, directory, .htaccess |
Status: | Experimental |
Module: | mod_session_crypto |
Compatibility: | Available in Apache 2.3.0 and later |
The SessionCryptoPassphrase
directive specifies the key
+
The SessionCryptoPassphrase
directive specifies the keys
to be used to enable symmetrical encryption on the contents of the session before
writing the session, or decrypting the contents of the session after reading the
session.
Keys are more secure when they are long, and consist of truly random characters. Changing the key on a server has the effect of invalidating all existing sessions.
-The cipher can be set to 3des192 or aes256 using the - cipher parameter as per the example below. If not set, the cipher defaults - to aes256.
+Multiple keys can be specified in order to support key rotation. The first key + listed will be used for encryption, while all keys listed will be attempted for + decryption. To rotate keys across multiple servers over a period of time, add a new + secret to the end of the list, and once rolled out completely to all servers, remove + the first key from the start of the list.
-
- SessionCryptoPassphrase secret cipher=aes256
-
As of version 2.4.7 if the value begins with exec: the resulting command + will be executed and the first line returned to standard output by the program will be + used as the key.
+#key used as-is +SessionCryptoPassphrase secret -The openssl crypto driver supports an optional parameter to specify - the engine to be used for encryption.
+#Run /path/to/program to get key +SessionCryptoPassphrase exec:/path/to/program + +#Run /path/to/otherProgram and provide arguments +SessionCryptoPassphrase "exec:/path/to/otherProgram argument1"
Description: | File containing keys used to encrypt the session |
---|---|
Syntax: | SessionCryptoPassphraseFile filename |
Default: | none |
Context: | server config, virtual host, directory |
Status: | Experimental |
Module: | mod_session_crypto |
Compatibility: | Available in Apache 2.3.0 and later |
The SessionCryptoPassphraseFile
directive specifies the
+ name of a configuration file containing the keys to use for encrypting or decrypting
+ the session, specified one per line. The file is read on server start, and a graceful
+ restart will be necessary for httpd to pick up changes to the keys.
Unlike the SessionCryptoPassphrase
directive, the keys are
+ not exposed within the httpd configuration and can be hidden by protecting the file
+ appropriately.
- SessionCryptoPassphrase secret engine=name
-
Multiple keys can be specified in order to support key rotation. The first key + listed will be used for encryption, while all keys listed will be attempted for + decryption. To rotate keys across multiple servers over a period of time, add a new + secret to the end of the list, and once rolled out completely to all servers, remove + the first key from the start of the list.
Available Languages: en
-