Publish a BEP explaining how to add support for WebTorrent #881

yciabaud · 2016-08-08T10:13:01Z

This PR proposes a BEP document as discussed in #168

I would like to have some feedback on the content and on some changes I made in the messages.
I changed some properties to have a cleaner protocol, if we keep it, we will have to update bittorrent-tracker to fit with this document.

You can view the html output on github: https://github.com/yciabaud/webtorrent/blob/486a94d2b651e7aed86ba27b82e679f5d1d1e700/bep_webrtc.rst

@feross @DiegoRBaquero @bbarrows

yciabaud · 2016-08-08T10:15:30Z

bep_webrtc.rst

+
+  {
+    "announce": "",
+    "info_hash": "",


I changed the scrape response format from "infoHash" to "info_hash" to be consistent with the other messages.

Actually I "think" (still not sure) that the response is created here : https://github.com/feross/bittorrent-tracker/blob/master/server.js#L698-L701, and that the "infoHash" field is used as a key in the forEachloop when creating a new entry in files list.

To me, it seems that either for a single or multi scrape request the response will contains a field list where the keys are the info_hash and the value an object with the stats of the related swarm.

lmatteis · 2016-08-20T15:27:10Z

I'm a bit confused. So trackers supporting this would be able to track IP addresses of "normal" clients and also WebRTC contacts, right? That's cool but if WebRTC tabs can't connect to current BitTorrent client nodes (because most torrent clients don't support WebRTC), what's the point?

yciabaud · 2016-08-21T08:32:04Z

The point of this BEP is to document the process of signalling webrtc peers on a tracker to connect each other.

Aside from the tracker implementation, the clients supporting this would become hybrid clients and could use webrtc to connect to browser clients.

This would help a lot to make bittorrent content available in webtorrent network.

Do you understand now? Do you have an idea to make it clearer for a reader to understand what we are aiming?

yciabaud · 2016-08-21T08:34:01Z

The point is to make clients support webrtc by giving them a standard documentation ;)

DiegoRBaquero · 2016-08-21T17:49:55Z

Just read it all. It's very technical to the point of a BEP. Is there any place where I can see the guideline for a BEP?

Looking good @yciabaud

yciabaud · 2016-08-21T18:29:21Z

Thank you for reviewing @DiegoRBaquero.
This page details the BEP process: http://www.bittorrent.org/beps/bep_0001.html, some other guidelines can be found in http://www.bittorrent.org/beps/bep_0002.html

austlane · 2016-08-28T23:06:02Z

@yciabaud Thanks so much for writing this up. Looks detailed and well done!
I've been following this project for a number of years, hoping feross would do this sooner rather than later.

yciabaud · 2016-08-29T06:26:02Z

Thank you very much @austlane, lets hope we will push that to bittorrent soon!

yciabaud · 2016-08-29T07:32:22Z

bep_webrtc.rst

+  {
+    "action":   "error"
+    "message":  ""
+  }


I changed the error response message for it to look like the other messages like in other beps.

Tbh, I think that both failure reason and an extra error field are necesseray. The first one wpuld stay for legacy reasons and would be used only for Bittorrent protocol related failures (either announce or scrape) while another extra field (or object, with code/message ?) could describe a signalling error.

wI2L · 2016-10-11T13:51:13Z

@yciabaud Just to clarify, is this BEP based on the actual implementation ? I couldn't find the error message you describe in the source code of the bittorrent-tracker project, instead it send back a failure reason key.

yciabaud · 2016-10-11T14:40:22Z

@wI2L I made some changes that I have commented inline in this PR. You are right, ATM the errors are labelled with failure reason.

I changed a bit some of the payloads too, all changes are inline commented.

wI2L · 2016-10-11T15:32:06Z

@yciabaud Ok. I have added comments on some.
While reading the source of bittorrent-tracker I have noticed the use of common.hexToBinary (for info_hash) and I am not sure of how to interpret that. Like I have mentionned it in our mail exchanges, the "type" of each field could be described.
Also, the websocket protocol describes binary and text messages. it may be necessary to define what kind of messages are supposed to be sent and read ?

EDIT: Messages are text, but encoding of info_hash and peer_id fields is binary. What is the reason behind that? This should be mentionned in the BEP.

wI2L · 2016-10-11T19:09:35Z

bep_webrtc.rst

+    "uploaded":   0,
+    "downloaded": 0,
+    "left":       0,
+    "event":      "",


