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.

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

docs: remove privatekey: & user key -> shared key #133

Closed
wants to merge 4 commits into from
Closed

docs: remove privatekey: & user key -> shared key #133

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
bff9b82
docs: rename user key to shared key
JeremyTubongbanua Feb 14, 2024
27ee1ce
docs: remove privatekey:
JeremyTubongbanua Feb 14, 2024
f12cf77
docs: make linter happy
JeremyTubongbanua Feb 14, 2024
271808e
docs:
JeremyTubongbanua Feb 14, 2024
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
22 changes: 4 additions & 18 deletions specification/at_protocol_specification.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,21 +68,7 @@ atServer can be any of the following 5 types:
> The owner of the atServer should be allowed to update or delete the
> value of a public key.

2. Private Key

* A private key is a key which cannot be looked up any atSign user other
than the one created it.
* A private key should not be returned in a _scan_ verb result.
* Format of the private key should be **privatekey::<@sign>**.

**Example:**

`privatekey:pk1@alice`

> The owner of the atServer should be allowed to update or delete the
> value of a private key.

3. User key
Copy link
Contributor

Choose a reason for hiding this comment

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

concept of private key still exists, but does not have an explicit scope of privatekey: - rather, it has no explicit scope - i.e. an example being pk1@alice - and is therefore interpreted as being private.

Copy link
Contributor

Choose a reason for hiding this comment

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

So section 2 still needs to exist - but needs to be reworded so it does not include the specific visibility scope of privatekey:

2. Shared Key

* A user key can only be looked up by an atSign owner with whom the data
has been shared.
Expand All @@ -101,12 +87,12 @@ atServer can be any of the following 5 types:
> The owner of the atServer should be allowed to update or delete the
> value of a user key.

4. Internal Key
3. Internal Key

* Internal keys start with an underscore(\_) and are not displayed in scan
results. Internal keys can be looked up only by the owner of the atServer.

5. Cached Key
4. Cached Key

* A cached key is a key that was originally created by another atSign user
but is now cached on the atServer of another user's atSign as he/she was
Expand Down Expand Up @@ -841,7 +827,7 @@ authenticated atSigns can use the `delete` verb.

The following is the regex of the `delete` verb:

`^delete(:priority:(?<priority>low|medium|high))?(:cached)?(:((?<publicScope>public)|(@(?<forAtSign>[^:@\s]+))))?:(?<atKey>(([^:@\s]+)|(privatekey:at_secret)))(@(?<atSign>[^:@\s]+))?$'`
`^delete(:priority:(?<priority>low|medium|high))?(:cached)?(:((?<publicScope>public)|(@(?<forAtSign>[^:@\s]+))))?:(?<atKey>(([^:@\s]+)|(at_secret)))(@(?<atSign>[^:@\s]+))?$`

**Example:**

Expand Down