docs: OTP within secure enclaves — new security page + updated activity types#583
Open
turnkeyintern wants to merge 1 commit intotkhq:mainfrom
Open
docs: OTP within secure enclaves — new security page + updated activity types#583turnkeyintern wants to merge 1 commit intotkhq:mainfrom
turnkeyintern wants to merge 1 commit intotkhq:mainfrom
Conversation
- Add security/otp-enclave.mdx: comprehensive doc covering the enclave-first
OTP architecture (INIT_OTP_V3, VERIFY_OTP_V2, OTP_LOGIN_V2), including
sequence flows, key invariants, client-side security changes from SDK v2026.2.8,
and security controls (bundle sig verification, HPKE encryption, brute-force
protection, inflight limits)
- Update authentication/email.mdx:
- Add callout card linking to new security page with summary of SDK v2026.2.8
client-side security improvements
- Update activity type references: INIT_OTP → INIT_OTP_V3, VERIFY_OTP →
VERIFY_OTP_V2, OTP_LOGIN → OTP_LOGIN_V2
- Expand Breaking Change policy table with VERIFY_OTP_V2 and OTP_LOGIN_V2
version progression
- Update Authorization section to list both enclave (V3) and legacy auth (V3)
paths with correct activity types
- Update authentication/sms.mdx:
- Update How it Works activity types to V3/V2 equivalents
- Add note linking to OTP enclave security page
- Fix sandbox verify/login activity type references
- Update docs.json: add security/otp-enclave to Security tab navigation
References: tkhq/sdk#1220, tkhq/sdk#1221
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds documentation for the new enclave-based OTP architecture released in SDK
v2026.2.8.What changed
New file:
security/otp-enclave.mdxA dedicated security page covering:
Updated:
authentication/email.mdxINIT_OTP→INIT_OTP_V3,VERIFY_OTP→VERIFY_OTP_V2,OTP_LOGIN→OTP_LOGIN_V2VERIFY_OTP_V2andOTP_LOGIN_V2version progressionsUpdated:
authentication/sms.mdxUpdated:
docs.jsonsecurity/otp-enclaveadded to the Security tab navigation (afterenclave-secure-channels)