Merge pull request #2055 from bluesky-social/entryway-twilio

Phone verification on entryway
bluesky-social · Jan 29, 2024 · c7d95e9 · c7d95e9
2 parents 39e2956 + 49ced7c
commit c7d95e9
Show file tree

Hide file tree

Showing 44 changed files with 917 additions and 31 deletions.
diff --git a/.github/workflows/build-and-push-pds-aws.yaml b/.github/workflows/build-and-push-pds-aws.yaml
@@ -3,7 +3,6 @@ on:
   push:
     branches:
       - main
-      - multi-pds-auth
 env:
   REGISTRY: ${{ secrets.AWS_ECR_REGISTRY_USEAST2_PACKAGES_REGISTRY }}
   USERNAME: ${{ secrets.AWS_ECR_REGISTRY_USEAST2_PACKAGES_USERNAME }}

diff --git a/lexicons/com/atproto/server/createAccount.json b/lexicons/com/atproto/server/createAccount.json
@@ -15,6 +15,8 @@
             "handle": { "type": "string", "format": "handle" },
             "did": { "type": "string", "format": "did" },
             "inviteCode": { "type": "string" },
+            "verificationCode": { "type": "string" },
+            "verificationPhone": { "type": "string" },
             "password": { "type": "string" },
             "recoveryKey": { "type": "string" },
             "plcOp": { "type": "unknown" }

