API 参考
访客 GraphQL
通过分享链接加密访问。
key = Base64UrlDecode(shared_token)分享链接中的 shared_token;c-id = shareId
客户端
https://<host>:<port>/guest_graphql服务端
POST /guest_graphql
c-id: 01a1cd7b-b900-7331-9331-313131313131
HTTP · binary
JSON({ requestId, query, variables })
requestId 为 UUIDv7,内含请求时间;variables、operationName、extensions 可选。
XChaCha20-Poly1305 · 悬停或点按字段
防重放
requestId = UUIDv7()JSON { requestId, query, variables } → authenticated encryption认证并解密
↓shareId → shared_token✕ → 拒绝校验 UUIDv7 时间
↓|serverTime − requestId timestamp| ≤ 60 s✕ → 拒绝执行前记录 requestId
SQLite: guest + shareId + requestId✓ ↓执行 GraphQL
✕ ↓拒绝重复的 requestId
库调用示例
Desktop 代码节选。复用 graphqlRequestPayload 生成 UUIDv7 requestId,不再发送独立 timestamp 或防重放 nonce。
typescript
// plain-desktop/src/lib/api/guest.ts
const payload = graphqlRequestPayload(query, variables)
const requestBody = chachaEncrypt(key, payload, httpRequestAad('/guest_graphql'))
const response = await httpRequest(url, {
method: 'POST', headers: { 'c-id': shareId }, body: requestBody
})
if (!response.ok) throw new Error(String(response.status))
const bytes = new Uint8Array(await response.arrayBuffer())
const result = JSON.parse(decryptGraphqlResponse(key, requestBody, bytes))
// Feature error codes are carried in extensions.code; message is diagnostic text.
if (result.errors?.length) throw GqlError.fromGraphql(result.errors[0])HTTP 403:分享失效或远程访问关闭。401:解密失败。400:请求格式错误、过期或重复。
类型定义
graphql
scalar Instant
scalar Long
type Query {
sharedInfo(: String, : String): SharedInfo!
}
type SharedFile {
name: String!
relativePath: String!
isDir: Boolean!
size: Long!
mimeType: String!
hasThumb: Boolean!
createdAt: Instant
updatedAt: Instant!
}
type SharedInfo {
name: String!
readOnly: Boolean!
requiresPassword: Boolean!
expiresAt: Instant
urlToken: String!
entries: [SharedFile!]!
}
"""
Directs the executor to include this field or fragment only when the `if` argument is true.
"""
directive @include(if: Boolean!) on FIELD | FRAGMENT_SPREAD | INLINE_FRAGMENT
"""
Directs the executor to skip this field or fragment when the `if` argument is true.
"""
directive @skip(if: Boolean!) on FIELD | FRAGMENT_SPREAD | INLINE_FRAGMENT
schema {
query: Query
}