aiden
/
synctv
mirror of https://github.com/synctv-org/synctv
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs(apple): explain Developer ID browser authentication

Browse Source
codex/apple-review-docs
zijiren233 2 months ago
parent 4b1e677d21
commit 6eeb974c9b
No known key found for this signature in database
GPG Key ID: 534E082AAA9B39DC
6 changed files with 10 additions and 10 deletions
Show Stats Download Patch File Download Diff File

4
docs/src/content/docs/configuration/email-oauth2.mdx
Unescape Escape View File

@ -128,7 +128,7 @@ Microsoft provider 额外使用 `tenant`（默认值为 `common`），Feishu pro
]
```
`webClientId` 是 Apple Services ID，供浏览器授权使用；它必须注册对应的 HTTPS Return URL。`nativeClientId` 是签名 App 的 Bundle ID，供 iOS/macOS 原生 Sign in with Apple 使用；它必须与安装包的 Bundle ID 一致。至少配置一组完整凭据：`webClientId` 与 `webClientSecret` 启用浏览器授权，`nativeClientId` 与 `nativeClientSecret` 启用原生授权。仅使用一种模式时可以省略另一组。两个 `clientSecret` 都是服务端凭据，使用 Apple Developer Team、Key ID、私钥和对应 client ID 生成，禁止写入客户端或提交到仓库。
`webClientId` 是 Apple Services ID，供浏览器授权使用；它必须注册对应的 HTTPS Return URL。`nativeClientId` 是签名 App 的 Bundle ID，供 iOS 和 Mac App Store 构建的原生 Sign in with Apple 使用；它必须与安装包的 Bundle ID 一致。macOS Developer ID 构建使用浏览器授权流程，因为 Developer ID profile 不携带受限制的原生 Apple entitlement。至少配置一组完整凭据：`webClientId` 与 `webClientSecret` 启用浏览器授权，`nativeClientId` 与 `nativeClientSecret` 启用原生授权。仅使用一种模式时可以省略另一组。两个 `clientSecret` 都是服务端凭据，使用 Apple Developer Team、Key ID、私钥和对应 client ID 生成，禁止写入客户端或提交到仓库。
官方 SyncTV 构建使用 `org.synctv.app`。自托管服务器通常没有官方 Apple Developer Team 的 App ID 私钥和 client secret，因此自托管发行应创建自己的 Apple Developer Team、Bundle ID 和 Sign in with Apple 配置，使用自己的 Bundle ID 重新签名客户端，并将它配置为 `nativeClientId`。
@ -158,7 +158,7 @@ Apple 官方配置入口：[Web Sign in with Apple](https://developer.apple.com/
浏览器授权请求传入 `redirectUrl`，服务端使用 `oauth2.allowedRedirectUrls` 校验 HTTPS 回调地址，loopback 回调单独放行。客户端应在每次授权开始时生成或选择当前回调地址，并在第三方平台注册相同地址。
原生授权请求省略 `redirectUrl`，并传入 `native=true`。Apple provider 通过 `supportedModes` 声明原生能力；iOS/macOS 通过系统 Sign in with Apple 返回 authorization code，客户端随后把 code 和 state 交给 SyncTV 服务端交换。服务端会拒绝 provider 未声明的模式。
原生授权请求省略 `redirectUrl`，并传入 `native=true`。Apple provider 通过 `supportedModes` 声明原生能力；iOS 和 Mac App Store 构建通过系统 Sign in with Apple 返回 authorization code，客户端随后把 code 和 state 交给 SyncTV 服务端交换。macOS Developer ID 构建使用浏览器授权流程。服务端会拒绝 provider 未声明的模式。
Apple 原生登录不使用 `/.well-known/apple-app-site-association`。该文件属于 Apple Universal Links、浏览器 OAuth 回调关联和 Passkey 关联。

4
docs/src/content/docs/en/configuration/email-oauth2.mdx
Unescape Escape View File

@ -128,7 +128,7 @@ The Microsoft provider also accepts `tenant` (default `common`). The Feishu prov
]
```
`webClientId` is an Apple Services ID for browser authorization and must have the HTTPS Return URL registered. `nativeClientId` is the signed app's Bundle ID for native Sign in with Apple on iOS and macOS; it must match the installed app's Bundle ID. Configure at least one complete pair: `webClientId` plus `webClientSecret` enables browser authorization, while `nativeClientId` plus `nativeClientSecret` enables native authorization. The unused pair can be omitted for a single-mode deployment. Both `clientSecret` values are server credentials generated with the Apple Developer Team, Key ID, private key, and corresponding client ID. Keep them on the server and out of the client or repository.
`webClientId` is an Apple Services ID for browser authorization and must have the HTTPS Return URL registered. `nativeClientId` is the signed app's Bundle ID for native Sign in with Apple on iOS and Mac App Store builds; it must match the installed app's Bundle ID. macOS Developer ID builds use browser authorization because Developer ID profiles do not carry the restricted native Apple entitlement. Configure at least one complete pair: `webClientId` plus `webClientSecret` enables browser authorization, while `nativeClientId` plus `nativeClientSecret` enables native authorization. The unused pair can be omitted for a single-mode deployment. Both `clientSecret` values are server credentials generated with the Apple Developer Team, Key ID, private key, and corresponding client ID. Keep them on the server and out of the client or repository.
The official SyncTV build uses `org.synctv.app`. A self-hosted operator normally does not have the official Apple Developer Team's App ID private key and client secret. A self-hosted Apple distribution should create its own Apple Developer Team, Bundle ID, and Sign in with Apple configuration, sign a client with that Bundle ID, and configure the same value as `nativeClientId`.
@ -158,7 +158,7 @@ Apple configuration links: [Web Sign in with Apple](https://developer.apple.com/
Browser authorization requests pass `redirectUrl`; the server validates HTTPS callbacks against `oauth2.allowedRedirectUrls`, while loopback callbacks are handled separately. Register the same callback URL with the third-party provider.
Native authorization requests omit `redirectUrl` and pass `native=true`. The Apple provider advertises native support through `supportedModes`; iOS and macOS use Apple's system Sign in with Apple flow and return an authorization code to the client, which exchanges it with the SyncTV server. The server rejects modes that the provider has not advertised.
Native authorization requests omit `redirectUrl` and pass `native=true`. The Apple provider advertises native support through `supportedModes`; iOS and Mac App Store builds use Apple's system Sign in with Apple flow and return an authorization code to the client, which exchanges it with the SyncTV server. macOS Developer ID builds use browser authorization. The server rejects modes that the provider has not advertised.
Native Apple login does not use `/.well-known/apple-app-site-association`. That document is used for Apple Universal Links, browser OAuth callback association, and passkey association.

4
docs/src/content/docs/en/integrations/client-integration.mdx
Unescape Escape View File

@ -226,9 +226,9 @@ Then call login with `email` and `email_token`. Do not mix email-login tokens wi
OAuth2/OIDC is frontend-driven:
<Steps>
1. Call `GET /api/oauth2/providers` to discover provider instances, `signupEnabled`, `signupNeedReview`, and `supportedModes`. iOS/macOS prefers an Apple instance supporting both `browser` and `native`; other platforms use `browser`, and unsupported instances stay hidden.
1. Call `GET /api/oauth2/providers` to discover provider instances, `signupEnabled`, `signupNeedReview`, and `supportedModes`. iOS and Mac App Store builds prefer an Apple instance supporting both `browser` and `native`; macOS Developer ID, Windows, Linux, and other platforms use `browser`, and unsupported instances stay hidden.
2. For browser authorization, call `GET /api/oauth2/{provider}/authorize?redirectUrl=<callback>` to get the provider authorization URL and state; `authorizationUrl` is present in this response. For native Apple authorization, call `GET /api/oauth2/{provider}/authorize?native=true` and omit `redirectUrl`; native responses omit `authorizationUrl` and the client uses Apple's system Sign in with Apple flow directly.
3. Browser authorization redirects the user to the provider, which returns `code` and `state` to the client callback. Native Apple authorization uses Sign in with Apple on iOS/macOS and returns `code` and `state` through the platform API. Use the `nonce` returned by the native authorize response as the server-side nonce input: hash it with SHA-256 and set the Apple request nonce to the lowercase hexadecimal digest. Preserve the returned `state` and send it with the code during exchange.
3. Browser authorization redirects the user to the provider, which returns `code` and `state` to the client callback. Native Apple authorization uses Sign in with Apple on iOS and Mac App Store builds and returns `code` and `state` through the platform API. Use the `nonce` returned by the native authorize response as the server-side nonce input: hash it with SHA-256 and set the Apple request nonce to the lowercase hexadecimal digest. Preserve the returned `state` and send it with the code during exchange.
4. Call `POST /api/oauth2/{provider}/exchange`.
5. If the response has `registrationReviewRequired=true`, show pending-review state and keep `registrationReviewId`; do not treat it as logged in.
6. If the response contains tokens, store the SyncTV access and refresh tokens.

2
docs/src/content/docs/en/reference/runtime-settings.mdx
Unescape Escape View File

@ -123,7 +123,7 @@ synctv settings update --set 'oauth2.allowedRedirectUrls=["https://syncs.tv/oaut
Apple browser authorization uses a Services ID and accepts only registered HTTPS Return URLs. Clients pass a request-level `redirectUrl`; the server validates it against `oauth2.allowedRedirectUrls`. macOS and iOS clients receive this HTTPS callback through `ASWebAuthenticationSession`.
Apple native authorization uses `native=true` and omits `redirectUrl`; iOS and macOS receive an authorization code from Sign in with Apple. The Apple provider advertises native support through `supportedModes` in `/api/oauth2/providers`. Configure at least one complete credential pair: `webClientId` with `webClientSecret` enables browser authorization, and `nativeClientId` with `nativeClientSecret` enables native authorization. `nativeClientId` must match the signed app's Bundle ID. The official client uses `org.synctv.app`; a self-hosted distribution normally needs its own Apple Developer Team, Bundle ID, signing, and matching `nativeClientSecret`. See [Email and OAuth2](../../configuration/email-oauth2/).
Apple native authorization uses `native=true` and omits `redirectUrl`; iOS and Mac App Store builds receive an authorization code from Sign in with Apple. macOS Developer ID builds use browser authorization because Developer ID profiles do not carry the restricted native Apple entitlement. The Apple provider advertises native support through `supportedModes` in `/api/oauth2/providers`. Configure at least one complete credential pair: `webClientId` with `webClientSecret` enables browser authorization, and `nativeClientId` with `nativeClientSecret` enables native authorization. `nativeClientId` must match the signed app's Bundle ID. The official client uses `org.synctv.app`; a self-hosted distribution normally needs its own Apple Developer Team, Bundle ID, signing, and matching `nativeClientSecret`. See [Email and OAuth2](../../configuration/email-oauth2/).
Native Apple OAuth does not depend on `/.well-known/apple-app-site-association`. That document serves Universal Links, browser OAuth callback association, and passkeys.

4
docs/src/content/docs/integrations/client-integration.mdx
Unescape Escape View File

@ -232,9 +232,9 @@ curl -sS http://localhost:8080/api/auth/email/request \
OAuth2/OIDC 是前端驱动流程：
<Steps>
1. 调用 `GET /api/oauth2/providers` 获取可用 provider 实例、`signupEnabled`、`signupNeedReview` 和 `supportedModes`。iOS/macOS 优先使用同时支持 `browser` 与 `native` 的 Apple 实例，其他平台使用 `browser`，当前平台不支持的实例隐藏。
1. 调用 `GET /api/oauth2/providers` 获取可用 provider 实例、`signupEnabled`、`signupNeedReview` 和 `supportedModes`。iOS 和 Mac App Store 构建优先使用同时支持 `browser` 与 `native` 的 Apple 实例，macOS Developer ID、Windows、Linux 和其他平台使用 `browser`，当前平台不支持的实例隐藏。
2. 浏览器授权调用 `GET /api/oauth2/{provider}/authorize?redirectUrl=<callback>`，获取第三方授权 URL 和 state；响应的 `authorizationUrl` 必须存在。原生 Apple 授权调用 `GET /api/oauth2/{provider}/authorize?native=true`，省略 `redirectUrl`；原生响应省略 `authorizationUrl`，客户端直接使用系统 Sign in with Apple。
3. 浏览器授权把用户跳转到第三方授权页面，第三方回调到客户端 URL 并带回 `code` 和 `state`。原生 Apple 授权由 iOS/macOS 的 Sign in with Apple 返回 `code` 和 `state`。原生授权响应中的 `nonce` 用作服务端 nonce 输入：客户端对它计算 SHA-256，并把小写十六进制摘要设置为 Apple 请求的 nonce；保留响应中的 `state`，在 exchange 时和 code 一起提交。
3. 浏览器授权把用户跳转到第三方授权页面，第三方回调到客户端 URL 并带回 `code` 和 `state`。原生 Apple 授权由 iOS 和 Mac App Store 构建的 Sign in with Apple 返回 `code` 和 `state`。原生授权响应中的 `nonce` 用作服务端 nonce 输入：客户端对它计算 SHA-256，并把小写十六进制摘要设置为 Apple 请求的 nonce；保留响应中的 `state`，在 exchange 时和 code 一起提交。
4. 客户端调用 `POST /api/oauth2/{provider}/exchange`。
5. 如果响应包含 `registrationReviewRequired=true`，展示待审核状态并保存 `registrationReviewId`，不要把它当作已登录。
6. 如果响应包含 token，保存 SyncTV access/refresh token。

2
docs/src/content/docs/reference/runtime-settings.mdx
Unescape Escape View File

@ -123,7 +123,7 @@ synctv settings update --set 'oauth2.allowedRedirectUrls=["https://syncs.tv/oaut
Apple 浏览器授权使用 Services ID，只接受已登记的 HTTPS Return URL。客户端通过请求级 `redirectUrl` 选择回调地址，地址必须位于 `oauth2.allowedRedirectUrls` 白名单；macOS 和 iOS 客户端通过 `ASWebAuthenticationSession` 接收这个 HTTPS 回调。
Apple 原生授权使用 `native=true`，省略 `redirectUrl`，由 iOS/macOS 的 Sign in with Apple 返回 authorization code。Apple provider 通过 `/api/oauth2/providers` 的 `supportedModes` 声明原生能力。至少配置一组完整凭据：`webClientId` 与 `webClientSecret` 启用浏览器授权，`nativeClientId` 与 `nativeClientSecret` 启用原生授权。`nativeClientId` 必须匹配签名 App 的 Bundle ID。官方客户端使用 `org.synctv.app`；自托管发行通常需要自有 Apple Developer Team、Bundle ID、签名和对应的 `nativeClientSecret`，详见 [邮件与 OAuth2](../../configuration/email-oauth2/)。
Apple 原生授权使用 `native=true`，省略 `redirectUrl`，由 iOS 和 Mac App Store 构建的 Sign in with Apple 返回 authorization code。macOS Developer ID 构建使用 Apple 浏览器授权流程，因为 Developer ID profile 不携带受限制的原生 Apple entitlement。Apple provider 通过 `/api/oauth2/providers` 的 `supportedModes` 声明原生能力。至少配置一组完整凭据：`webClientId` 与 `webClientSecret` 启用浏览器授权，`nativeClientId` 与 `nativeClientSecret` 启用原生授权。`nativeClientId` 必须匹配签名 App 的 Bundle ID。官方客户端使用 `org.synctv.app`；自托管发行通常需要自有 Apple Developer Team、Bundle ID、签名和对应的 `nativeClientSecret`，详见 [邮件与 OAuth2](../../configuration/email-oauth2/)。
原生 Apple OAuth 不依赖 `/.well-known/apple-app-site-association`。该文件用于 Universal Links、浏览器 OAuth 回调关联和 Passkey。

Write Preview
Loading…
Cancel
Save