couchdb-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From kxe...@apache.org
Subject [30/32] git commit: updated refs/heads/1781-reorganize-and-improve-docs to 11fd32a
Date Fri, 14 Jun 2013 08:25:27 GMT
Add Proxy Auth related config options.


Project: http://git-wip-us.apache.org/repos/asf/couchdb/repo
Commit: http://git-wip-us.apache.org/repos/asf/couchdb/commit/b70cee23
Tree: http://git-wip-us.apache.org/repos/asf/couchdb/tree/b70cee23
Diff: http://git-wip-us.apache.org/repos/asf/couchdb/diff/b70cee23

Branch: refs/heads/1781-reorganize-and-improve-docs
Commit: b70cee2329e64df1042f4f8a8034f2e4bff7c898
Parents: 29903e0
Author: Alexander Shorin <kxepal@apache.org>
Authored: Fri Jun 14 12:06:46 2013 +0400
Committer: Alexander Shorin <kxepal@apache.org>
Committed: Fri Jun 14 12:21:31 2013 +0400

----------------------------------------------------------------------
 share/doc/src/config/couch-httpd-auth.rst | 64 ++++++++++++++++++++++++++
 1 file changed, 64 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/couchdb/blob/b70cee23/share/doc/src/config/couch-httpd-auth.rst
----------------------------------------------------------------------
diff --git a/share/doc/src/config/couch-httpd-auth.rst b/share/doc/src/config/couch-httpd-auth.rst
index 1d5e7eb..b613211 100644
--- a/share/doc/src/config/couch-httpd-auth.rst
+++ b/share/doc/src/config/couch-httpd-auth.rst
@@ -84,6 +84,18 @@ that requires authentication::
   iterations = 10000
 
 
+.. _config/couch_httpd_auth/proxy_use_secret:
+
+``proxy_use_secret`` :: Force proxy auth use secret token
+---------------------------------------------------------
+
+When this option ``true`` the :ref:`secret <config/couch_httpd_auth/secret>` is
+required for `Proxy Auth`::
+
+  [couch_httpd_auth]
+  proxy_use_secret = false
+
+
 .. _config/couch_httpd_auth/require_valid_user:
 
 ``require_valid_user`` :: Force users authentication
@@ -96,6 +108,17 @@ should be authenticated::
   require_valid_user = false
 
 
+.. _config/couch_httpd_auth/secret:
+
+``secret`` :: Proxy Auth secret token
+-------------------------------------
+
+The secret token used for `Proxy Auth` authentication method::
+
+  [couch_httpd_auth]
+  secret = 92de07df7e7a3fe14808cef90a7cc0d91
+
+
 .. _config/couch_httpd_auth/timeout:
 
 ``timeout`` :: Session timeout
@@ -106,3 +129,44 @@ Number of seconds since the last request before session will be expired::
   [couch_httpd_auth]
   timeout = 600
 
+
+.. _config/couch_httpd_auth/x_auth_roles:
+
+``x_auth_roles`` :: Proxy Auth roles header
+-------------------------------------------
+
+HTTP header name (``X-Auth-CouchDB-Roles`` by default) that contains the list of
+user's roles separated by a comma. Used for `Proxy Auth`::
+
+  [couch_httpd_auth]
+  x_auth_roles = X-Auth-CouchDB-Roles
+
+
+.. _config/couch_httpd_auth/x_auth_token:
+
+``x_auth_token`` :: Proxy Auth token header
+-------------------------------------------
+
+HTTP header name (``X-Auth-CouchDB-Token`` by default) with token to
+authenticate the authorization. This token is an `HMAC-SHA1` created from
+:ref:`secret key <config/couch_httpd_auth/secret>` and
+:ref:`username <config/couch_httpd_auth/x_auth_username>`. The secret key
+should be the same in the client and CouchDB node. This token is optional
+if value of :ref:`proxy_use_secret <config/couch_httpd_auth/proxy_use_secret>`
+option isn't ``true``. Used for `Proxy Auth`::
+
+  [couch_httpd_auth]
+  x_auth_roles = X-Auth-CouchDB-Token
+
+
+.. _config/couch_httpd_auth/x_auth_username:
+
+``x_auth_username`` :: Proxy Auth username header
+-------------------------------------------------
+
+HTTP header name (``X-Auth-CouchDB-UserName`` by default) containing the
+username. Used for `Proxy Auth`::
+
+  [couch_httpd_auth]
+  x_auth_username = X-Auth-CouchDB-UserName
+


Mime
View raw message