Skip to content

Latest commit

 

History

History

proxy-blocks

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
README.md
README.md
 
 
main.go
main.go
 
 
main_test.go
main_test.go
 
 

README.md

Gateway as a Verifying Proxy for Untrusted Remote Blockstore

This is an example of building a Gateway that uses application/vnd.ipld.raw responses from another gateway acting as a remote blockstore and IPNS resolver.

Key benefits:

  1. Verifies raw blocks and IPNS records fetched from untrusted third-party gateways.
  2. The proxy provides web gateway functionalities: returns deserialized files and websites, including index.html support, while the remote gateway only needs to support block responses.

In this example, we implement two major structures:

  • Block Store, which forwards the block requests to the backend gateway using ?format=raw, and
  • Routing System, which forwards the IPNS requests to the backend gateway using ?format=ipns-record. In addition, DNSLink lookups are done locally.
    • Note: ipns-record was introduced just recently in IPIP-351 and reference support for it will ship in Kubo 0.19. Until that happens, it may not be supported by public gateways yet.

Build

> go build -o gateway

Usage

First, you need a compliant gateway that supports both RAW Block and IPNS Record response types. Once you have it, run the proxy gateway with its address as the host parameter:

./gateway -g https://trustless-gateway.link -p 8040

Subdomain gateway

Now you can access the gateway in localhost:8040. It will behave like a regular Subdomain IPFS Gateway, except for the fact that it runs no libp2p, and has no local blockstore. All contents are provided by a remote gateway and fetched as RAW Blocks and Records, and verified locally.

Path gateway

If you don't need Origin isolation and only care about hosting flat files, a plain path gateway at 127.0.0.1:8040 may suffice.

DNSLink gateway

Gateway supports hosting of DNSLink websites. All you need is to pass Host header with FQDN that has DNSLink set up:

$ curl -sH 'Host: en.wikipedia-on-ipfs.org' 'http://127.0.0.1:8080/wiki/' | head -3
<!DOCTYPE html><html class="client-js"><head>
  <meta charset="UTF-8">
  <title>Wikipedia, the free encyclopedia</title>

Put it behind a reverse proxy terminating TLS (like Nginx) and voila!