summaryrefslogtreecommitdiff
path: root/doc/index.mdwn
blob: 2b7f48588efa406e0740ac50553f75bc66f8795d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
Lace - Lua Access Control Engine
================================

Lace is the core of an access control engine designed to be embedded into other
applications.  It is also designed to be extended by the very applications it
is embedded into.

As such, Lace provides only the core lexing, parsing, error handling and
related functionality of an access control engine, along with some initial
semantics to help the application developer along.

All rules and mechanisms of deciding if access is to be permitted or not are up
to the application author to define.  As such, while this documentation for
Lace will be useful for the application developer; it is recommended that the
applications do not refer their users to the Lace documentation except to
augment that provided in the application specific documentation.

The Lace codebase provides an example of using the library which should be
referred to for getting started with Lace.  However, there is also extensive
documentation on the [[syntax]] of Lace rulesets and also on the
[[compilation]] and [[execution]] phases of access control.

If you wish to assist with Lace development, then see the [[developing]]
document for pointers around the codebase and the test suite.