Skip to content

Update PNS RFC #284

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.

Sign up for GitHub

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

Open
joshuef wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Update PNS RFC #284

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
66c2f3c
Remove some json-ld specifics when describing RDF
joshuef Nov 23, 2018
a0efba1
remove need for base URI to point to xor
joshuef Nov 23, 2018
3bc5806
Remove public name structure from PubName RFC
joshuef Nov 23, 2018
85f2f04
Clarify RDF graphs can be in one file
joshuef Nov 23, 2018
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
21 changes: 6 additions & 15 deletions text/0052-RDF-for-public-name-resolution/0052-RDF-for-public-name-resolution.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -80,8 +80,8 @@ Unavailability of any data being dereferenced will throw an error.

`safe://<subName>.<subName>.<subName>.<subName>.<publicName>`

- As above, resolving each additional substring, up to a defined maximum of redirects (implemented in the resolver.)
- Safe Browser will implement redirect limit of 10 redirects per url resolution. Any more than this would throw an error.
- As above, resolving each additional `subName` will lead to another `Resolvable Map`... on and on up to a defined maximum of redirects (implemented by the resolver.)
- eg. Safe Browser will implement redirect limit of 10 redirects per url resolution. Any more than this would throw an error.

Unavailability of any data being dereferenced will throw an error.

Expand All @@ -90,13 +90,15 @@ Unavailability of any data being dereferenced will throw an error.

`safe://<subName>.<publicName><path>`, eg `safe://pns.rfc/resolution`

Once the final data has been resolved in a browser, if a `Files Map` type of `Resolvable Map` has been located, then the trailing url path would be resolved, too.
Once the final MD has been resolved, if a `Files Map` type of `Resolvable Map` has been located, then the trailing `path` of the url would be resolved as part of that `Map`, too.


### Data Structures fo Resolution

![Image of PNS Resolution Data Structures](https://raw.githubusercontent.com/joshuef/rfcs/PnsAndResolveableMap/text/0000-RDF-for-public-name-resolution/PNS_data_representation.png)

It is worth nothing, that while we describe RDF data here as discrete MDs, as graphs these could be stored in one file with all sub-graphs included to save fetches. The exact storage of the data / when to use new data objects / XOR-ULs is at the discretion of those saving the data.

#### Resolvable Map Structure

The idea for this is an RDF Data Set stored on the safe network. This will follow a newly defined schema, that represents a list of `keys`, which map to XOR-URLs. Each entry can contain more information to aid in resolving data, depending on context / application.
Expand All @@ -111,7 +113,6 @@ Provides data to be shown at the public name.
- It must be an RDF data object
`<safe/ResolvableMap>`, `Sub Name` graphs will pointing to a SAFE Url for data location (could be xor or using a subName).
- Extra data can be added to the graph for each entry to aid in service discovery for the key.
- `@id` entries _must_ point to a XOR-URL for consistency (while pubNames may change, _this_ data will not move location);


For `safe://<subName>.<myPublicName>`
Expand Down Expand Up @@ -153,7 +154,7 @@ Provides data to be shown at the public name.

`safe://www.happyurl` is the same as `<safe://asdadfiojf3289ry9uy329ryfhusdhfdsfsdsd#www>`

Providing different `@type` info or other details in the RDF can facilitate service discovery. In the example above, an email application could resolve `safe://happyurl`, and as the `default` value is a `Files Map` (which is does not want), could search remaining keys for something of `type: inbox` and resolve this data automatically.
Providing different type of graph can facilitate service discovery. In the example above, an email application could resolve `safe://happyurl`, and as the `default` value is a `Files Map` (which is does not want), could search remaining keys for something of `type: inbox` and resolve this data automatically.


#### Files Map
Expand Down Expand Up @@ -203,16 +204,6 @@ I would propose that we create a `Files Map` RDF type, which follows the same da

```

### PublicName Container Structure

The structure of a user's `_publicNames` container (for managing their `Public Names`) must be:

- The Public Name Map is an RDF MD w/specific type tag (`1500`) stored at the sha3 hash of the `Public Name` string `shahash3('Public Name')`.
- A Public Name must point to a `Resolvable Map` RDF schema. With the target MD location XOR-URL as the value to the key.
- A user's `Public Names` are saved/managed in the user's `_publicNames` container.
- A user's `_publicNames` container must be encrypted.


## Drawbacks

It changes the current DNS implementation, which will require updates to our libraries.
Expand Down