Analyzing a bit the payloads from wss://tracker.openwebtorrent.com/, this field is not present for announce done at regular intervals. However, for consistency with the BT protocol it should be mentionned that a missing event, or an event that is represented by an empty string is one of those made at regular intervals.

wI2L · 2016-10-11T19:14:54Z

bep_webrtc.rst

+    "offer_id":   "",
+    "peer_id":    "",
+    "to_peer_id":    "",
+    "answer":     ""


answer is an object with the fields type and sdp.

yciabaud · 2016-10-12T17:07:13Z

Thanks @wI2L for these reviews, I agree that the types of the fields must be added to the BEP.
I will try to find a moment to work again on this.

wI2L · 2016-10-12T17:27:24Z

np @yciabaud
Also, I was wondering if the BEP should indicates how a BitTorrent tracker answer to a Webclient before the connection is actually upgraded to the Websocket protocol, in case of errors.
A standard tracker send back a bencoded dict with a failure reason key, with status code 200.

Miserlou · 2016-10-23T18:15:18Z

bep_webrtc.rst

+--------
+The websocket tracker uses JSON payloads reflecting the HTTP request parameters
+and an additionnal action property used to switch between announce and other
+actions (ex. scrape). If the announce URL of the torrent contains the ws or wss


I STRONGLY recommend that we formally drop support for insecure websockets. It's almost 2017, there is no reason to introduce a potential security vulnerability or vector for surveillance. Especially with Let's Encrypt available for free, there is simply no excuse for running an insecure public service. WebRTC itself already disallows insecure connections, we should incorporate that momentum into this BEP.

I suggest we change this explicitly disallow 'ws' and only allow 'wss' here.

wI2L · 2016-11-06T01:32:20Z

bep_webrtc.rst

