Skip to content

Commit 29b7640

Browse files
committed
docs(trustless-gateway): merge main, fix p2p security wording
- align transport security with SHOULD (not MUST) per transport section - fix connection coalescing direction (origins->server, not reverse) - replace "path traversal attacks" with actual DAG-related threats
2 parents 81accd9 + cbd6ae2 commit 29b7640

File tree

9 files changed

+683
-43
lines changed

9 files changed

+683
-43
lines changed

.github/workflows/deploy.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,8 +46,8 @@ jobs:
4646
cluster-url: "/dnsaddr/ipfs-websites.collab.ipfscluster.io"
4747
cluster-user: ${{ secrets.CLUSTER_USER }}
4848
cluster-password: ${{ secrets.CLUSTER_PASSWORD }}
49-
storacha-key: ${{ secrets.STORACHA_KEY }}
50-
storacha-proof: ${{ secrets.STORACHA_PROOF }}
49+
#TODO storacha-key: ${{ secrets.STORACHA_KEY }}
50+
#TODO storacha-proof: ${{ secrets.STORACHA_PROOF }}
5151
#TODO pinata-jwt-token: ${{ secrets.PINATA_JWT_TOKEN }}
5252
github-token: ${{ github.token }}
5353

ARCHITECTURE.md

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# ![](https://img.shields.io/badge/status-wip-orange.svg?style=flat-square) IPFS Architecture Overview
1+
# ![status: deprecated](https://img.shields.io/badge/status-deprecated-red.svg?style=flat-square) IPFS Architecture Overview
22

33
> [!NOTE]
44
> This document contains historical notes about IPFS architecture from ~2015. For current specifications, please refer to https://specs.ipfs.tech/
@@ -12,20 +12,20 @@
1212

1313
* * *
1414

15-
**Abstract**
15+
## Abstract
1616

1717
This spec document defines the IPFS protocol stack, the subsystems, the interfaces, and how it all fits together. It delegates non-interface details to other specs as much as possible. This is meant as a top-level view of the protocol and how the system fits together.
1818

1919
Note, this document is not meant to be an introduction of the concepts in IPFS and is not recommended as a first pass to understanding how IPFS works. For that, please refer to the [IPFS paper](https://github.com/ipfs/papers/raw/master/ipfs-cap2pfs/ipfs-p2p-file-system.pdf).
2020

2121
# Table of Contents
2222

23-
- 1. IPFS and the Merkle DAG
24-
- 2. Nodes and Network Model
25-
- 3. The Stack
26-
- 4. Applications and data structures -- on top of IPFS
27-
- 5. Lifetime of fetching an object
28-
- 6. IPFS User Interfaces
23+
1. IPFS and the Merkle DAG
24+
1. Nodes and Network Model
25+
1. The Stack
26+
1. Applications and data structures -- on top of IPFS
27+
1. Lifetime of fetching an object
28+
1. IPFS User Interfaces
2929

3030
# 1. IPFS and the Merkle DAG
3131

@@ -48,7 +48,6 @@ In turn, these yield properties for the system as a whole:
4848

4949
IPFS is a stack of network protocols that organize agent networks to create, publish, distribute, serve, and download merkledags. It is the authenticated, decentralized, permanent web.
5050

51-
5251
# 2. Nodes and Network Model
5352

5453
The IPFS network uses PKI based identity. An "ipfs node" is a program that can find, publish, and replicate merkledag objects. Its identity is defined by a private key. Specifically:
@@ -72,7 +71,6 @@ sha2-512
7271
sha3
7372
```
7473

75-
7674
# 3. The Stack
7775

7876
IPFS has a stack of modular protocols. Each layer may have multiple implementations, all in different modules. This spec will only address the interfaces between the layers, and briefly mention possible implementations. Details are left to the other specs.
@@ -85,7 +83,7 @@ IPFS has five layers:
8583
- **routing** - locating peers and objects
8684
- **network** - establishing connections between peers
8785

88-
![](img/ipfs-stack.png)
86+
![IPFS protocol stack](img/ipfs-stack.png)
8987

9088
These are briefly described bottom-up.
9189

@@ -165,7 +163,7 @@ The merkledag is enough to resolve paths:
165163

166164
See more in the [path resolution spec](https://github.com/ipld/specs/blob/master/data-model-layer/paths.md).
167165

168-
![](img/ipfs-resolve/ipfs-resolve.gif)
166+
![IPFS path resolution](img/ipfs-resolve/ipfs-resolve.gif)
169167

170168
## 3.5 Naming -- PKI namespace and mutable pointers
171169

@@ -196,7 +194,7 @@ The unix filesystem abstractions -- files and directories -- are the main way pe
196194

197195
See more in the [unixfs spec](https://github.com/ipfs/specs/blob/master/UNIXFS.md).
198196

199-
## 5. Lifetime of fetching an object.
197+
## 5. Lifetime of fetching an object
200198

201199
Suppose we ask an IPFS node to retrieve
202200

@@ -225,7 +223,7 @@ IPFS is not just a protocol. It is also a toolset. IPFS implementations include
225223

226224
* * *
227225

228-
# WIP Stack Dump:
226+
# WIP Stack Dump
229227

230228
- How the layers fit together
231229
- How they call on each other

0 commit comments

Comments
 (0)