From 9217131a2c0144b9df3b96a60c2b157a7282ebf1 Mon Sep 17 00:00:00 2001
From: Chris McDonough <chrism@agendaless.com>
Date: Wed, 16 Jul 2008 21:23:17 +0000
Subject: Security docs.

---
 docs/modules/index.rst    |  2 ++
 docs/modules/security.rst | 53 +++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 55 insertions(+)
 create mode 100644 docs/modules/security.rst

(limited to 'docs/modules')

diff --git a/docs/modules/index.rst b/docs/modules/index.rst
index 38cd5a29d..644b9fdf4 100644
--- a/docs/modules/index.rst
+++ b/docs/modules/index.rst
@@ -16,3 +16,5 @@ Sub-packages
    :maxdepth: 2
 
    router
+   security
+
diff --git a/docs/modules/security.rst b/docs/modules/security.rst
new file mode 100644
index 000000000..0a692e521
--- /dev/null
+++ b/docs/modules/security.rst
@@ -0,0 +1,53 @@
+.. _security_module:
+
+:mod:`repoze.bfg.security`
+==========================
+
+.. automodule:: repoze.bfg.security
+
+  .. autofunction:: has_permission
+
+  .. attribute:: Everyone
+
+    The special principal id named 'Everyone'.  This principal id is
+    granted to all requests.  Its actual value is the string
+    'system.Everyone'.
+
+  .. attribute:: Authenticated
+
+    The special principal id named 'Authenticated'.  This principal id
+    is granted to all requests which contain any other non-Everyone
+    principal id (according to the security policy).  Its actual value
+    is the string 'system.Authenticated'.
+
+  .. attribute:: Allow
+
+    The ACE "action" (the first element in an ACE e.g. ``(Allow, Everyone,
+    'read')`` that means allow access.  A sequence of ACEs makes up an
+    ACL.  It is a string, and it's actual value is "Allow".
+
+  .. attribute:: Deny
+
+    The ACE "action" (the first element in an ACE e.g. ``(Deny,
+    'george', 'read')`` that means deny access.  A sequence of ACEs
+    makes up an ACL.  It is a string, and it's actual value is "Deny".
+
+  :class:`RemoteUserACLSecurityPolicy`
+  ------------------------------------
+
+  .. autoclass:: RemoteUserACLSecurityPolicy
+
+     .. automethod:: permits
+
+  :class:`Denied`
+  ===============
+
+  .. autoclass:: Denied
+     :members:
+
+  :class:`Allowed`
+  ================
+
+  .. autoclass:: Allowed
+     :members:
+
-- 
cgit v1.2.3