密钥
采集密钥只能写入,按设计就是公开的;服务器密钥、只读密钥和管理密钥只放在服务器上。
一个密钥(key)属于一个项目,并具有四种权限范围之一。从前缀就能看出是哪一种。
| 范围 | 前缀 | 控制台中的名称 | 能做什么 | 放在哪里 |
|---|---|---|---|---|
| 采集 | lyr_ing_ | Send events | 追加事件,别无其他 | 你的应用或网页中 |
| 服务器 | lyr_srv_ | Send events from a server | 追加事件,别无其他。它发送的事件是已验证的。 | 只放在你的后端。务必保密。 |
| 只读 | lyr_read_ | Read events | 查询事件 | 服务器或脚本中。务必保密。 |
| 管理 | lyr_adm_ | Full access | 发送和查询事件,用于管理类任务 | 服务器上。务必保密。 |
只读密钥通过读取 API 查询所属项目的事件:可以在服务器上的脚本、notebook 或 agent 中使用。 它能读取项目中的全部数据,所以绝不能放进应用或网页。
服务器密钥用于从你的后端发送事件:通过 Node、Python、Go 或 JVM SDK,或者用 curl。它和采集密钥一样不能读取,
但它是机密:因为只有你的服务器持有它,所以它发送的事件会被标记为已验证,而且不受单个地址每日配额的限制。
它绝不能放进应用或网页。应用和网页使用采集密钥。
为什么采集密钥可以公开
采集密钥随应用二进制文件或网页一起发布,所以要假定任何人都能读到它。这没有问题,因为它只能向所属项目追加事件:
不能读取、修改或删除任何东西。事件落在哪个项目,始终由密钥决定,而不是由事件决定。为了限制滥用,每个项目都有速率限制
(默认每分钟 60,000 个事件),超过限制的批次会收到 429。此外,用它发送时,单个地址每天最多只能发送每日配额以内的事件,
这个配额是组织每月用量的一部分。
反过来说:任何持有采集密钥的人都能发送看起来和你的应用一样的事件,所以这些事件不是已验证的, 除非它们来自你的 Apple 应用并由 Apple 通过 App Attest 证明, 或者来自你的 Android 应用并由手机通过 Key Attestation 证明。 这类事件同样不计入每日配额。
密钥只显示一次
Lyrelog 只存储每个密钥的 SHA-256 哈希。密钥只在你创建时显示一次:请当场复制。丢失的密钥无法找回,只能新建一个。
创建与吊销
密钥位于项目的 API keys 页面:依次进入 Settings 和 API keys,或者按 ⌘ K 后选择 API keys。只有所有者可以创建和吊销密钥。
- 一个项目最多有 20 个有效密钥。要新建,先吊销一个。
- 密钥不会过期:在被吊销或所属项目被删除之前,它一直有效。
- 创建 Send events from a server、Read events 或 Full access 密钥需要近期登录过(10 分钟以内)。 Send events 密钥不需要。
- 当有人离开组织或被移除时,其创建的只读密钥和完全访问密钥会被吊销。采集密钥保留,因为已经发布出去的应用还在用它们发送。 服务器密钥也保留,因为你的服务器在用它们发送:如果离开的人见过某个服务器密钥,请吊销并替换它。
- 组织中的每个人都能看到密钥列表,以及每个密钥最后一次使用的时间。
密钥吊销后会立即失效,但请留出最多一分钟的生效时间。收到 401 或 403 的 SDK 会停止发送,直到应用重启,并保留已入队的事件。