62 Commits

Author SHA1 Message Date
hzrd149
f1847b56d7 Merge pull request #65 from hzrd149/list-pagination
Use cursor based pagination instead of date based pagination
2025-11-04 09:18:31 -06:00
hzrd149
0ccf399577 Merge branch 'master' into list-pagination 2025-11-04 09:17:20 -06:00
hzrd149
7efca7a2a5 Update pagination method for /list/<pubkey> endpoint 2025-11-04 09:14:33 -06:00
hzrd149
e8d0a1ec44 Merge pull request #29 from quentintaranpino/BUD07-paid-storage
BUD-07 Paid storage
2025-07-30 12:58:36 -05:00
hzrd149
847f449acf Merge branch 'master' into BUD07-paid-storage 2025-07-30 12:57:34 -05:00
hzrd149
90affdd4d9 Update to use cashu NUT-24 2025-07-30 12:55:58 -05:00
hzrd149
385913adef Merge pull request #74 from aaccioly-open-source/docs/make-file-extension-detection-mandatory
Clarify requirements around file extensions, Content-Type, Content-Length and redirection.
2025-06-23 17:41:30 -05:00
Anthony Accioly
39ce39aa4d fix: correct grammar in bud/01 redirect requirements
Co-authored-by: hzrd149 <8001706+hzrd149@users.noreply.github.com>
2025-06-23 14:21:32 +01:00
Anthony Accioly
85de0197f0 fix: correct typo in Content-Length headers description in blob retrieval documentation 2025-06-17 23:18:13 +01:00
Anthony Accioly
658c608b11 fix: update authorization event reference link in mirroring documentation 2025-06-17 23:03:27 +01:00
Anthony Accioly
b1a336fe75 Add optional file extension normalization during upload 2025-06-17 23:03:27 +01:00
Anthony Accioly
611272e251 Enhance proxying and redirection specification for blob retrieval 2025-06-17 23:03:27 +01:00
Anthony Accioly
1a085ed7bf fix: clarify Content-Type handling for blob retrieval and mirroring 2025-06-17 23:02:05 +01:00
Anthony Accioly
cacfa520dd Clarify requirements around Content-Type and Content-Length
- Specify that the server must return the MIME type in the Content-Type header for blob retrieval.
- Clarify fallback behaviour for unknown MIME types to application/octet-stream.
- Improve the description of how servers should infer MIME types and handle Content-Length for mirror requests.
2025-06-17 23:01:20 +01:00
Anthony Accioly
5ef2889547 Make type mandatory in the blob descriptor 2025-06-17 22:54:54 +01:00
hzrd149
e1299a6ce5 Merge pull request #73 from hzrd149/update-has-blob
Clarify has blob endpoint in BUD-01
2025-06-17 15:50:04 -05:00
hzrd149
6a27b156ba Merge pull request #71 from hzrd149/define-buds
Add BUD-00 to define BUDs and common language
2025-06-17 15:21:31 -05:00
hzrd149
977d0be083 explicitly require content-type and content-length 2025-06-17 15:00:33 -05:00
hzrd149
2cbdc130a0 Merge pull request #70 from hzrd149/missing-head
Add missing HEAD for CORS headers
2025-06-17 14:55:42 -05:00
hzrd149
065756a976 Merge pull request #75 from SwimmingRieux/patch-1
Fix typo: Change 'where' to 'were' in (BUD-02)
2025-06-09 18:21:24 -05:00
Sadeq
d6c2f9721f Fix typo: Change 'where' to 'were' in Blob upload and management (BUD-02) 2025-06-06 18:56:56 +03:30
hzrd149
3f2aa40eb9 Merge pull request #72 from hzrd149/clarify-bud-04
Clarify wording on BUD-04
2025-05-30 11:34:42 -05:00
hzrd149
0baee02851 add fallback to application/octet-stream 2025-05-24 12:08:00 -05:00
hzrd149
620d74c2a2 Clarify has blob endpoint in BUD-01
Require headers to be identical to get endpoint
2025-05-13 10:50:44 -05:00
hzrd149
2d1593d634 Clarify wording on BUD-04 2025-05-13 10:32:09 -05:00
hzrd149
fca1c42406 Add missing HEAD for CORS headers 2025-05-13 09:31:54 -05:00
hzrd149
66e6dcec74 Add BUD-00 to define BUDs and common language 2025-05-13 09:31:19 -05:00
hzrd149
3ae2361b41 switch to cursor and limit with optional date filters 2025-05-12 09:38:25 -05:00
hzrd149
2aa65cc373 Fix spelling mistakes 2025-04-25 08:00:47 -05:00
Quentin
542c654045 Update buds/07.md
Co-authored-by: hzrd149 <8001706+hzrd149@users.noreply.github.com>
2025-04-20 18:37:03 +02:00
hzrd149
39d1ae9e93 add alternative line for cursor based pagination 2025-03-30 10:13:35 +01:00
hzrd149
a63959f1e0 Use offset limit pagination instead of date based pagination 2025-03-30 10:02:21 +01:00
quentintaranpino
8e12280410 fix typo 2024-12-03 13:06:04 +01:00
quentintaranpino
4d9b22a96c remove recurring payments 2024-12-03 13:03:23 +01:00
Quentin
3cb8c92197 Merge branch 'master' into BUD07-paid-storage 2024-12-03 13:02:24 +01:00
Quentin
463f28da7b error handling 402->400. Special note for Head requests 2024-11-20 21:22:20 +01:00
Quentin
73fcfbfbd3 update BUD-07 2024-11-20 20:57:46 +01:00
Quentin
f9f44fc592 Update buds/07.md
Co-authored-by: hzrd149 <8001706+hzrd149@users.noreply.github.com>
2024-11-20 16:32:04 +01:00
Quentin
38274c6a5e Update buds/07.md
Co-authored-by: hzrd149 <8001706+hzrd149@users.noreply.github.com>
2024-11-20 16:28:13 +01:00
Quentin
8f95ad7468 Update buds/07.md
Co-authored-by: hzrd149 <8001706+hzrd149@users.noreply.github.com>
2024-11-20 16:27:35 +01:00
Quentin
ffe55bbffc Update buds/07.md
Co-authored-by: hzrd149 <8001706+hzrd149@users.noreply.github.com>
2024-11-20 16:26:17 +01:00
Quentin
0d039843a0 Update buds/07.md
Co-authored-by: hzrd149 <8001706+hzrd149@users.noreply.github.com>
2024-11-20 16:25:58 +01:00
Quentin
cda53cf47a Update buds/07.md
Co-authored-by: hzrd149 <8001706+hzrd149@users.noreply.github.com>
2024-11-20 16:25:33 +01:00
Quentin
e003b22318 Fix typos. 2024-11-20 12:40:39 +01:00
Quentin
8600dbecfc Recurring payments. 2024-11-20 12:35:18 +01:00
Quentin
0aa5a9dd6f Refactored to clarify payment header encoding and method-specific requirements 2024-11-20 12:14:00 +01:00
Quentin
18a57e361c Merge branch 'master' into BUD07-paid-storage 2024-11-19 10:45:46 +01:00
Quentin
970fc2b072 fix typo 2024-11-18 12:41:51 +01:00
Quentin
8a4728e3e6 remove some texts 2024-11-18 12:41:43 +01:00
Quentin
b450680b00 fix typo 2024-11-18 12:39:10 +01:00
Quentin
3524b81bac fix typos 2024-11-18 12:37:37 +01:00
Quentin
bf417ae115 using different headers for each payment method 2024-11-18 12:28:43 +01:00
Quentin
5c0ecbb4fa fix typo 2024-11-12 10:01:43 +01:00
Quentin
942fb60e97 Update BUD-07 for multiple L2; discard L402 2024-11-01 10:55:49 +01:00
quentintaranpino
cd778dec22 change backward compatibility text 2024-09-16 09:22:58 +02:00
quentintaranpino
40a7cd943c fix typos 2024-09-12 10:04:30 +02:00
quentintaranpino
7a57b0c19a Backward compatibility proposal 2024-09-12 10:00:58 +02:00
Quentin
f0ac329e90 Update buds/07.md
Co-authored-by: hzrd149 <8001706+hzrd149@users.noreply.github.com>
2024-09-12 09:48:34 +02:00
Quentin
b6bd9b9a94 Update buds/07.md
Co-authored-by: hzrd149 <8001706+hzrd149@users.noreply.github.com>
2024-09-12 09:48:26 +02:00
Quentin
c3f7a5da0d Update buds/07.md
Co-authored-by: hzrd149 <8001706+hzrd149@users.noreply.github.com>
2024-09-12 09:48:20 +02:00
Quentin
17d6814fd0 Update buds/07.md
Co-authored-by: hzrd149 <8001706+hzrd149@users.noreply.github.com>
2024-09-12 09:48:05 +02:00
Quentin
2bd04954a4 Paid storage 2024-09-10 10:41:34 +02:00
11 changed files with 217 additions and 156 deletions

