Skip to content

Overhaul tracker keys in torrents and magnet links#494

Merged
josecelano merged 6 commits intotorrust:developfrom
josecelano:488-overhaul-tracker-keys-in-torrents
Feb 23, 2024
Merged

Overhaul tracker keys in torrents and magnet links#494
josecelano merged 6 commits intotorrust:developfrom
josecelano:488-overhaul-tracker-keys-in-torrents

Conversation

@josecelano
Copy link
Copy Markdown
Member

@josecelano josecelano commented Feb 23, 2024 •
edited
Loading 

1. Tracker running in `Public` or `Whitelisted` mode. 
   Downloaded torrents should never include any tracker key.
3. Tracker running in `Private` or `PrivateListed` mode.
   2.1 Guest user. 
       Downloaded torrents should never include any tracker key.
   2.2 Authenticated user
       2.2.1 Index can get the tracker user's key (from the Index database or generate new ones).
             - We should include the user's tracker key.
             - We should change the download torrent button label from `download torrent` to `download private torrent` (this is an Idex GUI issue).
       2.2.2 The user's tracker key is expired and the tracker API is unavailable (can't generate a new one).
             Return a `503 Service Unavailable` response with the text `Can't generate user's tracker key`.

Subtasks

  • Never include keys in the downloaded torrent file when the tracker is open (public or public-whitelisted).
  • Never include keys in the magnet link when the tracker is open (public or public-whitelisted).
  • Return an error when we can't connect to the tracker to generate the user's keys. Both for the download torrent endpoint and torrent details endpoint (magnet link).
  • Return 503 instead of 500 when the tracker is offline and for example we can not generate the user's tracker keys.
  • Removed duplicate URLs in the tracker lists. Both torrent file and torrent info endpoints.
  • Force the main tracker URL (the one in the tracker config) to be the first in the tracker lists, both in the tracker torrent file endpoint and the torrent details endpoint.
  • Panic starting the application with an invalid racker configuration. For example: private UDP tracker.

Subtasks in the Index GUI

@josecelano josecelano linked an issue Feb 23, 2024 that may be closed by this pull request
Overhaul tracker keys in torrents and magnet links #488
Closed
@josecelano josecelano self-assigned this Feb 23, 2024
@josecelano josecelano added Bug Incorrect Behavior Enhancement / Feature Request Something New labels Feb 23, 2024
@josecelano josecelano force-pushed the 488-overhaul-tracker-keys-in-torrents branch from 8cab267 to 10b3670 Compare February 23, 2024 12:42
@josecelano
Copy link
Copy Markdown
Member Author

josecelano commented Feb 23, 2024 •
edited
Loading

It's not easy to test this new behavior because the current test is using the "shared" env which uses a public tracker. I should run a second env with a private tracker but I think that's too complex. I would prefer to test this functionality with unit tests. The problem is the torrust_index::services::torrent::Index service is too big. Maybe we could refactor it to a command/handler pattern.

For the time being, I will test manually and remove the E2E test for the personal announce URL.

cc @WarmBeer @da2ce7

@josecelano josecelano force-pushed the 488-overhaul-tracker-keys-in-torrents branch from 10b3670 to bc509f4 Compare February 23, 2024 15:53
@josecelano josecelano force-pushed the 488-overhaul-tracker-keys-in-torrents branch from bc509f4 to a67c39b Compare February 23, 2024 16:27
@josecelano
fix: [torrust#488] torrent without tracker keys for open tracker
b41488b 
Tracker HTTP URL: http://localhost:7070

- announce: "http://localhost:7070".
- announce_list: "http://localhost:7070" and keeps the original URLs in the uploaded torrent.

Tracker UDP URL: udp://localhost:6969

- announce: "udp://localhost:7070".
- announce_list: "udp://localhost:7070" and keeps the original URLs in the uploaded torrent.

Tracker HTTP URL: http://localhost:7070

- announce: "http://localhost:7070/**KEY**".
- announce_list: "http://localhost:7070/**KEY**" and keeps the original URLs in the uploaded torrent.

Tracker UDP URL: udp://localhost:6969

- announce: "udp://localhost:7070/**KEY**".
- announce_list: "udp://localhost:7070/**KEY**" and keeps the original URLs in the uploaded torrent.

It returns an 505 error if it can't get the user's tracker keys.

TODO:

- The application should not start with close tracker and UDP url in the
  configuration.
- The API should return 503 instead of 500 when it can't connect to the
  tracker.
@josecelano
feat: [torrust#488] return an error in the torrent details endpoint w…
c1fd866 
…hen user tracker keys can't be generated
@josecelano josecelano force-pushed the 488-overhaul-tracker-keys-in-torrents branch from a67c39b to c1fd866 Compare February 23, 2024 16:36
@josecelano josecelano force-pushed the 488-overhaul-tracker-keys-in-torrents branch from f2bea54 to d100b5b Compare February 23, 2024 17:58
@josecelano
feat!: [torrust#488] return 503 instead of 500 when tracker is offline
b8624a8 
when the Index needs to make a request to the Tracker API and is not
available.
@josecelano
feat: [torrust#488] panic starting the app when tracker config is inv…
9b7c5c8 
…alid

For the time being, it only checks that private tracker don't use UDP.
@josecelano josecelano marked this pull request as ready for review February 23, 2024 18:25
@josecelano
Copy link
Copy Markdown
Member Author

josecelano commented Feb 23, 2024

ACK 9b7c5c8

@josecelano josecelano mentioned this pull request Feb 23, 2024
Closed
@josecelano josecelano added this to the v3.0.0 milestone Feb 23, 2024
@josecelano josecelano merged commit fbe8455 into torrust:develop Feb 23, 2024
@josecelano josecelano mentioned this pull request Feb 26, 2024
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@da2ce7 da2ce7 Awaiting requested review from da2ce7

@mickvandijke mickvandijke Awaiting requested review from mickvandijke

Assignees

@josecelano josecelano

Labels

Bug Incorrect Behavior Enhancement / Feature Request Something New

Projects

None yet

Milestone

v3.0.0

Development

Successfully merging this pull request may close these issues.

Overhaul tracker keys in torrents and magnet links

1 participant

@josecelano