Commit Graph

469 Commits

Author SHA1 Message Date
Oskar Thorén 3c53953b0e
Swap - add game theory / donations game section (#290)
* Add game theory section

* Address review comments

* Bump alpha

* add book of swarm reference
2021-02-19 11:07:08 +08:00
Oskar Thorén 5da4474fe4
Improve README (#289)
* Improve README

* Fix more links

* Add rln relay, swap and v2 rpc api; fix links

* Update README.md

Co-authored-by: Sanaz Taheri Boshrooyeh <35961250+staheri14@users.noreply.github.com>

Co-authored-by: Sanaz Taheri Boshrooyeh <35961250+staheri14@users.noreply.github.com>
2021-02-18 12:11:51 +08:00
Sanaz Taheri Boshrooyeh b6a965ca70
Summarizing the security features/considerations of Waku v2 (#283)
* WIP: adds the security section, adversarial model and anonymity feature

* adds 3 sections: the security features, considerations, and future work

* removes some comments and adds an introductory paragraph

* fixes the changelog

* updates security considerations and future work

* minor edits

* fixes some issues

* updates wordlist

* fixes a typo

* minor

* adds todo

* edits the confidentiality part

* adds a todo

* changes the outline of security features section

* Apply suggestions from code review

Co-authored-by: Kim De Mey <kim.demey@gmail.com>
Co-authored-by: Hanno Cornelius <68783915+jm-clius@users.noreply.github.com>

* updates changelog and adversarial model title

* clarifies the definition of spam messages

* minor edit

Co-authored-by: Kim De Mey <kim.demey@gmail.com>
Co-authored-by: Hanno Cornelius <68783915+jm-clius@users.noreply.github.com>
2021-01-07 15:25:31 -08:00
Sanaz Taheri Boshrooyeh 607b153dc2
Design requirements of store and filter protocols (#285)
* adds design requirements of store and filter protocols

* Update waku-store.md

* Update waku-filter.md

* minor edit
2021-01-07 10:14:50 -08:00
Hanno Cornelius 7a03ac8658
Fix/private api fixes (#284)
* Bring Private API spec in line with implementation
2020-12-24 10:03:22 +02:00
Sanaz Taheri Boshrooyeh eaac5b9946
Security analysis of the relay protocol (#268)
* WIP: adds the security analysis file with some initial  incomplete writeup

* fixes some formatting issue

* minor

* changes a terminology

* adds the outline

* Anlysis -> Analysis

* removes old changelogs

* edits the publisher anonymity

* Minor

* incorporates the security section into the relay specs

* updates authors

* deletes the security analysis file

* adds the security requirements

* adds the adversarial model

* adds security analysis and future work

* adds a todo

* removes an empty item

* Update waku-relay.md

* adds the terminologies subsection

* adds some revisions

* adds some todos

* adds more todos

* mentions the traffic analysis attack

* minor edits on the adversarial model

* adds some clarification about the adversarial model & some final edits

* changes topicID to topic ID

* Update waku-relay.md

* adds minor clarification

* WIP: adds the security analysis file with some initial  incomplete writeup

* fixes some formatting issue

* minor

* changes a terminology

* adds the outline

* Anlysis -> Analysis

* removes old changelogs

* edits the publisher anonymity

* Minor

* incorporates the security section into the relay specs

* updates authors

* deletes the security analysis file

* adds the security requirements

* adds the adversarial model

* adds security analysis and future work

* adds a todo

* removes an empty item

* Update waku-relay.md

* adds the terminologies subsection

* adds some revisions

* adds some todos

* adds more todos

* mentions the traffic analysis attack

* minor edits on the adversarial model

* adds some clarification about the adversarial model & some final edits

* changes topicID to topic ID

* Update waku-relay.md

* adds minor clarification

* rephrases the PII

* itemizes the adversarial model

* Update waku-relay.md

* restructures, removes unsupported features, adds further clarifications

* Update waku-relay.md

* fixes some wordings

* comments out footnotes

* substitutes relay with wakurelay

* minor

* fixes a notational issue

* Update waku-relay.md

* WIP: addresses some of the comments

* WIP: clarifies upper level protocols


WIP: fixes headings issue


WIP: adds scoring function 


minor edits


updates the subscriber-topic unlinkability

* Update specs/waku/v2/waku-relay.md

Co-authored-by: Dean Eigenmann <7621705+decanus@users.noreply.github.com>

Co-authored-by: Dean Eigenmann <7621705+decanus@users.noreply.github.com>
2020-12-21 11:43:11 -08:00
Sanaz Taheri Boshrooyeh c030ee6920
Waku message security considerations (#280)
* adds security consideration

* removes the waku version for the security consideration
2020-12-21 11:25:52 -08:00
Sanaz Taheri Boshrooyeh 01f279893e
Continuation of the security analysis of the store protocol (#273)
* adds the next changelog

* restructures, adds todos, changes headings

* minor updates

* Update specs/waku/v2/waku-store.md

Co-authored-by: Oskar Thorén <ot@oskarthoren.com>

* minor edits

* Update specs/waku/v2/waku-store.md

Co-authored-by: Oskar Thorén <ot@oskarthoren.com>

* removes security analysis section

* replaces waku with wakustore

* changes the heading

* adds the security consideration

Co-authored-by: Oskar Thorén <ot@oskarthoren.com>
2020-12-21 11:22:55 -08:00
Sanaz 10d6e3080e adds the terminology and adversarial model 2020-12-21 11:16:36 -08:00
Sanaz f3411c6ec3 fixes the format 2020-12-21 11:16:36 -08:00
Sanaz 8aeb2843dc removes DoS and adds a note about privacy cost 2020-12-21 11:16:36 -08:00
Sanaz 234a326946 fixes formatting issue 2020-12-21 11:16:36 -08:00
Sanaz Taheri Boshrooyeh b993a5c364 Update specs/waku/v2/waku-filter.md
Co-authored-by: Oskar Thorén <ot@oskarthoren.com>
2020-12-21 11:16:36 -08:00
Sanaz 5fabd8402b minor update 2020-12-21 11:16:36 -08:00
Sanaz 4b66be9340 combines two todos 2020-12-21 11:16:36 -08:00
Sanaz fe8b0245d2 itemizes the adversarial model 2020-12-21 11:16:36 -08:00
Sanaz f6c3d0a039 adds changelog, updates PII definition 2020-12-21 11:16:36 -08:00
Sanaz 94b2918cf1 restructures the specs, adds more todos, re-phrases some parts 2020-12-21 11:16:36 -08:00
Sanaz 8a96814dfb rewording and adds some todos 2020-12-21 11:16:36 -08:00
Sanaz 72bb6e7eb1 adds the security analysis 2020-12-21 11:16:36 -08:00
Sanaz f48a8b7442 adds the security requirements, terminologies and the adversarial model 2020-12-21 11:16:36 -08:00
Dean Eigenmann 82c94db89f
enhancement/strict-no-sign (#278) 2020-12-17 17:06:54 +01:00
Hanno Cornelius 4f95e7c0ce
Feature/add private api (#277)
* Add Private API
2020-12-17 10:17:52 +02:00
Sanaz Taheri Boshrooyeh 29400162d4
adds mscgenjs (#275) 2020-12-15 12:38:55 +08:00
Sanaz Taheri Boshrooyeh 5d13b0e59d
Security Analysis of the Store protocol (#270)
* edits the outline to accommodate the security analysis

* adds the anonymous query feature and analysis

* adds more about the anonymous query

* adds DoS and edits the adversarial model

* fixes a formatting issue

* adds DoS abbreviation

* adds todo

* minor

* adds todo

* minor
2020-12-10 12:33:19 -08:00
Sanaz Taheri Boshrooyeh 92e81376fa
Adds the sequence diagram of rln relay (#264)
* adds the registration image

* Updates the registration seq diagram with more descriotions

* WIP: the message verification diagram

* fixes some spacing issues

* minor

* adds the routing and publishing figure

* minor

* fixes a format issue

* adds nullifier map init for all the relay nodes

* removes box borders

* returns the borders

* fixes spacing issues

* Feature/add json rpc api spec (#265)

* Minor improvements; added polling for latest messages

* internalNullifier -> nullifier, and edits on the msc figures

* edits the slash part

* updates spacing of the rln-relay figure

* edits on entities

* Update waku-rln-relay.md

* adds references to the figures in the text

* minor

* adds one more relay node to the registration fig

* Add Admin API (#267)

* Add Admin API

* Update assets/rln-relay/rln-relay.msc

Co-authored-by: Oskar Thorén <ot@oskarthoren.com>

* changes the width of figure 2

* some spacing edits and file headers

* adds the registration image

* Updates the registration seq diagram with more descriotions

* WIP: the message verification diagram

* fixes some spacing issues

* minor

* adds the routing and publishing figure

* minor

* fixes a format issue

* adds nullifier map init for all the relay nodes

* removes box borders

* returns the borders

* fixes spacing issues

* internalNullifier -> nullifier, and edits on the msc figures

* edits the slash part

* updates spacing of the rln-relay figure

* edits on entities

* Update waku-rln-relay.md

* adds references to the figures in the text

* minor

* adds one more relay node to the registration fig

* Update assets/rln-relay/rln-relay.msc

Co-authored-by: Oskar Thorén <ot@oskarthoren.com>

* changes the width of figure 2

* some spacing edits and file headers

Co-authored-by: Hanno Cornelius <68783915+jm-clius@users.noreply.github.com>
Co-authored-by: Oskar Thorén <ot@oskarthoren.com>
2020-12-07 12:52:31 +08:00
Hanno Cornelius 9463537ccc
Add Admin API (#267)
* Add Admin API
2020-12-04 09:57:27 +02:00
Hanno Cornelius 419875cc4a
Feature/add json rpc api spec (#265)
* Minor improvements; added polling for latest messages
2020-12-02 10:55:34 +02:00
Oskar Thorén 430178c55b
Minor fixes to RFC 1 (#261)
Dead link and wrong domain in yaml header
2020-11-27 18:55:11 +08:00
Hanno Cornelius 0ad848ddf4 Fix spellcheck failures 2020-11-26 11:37:24 +02:00
Hanno Cornelius 3d3f63bcaf Complete rework: naming conventions, examples, polling, etc 2020-11-26 11:37:24 +02:00
Hanno Cornelius 4109a6ff76 Formatting improvements 2020-11-26 11:37:24 +02:00
Hanno Cornelius 415a4979be Add basic functionality and spec outline 2020-11-26 11:37:24 +02:00
Sanaz Taheri Boshrooyeh 1385a5e720
fixes some formatting issue (#260)
Update waku-rln-relay.md
2020-11-25 11:36:17 +08:00
Sanaz Taheri Boshrooyeh c699583419
Spam-protected relay protocol raw spec (#254)
* WIP: adds the draft of spam-protected relay protocol


minor edits


adds minor edits


fixes minor typos

* updates wordlist

* adds some headers to the flow description

* adds the revised version

* Update waku-spam-protected-relay.md

* Delete waku-spam-protection.md

* Auto stash before merge of "spam-protection/solution-overview" and "origin/spam-protection/solution-overview"

* minor

* Update waku-spam-protected-relay.md

* minor

* updates wordlist


adds more TODOs


adds root


adds field numbers


adds the security consideration section


renames waku_rln_relay


adds note for WakuMessage protobuf


adds more TODOs
2020-11-24 17:17:41 -08:00
Dean Eigenmann a3f449925c
fix/v1-specs-stablized (#231)
* stabalized

* commit

* versions
2020-11-18 12:19:59 +01:00
Oskar Thorén 1af7dfc169
Accounting SWAP raw spec (#249)
* Inital raw accounting

* Add more to accounting spec; protobufs etc

* Elaborate on accounting, flow, policy etc
2020-11-13 14:00:14 +08:00
Oskar Thoren fdc45bb697 Add COSS RFC
Import COSS spec from unprotocols

Update shortname, editor, history and copyright

Format and link fixes

Add brief changelog notice

Update content/docs/rfcs/1/README.md

Misc fixes
2020-11-11 14:04:24 +08:00
Sanaz f875bfb1b2
Merge branch 'sanaz/pagination' 2020-11-05 11:36:39 -08:00
Sanaz Taheri Boshrooyeh 889213df67
adds commit info 2020-11-05 11:35:25 -08:00
Sanaz edc90625ff
adds pagination specs
adds some edits


fixes minor typo


WIP: integrates the pagination into store protocol


updates wordlist.txt


WIP: minor updates


updates wordlist


minor updates


updates TOC


updates the specs


fixes a typo


beta1 to beta2


deletes waku-store-pagination.md 


updates TOC with an autogenerated markdown-toc 


Update specs/waku/v2/waku-store.md

Co-authored-by: Oskar Thorén <ot@oskarthoren.com>
Update specs/waku/v2/waku-store.md

Co-authored-by: Oskar Thorén <ot@oskarthoren.com>
Update specs/waku/v2/waku-store.md

Co-authored-by: Oskar Thorén <ot@oskarthoren.com>
Update specs/waku/v2/waku-store.md

Co-authored-by: Oskar Thorén <ot@oskarthoren.com>
Update specs/waku/v2/waku-store.md

Co-authored-by: Oskar Thorén <ot@oskarthoren.com>
itemizes the message fields of HistoryRPC 


some updates


Update specs/waku/v2/waku-store.md

Co-authored-by: Dean Eigenmann <7621705+decanus@users.noreply.github.com>
WIP: initial reorganization 


WIP: shortens the pagination spec


removes some comments and adds more details to the wire spec


minor updates


beta1 to beta2


converts direction to enum


edits the Index description 


Update specs/waku/v2/waku-store.md

Co-authored-by: Oskar Thorén <ot@oskarthoren.com>
shortens the abstract


Update specs/waku/v2/waku-store.md

Co-authored-by: Oskar Thorén <ot@oskarthoren.com>
Update specs/waku/v2/waku-store.md

Co-authored-by: Oskar Thorén <ot@oskarthoren.com>
edits changelog


Update specs/waku/v2/waku-store.md

Co-authored-by: Dean Eigenmann <7621705+decanus@users.noreply.github.com>
Update specs/waku/v2/waku-store.md

Co-authored-by: Dean Eigenmann <7621705+decanus@users.noreply.github.com>
Update specs/waku/v2/waku-store.md

Co-authored-by: Dean Eigenmann <7621705+decanus@users.noreply.github.com>
Update specs/waku/v2/waku-store.md

Co-authored-by: Dean Eigenmann <7621705+decanus@users.noreply.github.com>
minor


minor


reformats the change log


Update specs/waku/v2/waku-store.md

Co-authored-by: Dean Eigenmann <7621705+decanus@users.noreply.github.com>
edits version numbers


updates the release date


removes Table of content from Table of content!
Update specs/waku/v2/waku-store.md

Co-authored-by: Kim De Mey <kim.demey@gmail.com>
edits the wordlist


explains the case where pageSize is zero


Update waku-store.md

Update waku-v2.md
adds an overview of the sorting approach


minor


Update waku-store.md
2020-11-05 11:29:17 -08:00
Dean Eigenmann e7ec3fe0fa
fix/make-version-int (#238)
* Update waku-message.md

* Update waku-message.md
2020-11-03 13:10:24 +01:00
Oskar Thorén a62e4dca21 Update CONTRIBUTING.md 2020-10-29 14:15:27 +08:00
Oskar Thoren cc8a60467a Add contributing file with lifecycle 2020-10-29 14:15:27 +08:00
Oskar Thoren 3d3f323438 Add default PubSub topic
Indicate in next version, don't release it yet (pending store and filter protocol
changes).
2020-10-28 17:44:38 +08:00
Hanno Cornelius fff669230d Add release commit ID 2020-10-28 10:19:42 +02:00
Hanno Cornelius c15ed04308 Add unsubscribing from content filters to spec 2020-10-28 10:19:42 +02:00
Oskar Thoren 6ce2219748 Release Waku Message draft 2020-10-22 18:36:59 +08:00
Oskar Thoren 0b9087b921 Waku Message draft 2020-10-22 18:36:59 +08:00
Dean Eigenmann 0b65ed5799
fix/content-topic-type (#217)
* Update waku-message.md

* Update waku-message.md

* Update waku-message.md
2020-10-20 10:22:42 +08:00