Skip to content

Commit 9ae088a

Browse files
committed
updated intra-links
1 parent c7053af commit 9ae088a

13 files changed

Lines changed: 42 additions & 57 deletions

docs/01_0_Introduction.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@ Supporting objectives include the ability to:
3030

3131
* Understand what a XID is.
3232
* Know what a pseudonymous identity is.
33+
* Understand a variety of underlying concepts.
3334
* Understand the power of dereferencing.
3435

3536
## Table of Contents

docs/01_1_Getting_Started_SSI_XIDs.md

Lines changed: 9 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ users should have full visibility on their identity, they should have
2626
principal authority over it, and they should be able to move it around as
2727
they see fit.
2828

29-
Unfortunately, as the SSI ecosystem matured, it has moved away from
30-
these core principles, as discussed in ["Has our SSI Ecosystem Become
29+
Unfortunately, as the SSI ecosystem matured, it moved away from these
30+
core principles, as discussed in ["Has our SSI Ecosystem Become
3131
Morally
3232
Bankrupt?"](https://www.blockchaincommons.com/musings/musings-ssi-bankruptcy/). Issuers
3333
took control of identities and created centralized points-of-failure
@@ -47,7 +47,7 @@ It starts out with the core design: a XID is an autonomous
4747
cryptographic object (ACO). It's a self-sufficient package that
4848
contains an identifier, keys to control that identifier, and other
4949
data. You don't need to depend on any infrastructure: there's no
50-
separate issuer or verifier, no centralized authority at all. It's
50+
separate issuer or verifier, no centralized authority at all. A XID is
5151
holder-created and holder-controlled. That's the dream of
5252
self-sovereign identity.
5353

@@ -63,11 +63,11 @@ issuer (which violates the most central vision of SSI).
6363
The technology in XIDs is novel (including deterministic encoding,
6464
radical elision, and progressive trust). The privacy is greatly
6565
improved over existing systems that put issuers in the driver's
66-
seat. Finally, it's supported by radically private communication
66+
seat. Finally, it's bolstered by radically private communication
6767
methods such as
6868
[Garner](https://developer.blockchaincommons.com/garner/), which
69-
ensure your self-sovereign identity is supported by self-sovereign
70-
networking.
69+
ensure that your self-sovereign identity is supported by
70+
self-sovereign networking.
7171

7272
If you believe in self-sovereign identity (or privacy or novel
7373
technologies or improving the specifications we already have), then
@@ -90,24 +90,6 @@ feel for how everything works. Explore the results, digging into them
9090
further if you wish, as that's the power of a hands-on course like
9191
this.
9292

93-
### Core Concepts
94-
95-
A set of [Core Concepts
96-
documents](https://github.com/BlockchainCommons/XID-Quickstart/blob/main/concepts/README.md)
97-
were written in conjunction with the course. They're not an integrated
98-
part of the "Learning XIDs" tutorial, but they offer deep hands-on
99-
exercises for a variety of related technologies.
100-
101-
In particular, we suggest reading three fundamental concepts before
102-
you start in on the course:
103-
[XIDs](https://github.com/BlockchainCommons/XID-Quickstart/blob/main/concepts/xid.md),
104-
[Gordian
105-
Envelope](https://github.com/BlockchainCommons/XID-Quickstart/blob/main/concepts/gordian-envelope.md),
106-
and [Data
107-
Minimization](https://github.com/BlockchainCommons/XID-Quickstart/blob/main/concepts/data-minimization.md). At
108-
a future point, we expect to move these to the [Developer web
109-
pages](https://developer.blockchaincommons.com/) or their own course.
110-
11193
## Summary: Doing Self-Sovereign Identity Right
11294

11395
Self-sovereign identity was a dream of giving us all autonomy on the
@@ -121,8 +103,9 @@ focused on the holder, not an issuer or verifier.
121103

122104
## What's Next
123105

124-
You now know what a XID is and should be ready to create one, which
125-
you'll do in [§1.2: Creating Your First XID](01_2_Your_First_XID.md ).
106+
A number of technologies and core concepts underlie XIDss. These are covered in [§1.2: Understanding Core Concepts](01_2_Core_Concepts.md).
107+
But if you're eager to get hands on with your XIDs, you should jump to
108+
[§1.3: Creating Your First XID](01_3_Your_First_XID.md).
126109

127110
## Appendix I: Key Terminology
128111

docs/01_3_Your_First_XID.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 1.2: Creating Your First XID
1+
# 1.3: Creating Your First XID
22

33
This section demonstrates how to create a basic XID (eXtensible
44
IDentifier) that enables pseudonymous contributions while maintaining
@@ -378,7 +378,7 @@ styles of quotes:
378378
### Step 3: Create a Public View of Your XID with Elision
379379

380380
Amira's XID is not ready for publication yet. You're going to add some
381-
more information in [§1.3](01_3_Making_a_XID_Verifiable.md) before
381+
more information in [§1.4](01_4_Making_a_XID_Verifiable.md) before
382382
sending it to Amira's first contact, Ben. But to prepare yourself for
383383
that, you're going to go over the crical step that _would_ be required
384384
to publish a XID: creating a public view.
@@ -733,7 +733,7 @@ actually published Amira's XID. More on that in the next tutorial!
733733

734734
### Additional Files
735735

736-
**Envelopes:** The envelopes for this section are not stored in the Learning-XIDs repo as they'll be updated in §1.3 prior to publication.
736+
**Envelopes:** The envelopes for this section are not stored in the Learning-XIDs repo as they'll be updated in §1.4 prior to publication.
737737

738738
**Scripts:** The [scripts](https://github.com/BlockchainCommons/XID-Quickstart/tree/main/scripts) directory contains [01_2_Your_First_XID-SCRIPT.sh](https://github.com/BlockchainCommons/XID-Quickstart/blob/main/scripts/01_2_Your_First_XID-SCRIPT.sh), which runs through all the commands in this section. From the command line, `git clone https://github.com/BlockchainCommons/XID-Quickstart.git`, then `cd XID-Quickstart`, then `bash scripts/01_2_Your_First_XID-SCRIPT.sh` to test it.
739739

@@ -749,7 +749,7 @@ Try these to solidify your understanding:
749749
## What's Next
750750

751751
Since XIDs are autonomous, Amira needs a way to assure people that
752-
they have an up-to-date verison. Doing that (and publishing that XID) is the topic of [§1.3: Making a XID Verifiable](01_3_Making_a_XID_Verifiable.md).
752+
they have an up-to-date verison. Doing that (and publishing that XID) is the topic of [§1.4: Making a XID Verifiable](01_4_Making_a_XID_Verifiable.md).
753753

754754
## Appendix I: Key Terminology
755755

docs/01_4_Making_a_XID_Verifiable.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# 1.3: Making a XID Verifiable
1+
# 1.4: Making a XID Verifiable
22

33
This section demonstrates how to maintain a XID's freshness without
44
direct communication through the use of a publication URL.
@@ -16,7 +16,7 @@ After working through this section, a developer will be able to:
1616

1717
## Amira's Story: The Freshness Problem
1818

19-
After §1.2, Amira could give Ben her public XID directly. She could
19+
After §1.3, Amira could give Ben her public XID directly. She could
2020
email it, share it via Signal, or do whatever else works. But what
2121
happens when she updates her XID next month? Ben has no way to know
2222
his copy is stale. He might verify signatures against outdated
@@ -46,7 +46,7 @@ provenance --version
4646
```
4747

4848
If either tool is not installed, see [Step 0 of
49-
§1.2](01_2_Your_First_XID.md#step-0-setting-up-your-workspace) for
49+
§1.3](01_3_Your_First_XID.md#step-0-setting-up-your-workspace) for
5050
installation instructions.
5151

5252
## Part I: Publishing a XID
@@ -217,7 +217,7 @@ the other.
217217

218218
You can now use `xid export` to create a public view by eliding your
219219
private keys and your provenance mark generator, just like you did in
220-
§1.2:
220+
§1.3:
221221

222222

223223
```
@@ -432,7 +432,7 @@ can he trust it?
432432
### Step 9: Verify the Signature & Provenance
433433

434434
Ben will now repeat the steps from
435-
[§1.2](01_2_Your_First_XID.md#part-iii-verifying-a-xid), verifying the
435+
[§1.3](01_3_Your_First_XID.md#part-iii-verifying-a-xid), verifying the
436436
signature and the provenance mark.
437437

438438
```
@@ -456,7 +456,7 @@ provenance validate "$PROVENANCE_MARK" && echo "✅ Provenance chain intact"
456456

457457
He could also examine details of the provenance mark with `provenance
458458
validate --format json-pretty "$PROVENANCE_MARK"`, but since this is
459-
Amira's first edition, it'll look the same as it did in 1.1 The more
459+
Amira's first edition, it'll look the same as it did in §1.3. The more
460460
interesting test would come if Ben had multiple, different copies of
461461
the XID and needed to determine which was stale and which fresh, but
462462
that's a topic for chapter 2

docs/02_1_Creating_Self_Attestations.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ provenance --version
9999
```
100100

101101
If not installed, see
102-
[§1.2](01_2_Your_First_XID.md#step-0-setting-up-your-workspace) for
102+
[§1.3](01_3_Your_First_XID.md#step-0-setting-up-your-workspace) for
103103
installation instructions.
104104

105105
You'll also want to reload your XID. The following assumes use of the [`envelopes`](https://github.com/BlockchainCommons/XID-Quickstart/tree/main/envelopes) directory that was described in the last tutorial.
@@ -291,7 +291,7 @@ So far, Amira has two keys:
291291

292292
| Key Type | Purpose | Verified Against | Added In |
293293
|----------|---------|------------------|----------|
294-
| 👤 XID inception key | Signs XID document updates | XID itself | §1.2 |
294+
| 👤 XID inception key | Signs XID document updates | XID itself | §1.3 |
295295
| 🗣️ Attestation key | Signs attestations | XID key list | §2.1 |
296296

297297
We'll talk more about the keys and the protections that heterogeneity
@@ -303,7 +303,7 @@ Here's a look at our two XID versions created to date:
303303

304304
| XID Version | New Content | Created In |
305305
|-------------|-------------|------------|
306-
| seq 0 | 👤 Identity | §1.2+§1.3 |
306+
| seq 0 | 👤 Identity | §1.3+§1.4 |
307307
| seq 1 | 🔑 Attestation Key | §2.1 |
308308

309309
## Part II: Creating a Detached Attestation

docs/02_2_Managing_Claims_Elision.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -151,7 +151,7 @@ This is the full attestation that Amira will keep secure and private. But she wa
151151

152152
You can now create a view of the attestation with the content removed
153153
but the cryptographic structure preserved. In
154-
[§1.2](01_2_Your_First_XID.md), we mentioned the general technique for
154+
[§1.3](01_3_Your_First_XID.md), we mentioned the general technique for
155155
doing this when we used an automated method to elide private keys and
156156
provenance mark generators. Generally, you need to (1) find the digest
157157
(hash) of the node or leaf that you want to elide and then (2) use the

docs/02_3_Managing_Claims_Encryption.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -307,8 +307,9 @@ BRadvoc8 account.
307307

308308
That problem has been lingering, and it'll be the reason for Amira to
309309
finally add a bit more information to her BRadvoc8 XID, proof that she
310-
controls the GitHub account she referenced in §1.3, but that'll be the
311-
topic of the next chapter.
310+
controls the GitHub account she referenced in
311+
[§1.4](01_4_Making_a_XID_Verifiable.md), but that'll be the topic of
312+
the next chapter.
312313

313314
## Summary: From Elision to Encryption
314315

docs/03_1_Creating_Edges.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -75,10 +75,10 @@ information can be found.
7575
| | `attachment` | `'attachment'` | 📂 Third-party metadata |
7676
| | `delegate` | `'delegate'` | 👌🏽 Permission delegation |
7777
| §3.1-§3.3 | `edge` | `'edge'` | 🗣️ Attestations |
78-
| §1.2, §2.1 | `key` | `'key'`<br>`'privateKey'` | 🔑 Key pairs |
79-
| §1.3 | `method`<br>`resolution` | `'dereferencevia'` | 🧶 Resolution method |
78+
| §1.3, §2.1 | `key` | `'key'`<br>`'privateKey'` | 🔑 Key pairs |
79+
| §1.4 | `method`<br>`resolution` | `'dereferencevia'` | 🧶 Resolution method |
8080
| | `service` | `'service'` | ☁️ Service delegation |
81-
| §1.2, §2.1 | `provenance` | `'provenance'` | ⛓️ Provenance mark |
81+
| §1.3, §2.1 | `provenance` | `'provenance'` | ⛓️ Provenance mark |
8282

8383
Edges will be the topic of this chapter.
8484

@@ -172,7 +172,7 @@ Amira now has three different keys serving three different purposes:
172172

173173
| Key Type | Purpose | Verified Against | Added In |
174174
|----------|---------|------------------|----------|
175-
| 👤 XID inception key | Signs XID document updates | XID itself | §1.2 |
175+
| 👤 XID inception key | Signs XID document updates | XID itself | §1.3 |
176176
| 🗣️ Attestation key | Signs attestations | XID key list | §2.1 |
177177
| 🖋️ SSH signing key | Signs Git commits | GitHub account | §3.1 |
178178

@@ -521,7 +521,7 @@ what each version contains
521521

522522
| XID Version | New Content | Created In |
523523
|-------------|-------------|------------|
524-
| seq 0 | 👤 Identity | §1.2+§1.3 |
524+
| seq 0 | 👤 Identity | §1.3+§1.4 |
525525
| seq 1 | 🔑 Attestation Key | §2.1 |
526526
| seq 2 | 🗣️ GitHub Edge | §3.1 |
527527

docs/03_2_Supporting_Cross_Verification.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -358,7 +358,7 @@ piece plays a role in the verification chain that they're about to build.
358358
DevReviewer now needs to extract the SSH public keys (and other
359359
information) that they'll use for the purpose of cross-verification.
360360

361-
[§1.3](01_3_Making_a_XID_Verifiable.md) briefly talked about how to
361+
[§1.4](01_4_Making_a_XID_Verifiable.md) briefly talked about how to
362362
extract data from a XID. Generally, you need to iteratively cut an
363363
envelope down to the point where you just have a subject and a set of
364364
assertions, and then pull out the assertions that you want. (Again,
@@ -736,7 +736,7 @@ This is courtesy of a chain of evidence, much of which was locked down in this s
736736

737737
| ⛓️ Evidence | Verification | Section |
738738
|----------|--------------|---------|
739-
| 🔗 derefenceVia URL | URL is on GitHub | §1.3 |
739+
| 🔗 derefenceVia URL | URL is on GitHub | §1.4 |
740740
| 🌌 Galaxy PR | PR Exists | §2.1 |
741741
| 👀 Cryptographic Audit Work | Previous Commitment | §2.2 |
742742
| 🔐 Security Work for Civil Trust | Similar PRs | §2.3 |

docs/03_3_Creating_Peer_Endorsements.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -551,7 +551,7 @@ each version contains
551551

552552
| XID Version | New Content | Created In |
553553
|-------------|-------------|------------|
554-
| seq 0 | 👤 Identity | §1.2+§1.3 |
554+
| seq 0 | 👤 Identity | §1.3+§1.4 |
555555
| seq 1 | 🔑 Attestation Key | §2.1 |
556556
| seq 2 | 🗣️ GitHub Edge | §3.1 |
557557
| seq 3 | 🗣️ Endorsement Edge | §3.3 |
@@ -812,8 +812,8 @@ self-attestations.
812812

813813
At this point, Amira has built a succession of progressive trust layers:
814814

815-
1. [§1.2](01_2_Your_First_XID.md): Self-sovereign identity (XID exists)
816-
2. [§1.3](01_3_Making_a_XID_Verifiable.md): Self-consistent (signature verifies, fresh)
815+
1. [§1.3](01_3_Your_First_XID.md): Self-sovereign identity (XID exists)
816+
2. [§1.4](01_4_Making_a_XID_Verifiable.md): Self-consistent (signature verifies, fresh)
817817
3. [§2.1](02_1_Creating_Self_Attestations.md): Fair-witness claims (public, verifiable claims)
818818
4. [§2.2](02_2_Managing_Claims_Elision.md): Medium sensitive claims managed (commit elided, reveal later)
819819
5. [§2.3](02_3_Managing_Claims_Encryption.md) High sensitive claims managed (encrypted, sent to trusted parties)

0 commit comments

Comments
 (0)