Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Modify concepts sections to point at Event-Centric future #915

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

This is the Home of the DataTrails Documentation.

DataTrails provides Provenance as a Service to attest trustworthiness of Assets and boost confidence in digital decisions. Find out more on our [website](https://DataTrails.ai).
DataTrails provides Provenance as a Service to attest trustworthiness of data and boost confidence in digital decisions. Find out more on our [website](https://DataTrails.ai).

## Contributing

Expand Down
2 changes: 1 addition & 1 deletion config/_default/params.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
title = "DataTrails"
titleSeparator = "-"
titleAddition = "Provenance as a Service to boost confidence in digital decisions."
description = "DataTrails provides Provenance as a Service to attest trustworthiness of assets, and boost confidence in digital decisions. Find out more on our [website](https://datatrails.ai)."
description = "DataTrails provides Provenance as a Service to attest trustworthiness of data and boost confidence in digital decisions. Find out more on our [website](https://datatrails.ai)."

## Open Graph + Twitter Cards
images = ["RKVST_WhtLogo_CMYK.svg"]
Expand Down
2 changes: 1 addition & 1 deletion content/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
title : "DataTrails"
description: "DataTrails provides Provenance as a Service to attest trustworthiness of assets, and boost confidence in digital decisions. Find out more on our [website](https:/datatrails/.ai)."
description: "DataTrails provides Provenance as a Service to attest trustworthiness of data and boost confidence in digital decisions. Find out more on our [website](https:/datatrails/.ai)."
lead: "Data provenance with a simple API."
sublead: "Prove and verify the provenance and authenticity of any data, anywhere."
date: 2020-10-06T08:47:36+00:00
Expand Down
6 changes: 3 additions & 3 deletions content/platform/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ aliases:
<div class="col-md-12 col-lg-10 col-xl-10">
<h1>Platform</h1>
<p>If you are new to DataTrails, this is the place to start.<br></p>
<p>The foundations of understanding the DataTrails platform are explained in the Overview. This will introduce the basic (and not so basic) concepts and take you through creating your first Asset and registering the first Event of your audit trail.</p>
<p>The Administration section will show you how to manage your Tenancy and control access to your Assets.
<p>The foundations of understanding the DataTrails platform are explained in the Overview. This will introduce the main concepts and take you through registering the first Events of your Audit Trail.</p>
<p>The Administration section will show you how to manage your Tenancy and control access to the Events you create.
<p> Check out the sub-sections below for more information!</p>
</div>
</div>
Expand All @@ -25,7 +25,7 @@ aliases:
<a href="/platform/overview/introduction/">Overview &rarr;</a><br>
Core concepts and tasks<br>
<a href="/platform/administration/identity-and-access-management/">Administration &rarr;</a><br>
Create users, set access rights and share Assets
Create users, set access rights and share Events
</div>
</div>
</section>
2 changes: 0 additions & 2 deletions content/platform/administration/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,5 @@ toc: true
<a href="/platform/administration/sharing-access-inside-your-tenant/">Managing Internal Access to Your Tenant &rarr;</a><br>
<a href="/platform/administration/sharing-assets-outside-your-tenant/">Managing External Access to Your Tenant &rarr;</a><br>
<a href="/platform/administration/dropbox-integration/">Dropbox Integration &rarr;</a><br>
<a href="/platform/administration/compliance-policies/">Compliance Policies &rarr;</a><br>
<a href="/platform/administration/grouping-assets-by-location/">Grouping Assets by Location &rarr;</a></p>
</div>
</div>
Original file line number Diff line number Diff line change
Expand Up @@ -21,23 +21,24 @@ aliases:
**Caution:** You will only have access to the `Access Policies` screen if you are an Administrator in your organization.
{{< /caution >}}

Attribute-Based Access Control (ABAC) policies can be used to control access to Assets, their attributes, and Events within a single organization.
Attribute-Based Access Control (ABAC) policies can be used to control access Audit Trails and Events within a single organization.

Specifically, ABAC policies are created by Administrators to share information with Non-Administrators in the same Tenancy.

ABAC policies can be granular, with users only allowed to see single attributes at a time.

It is possible to control policies based on types of Assets, their location, and whether Users can read or write any information in an Asset.
It is possible to control read and write access to Trails based on a combination of properties of the Trail as specified in the Asset attributes, such as type and location (eg: "all models trained in Gondwalaland")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Still references Asset. Should that be Event attributes, or still needs to be Asset 'till we retire Assets all together?


By default, no Non-Administrators will see any existing Assets and Events unless an Administrator explicitly creates an ABAC policy to allow it.
By default, no Non-Administrators will see any existing Trails or Events unless an Administrator explicitly creates an ABAC policy to allow it.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not from this PR, but while you're "touching it", double negatives a bit confusing.

Suggested change
By default, no Non-Administrators will see any existing Trails or Events unless an Administrator explicitly creates an ABAC policy to allow it.
By default, only Administrators will see any existing Trails or Events until an Administrator creates an ABAC policy to allow it.


{{< note >}}
**Note:** To create an ABAC policy, first [add users to your tenancy](/platform/administration/identity-and-access-management/#how-do-i-add-users-to-my-organization).
{{< /note >}}

## Creating an ABAC Policy
{{< note >}}
**Note:** Access polices are applied to the Asset. This means that when a policy is created or updated an Event will be recorded in the audit trail of matching Assets from the Actor `Archivist Internal`.
**Note:** Access polices are applied to the Trail and are themselves transparent. This means that when a policy is created or updated an Event will be recorded in the audit trail of matching Assets from the Actor `Archivist Internal` to let people know if their access has changed. This prevents 'log black-out' attacks.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
**Note:** Access polices are applied to the Trail and are themselves transparent. This means that when a policy is created or updated an Event will be recorded in the audit trail of matching Assets from the Actor `Archivist Internal` to let people know if their access has changed. This prevents 'log black-out' attacks.
**Note:** Access policies are applied to the Trail and are themselves transparent.
When a policy is created or updated, an Event will be recorded in the audit trail of matching Assets from the Actor `Archivist Internal` to let people know if their access has changed.
This prevents 'log black-out' attacks.


{{< /note >}}
Consider the Shipping Container Asset we created. There may be many people within an organization who need access to specific attributes of the container.

Expand Down Expand Up @@ -86,12 +87,12 @@ Create an empty file, in later steps we will add the correct JSON.
When adding a policy, you will see this form:
{{< img src="PolicyForm.png" alt="Rectangle" caption="<em>Policy Web Form</em>" class="border-0" >}}

Here you can apply policy filters to the correct Assets. In this case, we shall apply the policy to any Asset with the type `Shipping Container`.
Here you can apply policy filters to apply to specific Trails or groups of Trails. In this case, we shall apply the policy to any Asset with the type `Shipping Container`.

{{< img src="PolicyABACFilter.png" alt="Rectangle" caption="<em>Filtering for specific Assets and Locations</em>" class="border-0" >}}
{{< /tab >}}
{{< tab name="JSON" >}}
Filters can use `and` or `or` to categorize Assets. You may also use filters on attribute values, such as `=` and `!=` for equal and not equal, respectively. These can be used for specific attribute values, or to check if the value exists at all. For example, to filter for Assets not associated with a location, you could use:
Filters can use `and` or `or` to define scope. You may also use filters on attribute values, such as `=` and `!=` for equal and not equal, respectively. These can be used for specific attribute values, or to check if the value exists at all. For example, to filter for Assets not associated with a location, you could use:

```json
"attributes.arc_home_location_identity!=*"
Expand Down Expand Up @@ -124,10 +125,10 @@ Following our Shipping Container example, this is how we would set our Asset fil
{{< /tab >}}}
{{< /tabs >}}

1. Enter the desired `Permissions` to set user's Asset and Event attribute access
1. Enter the desired `Permissions` to set user's access
{{< tabs name="permissions_abac" >}}
{{{< tab name="UI" >}}
We select the `Permissions` Tab to set Users' Asset and Event attribute access policy.
We select the `Permissions` Tab to set Users' access policy.
{{< img src="PolicyABACForm.png" alt="Rectangle" caption="<em>Default view of Policy Permissions</em>" class="border-0" >}}

In this example, the `User` actor is identified by email. Type the relevant email address and hit enter; you may also see a dropdown list of users within your tenancy.
Expand Down
Loading
Loading