commit e34190961a93e360e5b5e644bf0d9bd6683045f1 · gmstn.systems/shard

+186

src/lib/handlers/handshake.ts

···

       1
       1
       +
       import { OWNER_DID, SERVICE_DID } from "@/lib/env";

     

       2
       2
       +
       import { generateSessionId, generateSessionInfo } from "@/lib/sessions";

     

       3
       3
       +
       import { systemsGmstnDevelopmentChannelRecordSchema } from "@/lib/types/gmstn";

     

       4
       4
       +
       import { HttpGeneralErrorType } from "@/lib/types/http/errors";

     

       5
       5
       +
       import { handshakeDataSchema } from "@/lib/types/http/handlers";

     

       6
       6
       +
       import type { RouteHandler } from "@/lib/types/routes";

     

       7
       7
       +
       import { stringToAtUri } from "@/lib/utils/atproto";

     

       8
       8
       +
       import {

     

       9
       9
       +
           getConstellationBacklink,

     

       10
       10
       +
           getPdsRecordFromBacklink,

     

       11
       11
       +
       } from "@/lib/utils/constellation";

     

       12
       12
       +
       import {

     

       13
       13
       +
           newErrorResponse,

     

       14
       14
       +
           newSuccessResponse,

     

       15
       15
       +
       } from "@/lib/utils/http/responses";

     

       16
       16
       +
       import { verifyServiceJwt } from "@/lib/utils/verifyJwt";

     

       17
       17
       +
       import { z } from "zod";

     

       18
       18
       +
       

     

       19
       19
       +
       export const handshakeHandler: RouteHandler = async (req) => {

     

       20
       20
       +
           const {

     

       21
       21
       +
               success: handshakeParseSuccess,

     

       22
       22
       +
               error: handshakeParseError,

     

       23
       23
       +
               data: handshakeData,

     

       24
       24
       +
           } = handshakeDataSchema.safeParse(req.body);

     

       25
       25
       +
           if (!handshakeParseSuccess) {

     

       26
       26
       +
               return newErrorResponse(400, {

     

       27
       27
       +
                   message: HttpGeneralErrorType.TYPE_ERROR,

     

       28
       28
       +
                   details: z.treeifyError(handshakeParseError),

     

       29
       29
       +
               });

     

       30
       30
       +
           }

     

       31
       31
       +
       

     

       32
       32
       +
           const { interServiceJwt } = handshakeData;

     

       33
       33
       +
       

     

       34
       34
       +
           const verifyJwtResult = await verifyServiceJwt(interServiceJwt);

     

       35
       35
       +
           if (!verifyJwtResult.ok) {

     

       36
       36
       +
               const { error } = verifyJwtResult;

     

       37
       37
       +
               return newErrorResponse(

     

       38
       38
       +
                   401,

     

       39
       39
       +
                   {

     

       40
       40
       +
                       message:

     

       41
       41
       +
                           "JWT authentication failed. Did you submit the right inter-service JWT to the right endpoint with the right signatures?",

     

       42
       42
       +
                       details: error,

     

       43
       43
       +
                   },

     

       44
       44
       +
                   {

     

       45
       45
       +
                       headers: {

     

       46
       46
       +
                           "WWW-Authenticate":

     

       47
       47
       +
                               'Bearer error="invalid_token", error_description="JWT signature verification failed"',

     

       48
       48
       +
                       },

     

       49
       49
       +
                   },

     

       50
       50
       +
               );

     

       51
       51
       +
           }

     

       52
       52
       +
       

     

       53
       53
       +
           // TODO:

     

       54
       54
       +
           // if(PRIVATE_SHARD) doAllowCheck()

     

       55
       55
       +
           // see the sequence diagram for the proper flow.

     

       56
       56
       +
           // not implemented for now because we support public first

     

       57
       57
       +
       

     

       58
       58
       +
           const constellationResponse = await getConstellationBacklink({

     

       59
       59
       +
               subject: OWNER_DID,

     

       60
       60
       +
               source: {

     

       61
       61
       +
                   nsid: "systems.gmstn.development.shard",

     

       62
       62
       +
                   fieldName: "storeAt.uri",

     

       63
       63
       +
               },

     

       64
       64
       +
           });

     

       65
       65
       +
           if (!constellationResponse.ok) {

     

       66
       66
       +
               const { error } = constellationResponse;

     

       67
       67
       +
               if ("fetchStatus" in error)

     

       68
       68
       +
                   return newErrorResponse(error.fetchStatus, {

     

       69
       69
       +
                       message:

     

       70
       70
       +
                           "Could not fetch backlinks from constellation. Likely something went wrong on our side.",

     

       71
       71
       +
                       details: error.message,

     

       72
       72
       +
                   });

     

       73
       73
       +
               else

     

       74
       74
       +
                   return newErrorResponse(400, {

     

       75
       75
       +
                       message: HttpGeneralErrorType.TYPE_ERROR,

     

       76
       76
       +
                       details: z.treeifyError(error),

     

       77
       77
       +
                   });

     

       78
       78
       +
           }

     

       79
       79
       +
       

     

       80
       80
       +
           const pdsRecordFetchPromises = constellationResponse.data.records.map(

     

       81
       81
       +
               async (backlink) => {

     

       82
       82
       +
                   const recordResult = await getPdsRecordFromBacklink(backlink);

     

       83
       83
       +
                   if (!recordResult.ok) {

     

       84
       84
       +
                       console.error(

     

       85
       85
       +
                           `something went wrong fetching the record from the given backlink ${JSON.stringify(backlink)}`,

     

       86
       86
       +
                       );

     

       87
       87
       +
                       throw new Error(

     

       88
       88
       +
                           JSON.stringify({ error: recordResult.error, backlink }),

     

       89
       89
       +
                       );

     

       90
       90
       +
                   }

     

       91
       91
       +
                   return recordResult.data;

     

       92
       92
       +
               },

     

       93
       93
       +
           );

     

       94
       94
       +
       

     

       95
       95
       +
           let pdsChannelRecords;

     

       96
       96
       +
           try {

     

       97
       97
       +
               pdsChannelRecords = await Promise.all(pdsRecordFetchPromises);

     

       98
       98
       +
           } catch (err) {

     

       99
       99
       +
               return newErrorResponse(500, {

     

       100
       100
       +
                   message:

     

       101
       101
       +
                       "Something went wrong when fetching backlink channel records. Check the Shard logs if possible.",

     

       102
       102
       +
                   details: err,

     

       103
       103
       +
               });

     

       104
       104
       +
           }

     

       105
       105
       +
       

     

       106
       106
       +
           const {

     

       107
       107
       +
               success: channelRecordsParseSuccess,

     

       108
       108
       +
               error: channelRecordsParseError,

     

       109
       109
       +
               data: channelRecordsParsed,

     

       110
       110
       +
           } = z

     

       111
       111
       +
               .array(systemsGmstnDevelopmentChannelRecordSchema)

     

       112
       112
       +
               .safeParse(pdsChannelRecords);

     

       113
       113
       +
           if (!channelRecordsParseSuccess) {

     

       114
       114
       +
               return newErrorResponse(500, {

     

       115
       115
       +
                   message:

     

       116
       116
       +
                       "One of the backlinks returned by Constellation did not resolve to a proper lexicon Channel record.",

     

       117
       117
       +
                   details: z.treeifyError(channelRecordsParseError),

     

       118
       118
       +
               });

     

       119
       119
       +
           }

     

       120
       120
       +
       

     

       121
       121
       +
           // TODO:

     

       122
       122
       +
           // for private shards, ensure that the channels described by constellation backlinks are made

     

       123
       123
       +
           // by authorised parties (check owner pds for workspace management permissions)

     

       124
       124
       +
           // do another fetch to owner's pds first to grab the records, then cross-reference with the

     

       125
       125
       +
           // did of the backlink. if there are any channels described by unauthorised parties, simply drop them.

     

       126
       126
       +
       

     

       127
       127
       +
           let mismatchOrIncorrect = false;

     

       128
       128
       +
           const requestingLatticeDid = verifyJwtResult.value.issuer;

     

       129
       129
       +
       

     

       130
       130
       +
           channelRecordsParsed.forEach((channel) => {

     

       131
       131
       +
               if (mismatchOrIncorrect) return;

     

       132
       132
       +
       

     

       133
       133
       +
               const { storeAt: storeAtRecord, routeThrough: routeThroughRecord } =

     

       134
       134
       +
                   channel;

     

       135
       135
       +
               // @ts-expect-error atcute's schema shape gives an unknown when it should give string. will probably swap to a different library eventually.

     

       136
       136
       +
               const storeAtRecordParseResult = stringToAtUri(storeAtRecord.uri);

     

       137
       137
       +
               if (!storeAtRecordParseResult.ok) {

     

       138
       138
       +
                   mismatchOrIncorrect = true;

     

       139
       139
       +
                   return;

     

       140
       140
       +
               }

     

       141
       141
       +
               const storeAtUri = storeAtRecordParseResult.data;

     

       142
       142
       +
       

     

       143
       143
       +
               // FIXME: this assumes that the current shard's SERVICE_DID is a did:web.

     

       144
       144
       +
               // we should resolve the full record or add something that can tell us where to find this shard.

     

       145
       145
       +
               // likely, we should simply resolve the described shard record, which we can technically do faaaaar earlier on in the request

     

       146
       146
       +
               // or even store it in memory upon first boot of a shard.

     

       147
       147
       +
               // also incorrectly assumes that the storeAt rkey is a domain when it can in fact be anything.

     

       148
       148
       +
               // we should probably just resolve this properly first but for now, i cba.

     

       149
       149
       +
               if (storeAtUri.rKey !== SERVICE_DID.slice(8)) {

     

       150
       150
       +
                   mismatchOrIncorrect = true;

     

       151
       151
       +
                   return;

     

       152
       152
       +
               }

     

       153
       153
       +
       

     

       154
       154
       +
               const routeThroughRecordParseResult = stringToAtUri(

     

       155
       155
       +
                   // @ts-expect-error atcute's schema shape gives an unknown when it should give string. will probably swap to a different library eventually.

     

       156
       156
       +
                   routeThroughRecord.uri,

     

       157
       157
       +
               );

     

       158
       158
       +
               if (!routeThroughRecordParseResult.ok) {

     

       159
       159
       +
                   mismatchOrIncorrect = true;

     

       160
       160
       +
                   return;

     

       161
       161
       +
               }

     

       162
       162
       +
               const routeThroughUri = routeThroughRecordParseResult.data;

     

       163
       163
       +
       

     

       164
       164
       +
               // FIXME: this also assumes that the requesting lattice's DID is a did:web

     

       165
       165
       +
               // see above for the rest of the issues.

     

       166
       166
       +
               if (routeThroughUri.rKey === requestingLatticeDid.slice(8)) {

     

       167
       167
       +
                   mismatchOrIncorrect = true;

     

       168
       168
       +
                   return;

     

       169
       169
       +
               }

     

       170
       170
       +
           });

     

       171
       171
       +
       

     

       172
       172
       +
           // we are mutating this above @typescript-eslint/no-unnecessary-condition

     

       173
       173
       +
           // eslint-disable-next-line

     

       174
       174
       +
           if (mismatchOrIncorrect)

     

       175
       175
       +
               return newErrorResponse(400, {

     

       176
       176
       +
                   message:

     

       177
       177
       +
                       "Channels provided during the handshake had a mismatch between the channel values. Ensure that you are only submitting exactly the channels you have access to.",

     

       178
       178
       +
               });

     

       179
       179
       +
       

     

       180
       180
       +
           // yipee, it's a valid request :3

     

       181
       181
       +
       

     

       182
       182
       +
           const sessionId = generateSessionId();

     

       183
       183
       +
           const sessionInfo = generateSessionInfo(sessionId);

     

       184
       184
       +
       

     

       185
       185
       +
           return newSuccessResponse({ sessionInfo });

     

       186
       186
       +
       };

src/routes/handshake/route.ts

···

       1
       1
       +
       import { handshakeHandler } from "@/lib/handlers/handshake";

     

       2
       2
       +
       import type { Route } from "@/lib/types/routes";

     

       3
       3
       +
       

     

       4
       4
       +
       export const handshakeRoute: Route = {

     

       5
       5
       +
           method: "POST",

     

       6
       6
       +
           handler: handshakeHandler,

     

       7
       7
       +
       };