Skip to content

Commit

Permalink
upd readme
Browse files Browse the repository at this point in the history
  • Loading branch information
randomlogin committed Sep 4, 2024
1 parent efb0b44 commit 9d6149b
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 3 deletions.
12 changes: 10 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@ is correct and then outputs a self-signed certificate (signed by local certifica

### hnsd
Internally it uses hnsd to sync tree roots. The initial syncronization might take several minutes. Afterwards, using
checkpoints, hnsd has to syncrhonize last ~2k roots which usually takes 5 seconds. After synchronization, hnsd is
terminated.
checkpoints, hnsd has to syncrhonize last ~2k roots which usually takes 5 seconds. After synchronization, hnsd is terminated.

Internal hnsd daemon has `5350` as a default port.

Expand Down Expand Up @@ -77,6 +76,11 @@ Additional arguments can be viewed by invoking help:
./sane --help
```

There are several public community-hosted external services:
- https://sdaneproofs.htools.work/proofs/ (@rithvikvibhu)
- https://sdaneproofs.woodburn.au/proofs (@nathanwoodburn)
- https://sdaneproofs.shakestation.io/proofs

### Urkel tree
SANE looks for an extension in the certificate which contains an urkel tree proof, verifies it, checks if the root is not
older than a week.\
Expand All @@ -86,6 +90,10 @@ Native [golang implementation of urkel tree](https://github.com/nodech/go-hsd-ut
Another extension from the certificate contains DNSSEC verifiation chain. Its verification is done locally using
[getdns](https://getdnsapi.net/), it does not call any resolvers.

### External service

It allows the owner of the website not to update their ceritificate each week with the new proofs, but


### Browser settings
- Add SANE proxy to your web browser `127.0.0.1:8080` ([Firefox example](https://user-images.githubusercontent.com/41967894/117558156-8f5b2a00-b02f-11eb-98ba-91ce8a9bdd4a.png))
Expand Down
2 changes: 1 addition & 1 deletion cmd/sane/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ var (
hnsdPath = flag.String("hnsd", os.Getenv("HNSD_PATH"), "path to hnsd executable, also may be set as environment variable HNSD_PATH")
hnsdCheckpointPath = flag.String("checkpoint", "", "path to hnsd checkpoint location, default ~/.hnsd")
resyncInterval = flag.Duration("resync-interval", 24*time.Hour, "interval for roots resyncronization")
externalService = flag.String("external-service", "", "uri to an external service providing SANE data, can be a comma-separated list")
externalService = flag.String("external-service", "", "uri to an external service providing SANE data, comma-separated list of URIs")
)

func getConfPath() string {
Expand Down

0 comments on commit 9d6149b

Please sign in to comment.