mochi/docs/middleware/torrent_approval.md

Approved torrents list

Package torrentapproval can be used for only allow or block specified hashes or block specified hashes.

Functionality

As said above, there are two modes of approval: white list and black list.

If mode is white list (invert set to false), tracker works in semi-private mode, which means, than peers can could share and receive info about only specified list of torrents' hashes.

I.e.: if configuration contains hash AAAA, but peer announces hash BBBB tracker will return unapproved torrent message back to peer.

If mode is black list (invert set to true), tracker will allow all hashes except specified.

Hash sources

There are two sources of hashes: list and directory.

• list is the static set of hashes, specified in configuration file.

• directory will watch for *.torrent files in specified path and append/delete records from storage. This source will parse all existing files at start and then periodically watch for new files to add, or for delete events to remove hash from storage.

• s3 will search for torrent files in specified S3-compatible storage (AWS S3, MinIO, etc.) and append/delete records from storage. This source will parse all existing files at start and then periodically watch for new files to add, or for delete events to remove hash from storage.

Note: if storage is not memory, and preserve option set to true, records will be persisted in storage until somebody or something (different tool with access to storage) won't delete it.

Configuration

This middleware provides the following parameters for configuration:

• initial_source - source type: list or directory
• storage - storage configuration to store data, structure is same as global storage section. If name is empty or internal global storage will be used
• configuration - options for specified source
  • list:
    • hash_list - list of HEX encoded hashes
    • invert - working mode: true - black list, false - white list
    • storage_ctx - name of storage context where to store data. It may be redis hash key, DB table name etc.
  • directory:
    • path - directory to watch
    • period - time between two directory checks
    • invert and storage_ctx has the same meaning as list's options
  • s3:
    • endpoint* - base URL of S3 provider
    • region* - S3 region to connect to
    • key_id* - S3 access key ID
    • key_secret* - S3 secret access key
    • session_token* - S3 temporary security credential
    • bucket - S3 bucket
    • prefix - prefix path to search entries
    • suffix - suffix to filter returned entries, such as extension (e.g. .torrent)
    • period - time between two S3 checks
    • invert and storage_ctx has the same meaning as list's options

Note: s3 options marked with * and any other specific options can be omitted in MoChi and can be provided with environment variables or in $HOME/.aws/* files (see AWS SDK documentation).

Configuration example:

An example config might look like this:

mochi:
    prehooks:
        -   name: torrent approval
                options:
                    initial_source: list
					storage:
						name: internal
						config:
                    configuration:
                        hash_list: [ "AAA", "BBB" ]
						path: "some/path"
						period: 1m
                        invert: false
                        storage_ctx: APPROVED_HASH