Skip to content

Commit 4e8410b

Browse files
committed
refactor(docs): improve formatting and linking on architecture page
This refactors the architecture page to improve readability and navigation. The layout is updated to a single column, the diagram is reoriented, and all components and NIST terms are now linked to their respective pages.
1 parent ac457b5 commit 4e8410b

1 file changed

Lines changed: 13 additions & 13 deletions

File tree

docs/architecture.mdx

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -46,37 +46,37 @@ graph TD
4646
class POLICY,AUTHZ,ERS,KAS opentdfService
4747
class ATTR_SOURCES,IDP,CLIENT externalSystem
4848
49-
click POLICY "components/policy/" "Go to Policy Service docs"
50-
click AUTHZ "components/authorization" "Go to Authorization Service docs"
51-
click ERS "components/entity_resolution" "Go to Entity Resolution Service docs"
52-
click KAS "components/key_access" "Go to Key Access Server docs"
49+
click POLICY "components/policy/"
50+
click AUTHZ "components/authorization"
51+
click ERS "components/entity_resolution"
52+
click KAS "components/key_access"
5353
```
5454

5555
### [Policy Service](components/policy/)
5656

57-
The **Policy Service** is where all access control policies are defined and managed. It provides the tools and APIs to create a rich set of policies that govern data access. This includes not only attributes and their values, but also the definitions of **actions, obligations, and key access mappings**.
57+
The Policy Service is where all access control policies are defined and managed. It provides the tools and APIs to create a rich set of policies that govern data access. This includes not only attributes and their values, but also the definitions of **actions, obligations, and key access mappings**.
5858

59-
In the context of the NIST ABAC model, the Policy Service functions as the **Policy Administration Point (PAP)**.
59+
In the context of the NIST ABAC model, the Policy Service functions as the [Policy Administration Point (PAP)](https://csrc.nist.gov/glossary/term/policy_administration_point).
6060

6161
### [Authorization Service](components/authorization)
6262

63-
The **Authorization Service** is the core decision-making engine of the platform. It is responsible for evaluating the rich policies from the Policy Service against a set of attributes to render an authorization decision.
63+
The Authorization Service is the core decision-making engine of the platform. It is responsible for evaluating the rich policies from the Policy Service against a set of attributes to render an authorization decision.
6464

65-
In the context of the NIST ABAC model, it functions as the **Policy Decision Point (PDP)**.
65+
In the context of the NIST ABAC model, it functions as the [Policy Decision Point (PDP)](https://csrc.nist.gov/glossary/term/policy_decision_point).
6666

6767
### [Entity Resolution Service (ERS)](components/entity_resolution)
6868

69-
The **Entity Resolution Service** is responsible for gathering the attributes about a subject needed for a decision. By default, it can derive attributes from claims in an authentication token. Optionally, it can be configured to connect to external attribute sources (LDAP, SQL) to "hydrate" the entity with more attributes.
69+
The Entity Resolution Service is responsible for gathering the attributes about a subject needed for a decision. By default, it can derive attributes from claims in an authentication token. Optionally, it can be configured to connect to external attribute sources (LDAP, SQL) to "hydrate" the entity with more attributes.
7070

71-
In the context of the NIST ABAC model, the ERS functions as the **Policy Information Point (PIP)**.
71+
In the context of the NIST ABAC model, the ERS functions as the [Policy Information Point (PIP)](https://csrc.nist.gov/glossary/term/policy_information_point).
7272

7373
### [Key Access Server (KAS)](components/key_access)
7474

75-
The **Key Access Server (KAS)** enforces access control decisions. Its role is more extensive than a typical enforcement point:
75+
The Key Access Server (KAS) enforces access control decisions. Its role is more extensive than a typical enforcement point:
7676

7777
- **Cryptographic Enforcement:** It enforces decisions by granting or withholding cryptographic keys for TDF decryption.
7878
- **Encryption Enablement:** It manages key exchanges and enables various TDF encryption modes.
7979

80-
In the context of the NIST ABAC model, the KAS functions as the **Policy Enforcement Point (PEP)**.
80+
In the context of the NIST ABAC model, the KAS functions as the [Policy Enforcement Point (PEP)](https://csrc.nist.gov/glossary/term/policy_enforcement_point).
8181

82-
Furthermore, the OpenTDF platform is designed for flexibility. Developers can **build and integrate their own custom PEPs**. These custom enforcement points can leverage the platform's robust Authorization (PDP) and Policy (PAP) services while implementing enforcement logic tailored to specific applications. These custom PEPs can also optionally interface with the KAS to take advantage of its powerful cryptographic capabilities.
82+
Furthermore, the OpenTDF platform is designed for flexibility. Developers can **build and integrate their own custom PEPs**. These custom enforcement points can leverage the platform's robust Authorization ([PDP](https://csrc.nist.grov/glossary/term/policy_decision_point)) and Policy ([PAP](https://csrc.nist.gov/glossary/term/policy_administration_point)) services while implementing enforcement logic tailored to specific applications. These custom PEPs can also optionally interface with the KAS to take advantage of its powerful cryptographic capabilities.

0 commit comments

Comments
 (0)