+
+  {
+    "ih1": {
+      "announce": "",


According to https://github.com/feross/bittorrent-tracker/blob/master/server.js#L691-L695 and https://github.com/feross/bittorrent-tracker/blob/master/server.js#L698-L701, there is no shuch field announce.

wI2L · 2016-11-06T01:33:44Z

bep_webrtc.rst

+scrape response::
+
+  {
+    "announce": "",


According to https://github.com/feross/bittorrent-tracker/blob/master/server.js#L677-L680, there is no such field announce.

DiegoRBaquero · 2017-05-24T14:37:20Z

Is there anything missing so this can be sent?

wI2L · 2017-05-24T15:27:29Z

@DiegoRBaquero Depends, would you like with @feross and @yciabaud to address my proposals I have made in the PR here: yciabaud#1
There is two ideas, publish a document that describes the actual state of the protocol, which could be done by finishing/polishing the original draft of @yciabaud or discuss furthermore about the changes I intoduced in favor of a more comprehensive protocol.

stale · 2018-08-02T00:02:15Z

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.

rom1504 · 2018-08-03T07:13:44Z

Why is this blocked ? It seems important for webtorrent and isn't most of the work already done ?

stale · 2019-02-06T17:35:28Z

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.

feross · 2019-08-03T21:00:27Z

Unlocking and re-opening this.

yciabaud added 3 commits August 8, 2016 12:07

First revision of the webtorrent BEP!

a85a200

Typos and to_peer_id property

ab730e7

Fix footnote ref

486a94d

yciabaud reviewed Aug 8, 2016
View reviewed changes

yciabaud mentioned this pull request Aug 8, 2016

Publish a BEP explaining how to add support for WebTorrent #168

Open

Change the error response to have an action prop

0544a16

yciabaud reviewed Aug 29, 2016
View reviewed changes

wI2L reviewed Oct 11, 2016

View reviewed changes

bep_webrtc.rst

"offer_id": "",

"peer_id": "",

"to_peer_id": "",

"answer": ""

Copy link

wI2L Oct 11, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

answer is an object with the fields type and sdp.

Miserlou reviewed Oct 23, 2016

View reviewed changes

wI2L reviewed Nov 6, 2016

View reviewed changes

yciabaud mentioned this pull request Nov 15, 2016

Add WebRTC support to popular torrent clients #369

Open

9 tasks

stale bot added the stale label May 3, 2018

webtorrent deleted a comment from stale bot May 3, 2018

stale bot removed the stale label May 3, 2018

stale bot added the stale label Aug 2, 2018

stale bot removed the stale label Aug 3, 2018

jimmywarting mentioned this pull request Aug 28, 2018

Support webrtc for webtorrent clients transmission/transmission#47

Open

stale bot added the stale label Nov 1, 2018

stale bot closed this Nov 8, 2018

DiegoRBaquero reopened this Nov 8, 2018

stale bot removed the stale label Nov 8, 2018

webtorrent deleted a comment from stale bot Nov 8, 2018

stale bot added the stale label Feb 6, 2019

stale bot closed this Feb 13, 2019

lock bot locked as resolved and limited conversation to collaborators May 14, 2019

wI2L mentioned this pull request Jul 24, 2019

Use Hex encoding for infohashes and offers IDs in tracker protocol. #1676

Open

webtorrent unlocked this conversation Aug 3, 2019

feross reopened this Aug 3, 2019

stale bot removed the stale label Aug 3, 2019

lock bot locked as resolved and limited conversation to collaborators Aug 3, 2019

feross added the meta label Aug 3, 2019

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Publish a BEP explaining how to add support for WebTorrent #881

Publish a BEP explaining how to add support for WebTorrent #881

yciabaud commented Aug 8, 2016 •

edited

yciabaud Aug 8, 2016 •

edited

wI2L Nov 6, 2016 •

edited

lmatteis commented Aug 20, 2016 •

edited

yciabaud commented Aug 21, 2016

yciabaud commented Aug 21, 2016

DiegoRBaquero commented Aug 21, 2016

yciabaud commented Aug 21, 2016 •

edited

austlane commented Aug 28, 2016

yciabaud commented Aug 29, 2016

yciabaud Aug 29, 2016

wI2L Oct 11, 2016

wI2L commented Oct 11, 2016

yciabaud commented Oct 11, 2016

wI2L commented Oct 11, 2016 •

edited

wI2L Oct 11, 2016

wI2L Oct 11, 2016

yciabaud commented Oct 12, 2016

wI2L commented Oct 12, 2016

Miserlou Oct 23, 2016

wI2L Nov 6, 2016 •

edited

wI2L Nov 6, 2016

DiegoRBaquero commented May 24, 2017

wI2L commented May 24, 2017

stale bot commented Aug 2, 2018

rom1504 commented Aug 3, 2018

stale bot commented Feb 6, 2019

feross commented Aug 3, 2019

Publish a BEP explaining how to add support for WebTorrent #881

Are you sure you want to change the base?

Publish a BEP explaining how to add support for WebTorrent #881

Conversation

yciabaud commented Aug 8, 2016 • edited

yciabaud Aug 8, 2016 • edited

Choose a reason for hiding this comment

wI2L Nov 6, 2016 • edited

Choose a reason for hiding this comment

lmatteis commented Aug 20, 2016 • edited

yciabaud commented Aug 21, 2016

yciabaud commented Aug 21, 2016

DiegoRBaquero commented Aug 21, 2016

yciabaud commented Aug 21, 2016 • edited

austlane commented Aug 28, 2016

yciabaud commented Aug 29, 2016

yciabaud Aug 29, 2016

Choose a reason for hiding this comment

wI2L Oct 11, 2016

Choose a reason for hiding this comment

wI2L commented Oct 11, 2016

yciabaud commented Oct 11, 2016

wI2L commented Oct 11, 2016 • edited

wI2L Oct 11, 2016

Choose a reason for hiding this comment

wI2L Oct 11, 2016

Choose a reason for hiding this comment

yciabaud commented Oct 12, 2016

wI2L commented Oct 12, 2016

Miserlou Oct 23, 2016

Choose a reason for hiding this comment

wI2L Nov 6, 2016 • edited

Choose a reason for hiding this comment

wI2L Nov 6, 2016

Choose a reason for hiding this comment

DiegoRBaquero commented May 24, 2017

wI2L commented May 24, 2017

stale bot commented Aug 2, 2018

rom1504 commented Aug 3, 2018

stale bot commented Feb 6, 2019

feross commented Aug 3, 2019

yciabaud commented Aug 8, 2016 •

edited

yciabaud Aug 8, 2016 •

edited

wI2L Nov 6, 2016 •

edited

lmatteis commented Aug 20, 2016 •

edited

yciabaud commented Aug 21, 2016 •

edited

wI2L commented Oct 11, 2016 •

edited

wI2L Nov 6, 2016 •

edited