View File

@@ -4,13 +4,30 @@ Blossom uses [nostr](https://github.com/nostr-protocol/nostr) public / private k
## What is it? ## What is it?
Blossom is a spec for a set of HTTP endpoints that allow users to store blobs of data on publicly accessible servers Blossom is a specification for a set of HTTP endpoints that allow users to store blobs of data on publicly accessible servers
## What are blobs ## What are blobs
Blobs are packs of binary data addressed by their sha256 hash Blobs are packs of binary data addressed by their sha256 hash
## How does it work? ## Protocol specification (BUDs)
BUDs or **Blossom Upgrade Documents** are short documents that outline an additional feature that a blossom server may implement.
## BUDs
- [BUD-00: Blossom Upgrade Documents](./buds/00.md)
- [BUD-01: Server requirements and blob retrieval](./buds/01.md)
- [BUD-02: Blob upload and management](./buds/02.md)
- [BUD-03: User Server List](./buds/03.md)
- [BUD-04: Mirroring blobs](./buds/04.md)
- [BUD-05: Media optimization](./buds/05.md)
- [BUD-06: Upload requirements](./buds/06.md)
- [BUD-07: Payment required](./buds/07.md)
- [BUD-08: Nostr File Metadata Tags](./buds/08.md)
- [BUD-09: Blob Report](./buds/09.md)
## Endpoints
Blossom Servers expose a few endpoints for managing blobs Blossom Servers expose a few endpoints for managing blobs
@@ -32,23 +49,6 @@ Blossom Servers expose a few endpoints for managing blobs
- `Authentication`: Signed [nostr event](./buds/05.md#upload-authorization) - `Authentication`: Signed [nostr event](./buds/05.md#upload-authorization)
- `PUT /report` [BUD-09](./buds/09.md) - `PUT /report` [BUD-09](./buds/09.md)
## Protocol specification (BUDs)
BUDs stand for **Blossom Upgrade Documents**.
See the [BUDs](./buds) folder and specifically [BUD-01](./buds/01.md) and [BUD-02](./buds/02.md) for a detailed explanation of the endpoints
## BUDs
- [BUD-01: Server requirements and blob retrieval](./buds/01.md)
- [BUD-02: Blob upload and management](./buds/02.md)
- [BUD-03: User Server List](./buds/03.md)
- [BUD-04: Mirroring blobs](./buds/04.md)
- [BUD-05: Media optimization](./buds/05.md)
- [BUD-06: Upload requirements](./buds/06.md)
- [BUD-08: Nostr File Metadata Tags](./buds/08.md)
- [BUD-09: Blob Report](./buds/09.md)
## Event kinds ## Event kinds
| kind | description | BUD | | kind | description | BUD |

19
buds/00.md Normal file
View File

@@ -0,0 +1,19 @@
# BUD-00
## Blossom Upgrade Documents
`draft` `mandatory`
This document details the common language for all following BUDs
## Language
All occurences of "MUST", "MUST NOT", "SHOULD", "SHOULD NOT" MUST be interpreted as per [RFC 2119](https://www.rfc-editor.org/rfc/rfc2119)
## BUDs
BUDs or "Blossom Upgrade Documents" are short documents that outline an additional requirement or feature that a blossom server MUST or MAY implement.
## Blobs
Blobs are raw binary data addressed by the sha256 hash of the data.

View File

@@ -11,7 +11,7 @@ _All pubkeys MUST be in hex format_
Servers MUST set the `Access-Control-Allow-Origin: *` header on all responses to ensure compatibility with applications hosted on other domains. Servers MUST set the `Access-Control-Allow-Origin: *` header on all responses to ensure compatibility with applications hosted on other domains.
For [preflight](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#preflighted_requests) (`OPTIONS`) requests, For [preflight](https://developer.mozilla.org/en-US/docs/Web/HTTP/CORS#preflighted_requests) (`OPTIONS`) requests,
servers MUST also set, at minimum, the `Access-Control-Allow-Headers: Authorization, *` and `Access-Control-Allow-Methods: GET, PUT, servers MUST also set, at minimum, the `Access-Control-Allow-Headers: Authorization, *` and `Access-Control-Allow-Methods: GET, HEAD, PUT,
DELETE` headers. DELETE` headers.
The header `Access-Control-Max-Age: 86400` MAY be set to cache the results of a preflight request for 24 hours. The header `Access-Control-Max-Age: 86400` MAY be set to cache the results of a preflight request for 24 hours.
@@ -28,7 +28,7 @@ Authorization events must be generic and must NOT be scoped to specific servers.
Events MUST be kind `24242` and have a `t` tag with a verb of `get`, `upload`, `list`, or `delete` Events MUST be kind `24242` and have a `t` tag with a verb of `get`, `upload`, `list`, or `delete`
Events MUST have the `content` set to a human readable string explaining to the user what the events inteded use is. For example `Upload Blob`, `Delete dog-picture.png`, `List Images`, etc Events MUST have the `content` set to a human readable string explaining to the user what the events intended use is. For example `Upload Blob`, `Delete dog-picture.png`, `List Images`, etc
All events MUST have a [NIP-40](https://github.com/nostr-protocol/nips/blob/master/40.md) `expiration` tag set to a unix timestamp at which the event should be considered expired. All events MUST have a [NIP-40](https://github.com/nostr-protocol/nips/blob/master/40.md) `expiration` tag set to a unix timestamp at which the event should be considered expired.
@@ -75,12 +75,29 @@ All endpoints MUST be served from the root of the domain (eg. the `/upload` endp
## GET /sha256 - Get Blob ## GET /sha256 - Get Blob
The `GET /<sha256>` endpoint MUST return the contents of the blob with the `Content-Type` header set to the appropriate MIME-type The `GET /<sha256>` endpoint MUST return the contents of the blob in the response body. the `Content-Type` header SHOULD beset to the appropriate MIME-type
The endpoint MUST accept an optional file extension in the URL. ie. `.pdf`, `.png`, etc The endpoint MUST accept an optional file extension in the URL. ie. `.pdf`, `.png`, etc
If the endpoints returns a 301 or 302 redirect it MUST redirect to a URL containing the same sha256 hash as the requested blob. Regardless of the file extension, the server MUST return the MIME type of the blob in the `Content-Type` header. If the
This ensures that if a user was to copy or reuse the redirect URL it would still contain the original sha256 hash server does not know the MIME type of the blob, it MUST default to `application/octet-stream`
### Proxying and Redirection (Optional)
If the endpoint returns a redirection 3xx status code such as 307 or 308 ([RFC 9110 section
15.4](https://datatracker.ietf.org/doc/html/rfc9110#name-redirection-3xx)), it MUST redirect to a URL containing the
same sha256 hash as the requested blob. This ensures that if a user copies or reuses the redirect URL, it will
contain the original sha256 hash.
While the final blob may not be served from a Blossom server (e.g. CDN, IPFS, object storage, etc.), the destination
server MUST set the `Access-Control-Allow-Origin: *` header on the response to allow cross-origin requests, as well as
the `Content-Type` and `Content-Length` headers to ensure the blob can be correctly displayed by clients. Two ways to
guarantee this are:
1. Proxying the blob through the Blossom server, allowing it to override headers such as `Content-Type`.
2. Manipulating the redirect URL to include a file extension that matches the blob type, such as `.pdf`, `.png`, etc. If
the server is unable to determine the MIME type of the blob, it MUST default to `application/octet-stream` and MAY
include a file extension in the URL that reflects the blob type (e.g. `.bin`, `.dat`, etc.).
### Get Authorization (optional) ### Get Authorization (optional)
@@ -131,7 +148,10 @@ Example event for retrieving multiple blobs from single server:
## HEAD /sha256 - Has Blob ## HEAD /sha256 - Has Blob
The `HEAD /<sha256>` endpoint MUST respond with either a `200` or `404` status code The `HEAD /<sha256>` endpoint SHOULD be identical to the `GET /<sha256>` endpoint except that it MUST NOT return the
blob in the reponse body per [RFC 7231](https://www.rfc-editor.org/rfc/rfc7231#section-4.3.2)
The endpoint MUST respond with the same `Content-Type` and `Content-Length` headers as the `GET /<sha256>` endpoint.
The endpoint MUST accept an optional file extension in the URL similar to the `GET /<sha256>` endpoint. ie. `.pdf`, `.png`, etc The endpoint MUST accept an optional file extension in the URL similar to the `GET /<sha256>` endpoint. ie. `.pdf`, `.png`, etc

View File

@@ -15,7 +15,7 @@ A blob descriptor is a JSON object containing `url`, `sha256`, `size`, `type`, a
- `url` A publicly accessible URL to the [BUD-01](./01.md#get-sha256---get-blob) `GET /<sha256>` endpoint with a file extension - `url` A publicly accessible URL to the [BUD-01](./01.md#get-sha256---get-blob) `GET /<sha256>` endpoint with a file extension
- `sha256` The sha256 hash of the blob - `sha256` The sha256 hash of the blob
- `size` The size of the blob in bytes - `size` The size of the blob in bytes
- `type` (optional) The MIME type of the blob - `type` The MIME type of the blob (falling back to `application/octet-stream` if unknown)
- `uploaded` The unix timestamp of when the blob was uploaded to the server - `uploaded` The unix timestamp of when the blob was uploaded to the server
Servers MUST include a file extension in the URL in the `url` field to allow clients to easily embed the URL in social posts or other content Servers MUST include a file extension in the URL in the `url` field to allow clients to easily embed the URL in social posts or other content
@@ -38,18 +38,25 @@ Example:
The `PUT /upload` endpoint MUST accept binary data in the body of the request and MAY use the `Content-Type` and `Content-Length` headers to get the MIME type and size of the data The `PUT /upload` endpoint MUST accept binary data in the body of the request and MAY use the `Content-Type` and `Content-Length` headers to get the MIME type and size of the data
The endpoint MUST NOT modify the blob in any way and should return the exact same sha256 that was uploaded. This is critical to allow users to re-upload their blobs to new servers The endpoint MUST NOT modify the blob in any way and SHOULD return the exact same sha256 that was uploaded. This is critical to allow users to re-upload their blobs to new servers
The endpoint MUST return a [Blob Descriptor](#blob-descriptor) if the upload was successful or an error object if it was not The endpoint MUST return a [Blob Descriptor](#blob-descriptor) if the upload was successful or an error object if it was not
Servers MAY reject an upload for any reason and should respond with the appropriate HTTP `4xx` status code and an error message explaining the reason for the rejection Servers MAY reject an upload for any reason and SHOULD respond with the appropriate HTTP `4xx` status code and an error message explaining the reason for the rejection
### File extension normalization (Optional)
When storing blobs, servers MAY normalise the file extension to a standard format (e.g. `.pdf`, `.png`, etc.) based on
the MIME type of the blob. This can be especially useful when the `GET /<sha256>` endpoint is redirected to an external
URL (see the [proxying and redirection section from BUD-01](./01.md#proxying-and-redirection-optional)), as external
servers may rely on the file extension to serve the blob correctly.
### Upload Authorization (Optional) ### Upload Authorization (Optional)
Servers MAY accept an authorization event when uploading blobs and should perform additional checks Servers MAY accept an authorization event when uploading blobs and SHOULD perform additional checks
1. The `t` tag MUST be set to `upload` 1. The `t` tag MUST be set to `upload`
2. MUST contain at least one `x` tag matching the sha256 hash of the body of the request 2. The authorization event MUST contain at least one `x` tag matching the sha256 hash of the body of the request
Example Authorization event: Example Authorization event:
@@ -71,19 +78,21 @@ Example Authorization event:
## GET /list/pubkey - List Blobs (Optional) ## GET /list/pubkey - List Blobs (Optional)
The `/list/<pubkey>` endpoint MUST return a JSON array of [Blob Descriptor](#blob-descriptor) that where uploaded by the specified pubkey The `/list/<pubkey>` endpoint MUST return a JSON array of [Blob Descriptor](#blob-descriptor) that were uploaded by the specified pubkey
The endpoint MUST support a `since` and `until` query parameter to limit the returned blobs by their `uploaded` date The endpoint MUST support `cursor` and `limit` query parameters for cursor based pagination. The `cursor` parameter MUST be the `sha256` hash of the last blob in the previous page, or omitted to request the first page. The `limit` parameter specifies the maximum number of results to return. The returned array of blob descriptors MUST be sorted by the `uploaded` date in descending order and MUST NOT include the blob at the cursor
Servers may reject a list for any reason and MUST respond with the appropriate HTTP `4xx` status code and an error message explaining the reason for the rejection The endpoint MAY support `since` and `until` query parameters to filter the list of blobs by their `uploaded` date. These parameters are deprecated for pagination purposes as they do not preserve server resources
Servers MAY reject a list request for any reason and MUST respond with the appropriate HTTP `4xx` status code and an error message explaining the reason for the rejection
### List Authorization (optional) ### List Authorization (optional)
The server may optionally require Authorization when listing blobs uploaded by the pubkey The server MAY optionally require Authorization when listing blobs uploaded by the pubkey
In this case the server must perform additional checks on the authorization event In this case the server MUST perform additional checks on the authorization event
1. The `t` tag must be set to `list` 1. The `t` tag MUST be set to `list`
Example Authorization event: Example Authorization event:
@@ -106,16 +115,16 @@ Example Authorization event:
Servers MUST accept `DELETE` requests to the `/<sha256>` endpoint Servers MUST accept `DELETE` requests to the `/<sha256>` endpoint
Servers may reject a delete request for any reason and should respond with the appropriate HTTP `4xx` status code and an error message explaining the reason for the rejection Servers MAY reject a delete request for any reason and SHOULD respond with the appropriate HTTP `4xx` status code and an error message explaining the reason for the rejection
### Delete Authorization (required) ### Delete Authorization (required)
Servers MUST accept an authorization event when deleting blobs Servers MUST accept an authorization event when deleting blobs
Servers should perform additional checks on the authorization event Servers SHOULD perform additional checks on the authorization event
1. The `t` tag must be set to `delete` 1. The `t` tag MUST be set to `delete`
2. MUST contain at least one `x` tag matching the sha256 hash of the blob being deleted 2. The authorization event MUST contain at least one `x` tag matching the sha256 hash of the blob being deleted
When multiple `x` tags are present on the authorization event the server MUST only delete the blob listed in the URL. When multiple `x` tags are present on the authorization event the server MUST only delete the blob listed in the URL.

View File

@@ -68,7 +68,7 @@ Take the following event as an example
Once the client discovers that the URL `https://cdn.broken-domain.com/b1674191a88ec5cdd733e4240a81803105dc412d6c6708d53ab94fc248f4f553.pdf` is no longer available. It can perform the following steps to find the blob: Once the client discovers that the URL `https://cdn.broken-domain.com/b1674191a88ec5cdd733e4240a81803105dc412d6c6708d53ab94fc248f4f553.pdf` is no longer available. It can perform the following steps to find the blob:
1. Get the SHA256 has from the URL 1. Get the SHA256 hash from the URL
2. Look for the authors server list `kind:10063` 2. Look for the authors server list `kind:10063`
3. If found, Attempt to retrieve the blob from each `server` listed started with the first 3. If found, Attempt to retrieve the blob from each `server` listed started with the first
4. If not found, the client MAY fallback to using a well-known popular blossom server to retrieve the blob 4. If not found, the client MAY fallback to using a well-known popular blossom server to retrieve the blob

View File

@@ -8,7 +8,7 @@ Defines the `/mirror` endpoint
## PUT /mirror - Mirror Blob ## PUT /mirror - Mirror Blob
A server may expose a `PUT /mirror` endpoint to allow users to copy a blob from a URL instead of uploading it A server MAY expose a `PUT /mirror` endpoint to allow users to copy a blob from a URL instead of uploading it
Clients MUST pass the URL of the remote blob as a stringified JSON object in the request body Clients MUST pass the URL of the remote blob as a stringified JSON object in the request body
@@ -19,23 +19,28 @@ Clients MUST pass the URL of the remote blob as a stringified JSON object in the
} }
``` ```
Clients MAY set the `Authorization` header to an upload authorization event defined in [BUD-02](./02.md#upload-authorization-required). When using authorization, the event MUST be of type "upload". Clients MAY set the `Authorization` header to an upload authorization event defined in [BUD-02](./02.md#upload-authorization-optional). When using authorization, the event MUST be of type "upload".
The `/mirror` endpoint MUST download the blob from the specified URL and verify that there is at least one `x` tag in the authorization event matching the sha256 hash of the download blob The `/mirror` endpoint MUST download the blob from the specified URL and verify that there is at least one `x` tag in the authorization event matching the sha256 hash of the download blob
**Multiple `x` tags in the authorization event MUST NOT be interpreted as the user requesting a bulk mirror.** **Multiple `x` tags in the authorization event MUST NOT be interpreted as the user requesting to mirror multiple blobs.**
The endpoint MUST return a [Blob Descriptor](#blob-descriptor) if the mirroring was successful or an error object if it was not The endpoint MUST return a [Blob Descriptor](#blob-descriptor) and a `2xx` status code if the mirroring was successful
or a `4xx` status code and error message if it was not.
Servers should re-use the `Content-Type` header returned from the URL to discover the mime type of the blob. if none is returned it may use the file extension in the URL The destination server SHOULD use the `Content-Type` header returned from the origin server to infer the mime type of
the blob. If the `Content-Type` header is not present the destination server SHOULD attempt to detect the `Content-Type`
from the blob contents and file extension, falling back to `application/octet-stream` if it cannot determine the type.
Servers MAY reject a mirror request for any reason and should respond with the appropriate HTTP `4xx` status code and an error message explaining the reason for the rejection Servers MAY use the `Content-Length` header to determine the size of the blob.
Servers MAY reject a mirror request for any reason and MUST respond with the appropriate HTTP `4xx` status code and an error message explaining the reason for the rejection.
## Example Flow ## Example Flow
1. Client signs authorization event and uploads blob to Server A 1. Client signs an `upload` authorization event and uploads blob to Server A
1. Server A returns blob descriptor with `url` 1. Server A returns a [Blob Descriptor](./02.md#blob-descriptor) with the `url`
1. Client sends the `url` to Server B `/mirror` using the original authorization event 1. Client sends the `url` to Server B `/mirror` using the original `upload` authorization event
1. Server B downloads blob from Server A using the url 1. Server B downloads the blob from Server A using the `url`
1. Server B verifies downloaded blob hash matches `x` tag in authorization event 1. Server B verifies the downloaded blob hash matches the `x` tag in the authorization event
1. Server B returns [Blob Descriptor](./02.md#blob-descriptor) 1. Server B returns a [Blob Descriptor](./02.md#blob-descriptor)

View File

@@ -20,7 +20,7 @@ Servers MAY reject media uploads for any reason and should respond with the appr
Servers MAY require a `media` [authorization event](./02.md#upload-authorization-required) to identify the uploader Servers MAY require a `media` [authorization event](./02.md#upload-authorization-required) to identify the uploader
If a server requires a `media` authorization event it MUST preform the following checks If a server requires a `media` authorization event it MUST perform the following checks
1. The `t` tag MUST be set to `media` 1. The `t` tag MUST be set to `media`
2. MUST contain at least one `x` tag matching the sha256 hash of the body of the request 2. MUST contain at least one `x` tag matching the sha256 hash of the body of the request
@@ -33,7 +33,7 @@ Servers MUST respond to `HEAD` requests on the `/media` endpoint in a similar wa
This endpoint is intentionally limited to optimizing a single blob with the goal of making it easier to distribute This endpoint is intentionally limited to optimizing a single blob with the goal of making it easier to distribute
How the blob is optimized is the sole respirability of the server and the client should have no say in what optimization process is used How the blob is optimized is the sole responsibility of the server and the client should have no say in what optimization process is used
The goal of this endpoint is to provide a simple "trusted" optimization endpoint clients can use to optimize media for distribution The goal of this endpoint is to provide a simple "trusted" optimization endpoint clients can use to optimize media for distribution

View File

@@ -8,7 +8,7 @@ Defines how clients can verify if the upload can be completed before sending the
## HEAD /upload - Upload requirements ## HEAD /upload - Upload requirements
The `HEAD /upload` endpoint `MUST` use the `X-SHA-256`, `X-Content-Type` and `X-Content-Length` headers sent by client to get the SHA-256 hash, MIME type and size of the blob that will be uploaded, returning a HTTP status code and a custom header `X-Reason` to indicate some human readable message about the upload requirements. The `HEAD /upload` endpoint MUST use the `X-SHA-256`, `X-Content-Type` and `X-Content-Length` headers sent by client to get the SHA-256 hash, MIME type and size of the blob that will be uploaded, returning a HTTP status code and a custom header `X-Reason` to indicate some human readable message about the upload requirements.
### Headers ### Headers
@@ -38,7 +38,7 @@ Example response from the server if the upload can be done:
HTTP/1.1 200 OK HTTP/1.1 200 OK
``` ```
If the upload cannot proceed, the server `MUST` return an appropriate `4xx` HTTP status code and a custom header `X-Reason` with a human readable error message. If the upload cannot proceed, the server MUST return an appropriate `4xx` HTTP status code and a custom header `X-Reason` with a human readable error message.
Some examples of error messages: Some examples of error messages:

105
buds/07.md Normal file
View File

@@ -0,0 +1,105 @@
BUD-07
======
Paid upload and download
---------------
`draft` `optional`
Payment requirements for blob storage.
## Payment Required
Some servers MAY require payment for uploads, downloads, or any other endpoint. In such cases, these endpoints MUST return a **402 Payment Required** status code.
Some endpoints a server may require payment for:
- [`HEAD /upload`](./06.md) to signal that payment is required for the `PUT` request ( if [BUD-06](./06.md) is supported )
- [`PUT /upload`](./02.md#put-upload---upload-blob) to require payment for uploads
- [`HEAD /<sha256>`](./01.md#head-sha256---has-blob) to signal that payment is required for the `GET` request
- [`GET /<sha256>`](./01.md#get-sha256---get-blob) to require payment for downloads ( maybe charge by MB downloaded? )
- [`HEAD /media`](./05.md) and [`PUT /upload`](./05.md) to require payment for media optimizations ( if [BUD-06](./06.md) is supported )
When payment is required, the server MUST include one or more `X-{payment_method}` header(s), each corresponding to a supported payment method.
## Server headers
The 402 status code and `X-{payment_method}` header is used by the server to inform the client that a payment is required for the requested operation. The server MUST provide specific headers for each supported payment method.
Supported payment methods:
- `X-Cashu`: Payment details for the cashu payment method, adhering to the [NUT-24](https://github.com/cashubtc/nuts/blob/main/24.md) standard.
- `X-Lightning`: Payment details for the lightning payment method, adhering to the [BOLT-11](https://github.com/lightning/bolts/blob/master/11-payment-encoding.md) standard.
If a server supports multiple payment methods, it MAY send multiple `X-{payment_method}` headers in the same response.
Schema:
```http
HTTP/1.1 402 Payment Required
X-{payment_method}: "<encoded_payload_according_to_{payment_method}_spec>"
```
### `X-Cashu` Header
When using the X-Cashu header, the server MUST adhere to the [NUT-24](https://github.com/cashubtc/nuts/blob/main/24.md) standard.
Example for cashu:
```http
HTTP/1.1 402 Payment Required
X-Cashu: creqApWF0gaNhdGVub3N0cmFheKlucHJvZmlsZTFxeTI4d3VtbjhnaGo3dW45ZDNzaGp0bnl2OWtoMnVld2Q5aHN6OW1od2RlbjV0ZTB3ZmprY2N0ZTljdXJ4dmVuOWVlaHFjdHJ2NWhzenJ0aHdkZW41dGUwZGVoaHh0bnZkYWtxcWd5ZGFxeTdjdXJrNDM5eWtwdGt5c3Y3dWRoZGh1NjhzdWNtMjk1YWtxZWZkZWhrZjBkNDk1Y3d1bmw1YWeBgmFuYjE3YWloYjdhOTAxNzZhYQphdWNzYXRhbYF4Imh0dHBzOi8vbm9mZWVzLnRlc3RudXQuY2FzaHUuc3BhY2U
```
### `X-Lightning` Header
When using the X-Lightning header, the server MUST adhere to the [BOLT-11](https://github.com/lightning/bolts/blob/master/11-payment-encoding.md) standard.
Example for lightning:
```http
HTTP/1.1 402 Payment Required
X-Lightning: lnbc30n1pnnmw3lpp57727jjq8zxctahfavqacymellq56l70f7lwfkmhxfjva6dgul2zqhp5w48l28v60yvythn6qvnpq0lez54422a042yaw4kq8arvd68a6n7qcqzzsxqyz5vqsp5sqezejdfaxx5hge83tf59a50h6gagwah59fjn9mw2d5mn278jkys9qxpqysgqt2q2lhjl9kgfaqz864mhlsspftzdyr642lf3zdt6ljqj6wmathdhtgcn0e6f4ym34jl0qkt6gwnllygvzkhdlpq64c6yv3rta2hyzlqp8k28pz
```
### Client implementation
Clients MUST parse and validate the `X-{payment_method}` header received from the server. The client SHOULD provide a way for the user to complete the payment and retry the request using the same `X-{payment_method}` header.
The client MUST provide the payment proof when re-trying the request using the same `X-{payment_method}` header that was chosen. The payment proof MUST align with the payment method specification:
- For cashu the payment proof should be a serialized `cashuB` token in the `X-Cashu` header according to [NUT-24](https://github.com/cashubtc/nuts/blob/main/24.md#client-payment).
- For lightning the payment proof should be the preimage of the payment request according to [BOLT-11](https://github.com/lightning/bolts/blob/master/11-payment-encoding.md).
Schema:
```http
X-{payment_method}: "<encoded_payment_proof_according_to_{payment_method}_spec>"
```
Example for Cashu:
```http
X-Cashu: cashuBo2F0gqJhaUgA_9SLj17PgGFwgaNhYQFhc3hAYWNjMTI0MzVlN2I4NDg0YzNjZjE4NTAxNDkyMThhZjkwZjcxNmE1MmJmNGE1ZWQzNDdlNDhlY2MxM2Y3NzM4OGFjWCECRFODGd5IXVW
```
Example for Lightning:
```http
X-Lightning: 966fcb8f153339372f9a187f725384ff4ceae0047c25b9ce607488d7c7e93bba
```
**Special Note on HEAD Requests**
The HEAD endpoints are only used to retrieve blob or server information. They MUST NOT be retried with payment proof. Instead, clients should complete the payment and proceed with the `PUT` or `GET` request.
### Error handling
If the client fails to provide the payment proof (expired invoice, invalid token, etc.) the server MUST respond with **400 Bad request** status code and include a `X-Reason` header with a human-readable message. The client SHOULD inform the user about the error and provide a way to retry the request.
### Extending with Future Payment Methods
To support future payment methods (e.g., other Layer 2 solutions), the specification allows the addition of new X-{payment_method} headers. Each new method MUST adhere to the following:
New methods MUST use a unique `X-{payment_method}` header containing the specific payment details.
New methods MUST adhere their own specification, which MUST be publicly available and linked in the header.

View File

@@ -6,7 +6,6 @@
This bud defines a new endpoint for clients and users to report blobs to servers. This bud defines a new endpoint for clients and users to report blobs to servers.
### PUT /report - reporting a blob ### PUT /report - reporting a blob
The request body MUST be a signed [NIP-56](https://github.com/nostr-protocol/nips/blob/master/56.md) report event with one or more `x` tags containing the hashes of the blobs being reported. The request body MUST be a signed [NIP-56](https://github.com/nostr-protocol/nips/blob/master/56.md) report event with one or more `x` tags containing the hashes of the blobs being reported.
@@ -35,7 +34,7 @@ The clients can show a blob report button on posts or in blob details. Or its RE
### Server behavior ### Server behavior
The servers MAY keep the reports somewhere for operators to check and take action on them. they MAY use a list of trusted people or moderators to directly take action on blob without operator request. The servers MAY keep the reports somewhere for operators to check and take action on them. they MAY use a list of trusted people or moderators to directly take action on blob without operator request.
Servers MAY consider removed blobs sha256 as blocked to prevent rewrite. Servers MAY consider removed blobs sha256 as blocked to prevent rewrite.
Servers SHOULD advertise a route or landing page to provide their rules and term of service which affects the report process. Servers SHOULD advertise a route or landing page to provide their rules and terms of service which affects the report process.

View File

@@ -1,96 +0,0 @@
# BUD-10
## Multi-part uploads
`draft` `optional`
This bud defines a new `PATCH` method for the `/upload` endpoint to allow clients to upload blobs in multiple parts.
### Signaling support for multi-part uploads
The server SHOULD respond to an `OPTIONS /upload` request with a `204` "No Content" response according to [RFC-9110](https://httpwg.org/specs/rfc9110.html#rfc.section.9.3.7) including the [`Allow`](https://httpwg.org/specs/rfc9110.html#field.allow) header with `PATCH`
### Upload requirements
The server SHOULD implement [BUD-06](06.md) "Upload requirements" to allow clients to check if a blob can be uploaded before uploading any chunks.
### Chunking strategy
The client MAY split the blob into as many chunks as needed and MAY include overlap in the chunks if needed.
The server MUST concatenate the chunks based on the `Upload-Offset` and `Content-Length` headers to reconstruct the final blob to ensure any overlap is accounted for.
### Uploading chunks
Clients MUST send the following headers in each `PATCH /upload` request:
- `X-SHA-256`: The sha256 hash of the final blob. this should be considered the "ID" of the multi-part upload.
- `Upload-Type`: The mine type of the final blob. should be set like `Content-Type` defined in [RFC-9110](https://httpwg.org/specs/rfc9110.html#field.content-type)
- `Upload-Length`: The total length of the blob. should be set like `Content-Length` defined in [RFC-9110](https://httpwg.org/specs/rfc9110.html#field.content-length)
- `Content-Length`: The length of the chunk in bytes.
- `Upload-Offset`: The offset of the chunk in the blob.
- `Content-Type`: The type of the chunk. MUST be set to `application/octet-stream`
The server MUST respond with a `204` "No Content" response if the chunk was accepted or a `4xx` status code if it was not.
### Uploading the final chunk
Once the server has received enough chunks to cover the `Upload-Length` of the blob the server MUST respond with a `2xx` status code following [BUD-02](02.md) or a `4xx` status code if the blob hash does not match the `X-SHA-256` header
### Authorization
The server MAY require authorization for uploads by checking the `Authorization` header similar to the [`PUT /upload`](./02.md#upload-authorization-required) endpoint
The server SHOULD validate that the authorization event contains the following tags:
- A `t` tag set to `upload`
- One `x` tag for each chunk with the sha256 hash of the chunk
- A final `x` tag with the sha256 hash of the final blob
### Resuming uploads
The client SHOULD keep track of a chunks it has uploaded in order to resume uploads after a failure.
### Example upload flow
```sh
# Client splits the blob into 4 chunks
split -b 46073 bitcoin.pdf chunk_
# Client uploads the first chunk
curl -X PATCH http://cdn.example.com/upload \
-H "X-SHA-256: b1674191a88ec5cdd733e4240a81803105dc412d6c6708d53ab94fc248f4f553" \
-H "Upload-Type: application/pdf" \
-H "Upload-Length: 184292" \
-H "Upload-Offset: 0" \
-H "Content-Length: 46073" \
-H "Content-Type: application/octet-stream" \
--data-binary "@chunk_aa"
# Server accepts the chunk and responds with a 204
HTTP/1.1 204 No Content
# CLient uploads remaining chunks (2-4)
curl -X PATCH http://cdn.example.com/upload
# ..
--data-binary "@chunk_ab"
curl -X PATCH http://cdn.example.com/upload
# ...
--data-binary "@chunk_ac"
curl -X PATCH http://cdn.example.com/upload
# ...
--data-binary "@chunk_ad"
# Server responds with 200 OK
HTTP/1.1 200 OK
Content-Type: application/pdf
Content-Length: 184292
{
"url": "https://cdn.example.com/b1674191a88ec5cdd733e4240a81803105dc412d6c6708d53ab94fc248f4f553.pdf",
"sha256": "b1674191a88ec5cdd733e4240a81803105dc412d6c6708d53ab94fc248f4f553",
"uploaded": 1725105921,
"type": "application/pdf",
"length": 184292
}
```