loveisgrief/muwire
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Switch to personas for search queries and altlocs. Encrypt URLs in GET and POST requests

Browse Source
This commit is contained in:
Zlatin Balevsky
2018-10-29 11:12:00 +00:00
parent b17928967d
commit e9faeb8d5f
2 changed files with 15 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
doc/design.md
View File

@ -19,15 +19,15 @@ This is similar but not equivalent to setting the maximum TTL in Gnutella to 1.
### Search result verification
Unlike Gnutella, MuWire nodes send search results over a streaming connection. This is to ensure that the Destination carried in the search result cannot be spoofed, and to make blacklisting of Destinations that return undesired results effective. To make spamming more difficult, the UI will show up to 3 search results by default from each Destination, but will give the option to display all of them. After the results have been delivered, the streaming connection is closed.
Unlike Gnutella, MuWire nodes send search results over a streaming I2P connection. This is to ensure that the persona carried in the search result cannot be spoofed, and to make blacklisting of personas that return undesired results effective. To make spamming less efficient, the UI will show up to 3 search results by default from each persona, but will give the option to display all of them. After the results have been delivered, the streaming connection is closed.
### File transfer
Files are transferred over HTTP1.1 protocol with some custom headers added for download mesh management. Files are requested with a GET request which includes the infohash of the file in the URL.
Files are transferred over HTTP1.1 protocol with some custom headerss added for download mesh management. Files are requested with a GET request which includes the infohash of the file in the URL. The URL itself is encrypted with the public key of the target persona to prevent carpet-bombing the network with GET requests.
### Mesh management
Download mesh management is identical to Gnutella, except instead of ip addresses b64 I2P destinations are used. [More information](http://rfc-gnutella.sourceforge.net/developer/tmp/download-mesh.html)
Download mesh management is identical to Gnutella, except instead of ip addresses MuWire personas are used. [More information](http://rfc-gnutella.sourceforge.net/developer/tmp/download-mesh.html)
### In-Network updates

21
doc/wire-protocol.md
View File

@ -22,6 +22,10 @@ Rejecting the handshake is done by responding with the word "REJECT", optionally
All traffic after the handshake is compressed using the same compression algorithm in Gnutella.
## Blobs in JSON
All protocol elements that are represented as blobs (personas, certificates, file names, seach terms) get Base64 encoded when transmitted as part of JSON documents.
## Internationalization support
All protocol elements that may contain non-ascii characters (file names, search terms, persona nicknames) are represented as a binary blob with the following format:
@ -31,7 +35,6 @@ bytes 1 to N: name of the charset in ASCII
bytes N+1 and N+2: unsigned length of the binary representation of the string
bytes N+3 to N+M: binary representation of the string
```
When transferred in JSON documents, this blob gets Base64-encoded.
## Persona wire format
(See the "web-of-trust" document for the definition of a MuWire persona).
@ -122,21 +125,21 @@ The opposite of Upsert - the leaf is no longer sharing the specified file. The
#### "Search"
Sent by a leaf or ultrapeer when performing a search. Contains the reply-to b64 destination for signed I2P datagrams.
Sent by a leaf or ultrapeer when performing a search. Contains the reply-to persona of the originator (base64-encoded).
```
{
type : "Search",
version: 1,
uuid: "asdf-1234..."
uuid: "asdf-1234..."
firstHop: false,
keywords : "great speeches",
keywords : "search query (i18n encoded)",
infohash: "asdfasdf...",
replyTo : "asdfasf...b64"
}
```
A search can contain either a list of keyword or the infohash if the user is looking for a specific file. If both are present, the infohash takes precedence and the keywords are ignored.
A search can contain either the query entered by the user in the UI or the infohash if the user is looking for a specific file. If both are present, the infohash takes precedence and the keyword query is ignored.
### Ultrapeer to leaf
@ -158,22 +161,22 @@ This message starts with two unsigned bytes indicating the number of patches inc
### Search results - any node to any node
Search results are sent in "results" type connection from the responder to the originator of the query. This connection is uncompressed and only Alice sends any data on it, i.e. there is no handshake. The first thing that Alice sends is the UUID of the search that generated the results. This allows Bob to drop the connection if he does not recognize that UUID. After that, Alice sends a stream containing JSON messages prefixed by two unsigned bytes indicating the length of each message. The format is the following:
Search results are sent through and HTTP POST method from the responder to the originator of the query. The URL is the UUID of the search that prompted ther response, encrypted with the public key of the originating persona. This connection is uncompressed. The first thing sent on it is the persona of the responder in binary. After that follows a stream containing JSON messages prefixed by two unsigned bytes indicating the length of each message. The format is the following:
```
{
type: "Result",
version: 1,
name: "File name",
name: "File name (i18n encoded)",
infohash: "asdfasdf..."
size: 12345,
pieceSize: 17,
hashList: [ "asdfasdf...", "asdfasdf...", ... ]
altlocs: [ "b64.1", "b64.2", ... ]
altlocs: [ "persona.1", "persona.2", ... ]
}
```
* The "hashList" list contains the list of hashes that correspond to the pieces of the file
* The "altlocs" list contains list of alternate locations in b64 format that Alice thinks may also have the file.
* The "altlocs" list contains list of alternate personas that the responder thinks may also have the file.
* The "pieceSize" field is the size of the each individual file piece (except possibly the last) in powers of 2
# HostCache protocol