BTIP-79: Support filtering specific CIDs when accessing CIDs via the gateway.

BTIP: 79
title: Support filtering specific CIDs when accessing CIDs via the gateway
author: codymeng<[email protected]>
discussions-to: https://github.com/bittorrent/BTIPs/issues/79
status: Review
last-call-deadline: 2024-12-09
type: Client API
category (*only required for Core Protocol):
created: 2024-11-28

Simple Summary

Implement one command to add CIDs to the database and several other commands to view and remove these CIDs. This solution will filter out the added CIDs and make their associated files inaccessible when users attempt to access CIDs via the gateway.

Abstract

Provide an effective solution to restrict user access to specific CIDs via the gateway.

Motivation

Users may wish to avoid certain CID files that could pose risks to them when accessing publicly available CIDs through API gateways. The proposed feature prevents access to these files without requiring their removal from the BTFS network.

Specification

related commands

1. add cid

btfs cidstore add <cid>

2. del cid

btfs cidstore del <cid>

3. list cid

btfs cidstore list

4. has cid

btfs cidstore has <cid>

Rationale

The command provides a convenient way to manage CIDs that need to be filtered in the gateway.

Backwards Compatibility

This new feature is backward-compatible and won’t cause breaking changes.