a8660a7e53
This patch set reorganizes Deckhand's documentation structure for better organization into 3 distinct categories: * developer's guide * operator's guide * user's guide This means that the RTD navigation menu on the left-hand side will have fewer links (see list above) making navigation much easier. This is similar to how Armada organizes its documentation too. This patch set also updates README section with a better overview and trims some fat from it (remove testing documentation as it doesn't really belong there -- there is a dedicated page for that already). Finally, this patch set changes the exceptions page to render as a basic list of autoexception classes because the current tabularized view is not rendering correctly on RTD [0]. [0] https://airship-deckhand.readthedocs.io/en/latest/exceptions.html Change-Id: I162383bf8e3bbd5004603c979ac7b0d760a210c4
2.3 KiB
Rest API Policy Enforcement
Policy enforcement in Deckhand leverages the oslo.policy
library like all OpenStack projects. The implementation is located in
deckhand.policy. Two types of policy authorization exist in
Deckhand:
- Decorator-level authorization used for wrapping around
falcon"on{HTTP_VERB}" methods. In this case, if policy authorization fails a 403 Forbidden is always raised.- Conditional authorization, which means that the policy is only enforced if a certain set of conditions are true.
Deckhand, for example, will only conditionally enforce listing
encrypted documents if a document's metadata.storagePolicy
is "encrypted".
Policy Implementation
Deckhand uses authorize from oslo.policy as
the latter supports both enforce and
authorize. authorize is stricter because it'll
raise an exception if the policy action is not registered under
deckhand.policies (which enumerates all the legal policy
actions and their default rules). This means that attempting to enforce
anything not found in deckhand.policies will error out with
a 'Policy not registered' message.
deckhand.policy
Sample Policy File
The following is a sample Deckhand policy file for adaptation and use. It is auto-generated from Deckhand when this documentation is built, so if you are having issues with an option, please compare your version of Deckhand with the version of this documentation.
The sample configuration can also be viewed in file form.
../_static/deckhand.policy.yaml.sample