You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
"description": "JSON schema for structured log entries",
4
+
"description": "JSON schema for structured log entries. The project accepts both legacy `time` and canonical `timestamp` names for compatibility while requiring a timestamp, level, and msg payload.",
Copy file name to clipboardExpand all lines: docs/admin-signing.md
+9-9Lines changed: 9 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -10,7 +10,7 @@ All admin API requests must be signed with an HMAC-SHA256 signature to ensure au
10
10
11
11
Every admin API request must include the following headers:
12
12
13
-
1.`X-Stellabill-Date`: Unix timestamp in seconds (UTC) when the request was created. The timestamp must be within ±60 seconds of the server's current time.
13
+
1.`X-Stellabill-Date`: Unix timestamp in seconds (UTC) when the request was created. The timestamp must be within °60 seconds of the server's current time.
14
14
2.`X-Stellabill-Request-ID`: A unique identifier for this request (e.g., a UUID). This is used to prevent replay attacks.
15
15
3.`X-Stellabill-Signature`: The HMAC-SHA256 signature of the canonical request, prefixed with `v1=`.
16
16
@@ -19,17 +19,17 @@ Every admin API request must include the following headers:
19
19
The canonical request is a string constructed as follows:
20
20
21
21
```
22
-
<Method>
23
-
<Path>
24
-
<QueryString>
25
-
<SignedHeaders>
26
-
<SignedHeadersNames>
27
-
<BodyHash>
22
+
[Method]
23
+
[Path]
24
+
[QueryString]
25
+
[SignedHeaders]
26
+
[SignedHeadersNames]
27
+
[BodyHash]
28
28
```
29
29
30
30
### Component Details
31
31
32
-
1.**Method**: The HTTP method in uppercase (e.g., `POST`, `GET`).
32
+
1.**Method**: The HTTP method in uppercase (e.g., `Post`, `GET`).
33
33
2.**Path**: The URL path (e.g., `/api/admin/purge`). If empty, use `/`.
34
34
3.**QueryString**: The sorted, URL-encoded query parameters, joined with `&`. Parameters are sorted lexicographically by key, then by value.
35
35
4.**SignedHeaders**: The signed headers in the format `key:value\n` for each header. The keys are lowercase and values are trimmed.
0 commit comments