commit 0d0f59ba4f3ef77396055a66690699b59e4d6af9 · edouard.paris/did-method-plc

+30 -19

packages/lib/src/data.ts

···

       5
       5
        
       import * as crypto from '@atproto/crypto'

     

       6
       6
        
       import * as t from './types'

     

       7
       7
        
       import { didForCreateOp, normalizeOp } from './operations'

     

       8
       8
       -
       import { ServerError } from './error'

     

       8
       8
       +
       import {

     

       9
       9
       +
         GenesisHashError,

     

       10
       10
       +
         ImproperOperationError,

     

       11
       11
       +
         InvalidSignatureError,

     

       12
       12
       +
         LateRecoveryError,

     

       13
       13
       +
         MisorderedOperationError,

     

       14
       14
       +
         UnsupportedKeyError,

     

       15
       15
       +
       } from './error'

     

       9
       16
        
       

     

       10
       17
        
       export const assureValidNextOp = async (

     

       11
       18
        
         did: string,

     
···

       14
       21
        
       ): Promise<{ nullified: CID[]; prev: CID | null }> => {

     

       15
       22
        
         // ensure we support the proposed keys

     

       16
       23
        
         const keys = [proposed.signingKey, ...proposed.rotationKeys]

     

       17
       17
       -
         await Promise.all(keys.map((k) => crypto.parseDidKey(k)))

     

       24
       24
       +
         await Promise.all(

     

       25
       25
       +
           keys.map(async (k) => {

     

       26
       26
       +
             try {

     

       27
       27
       +
               crypto.parseDidKey(k)

     

       28
       28
       +
             } catch (err) {

     

       29
       29
       +
               throw new UnsupportedKeyError(k, err)

     

       30
       30
       +
             }

     

       31
       31
       +
           }),

     

       32
       32
       +
         )

     

       18
       33
        
       

     

       19
       34
        
         // special case if account creation

     

       20
       35
        
         if (ops.length === 0) {

     
···

       24
       39
        
       

     

       25
       40
        
         const proposedPrev = proposed.prev ? CID.parse(proposed.prev) : undefined

     

       26
       41
        
         if (!proposedPrev) {

     

       27
       27
       -
           throw new ServerError(400, `Invalid prev on operation: ${proposed.prev}`)

     

       42
       42
       +
           throw new ImproperOperationError('could not parse prev', proposed)

     

       28
       43
        
         }

     

       29
       44
        
       

     

       30
       45
        
         const indexOfPrev = ops.findIndex((op) => proposedPrev.equals(op.cid))

     

       31
       46
        
         if (indexOfPrev < 0) {

     

       32
       32
       -
           throw new ServerError(409, 'Operations not correctly ordered')

     

       47
       47
       +
           throw new MisorderedOperationError()

     

       33
       48
        
         }

     

       34
       49
        
       

     

       35
       50
        
         // if we are forking history, these are the ops still in the proposed canonical history

     
···

       37
       52
        
         const nullified = ops.slice(indexOfPrev + 1)

     

       38
       53
        
         const lastOp = opsInHistory.at(-1)

     

       39
       54
        
         if (!lastOp) {

     

       40
       40
       -
           throw new ServerError(400, 'Could not locate last op in history')

     

       55
       55
       +
           throw new MisorderedOperationError()

     

       41
       56
        
         }

     

       42
       57
        
         const lastOpNormalized = normalizeOp(lastOp.operation)

     

       43
       58
        
         const firstNullified = nullified[0]

     
···

       66
       81
        
           const RECOVERY_WINDOW = 72 * HOUR

     

       67
       82
        
           const timeLapsed = Date.now() - firstNullified.createdAt.getTime()

     

       68
       83
        
           if (timeLapsed > RECOVERY_WINDOW) {

     

       69
       69
       -
             throw new ServerError(

     

       70
       70
       -
               400,

     

       71
       71
       -
               'Recovery operation occured outside of the allowed 72 hr recovery window',

     

       72
       72
       -
             )

     

       84
       84
       +
             throw new LateRecoveryError(timeLapsed)

     

       73
       85
        
           }

     

       74
       86
        
         }

     

       75
       87
        
       

     
···

       86
       98
        
         // make sure they're all validly formatted operations

     

       87
       99
        
         const [first, ...rest] = ops

     

       88
       100
        
         if (!check.is(first, t.def.compatibleOp)) {

     

       89
       89
       -
           throw new ServerError(400, `Improperly formatted operation: ${first}`)

     

       101
       101
       +
           throw new ImproperOperationError('incorrect structure', first)

     

       90
       102
        
         }

     

       91
       103
        
         for (const op of rest) {

     

       92
       104
        
           if (!check.is(op, t.def.operation)) {

     

       93
       93
       -
             throw new ServerError(400, `Improperly formatted operation: ${op}`)

     

       105
       105
       +
             throw new ImproperOperationError('incorrect structure', op)

     

       94
       106
        
           }

     

       95
       107
        
         }

     

       96
       108
        
       

     
···

       100
       112
        
       

     

       101
       113
        
         for (const op of rest) {

     

       102
       114
        
           if (!op.prev || !CID.parse(op.prev).equals(prev)) {

     

       103
       103
       -
             throw new ServerError(400, 'Operations not correctly ordered')

     

       115
       115
       +
             throw new MisorderedOperationError()

     

       104
       116
        
           }

     

       105
       117
        
       

     

       106
       118
        
           await assureValidSig(doc.rotationKeys, op)

     
···

       120
       132
        
         await assureValidSig(normalized.rotationKeys, op)

     

       121
       133
        
         const expectedDid = await didForCreateOp(op, 64)

     

       122
       134
        
         if (!expectedDid.startsWith(did)) {

     

       123
       123
       -
           throw new ServerError(

     

       124
       124
       -
             400,

     

       125
       125
       -
             `Hash of genesis operation does not match DID identifier: ${expectedDid}`,

     

       126
       126
       -
           )

     

       135
       135
       +
           throw new GenesisHashError(expectedDid)

     

       127
       136
        
         }

     

       128
       137
        
         if (op.prev !== null) {

     

       129
       129
       -
           throw new ServerError(400, `Prev of create op is not null: ${op}`)

     

       138
       138
       +
           throw new ImproperOperationError('expected null prev on create', op)

     

       130
       139
        
         }

     

       131
       140
        
         const { signingKey, rotationKeys, handles, services } = normalized

     

       132
       141
        
         return { did, signingKey, rotationKeys, handles, services }

     
···

       142
       151
        
         let isValid = true

     

       143
       152
        
         for (const did of allowedDids) {

     

       144
       153
        
           isValid = await crypto.verifySignature(did, dataBytes, sigBytes)

     

       145
       145
       -
           if (isValid) return did

     

       154
       154
       +
           if (isValid) {

     

       155
       155
       +
             return did

     

       156
       156
       +
           }

     

       146
       157
        
         }

     

       147
       147
       -
         throw new ServerError(400, `Invalid signature on op: ${JSON.stringify(op)}`)

     

       158
       158
       +
         throw new InvalidSignatureError(op)

     

       148
       159
        
       }

+5 -4

packages/lib/src/document.ts

···

       1
       1
        
       import * as uint8arrays from 'uint8arrays'

     

       2
       2
        
       import * as crypto from '@atproto/crypto'

     

       3
       3
        
       import * as t from './types'

     

       4
       4
       -
       import { ServerError } from './error'

     

       4
       4
       +
       import { UnsupportedKeyError } from './error'

     

       5
       5
       +
       import { ParsedDidKey } from '@atproto/crypto'

     

       5
       6
        
       

     

       6
       7
        
       export const formatDidDoc = (data: t.DocumentData): t.DidDocument => {

     

       7
       8
        
         const context = ['https://www.w3.org/ns/did/v1']

     
···

       53
       54
        
       }

     

       54
       55
        
       

     

       55
       56
        
       const formatKeyAndContext = (key: string): KeyAndContext => {

     

       56
       56
       -
         let keyInfo

     

       57
       57
       +
         let keyInfo: ParsedDidKey

     

       57
       58
        
         try {

     

       58
       59
        
           keyInfo = crypto.parseDidKey(key)

     

       59
       60
        
         } catch (err) {

     

       60
       60
       -
           throw new ServerError(400, `Could not parse did:key: ${err}`)

     

       61
       61
       +
           throw new UnsupportedKeyError(key, err)

     

       61
       62
        
         }

     

       62
       63
        
         const { jwtAlg, keyBytes } = keyInfo

     

       63
       64
        
       

     
···

       74
       75
        
             publicKeyMultibase: `z${uint8arrays.toString(keyBytes, 'base58btc')}`,

     

       75
       76
        
           }

     

       76
       77
        
         }

     

       77
       77
       -
         throw new ServerError(400, `Unsupported key type: ${jwtAlg}`)

     

       78
       78
       +
         throw new UnsupportedKeyError(key, `Unsupported key type: ${jwtAlg}`)

     

       78
       79
        
       }

     

       79
       80
        
       

     

       80
       81
        
       export const ensureHttpPrefix = (str: string): string => {

+37 -4

packages/lib/src/error.ts

···

       1
       1
       -
       // @TODO fix

     

       2
       2
       -
       export class ServerError extends Error {

     

       3
       3
       -
         constructor(public code: number, msg: string) {

     

       4
       4
       -
           super(msg)

     

       1
       1
       +
       export class ImproperOperationError extends Error {

     

       2
       2
       +
         constructor(public reason: string, public op: unknown) {

     

       3
       3
       +
           super(`Improperly formatted operation, ${reason}: ${op}`)

     

       4
       4
       +
         }

     

       5
       5
       +
       }

     

       6
       6
       +
       

     

       7
       7
       +
       export class MisorderedOperationError extends Error {

     

       8
       8
       +
         constructor() {

     

       9
       9
       +
           super('Operations not correctly ordered')

     

       10
       10
       +
         }

     

       11
       11
       +
       }

     

       12
       12
       +
       

     

       13
       13
       +
       export class LateRecoveryError extends Error {

     

       14
       14
       +
         constructor(public timeLapsed: number) {

     

       15
       15
       +
           super(

     

       16
       16
       +
             `Recovery operation occured outside of the allowed 72 hr recovery window. Time lapsed: ${timeLapsed}`,

     

       17
       17
       +
           )

     

       18
       18
       +
         }

     

       19
       19
       +
       }

     

       20
       20
       +
       

     

       21
       21
       +
       export class GenesisHashError extends Error {

     

       22
       22
       +
         constructor(public expected: string) {

     

       23
       23
       +
           super(

     

       24
       24
       +
             `Hash of genesis operation does not match DID identifier: ${expected}`,

     

       25
       25
       +
           )

     

       26
       26
       +
         }

     

       27
       27
       +
       }

     

       28
       28
       +
       

     

       29
       29
       +
       export class InvalidSignatureError extends Error {

     

       30
       30
       +
         constructor(public op: unknown) {

     

       31
       31
       +
           super(`Invalid signature on op: ${JSON.stringify(op)}`)

     

       32
       32
       +
         }

     

       33
       33
       +
       }

     

       34
       34
       +
       

     

       35
       35
       +
       export class UnsupportedKeyError extends Error {

     

       36
       36
       +
         constructor(public key: string, public err: unknown) {

     

       37
       37
       +
           super(`Unsupported key type ${key}: ${err}`)

     

       5
       38
        
         }

     

       6
       39
        
       }

+2 -1

packages/lib/src/index.ts

···

       1
       1
       +
       export * from './client'

     

       1
       2
        
       export * from './data'

     

       2
       3
        
       export * from './document'

     

       4
       4
       +
       export * from './error'

     

       3
       5
        
       export * from './operations'

     

       4
       6
        
       export * from './types'

     

       5
       5
       -
       export * from './client'

+12

packages/lib/src/operations.ts

···

       23
       23
        
         }

     

       24
       24
        
       }

     

       25
       25
        
       

     

       26
       26
       +
       export const deprecatedSignCreate = async (

     

       27
       27
       +
         op: t.UnsignedCreateOpV1,

     

       28
       28
       +
         signingKey: Keypair,

     

       29
       29
       +
       ): Promise<t.CreateOpV1> => {

     

       30
       30
       +
         const data = new Uint8Array(cbor.encode(op))

     

       31
       31
       +
         const sig = await signingKey.sign(data)

     

       32
       32
       +
         return {

     

       33
       33
       +
           ...op,

     

       34
       34
       +
           sig: uint8arrays.toString(sig, 'base64url'),

     

       35
       35
       +
         }

     

       36
       36
       +
       }

     

       37
       37
       +
       

     

       26
       38
        
       export const normalizeOp = (op: t.CompatibleOp): t.Operation => {

     

       27
       39
        
         if (check.is(op, t.def.operation)) {

     

       28
       40
        
           return op

+224

packages/lib/tests/data.test.ts

···

       1
       1
       +
       import { check, cidForCbor } from '@atproto/common'

     

       2
       2
       +
       import {

     

       3
       3
       +
         EcdsaKeypair,

     

       4
       4
       +
         Keypair,

     

       5
       5
       +
         parseDidKey,

     

       6
       6
       +
         Secp256k1Keypair,

     

       7
       7
       +
       } from '@atproto/crypto'

     

       8
       8
       +
       import * as uint8arrays from 'uint8arrays'

     

       9
       9
       +
       import { InvalidSignatureError } from '../src'

     

       10
       10
       +
       import * as data from '../src/data'

     

       11
       11
       +
       import * as document from '../src/document'

     

       12
       12
       +
       import * as operations from '../src/operations'

     

       13
       13
       +
       import * as t from '../src/types'

     

       14
       14
       +
       

     

       15
       15
       +
       describe('plc did data', () => {

     

       16
       16
       +
         const ops: t.Operation[] = []

     

       17
       17
       +
       

     

       18
       18
       +
         let signingKey: Secp256k1Keypair

     

       19
       19
       +
         let rotationKey1: Secp256k1Keypair

     

       20
       20
       +
         let rotationKey2: EcdsaKeypair

     

       21
       21
       +
         let did: string

     

       22
       22
       +
         let handle = 'alice.example.com'

     

       23
       23
       +
         let atpPds = 'https://example.com'

     

       24
       24
       +
       

     

       25
       25
       +
         let oldSigningKey: Secp256k1Keypair

     

       26
       26
       +
         let oldRotationKey1: Secp256k1Keypair

     

       27
       27
       +
       

     

       28
       28
       +
         beforeAll(async () => {

     

       29
       29
       +
           signingKey = await Secp256k1Keypair.create()

     

       30
       30
       +
           rotationKey1 = await Secp256k1Keypair.create()

     

       31
       31
       +
           rotationKey2 = await EcdsaKeypair.create()

     

       32
       32
       +
         })

     

       33
       33
       +
       

     

       34
       34
       +
         const makeNextOp = async (

     

       35
       35
       +
           changes: Partial<t.Operation>,

     

       36
       36
       +
           key: Keypair,

     

       37
       37
       +
         ): Promise<t.Operation> => {

     

       38
       38
       +
           const lastOp = ops.at(-1)

     

       39
       39
       +
           if (!lastOp) {

     

       40
       40
       +
             throw new Error('expected an op on log')

     

       41
       41
       +
           }

     

       42
       42
       +
           const prev = await cidForCbor(lastOp)

     

       43
       43
       +
           return operations.signOperation(

     

       44
       44
       +
             {

     

       45
       45
       +
               signingKey: lastOp.signingKey,

     

       46
       46
       +
               rotationKeys: lastOp.rotationKeys,

     

       47
       47
       +
               handles: lastOp.handles,

     

       48
       48
       +
               services: lastOp.services,

     

       49
       49
       +
               prev: prev.toString(),

     

       50
       50
       +
               ...changes,

     

       51
       51
       +
             },

     

       52
       52
       +
             key,

     

       53
       53
       +
           )

     

       54
       54
       +
         }

     

       55
       55
       +
       

     

       56
       56
       +
         it('creates a valid create op', async () => {

     

       57
       57
       +
           const createOp = await operations.signOperation(

     

       58
       58
       +
             {

     

       59
       59
       +
               signingKey: signingKey.did(),

     

       60
       60
       +
               rotationKeys: [rotationKey1.did(), rotationKey2.did()],

     

       61
       61
       +
               handles: [handle],

     

       62
       62
       +
               services: {

     

       63
       63
       +
                 atpPds,

     

       64
       64
       +
               },

     

       65
       65
       +
               prev: null,

     

       66
       66
       +
             },

     

       67
       67
       +
             rotationKey1,

     

       68
       68
       +
           )

     

       69
       69
       +
           const isValid = check.is(createOp, t.def.operation)

     

       70
       70
       +
           expect(isValid).toBeTruthy()

     

       71
       71
       +
           ops.push(createOp)

     

       72
       72
       +
           did = await operations.didForCreateOp(createOp)

     

       73
       73
       +
         })

     

       74
       74
       +
       

     

       75
       75
       +
         it('parses an operation log with no updates', async () => {

     

       76
       76
       +
           const doc = await data.validateOperationLog(did, ops)

     

       77
       77
       +
       

     

       78
       78
       +
           expect(doc.did).toEqual(did)

     

       79
       79
       +
           expect(doc.signingKey).toEqual(signingKey.did())

     

       80
       80
       +
           expect(doc.rotationKeys).toEqual([rotationKey1.did(), rotationKey2.did()])

     

       81
       81
       +
           expect(doc.handles).toEqual([handle])

     

       82
       82
       +
           expect(doc.services).toEqual({ atpPds })

     

       83
       83
       +
         })

     

       84
       84
       +
       

     

       85
       85
       +
         it('updates handle', async () => {

     

       86
       86
       +
           handle = 'ali.example2.com'

     

       87
       87
       +
           const op = await makeNextOp({ handles: [handle] }, rotationKey1)

     

       88
       88
       +
           ops.push(op)

     

       89
       89
       +
       

     

       90
       90
       +
           const doc = await data.validateOperationLog(did, ops)

     

       91
       91
       +
           expect(doc.did).toEqual(did)

     

       92
       92
       +
           expect(doc.signingKey).toEqual(signingKey.did())

     

       93
       93
       +
           expect(doc.rotationKeys).toEqual([rotationKey1.did(), rotationKey2.did()])

     

       94
       94
       +
           expect(doc.handles).toEqual([handle])

     

       95
       95
       +
           expect(doc.services).toEqual({ atpPds })

     

       96
       96
       +
         })

     

       97
       97
       +
       

     

       98
       98
       +
         it('updates atpPds', async () => {

     

       99
       99
       +
           atpPds = 'https://example2.com'

     

       100
       100
       +
           const op = await makeNextOp(

     

       101
       101
       +
             {

     

       102
       102
       +
               services: {

     

       103
       103
       +
                 atpPds,

     

       104
       104
       +
               },

     

       105
       105
       +
             },

     

       106
       106
       +
             rotationKey1,

     

       107
       107
       +
           )

     

       108
       108
       +
           ops.push(op)

     

       109
       109
       +
       

     

       110
       110
       +
           const doc = await data.validateOperationLog(did, ops)

     

       111
       111
       +
           expect(doc.did).toEqual(did)

     

       112
       112
       +
           expect(doc.signingKey).toEqual(signingKey.did())

     

       113
       113
       +
           expect(doc.rotationKeys).toEqual([rotationKey1.did(), rotationKey2.did()])

     

       114
       114
       +
           expect(doc.handles).toEqual([handle])

     

       115
       115
       +
           expect(doc.services).toEqual({ atpPds })

     

       116
       116
       +
         })

     

       117
       117
       +
       

     

       118
       118
       +
         it('rotates signingKey', async () => {

     

       119
       119
       +
           const newSigningKey = await Secp256k1Keypair.create()

     

       120
       120
       +
           const op = await makeNextOp(

     

       121
       121
       +
             {

     

       122
       122
       +
               signingKey: newSigningKey.did(),

     

       123
       123
       +
             },

     

       124
       124
       +
             rotationKey1,

     

       125
       125
       +
           )

     

       126
       126
       +
           ops.push(op)

     

       127
       127
       +
       

     

       128
       128
       +
           oldSigningKey = signingKey

     

       129
       129
       +
           signingKey = newSigningKey

     

       130
       130
       +
       

     

       131
       131
       +
           const doc = await data.validateOperationLog(did, ops)

     

       132
       132
       +
           expect(doc.did).toEqual(did)

     

       133
       133
       +
           expect(doc.signingKey).toEqual(signingKey.did())

     

       134
       134
       +
           expect(doc.rotationKeys).toEqual([rotationKey1.did(), rotationKey2.did()])

     

       135
       135
       +
           expect(doc.handles).toEqual([handle])

     

       136
       136
       +
           expect(doc.services).toEqual({ atpPds })

     

       137
       137
       +
         })

     

       138
       138
       +
       

     

       139
       139
       +
         it('rotates rotation keys', async () => {

     

       140
       140
       +
           const newRotationKey = await Secp256k1Keypair.create()

     

       141
       141
       +
           const op = await makeNextOp(

     

       142
       142
       +
             {

     

       143
       143
       +
               rotationKeys: [newRotationKey.did(), rotationKey2.did()],

     

       144
       144
       +
             },

     

       145
       145
       +
             rotationKey1,

     

       146
       146
       +
           )

     

       147
       147
       +
           ops.push(op)

     

       148
       148
       +
       

     

       149
       149
       +
           oldRotationKey1 = rotationKey1

     

       150
       150
       +
           rotationKey1 = newRotationKey

     

       151
       151
       +
       

     

       152
       152
       +
           const doc = await data.validateOperationLog(did, ops)

     

       153
       153
       +
           expect(doc.did).toEqual(did)

     

       154
       154
       +
           expect(doc.signingKey).toEqual(signingKey.did())

     

       155
       155
       +
           expect(doc.rotationKeys).toEqual([rotationKey1.did(), rotationKey2.did()])

     

       156
       156
       +
           expect(doc.handles).toEqual([handle])

     

       157
       157
       +
           expect(doc.services).toEqual({ atpPds })

     

       158
       158
       +
         })

     

       159
       159
       +
       

     

       160
       160
       +
         it('no longer allows operations from old rotation key', async () => {

     

       161
       161
       +
           const op = await makeNextOp(

     

       162
       162
       +
             {

     

       163
       163
       +
               handles: ['bob'],

     

       164
       164
       +
             },

     

       165
       165
       +
             oldRotationKey1,

     

       166
       166
       +
           )

     

       167
       167
       +
           expect(data.validateOperationLog(did, [...ops, op])).rejects.toThrow(

     

       168
       168
       +
             InvalidSignatureError,

     

       169
       169
       +
           )

     

       170
       170
       +
         })

     

       171
       171
       +
       

     

       172
       172
       +
         it('does not allow operations from the signingKey', async () => {

     

       173
       173
       +
           const op = await makeNextOp(

     

       174
       174
       +
             {

     

       175
       175
       +
               handles: ['bob'],

     

       176
       176
       +
             },

     

       177
       177
       +
             signingKey,

     

       178
       178
       +
           )

     

       179
       179
       +
           expect(data.validateOperationLog(did, [...ops, op])).rejects.toThrow(

     

       180
       180
       +
             InvalidSignatureError,

     

       181
       181
       +
           )

     

       182
       182
       +
         })

     

       183
       183
       +
       

     

       184
       184
       +
         it('allows for operations from either rotation key', async () => {

     

       185
       185
       +
           const newHandle = 'ali.example.com'

     

       186
       186
       +
           const op = await makeNextOp(

     

       187
       187
       +
             {

     

       188
       188
       +
               handles: [newHandle],

     

       189
       189
       +
             },

     

       190
       190
       +
             rotationKey2,

     

       191
       191
       +
           )

     

       192
       192
       +
           const doc = await data.validateOperationLog(did, ops)

     

       193
       193
       +
           expect(doc.did).toEqual(did)

     

       194
       194
       +
           expect(doc.signingKey).toEqual(signingKey.did())

     

       195
       195
       +
           expect(doc.rotationKeys).toEqual([rotationKey1.did(), rotationKey2.did()])

     

       196
       196
       +
           expect(doc.handles).toEqual([handle])

     

       197
       197
       +
           expect(doc.services).toEqual({ atpPds })

     

       198
       198
       +
         })

     

       199
       199
       +
       

     

       200
       200
       +
         // it('requires operations to be in order', async () => {

     

       201
       201
       +
         //   const prev = await cidForCbor(ops[ops.length - 2])

     

       202
       202
       +
         //   const op = await operations.updateAtpPds(

     

       203
       203
       +
         //     'foobar.com',

     

       204
       204
       +
         //     prev.toString(),

     

       205
       205
       +
         //     signingKey,

     

       206
       206
       +
         //   )

     

       207
       207
       +
         //   expect(document.validateOperationLog(did, [...ops, op])).rejects.toThrow()

     

       208
       208
       +
         // })

     

       209
       209
       +
       

     

       210
       210
       +
         // it('does not allow a create operation in the middle of the log', async () => {

     

       211
       211
       +
         //   const op = await operations.create(

     

       212
       212
       +
         //     signingKey,

     

       213
       213
       +
         //     recoveryKey.did(),

     

       214
       214
       +
         //     handle,

     

       215
       215
       +
         //     atpPds,

     

       216
       216
       +
         //   )

     

       217
       217
       +
         //   expect(document.validateOperationLog(did, [...ops, op])).rejects.toThrow()

     

       218
       218
       +
         // })

     

       219
       219
       +
       

     

       220
       220
       +
         // it('requires that the log start with a create operation', async () => {

     

       221
       221
       +
         //   const rest = ops.slice(1)

     

       222
       222
       +
         //   expect(document.validateOperationLog(did, rest)).rejects.toThrow()

     

       223
       223
       +
         // })

     

       224
       224
       +
       })

+70 -255

packages/lib/tests/document.test.ts

···

       1
       1
       -
       import { check, cidForCbor } from '@atproto/common'

     

       1
       1
       +
       import * as uint8arrays from 'uint8arrays'

     

       2
       2
        
       import { EcdsaKeypair, parseDidKey, Secp256k1Keypair } from '@atproto/crypto'

     

       3
       3
       -
       import * as uint8arrays from 'uint8arrays'

     

       4
       3
        
       import * as document from '../src/document'

     

       5
       5
       -
       import * as operations from '../src/operations'

     

       6
       4
        
       import * as t from '../src/types'

     

       7
       5
        
       

     

       8
       8
       -
       describe('plc DID document', () => {

     

       9
       9
       -
         const ops: t.Operation[] = []

     

       10
       10
       -
       

     

       11
       11
       -
         let signingKey: EcdsaKeypair

     

       12
       12
       -
         let recoveryKey: Secp256k1Keypair

     

       13
       13
       -
         let did: string

     

       14
       14
       -
         let handle = 'alice.example.com'

     

       15
       15
       -
         let atpPds = 'https://example.com'

     

       16
       16
       -
       

     

       17
       17
       -
         let oldSigningKey: EcdsaKeypair

     

       18
       18
       -
         let oldRecoveryKey: Secp256k1Keypair

     

       19
       19
       -
       

     

       20
       20
       -
         beforeAll(async () => {

     

       21
       21
       -
           signingKey = await EcdsaKeypair.create()

     

       22
       22
       -
           recoveryKey = await Secp256k1Keypair.create()

     

       23
       23
       -
         })

     

       24
       24
       -
       

     

       25
       25
       -
         it('creates a valid create op', async () => {

     

       26
       26
       -
           const createOp = await operations.create(

     

       27
       27
       -
             signingKey,

     

       28
       28
       -
             recoveryKey.did(),

     

       29
       29
       -
             handle,

     

       30
       30
       -
             atpPds,

     

       31
       31
       -
           )

     

       32
       32
       -
           const isValid = check.is(createOp, t.def.createOp)

     

       33
       33
       -
           expect(isValid).toBeTruthy()

     

       34
       34
       -
           ops.push(createOp)

     

       35
       35
       -
           did = await operations.didForCreateOp(createOp)

     

       36
       36
       -
         })

     

       37
       37
       -
       

     

       38
       38
       -
         it('parses an operation log with no updates', async () => {

     

       39
       39
       -
           const doc = await document.validateOperationLog(did, ops)

     

       40
       40
       -
       

     

       41
       41
       -
           expect(doc.did).toEqual(did)

     

       42
       42
       -
           expect(doc.signingKey).toEqual(signingKey.did())

     

       43
       43
       -
           expect(doc.recoveryKey).toEqual(recoveryKey.did())

     

       44
       44
       -
           expect(doc.handle).toEqual(handle)

     

       45
       45
       -
           expect(doc.atpPds).toEqual(atpPds)

     

       46
       46
       -
         })

     

       47
       47
       -
       

     

       48
       48
       -
         it('allows for updating handle', async () => {

     

       49
       49
       -
           handle = 'ali.example2.com'

     

       50
       50
       -
           const prev = await cidForCbor(ops[ops.length - 1])

     

       51
       51
       -
           const op = await operations.updateHandle(

     

       52
       52
       -
             handle,

     

       53
       53
       -
             prev.toString(),

     

       54
       54
       -
             signingKey,

     

       55
       55
       -
           )

     

       56
       56
       -
           ops.push(op)

     

       57
       57
       -
       

     

       58
       58
       -
           const doc = await document.validateOperationLog(did, ops)

     

       59
       59
       -
           expect(doc.did).toEqual(did)

     

       60
       60
       -
           expect(doc.signingKey).toEqual(signingKey.did())

     

       61
       61
       -
           expect(doc.recoveryKey).toEqual(recoveryKey.did())

     

       62
       62
       -
           expect(doc.handle).toEqual(handle)

     

       63
       63
       -
           expect(doc.atpPds).toEqual(atpPds)

     

       64
       64
       -
         })

     

       65
       65
       -
       

     

       66
       66
       -
         it('allows for updating atpPds', async () => {

     

       67
       67
       -
           atpPds = 'https://example2.com'

     

       68
       68
       -
           const prev = await cidForCbor(ops[ops.length - 1])

     

       69
       69
       -
           const op = await operations.updateAtpPds(

     

       70
       70
       -
             atpPds,

     

       71
       71
       -
             prev.toString(),

     

       72
       72
       -
             signingKey,

     

       73
       73
       -
           )

     

       74
       74
       -
           ops.push(op)

     

       75
       75
       -
       

     

       76
       76
       -
           const doc = await document.validateOperationLog(did, ops)

     

       77
       77
       -
           expect(doc.did).toEqual(did)

     

       78
       78
       -
           expect(doc.signingKey).toEqual(signingKey.did())

     

       79
       79
       -
           expect(doc.recoveryKey).toEqual(recoveryKey.did())

     

       80
       80
       -
           expect(doc.handle).toEqual(handle)

     

       81
       81
       -
           expect(doc.atpPds).toEqual(atpPds)

     

       82
       82
       -
         })

     

       83
       83
       -
       

     

       84
       84
       -
         it('allows for rotating signingKey', async () => {

     

       85
       85
       -
           const newSigningKey = await EcdsaKeypair.create()

     

       86
       86
       -
           const prev = await cidForCbor(ops[ops.length - 1])

     

       87
       87
       -
           const op = await operations.rotateSigningKey(

     

       88
       88
       -
             newSigningKey.did(),

     

       89
       89
       -
             prev.toString(),

     

       90
       90
       -
             signingKey,

     

       91
       91
       -
           )

     

       92
       92
       -
           ops.push(op)

     

       93
       93
       -
           oldSigningKey = signingKey

     

       94
       94
       -
           signingKey = newSigningKey

     

       95
       95
       -
       

     

       96
       96
       -
           const doc = await document.validateOperationLog(did, ops)

     

       97
       97
       -
           expect(doc.did).toEqual(did)

     

       98
       98
       -
           expect(doc.signingKey).toEqual(signingKey.did())

     

       99
       99
       -
           expect(doc.recoveryKey).toEqual(recoveryKey.did())

     

       100
       100
       -
           expect(doc.handle).toEqual(handle)

     

       101
       101
       -
           expect(doc.atpPds).toEqual(atpPds)

     

       102
       102
       -
         })

     

       103
       103
       -
       

     

       104
       104
       -
         it('no longer allows operations from old signing key', async () => {

     

       105
       105
       -
           const prev = await cidForCbor(ops[ops.length - 1])

     

       106
       106
       -
           const op = await operations.updateHandle(

     

       107
       107
       -
             'bob',

     

       108
       108
       -
             prev.toString(),

     

       109
       109
       -
             oldSigningKey,

     

       110
       110
       -
           )

     

       111
       111
       -
           expect(document.validateOperationLog(did, [...ops, op])).rejects.toThrow()

     

       112
       112
       -
         })

     

       113
       113
       -
       

     

       114
       114
       -
         it('allows for rotating recoveryKey', async () => {

     

       115
       115
       -
           const newRecoveryKey = await Secp256k1Keypair.create()

     

       116
       116
       -
           const prev = await cidForCbor(ops[ops.length - 1])

     

       117
       117
       -
           const op = await operations.rotateRecoveryKey(

     

       118
       118
       -
             newRecoveryKey.did(),

     

       119
       119
       -
             prev.toString(),

     

       120
       120
       -
             signingKey,

     

       121
       121
       -
           )

     

       122
       122
       -
           ops.push(op)

     

       123
       123
       -
           oldRecoveryKey = recoveryKey

     

       124
       124
       -
           recoveryKey = newRecoveryKey

     

       125
       125
       -
       

     

       126
       126
       -
           const doc = await document.validateOperationLog(did, ops)

     

       127
       127
       -
           expect(doc.did).toEqual(did)

     

       128
       128
       -
           expect(doc.signingKey).toEqual(signingKey.did())

     

       129
       129
       -
           expect(doc.recoveryKey).toEqual(recoveryKey.did())

     

       130
       130
       -
           expect(doc.handle).toEqual(handle)

     

       131
       131
       -
           expect(doc.atpPds).toEqual(atpPds)

     

       132
       132
       -
         })

     

       133
       133
       -
       

     

       134
       134
       -
         it('no longer allows operations from old recovery key', async () => {

     

       135
       135
       -
           const prev = await cidForCbor(ops[ops.length - 1])

     

       136
       136
       -
           const op = await operations.updateHandle(

     

       137
       137
       -
             'bob',

     

       138
       138
       -
             prev.toString(),

     

       139
       139
       -
             oldRecoveryKey,

     

       140
       140
       -
           )

     

       141
       141
       -
           expect(document.validateOperationLog(did, [...ops, op])).rejects.toThrow()

     

       142
       142
       -
         })

     

       143
       143
       -
       

     

       144
       144
       -
         it('it allows recovery key to rotate signing key', async () => {

     

       145
       145
       -
           const newKey = await EcdsaKeypair.create()

     

       146
       146
       -
           const prev = await cidForCbor(ops[ops.length - 1])

     

       147
       147
       -
           const op = await operations.rotateSigningKey(

     

       148
       148
       -
             newKey.did(),

     

       149
       149
       -
             prev.toString(),

     

       150
       150
       -
             recoveryKey,

     

       151
       151
       -
           )

     

       152
       152
       -
           ops.push(op)

     

       153
       153
       -
           signingKey = newKey

     

       154
       154
       -
           const doc = await document.validateOperationLog(did, ops)

     

       155
       155
       -
           expect(doc.signingKey).toEqual(newKey.did())

     

       156
       156
       -
         })

     

       157
       157
       -
       

     

       158
       158
       -
         it('it allows recovery key to rotate recovery key', async () => {

     

       159
       159
       -
           const newKey = await Secp256k1Keypair.create()

     

       160
       160
       -
           const prev = await cidForCbor(ops[ops.length - 1])

     

       161
       161
       -
           const op = await operations.rotateRecoveryKey(

     

       162
       162
       -
             newKey.did(),

     

       163
       163
       -
             prev.toString(),

     

       164
       164
       -
             recoveryKey,

     

       165
       165
       -
           )

     

       166
       166
       -
           ops.push(op)

     

       167
       167
       -
           recoveryKey = newKey

     

       168
       168
       -
           const doc = await document.validateOperationLog(did, ops)

     

       169
       169
       -
           expect(doc.recoveryKey).toEqual(newKey.did())

     

       170
       170
       -
         })

     

       171
       171
       -
       

     

       172
       172
       -
         it('it allows recovery key to update handle', async () => {

     

       173
       173
       -
           handle = 'ally.example3.com'

     

       174
       174
       -
           const prev = await cidForCbor(ops[ops.length - 1])

     

       175
       175
       -
           const op = await operations.updateHandle(

     

       176
       176
       -
             handle,

     

       177
       177
       -
             prev.toString(),

     

       178
       178
       -
             recoveryKey,

     

       179
       179
       -
           )

     

       180
       180
       -
           ops.push(op)

     

       181
       181
       -
           const doc = await document.validateOperationLog(did, ops)

     

       182
       182
       -
           expect(doc.handle).toEqual(handle)

     

       183
       183
       -
         })

     

       184
       184
       -
       

     

       185
       185
       -
         it('it allows recovery key to update atpPds', async () => {

     

       186
       186
       -
           atpPds = 'https://example3.com'

     

       187
       187
       -
           const prev = await cidForCbor(ops[ops.length - 1])

     

       188
       188
       -
           const op = await operations.updateAtpPds(

     

       189
       189
       -
             atpPds,

     

       190
       190
       -
             prev.toString(),

     

       191
       191
       -
             recoveryKey,

     

       192
       192
       -
           )

     

       193
       193
       -
           ops.push(op)

     

       194
       194
       -
           const doc = await document.validateOperationLog(did, ops)

     

       195
       195
       -
           expect(doc.atpPds).toEqual(atpPds)

     

       196
       196
       -
         })

     

       197
       197
       -
       

     

       198
       198
       -
         it('requires operations to be in order', async () => {

     

       199
       199
       -
           const prev = await cidForCbor(ops[ops.length - 2])

     

       200
       200
       -
           const op = await operations.updateAtpPds(

     

       201
       201
       -
             'foobar.com',

     

       202
       202
       -
             prev.toString(),

     

       203
       203
       -
             signingKey,

     

       204
       204
       -
           )

     

       205
       205
       -
           expect(document.validateOperationLog(did, [...ops, op])).rejects.toThrow()

     

       206
       206
       -
         })

     

       207
       207
       -
       

     

       208
       208
       -
         it('does not allow a create operation in the middle of the log', async () => {

     

       209
       209
       -
           const op = await operations.create(

     

       210
       210
       -
             signingKey,

     

       211
       211
       -
             recoveryKey.did(),

     

       212
       212
       -
             handle,

     

       213
       213
       -
             atpPds,

     

       214
       214
       -
           )

     

       215
       215
       -
           expect(document.validateOperationLog(did, [...ops, op])).rejects.toThrow()

     

       216
       216
       -
         })

     

       217
       217
       -
       

     

       218
       218
       -
         it('requires that the log start with a create operation', async () => {

     

       219
       219
       -
           const rest = ops.slice(1)

     

       220
       220
       -
           expect(document.validateOperationLog(did, rest)).rejects.toThrow()

     

       221
       221
       -
         })

     

       222
       222
       -
       

     

       6
       6
       +
       describe('document', () => {

     

       223
       7
        
         it('formats a valid DID document', async () => {

     

       224
       224
       -
           const data = await document.validateOperationLog(did, ops)

     

       8
       8
       +
           const signingKey = await Secp256k1Keypair.create()

     

       9
       9
       +
           const rotate1 = await Secp256k1Keypair.create()

     

       10
       10
       +
           const rotate2 = await EcdsaKeypair.create()

     

       11
       11
       +
           const handles = ['alice.test', 'bob.test']

     

       12
       12
       +
           const atpPds = 'https://example.com'

     

       13
       13
       +
           const data: t.DocumentData = {

     

       14
       14
       +
             did: 'did:example:alice',

     

       15
       15
       +
             signingKey: signingKey.did(),

     

       16
       16
       +
             rotationKeys: [rotate1.did(), rotate2.did()],

     

       17
       17
       +
             handles,

     

       18
       18
       +
             services: {

     

       19
       19
       +
               atpPds,

     

       20
       20
       +
             },

     

       21
       21
       +
           }

     

       225
       22
        
           const doc = await document.formatDidDoc(data)

     

       226
       23
        
           expect(doc['@context']).toEqual([

     

       227
       24
        
             'https://www.w3.org/ns/did/v1',

     

       228
       228
       -
             'https://w3id.org/security/suites/ecdsa-2019/v1',

     

       229
       25
        
             'https://w3id.org/security/suites/secp256k1-2019/v1',

     

       230
       26
        
           ])

     

       231
       231
       -
           expect(doc.id).toEqual(did)

     

       232
       232
       -
           expect(doc.alsoKnownAs).toEqual([`https://${handle}`])

     

       233
       233
       -
       

     

       234
       234
       -
           expect(doc.verificationMethod.length).toBe(2)

     

       27
       27
       +
           expect(doc.id).toEqual(data.did)

     

       28
       28
       +
           const formattedHandles = handles.map((h) => `https://${h}`)

     

       29
       29
       +
           expect(doc.alsoKnownAs).toEqual(formattedHandles)

     

       30
       30
       +
           expect(doc.verificationMethod.length).toBe(1)

     

       235
       31
        
           expect(doc.verificationMethod[0].id).toEqual('#signingKey')

     

       236
       32
        
           expect(doc.verificationMethod[0].type).toEqual(

     

       237
       237
       -
             'EcdsaSecp256r1VerificationKey2019',

     

       33
       33
       +
             'EcdsaSecp256k1VerificationKey2019',

     

       238
       34
        
           )

     

       239
       239
       -
           expect(doc.verificationMethod[0].controller).toEqual(did)

     

       35
       35
       +
           expect(doc.verificationMethod[0].controller).toEqual(data.did)

     

       240
       36
        
           const parsedSigningKey = parseDidKey(signingKey.did())

     

       241
       37
        
           const signingKeyMultibase =

     

       242
       38
        
             'z' + uint8arrays.toString(parsedSigningKey.keyBytes, 'base58btc')

     

       243
       39
        
           expect(doc.verificationMethod[0].publicKeyMultibase).toEqual(

     

       244
       40
        
             signingKeyMultibase,

     

       245
       41
        
           )

     

       246
       246
       -
           expect(doc.verificationMethod[1].id).toEqual('#recoveryKey')

     

       247
       247
       -
           expect(doc.verificationMethod[1].type).toEqual(

     

       248
       248
       -
             'EcdsaSecp256k1VerificationKey2019',

     

       249
       249
       -
           )

     

       250
       250
       -
           expect(doc.verificationMethod[1].controller).toEqual(did)

     

       251
       251
       -
           const parsedRecoveryKey = parseDidKey(recoveryKey.did())

     

       252
       252
       -
           const recoveryKeyMultibase =

     

       253
       253
       -
             'z' + uint8arrays.toString(parsedRecoveryKey.keyBytes, 'base58btc')

     

       254
       254
       -
           expect(doc.verificationMethod[1].publicKeyMultibase).toEqual(

     

       255
       255
       -
             recoveryKeyMultibase,

     

       256
       256
       -
           )

     

       257
       257
       -
       

     

       258
       42
        
           expect(doc.assertionMethod).toEqual(['#signingKey'])

     

       259
       43
        
           expect(doc.capabilityInvocation).toEqual(['#signingKey'])

     

       260
       44
        
           expect(doc.capabilityDelegation).toEqual(['#signingKey'])

     
···

       264
       48
        
           expect(doc.service[0].serviceEndpoint).toEqual(atpPds)

     

       265
       49
        
         })

     

       266
       50
        
       

     

       267
       267
       -
         it('formats a valid DID document regardless of leading https://', async () => {

     

       268
       268
       -
           handle = 'https://alice.example.com'

     

       269
       269
       -
           const prev = await cidForCbor(ops[ops.length - 1])

     

       270
       270
       -
           const op1 = await operations.updateHandle(

     

       271
       271
       -
             handle,

     

       272
       272
       -
             prev.toString(),

     

       273
       273
       -
             signingKey,

     

       51
       51
       +
         it('handles P-256 keys', async () => {

     

       52
       52
       +
           const signingKey = await EcdsaKeypair.create()

     

       53
       53
       +
           const rotate1 = await Secp256k1Keypair.create()

     

       54
       54
       +
           const rotate2 = await EcdsaKeypair.create()

     

       55
       55
       +
           const handles = ['alice.test', 'bob.test']

     

       56
       56
       +
           const atpPds = 'https://example.com'

     

       57
       57
       +
           const data: t.DocumentData = {

     

       58
       58
       +
             did: 'did:example:alice',

     

       59
       59
       +
             signingKey: signingKey.did(),

     

       60
       60
       +
             rotationKeys: [rotate1.did(), rotate2.did()],

     

       61
       61
       +
             handles,

     

       62
       62
       +
             services: {

     

       63
       63
       +
               atpPds,

     

       64
       64
       +
             },

     

       65
       65
       +
           }

     

       66
       66
       +
           const doc = await document.formatDidDoc(data)

     

       67
       67
       +
           expect(doc.verificationMethod.length).toBe(1)

     

       68
       68
       +
           expect(doc['@context']).toEqual([

     

       69
       69
       +
             'https://www.w3.org/ns/did/v1',

     

       70
       70
       +
             'https://w3id.org/security/suites/ecdsa-2019/v1',

     

       71
       71
       +
           ])

     

       72
       72
       +
           expect(doc.verificationMethod[0].id).toEqual('#signingKey')

     

       73
       73
       +
           expect(doc.verificationMethod[0].type).toEqual(

     

       74
       74
       +
             'EcdsaSecp256r1VerificationKey2019',

     

       274
       75
        
           )

     

       275
       275
       -
           atpPds = 'example.com'

     

       276
       276
       -
           const prev2 = await cidForCbor(op1)

     

       277
       277
       -
           const op2 = await operations.updateAtpPds(

     

       278
       278
       -
             atpPds,

     

       279
       279
       -
             prev2.toString(),

     

       280
       280
       -
             signingKey,

     

       76
       76
       +
           expect(doc.verificationMethod[0].controller).toEqual(data.did)

     

       77
       77
       +
           const parsedSigningKey = parseDidKey(signingKey.did())

     

       78
       78
       +
           const signingKeyMultibase =

     

       79
       79
       +
             'z' + uint8arrays.toString(parsedSigningKey.keyBytes, 'base58btc')

     

       80
       80
       +
           expect(doc.verificationMethod[0].publicKeyMultibase).toEqual(

     

       81
       81
       +
             signingKeyMultibase,

     

       281
       82
        
           )

     

       282
       282
       -
           ops.push(op1)

     

       283
       283
       -
           ops.push(op2)

     

       284
       284
       -
           const data = await document.validateOperationLog(did, ops)

     

       83
       83
       +
         })

     

       84
       84
       +
       

     

       85
       85
       +
         it('formats a valid DID document regardless of leading https://', async () => {

     

       86
       86
       +
           const signingKey = await Secp256k1Keypair.create()

     

       87
       87
       +
           const rotate1 = await Secp256k1Keypair.create()

     

       88
       88
       +
           const rotate2 = await EcdsaKeypair.create()

     

       89
       89
       +
           const handles = ['https://alice.test', 'bob.test']

     

       90
       90
       +
           const atpPds = 'example.com'

     

       91
       91
       +
           const data: t.DocumentData = {

     

       92
       92
       +
             did: 'did:example:alice',

     

       93
       93
       +
             signingKey: signingKey.did(),

     

       94
       94
       +
             rotationKeys: [rotate1.did(), rotate2.did()],

     

       95
       95
       +
             handles,

     

       96
       96
       +
             services: {

     

       97
       97
       +
               atpPds,

     

       98
       98
       +
             },

     

       99
       99
       +
           }

     

       285
       100
        
           const doc = await document.formatDidDoc(data)

     

       286
       286
       -
           expect(doc.alsoKnownAs).toEqual([handle])

     

       101
       101
       +
           expect(doc.alsoKnownAs).toEqual(['https://alice.test', 'https://bob.test'])

     

       287
       102
        
           expect(doc.service[0].serviceEndpoint).toEqual(`https://${atpPds}`)

     

       288
       103
        
         })

     

       289
       104
        
       })