diff --git a/lexicons/com/atproto/server/describeServer.json b/lexicons/com/atproto/server/describeServer.json
@@ -12,6 +12,7 @@
           "required": ["availableUserDomains"],
           "properties": {
             "inviteCodeRequired": { "type": "boolean" },
+            "phoneVerificationRequired": { "type": "boolean" },
             "availableUserDomains": {
               "type": "array",
               "items": { "type": "string" }

diff --git a/lexicons/com/atproto/temp/requestPhoneVerification.json b/lexicons/com/atproto/temp/requestPhoneVerification.json
@@ -0,0 +1,20 @@
+{
+  "lexicon": 1,
+  "id": "com.atproto.temp.requestPhoneVerification",
+  "defs": {
+    "main": {
+      "type": "procedure",
+      "description": "Request a verification code to be sent to the supplied phone number",
+      "input": {
+        "encoding": "application/json",
+        "schema": {
+          "type": "object",
+          "required": ["phoneNumber"],
+          "properties": {
+            "phoneNumber": { "type": "string" }
+          }
+        }
+      }
+    }
+  }
+}
diff --git a/packages/api/src/agent.ts b/packages/api/src/agent.ts
@@ -89,12 +89,7 @@ export class AtpAgent {
     opts: AtpAgentCreateAccountOpts,
   ): Promise<ComAtprotoServerCreateAccount.Response> {
     try {
-      const res = await this.api.com.atproto.server.createAccount({
-        handle: opts.handle,
-        password: opts.password,
-        email: opts.email,
-        inviteCode: opts.inviteCode,
-      })
+      const res = await this.api.com.atproto.server.createAccount(opts)
       this.session = {
         accessJwt: res.data.accessJwt,
         refreshJwt: res.data.refreshJwt,

diff --git a/packages/api/src/client/index.ts b/packages/api/src/client/index.ts
@@ -84,6 +84,7 @@ import * as ComAtprotoSyncSubscribeRepos from './types/com/atproto/sync/subscrib
 import * as ComAtprotoTempFetchLabels from './types/com/atproto/temp/fetchLabels'
 import * as ComAtprotoTempImportRepo from './types/com/atproto/temp/importRepo'
 import * as ComAtprotoTempPushBlob from './types/com/atproto/temp/pushBlob'
+import * as ComAtprotoTempRequestPhoneVerification from './types/com/atproto/temp/requestPhoneVerification'
 import * as ComAtprotoTempTransferAccount from './types/com/atproto/temp/transferAccount'
 import * as AppBskyActorDefs from './types/app/bsky/actor/defs'
 import * as AppBskyActorGetPreferences from './types/app/bsky/actor/getPreferences'
@@ -229,6 +230,7 @@ export * as ComAtprotoSyncSubscribeRepos from './types/com/atproto/sync/subscrib
 export * as ComAtprotoTempFetchLabels from './types/com/atproto/temp/fetchLabels'
 export * as ComAtprotoTempImportRepo from './types/com/atproto/temp/importRepo'
 export * as ComAtprotoTempPushBlob from './types/com/atproto/temp/pushBlob'
+export * as ComAtprotoTempRequestPhoneVerification from './types/com/atproto/temp/requestPhoneVerification'
 export * as ComAtprotoTempTransferAccount from './types/com/atproto/temp/transferAccount'
 export * as AppBskyActorDefs from './types/app/bsky/actor/defs'
 export * as AppBskyActorGetPreferences from './types/app/bsky/actor/getPreferences'
@@ -1238,6 +1240,17 @@ export class TempNS {
       })
   }
 
+  requestPhoneVerification(
+    data?: ComAtprotoTempRequestPhoneVerification.InputSchema,
+    opts?: ComAtprotoTempRequestPhoneVerification.CallOptions,
+  ): Promise<ComAtprotoTempRequestPhoneVerification.Response> {
+    return this._service.xrpc
+      .call('com.atproto.temp.requestPhoneVerification', opts?.qp, data, opts)
+      .catch((e) => {
+        throw ComAtprotoTempRequestPhoneVerification.toKnownErr(e)
+      })
+  }
+
   transferAccount(
     data?: ComAtprotoTempTransferAccount.InputSchema,
     opts?: ComAtprotoTempTransferAccount.CallOptions,

diff --git a/packages/api/src/client/lexicons.ts b/packages/api/src/client/lexicons.ts
@@ -2855,6 +2855,12 @@ export const schemaDict = {
               inviteCode: {
                 type: 'string',
               },
+              verificationCode: {
+                type: 'string',
+              },
+              verificationPhone: {
+                type: 'string',
+              },
               password: {
                 type: 'string',
               },
@@ -3259,6 +3265,9 @@ export const schemaDict = {
               inviteCodeRequired: {
                 type: 'boolean',
               },
+              phoneVerificationRequired: {
+                type: 'boolean',
+              },
               availableUserDomains: {
                 type: 'array',
                 items: {
@@ -4331,6 +4340,29 @@ export const schemaDict = {
       },
     },
   },
+  ComAtprotoTempRequestPhoneVerification: {
+    lexicon: 1,
+    id: 'com.atproto.temp.requestPhoneVerification',
+    defs: {
+      main: {
+        type: 'procedure',
+        description:
+          'Request a verification code to be sent to the supplied phone number',
+        input: {
+          encoding: 'application/json',
+          schema: {
+            type: 'object',
+            required: ['phoneNumber'],
+            properties: {
+              phoneNumber: {
+                type: 'string',
+              },
+            },
+          },
+        },
+      },
+    },
+  },
   ComAtprotoTempTransferAccount: {
     lexicon: 1,
     id: 'com.atproto.temp.transferAccount',
@@ -8239,6 +8271,8 @@ export const ids = {
   ComAtprotoTempFetchLabels: 'com.atproto.temp.fetchLabels',
   ComAtprotoTempImportRepo: 'com.atproto.temp.importRepo',
   ComAtprotoTempPushBlob: 'com.atproto.temp.pushBlob',
+  ComAtprotoTempRequestPhoneVerification:
+    'com.atproto.temp.requestPhoneVerification',
   ComAtprotoTempTransferAccount: 'com.atproto.temp.transferAccount',
   AppBskyActorDefs: 'app.bsky.actor.defs',
   AppBskyActorGetPreferences: 'app.bsky.actor.getPreferences',

diff --git a/packages/api/src/client/types/com/atproto/server/createAccount.ts b/packages/api/src/client/types/com/atproto/server/createAccount.ts
@@ -14,6 +14,8 @@ export interface InputSchema {
   handle: string
   did?: string
   inviteCode?: string
+  verificationCode?: string
+  verificationPhone?: string
   password?: string
   recoveryKey?: string
   plcOp?: {}

diff --git a/packages/api/src/client/types/com/atproto/server/describeServer.ts b/packages/api/src/client/types/com/atproto/server/describeServer.ts
@@ -13,6 +13,7 @@ export type InputSchema = undefined
 
 export interface OutputSchema {
   inviteCodeRequired?: boolean
+  phoneVerificationRequired?: boolean
   availableUserDomains: string[]
   links?: Links
   [k: string]: unknown

diff --git a/packages/api/src/client/types/com/atproto/temp/requestPhoneVerification.ts b/packages/api/src/client/types/com/atproto/temp/requestPhoneVerification.ts
@@ -0,0 +1,32 @@
+/**
+ * GENERATED CODE - DO NOT MODIFY
+ */
+import { Headers, XRPCError } from '@atproto/xrpc'
+import { ValidationResult, BlobRef } from '@atproto/lexicon'
+import { isObj, hasProp } from '../../../../util'
+import { lexicons } from '../../../../lexicons'
+import { CID } from 'multiformats/cid'
+
+export interface QueryParams {}
+
+export interface InputSchema {
+  phoneNumber: string
+  [k: string]: unknown
+}
+
+export interface CallOptions {
+  headers?: Headers
+  qp?: QueryParams
+  encoding: 'application/json'
+}
+
+export interface Response {
+  success: boolean
+  headers: Headers
+}
+
+export function toKnownErr(e: any) {
+  if (e instanceof XRPCError) {
+  }
+  return e
+}
diff --git a/packages/api/src/types.ts b/packages/api/src/types.ts
@@ -1,3 +1,4 @@
+import { ComAtprotoServerCreateAccount } from './client'
 import { LabelPreference } from './moderation/types'
 
 /**
@@ -36,12 +37,8 @@ export interface AtpAgentOpts {
 /**
  * AtpAgent createAccount() opts
  */
-export interface AtpAgentCreateAccountOpts {
-  email: string
-  password: string
-  handle: string
-  inviteCode?: string
-}
+export type AtpAgentCreateAccountOpts =
+  ComAtprotoServerCreateAccount.InputSchema
 
 /**
  * AtpAgent login() opts

diff --git a/packages/bsky/src/lexicon/index.ts b/packages/bsky/src/lexicon/index.ts
@@ -81,6 +81,7 @@ import * as ComAtprotoSyncSubscribeRepos from './types/com/atproto/sync/subscrib
 import * as ComAtprotoTempFetchLabels from './types/com/atproto/temp/fetchLabels'
 import * as ComAtprotoTempImportRepo from './types/com/atproto/temp/importRepo'
 import * as ComAtprotoTempPushBlob from './types/com/atproto/temp/pushBlob'
+import * as ComAtprotoTempRequestPhoneVerification from './types/com/atproto/temp/requestPhoneVerification'
 import * as ComAtprotoTempTransferAccount from './types/com/atproto/temp/transferAccount'
 import * as AppBskyActorGetPreferences from './types/app/bsky/actor/getPreferences'
 import * as AppBskyActorGetProfile from './types/app/bsky/actor/getProfile'
@@ -1053,6 +1054,17 @@ export class TempNS {
     return this._server.xrpc.method(nsid, cfg)
   }
 
+  requestPhoneVerification<AV extends AuthVerifier>(
+    cfg: ConfigOf<
+      AV,
+      ComAtprotoTempRequestPhoneVerification.Handler<ExtractAuth<AV>>,
+      ComAtprotoTempRequestPhoneVerification.HandlerReqCtx<ExtractAuth<AV>>
+    >,
+  ) {
+    const nsid = 'com.atproto.temp.requestPhoneVerification' // @ts-ignore
+    return this._server.xrpc.method(nsid, cfg)
+  }
+
   transferAccount<AV extends AuthVerifier>(
     cfg: ConfigOf<
       AV,

diff --git a/packages/bsky/src/lexicon/lexicons.ts b/packages/bsky/src/lexicon/lexicons.ts
@@ -2855,6 +2855,12 @@ export const schemaDict = {
               inviteCode: {
                 type: 'string',
               },
+              verificationCode: {
+                type: 'string',
+              },
+              verificationPhone: {
+                type: 'string',
+              },
               password: {
                 type: 'string',
               },
@@ -3259,6 +3265,9 @@ export const schemaDict = {
               inviteCodeRequired: {
                 type: 'boolean',
               },
+              phoneVerificationRequired: {
+                type: 'boolean',
+              },
               availableUserDomains: {
                 type: 'array',
                 items: {
@@ -4331,6 +4340,29 @@ export const schemaDict = {
       },
     },
   },
+  ComAtprotoTempRequestPhoneVerification: {
+    lexicon: 1,
+    id: 'com.atproto.temp.requestPhoneVerification',
+    defs: {
+      main: {
+        type: 'procedure',
+        description:
+          'Request a verification code to be sent to the supplied phone number',
+        input: {
+          encoding: 'application/json',
+          schema: {
+            type: 'object',
+            required: ['phoneNumber'],
+            properties: {
+              phoneNumber: {
+                type: 'string',
+              },
+            },
+          },
+        },
+      },
+    },
+  },
   ComAtprotoTempTransferAccount: {
     lexicon: 1,
     id: 'com.atproto.temp.transferAccount',
@@ -8239,6 +8271,8 @@ export const ids = {
   ComAtprotoTempFetchLabels: 'com.atproto.temp.fetchLabels',
   ComAtprotoTempImportRepo: 'com.atproto.temp.importRepo',
   ComAtprotoTempPushBlob: 'com.atproto.temp.pushBlob',
+  ComAtprotoTempRequestPhoneVerification:
+    'com.atproto.temp.requestPhoneVerification',
   ComAtprotoTempTransferAccount: 'com.atproto.temp.transferAccount',
   AppBskyActorDefs: 'app.bsky.actor.defs',
   AppBskyActorGetPreferences: 'app.bsky.actor.getPreferences',

diff --git a/packages/bsky/src/lexicon/types/com/atproto/server/createAccount.ts b/packages/bsky/src/lexicon/types/com/atproto/server/createAccount.ts
@@ -15,6 +15,8 @@ export interface InputSchema {
   handle: string
   did?: string
   inviteCode?: string
+  verificationCode?: string
+  verificationPhone?: string
   password?: string
   recoveryKey?: string
   plcOp?: {}

diff --git a/packages/bsky/src/lexicon/types/com/atproto/server/describeServer.ts b/packages/bsky/src/lexicon/types/com/atproto/server/describeServer.ts
@@ -14,6 +14,7 @@ export type InputSchema = undefined
 
 export interface OutputSchema {
   inviteCodeRequired?: boolean
+  phoneVerificationRequired?: boolean
   availableUserDomains: string[]
   links?: Links
   [k: string]: unknown

diff --git a/packages/bsky/src/lexicon/types/com/atproto/temp/requestPhoneVerification.ts b/packages/bsky/src/lexicon/types/com/atproto/temp/requestPhoneVerification.ts
@@ -0,0 +1,38 @@
+/**
+ * GENERATED CODE - DO NOT MODIFY
+ */
+import express from 'express'
+import { ValidationResult, BlobRef } from '@atproto/lexicon'
+import { lexicons } from '../../../../lexicons'
+import { isObj, hasProp } from '../../../../util'
+import { CID } from 'multiformats/cid'
+import { HandlerAuth } from '@atproto/xrpc-server'
+
+export interface QueryParams {}
+
+export interface InputSchema {
+  phoneNumber: string
+  [k: string]: unknown
+}
+
+export interface HandlerInput {
+  encoding: 'application/json'
+  body: InputSchema
+}
+
+export interface HandlerError {
+  status: number
+  message?: string
+}
+
+export type HandlerOutput = HandlerError | void
+export type HandlerReqCtx<HA extends HandlerAuth = never> = {
+  auth: HA
+  params: QueryParams
+  input: HandlerInput
+  req: express.Request
+  res: express.Response
+}
+export type Handler<HA extends HandlerAuth = never> = (
+  ctx: HandlerReqCtx<HA>,
+) => Promise<HandlerOutput> | HandlerOutput
diff --git a/packages/dev-env/src/bin.ts b/packages/dev-env/src/bin.ts
@@ -1,7 +1,7 @@
 import './env'
 import { generateMockSetup } from './mock'
 import { TestNetwork } from './network'
-import { mockMailer } from './util'
+import { mockMailer, mockTwilio } from './util'
 
 const run = async () => {
   console.log(`
@@ -20,13 +20,18 @@ const run = async () => {
       hostname: 'localhost',
       dbPostgresSchema: 'pds',
       enableDidDocWithSession: true,
+      phoneVerificationRequired: true,
+      twilioAccountSid: 'ACXXXXXXX',
+      twilioAuthToken: 'AUTH',
+      twilioServiceSid: 'VAXXXXXXXX',
     },
     bsky: {
       dbPostgresSchema: 'bsky',
     },
     plc: { port: 2582 },
   })
   mockMailer(network.pds)
+  mockTwilio(network.pds)
   await generateMockSetup(network)
 
   console.log(