@atproto/identity 0.1.0 → 0.2.1

package/jest.config.js

@@ -2,5 +2,5 @@ const base = require('../../jest.config.base.js')
 
 module.exports = {
   ...base,
-  displayName: 'Identity'
+  displayName: 'Identity',
 }

package/package.json

@@ -1,34 +1,25 @@
 {
   "name": "@atproto/identity",
-  "version": "0.1.0",
-  "main": "dist/index.js",
+  "version": "0.2.1",
   "license": "MIT",
+  "description": "Library for decentralized identities in atproto using DIDs and handles",
+  "keywords": [
+    "atproto",
+    "did",
+    "identity"
+  ],
+  "homepage": "https://atproto.com",
   "repository": {
     "type": "git",
-    "url": "https://github.com/bluesky-social/atproto.git",
+    "url": "https://github.com/bluesky-social/atproto",
     "directory": "packages/identity"
   },
-  "scripts": {
-    "test": "jest",
-    "test:log": "cat test.log | pino-pretty",
-    "prettier": "prettier --check src/ tests/",
-    "prettier:fix": "prettier --write src/ tests/",
-    "lint": "eslint . --ext .ts,.tsx",
-    "lint:fix": "yarn lint --fix",
-    "verify": "run-p prettier lint",
-    "verify:fix": "yarn prettier:fix && yarn lint:fix",
-    "build": "node ./build.js",
-    "postbuild": "tsc --build tsconfig.build.json",
-    "update-main-to-dist": "node ./update-pkg.js --update-main-to-dist",
-    "update-main-to-src": "node ./update-pkg.js --update-main-to-src",
-    "prepublish": "npm run update-main-to-dist",
-    "postpublish": "npm run update-main-to-src"
-  },
+  "main": "dist/index.js",
   "dependencies": {
-    "@atproto/common-web": "*",
-    "@atproto/crypto": "*",
     "axios": "^0.27.2",
-    "zod": "^3.21.4"
+    "zod": "^3.21.4",
+    "@atproto/common-web": "^0.2.1",
+    "@atproto/crypto": "^0.2.2"
   },
   "devDependencies": {
     "@did-plc/lib": "^0.0.1",
@@ -36,5 +27,13 @@
     "cors": "^2.8.5",
     "express": "^4.18.2",
     "get-port": "^6.1.2"
-  }
-}
+  },
+  "scripts": {
+    "test": "jest",
+    "test:log": "cat test.log | pino-pretty",
+    "build": "node ./build.js",
+    "postbuild": "tsc --build tsconfig.build.json",
+    "update-main-to-dist": "node ../../update-main-to-dist.js packages/identity"
+  },
+  "types": "dist/index.d.ts"
+}

package/src/did/atproto-data.ts

@@ -10,13 +10,16 @@ export const getDid = (doc: DidDocument): string => {
 }
 
 export const getKey = (doc: DidDocument): string | undefined => {
+  const did = getDid(doc)
   let keys = doc.verificationMethod
   if (!keys) return undefined
   if (typeof keys !== 'object') return undefined
   if (!Array.isArray(keys)) {
     keys = [keys]
   }
-  const found = keys.find((key) => key.id === '#atproto')
+  const found = keys.find(
+    (key) => key.id === '#atproto' || key.id === `${did}#atproto`,
+  )
   if (!found) return undefined
 
   // @TODO support jwk
@@ -28,6 +31,9 @@ export const getKey = (doc: DidDocument): string | undefined => {
     didKey = crypto.formatDidKey(crypto.P256_JWT_ALG, keyBytes)
   } else if (found.type === 'EcdsaSecp256k1VerificationKey2019') {
     didKey = crypto.formatDidKey(crypto.SECP256K1_JWT_ALG, keyBytes)
+  } else if (found.type === 'Multikey') {
+    const parsed = crypto.parseMultikey(found.publicKeyMultibase)
+    didKey = crypto.formatDidKey(parsed.jwtAlg, parsed.keyBytes)
   }
   return didKey
 }
@@ -42,41 +48,24 @@ export const getHandle = (doc: DidDocument): string | undefined => {
 }
 
 export const getPds = (doc: DidDocument): string | undefined => {
-  let services = doc.service
-  if (!services) return undefined
-  if (typeof services !== 'object') return undefined
-  if (!Array.isArray(services)) {
-    services = [services]
-  }
-  const found = services.find((service) => service.id === '#atproto_pds')
-  if (!found) return undefined
-  if (found.type !== 'AtprotoPersonalDataServer') {
-    return undefined
-  }
-  if (typeof found.serviceEndpoint !== 'string') {
-    return undefined
-  }
-  validateUrl(found.serviceEndpoint)
-  return found.serviceEndpoint
+  return getServiceEndpoint(doc, {
+    id: '#atproto_pds',
+    type: 'AtprotoPersonalDataServer',
+  })
 }
 
 export const getFeedGen = (doc: DidDocument): string | undefined => {
-  let services = doc.service
-  if (!services) return undefined
-  if (typeof services !== 'object') return undefined
-  if (!Array.isArray(services)) {
-    services = [services]
-  }
-  const found = services.find((service) => service.id === '#bsky_fg')
-  if (!found) return undefined
-  if (found.type !== 'BskyFeedGenerator') {
-    return undefined
-  }
-  if (typeof found.serviceEndpoint !== 'string') {
-    return undefined
-  }
-  validateUrl(found.serviceEndpoint)
-  return found.serviceEndpoint
+  return getServiceEndpoint(doc, {
+    id: '#bsky_fg',
+    type: 'BskyFeedGenerator',
+  })
+}
+
+export const getNotif = (doc: DidDocument): string | undefined => {
+  return getServiceEndpoint(doc, {
+    id: '#bsky_notif',
+    type: 'BskyNotificationService',
+  })
 }
 
 export const parseToAtprotoDocument = (
@@ -118,3 +107,28 @@ const validateUrl = (url: string) => {
     throw new Error('Invalid pds hostname')
   }
 }
+
+const getServiceEndpoint = (
+  doc: DidDocument,
+  opts: { id: string; type: string },
+) => {
+  const did = getDid(doc)
+  let services = doc.service
+  if (!services) return undefined
+  if (typeof services !== 'object') return undefined
+  if (!Array.isArray(services)) {
+    services = [services]
+  }
+  const found = services.find(
+    (service) => service.id === opts.id || service.id === `${did}${opts.id}`,
+  )
+  if (!found) return undefined
+  if (found.type !== opts.type) {
+    return undefined
+  }
+  if (typeof found.serviceEndpoint !== 'string') {
+    return undefined
+  }
+  validateUrl(found.serviceEndpoint)
+  return found.serviceEndpoint
+}

package/tests/did-document.test.ts

@@ -0,0 +1,103 @@
+import { DidResolver, ensureAtpDocument } from '../src'
+
+describe('did parsing', () => {
+  it('throws on bad DID document', async () => {
+    const did = 'did:plc:yk4dd2qkboz2yv6tpubpc6co'
+    const docJson = `{
+  "ideep": "did:plc:yk4dd2qkboz2yv6tpubpc6co",
+  "blah": [
+    "https://dholms.xyz"
+  ],
+  "zoot": [
+    {
+      "id": "#elsewhere",
+      "type": "EcdsaSecp256k1VerificationKey2019",
+      "controller": "did:plc:yk4dd2qkboz2yv6tpubpc6co",
+      "publicKeyMultibase": "zQYEBzXeuTM9UR3rfvNag6L3RNAs5pQZyYPsomTsgQhsxLdEgCrPTLgFna8yqCnxPpNT7DBk6Ym3dgPKNu86vt9GR"
+    }
+  ],
+  "yarg": [ ]
+}`
+    const resolver = new DidResolver({})
+    expect(() => {
+      resolver.validateDidDoc(did, JSON.parse(docJson))
+    }).toThrow()
+  })
+
+  it('parses legacy DID format, extracts atpData', async () => {
+    const did = 'did:plc:yk4dd2qkboz2yv6tpubpc6co'
+    const docJson = `{
+  "@context": [
+    "https://www.w3.org/ns/did/v1",
+    "https://w3id.org/security/suites/secp256k1-2019/v1"
+  ],
+  "id": "did:plc:yk4dd2qkboz2yv6tpubpc6co",
+  "alsoKnownAs": [
+    "at://dholms.xyz"
+  ],
+  "verificationMethod": [
+    {
+      "id": "#atproto",
+      "type": "EcdsaSecp256k1VerificationKey2019",
+      "controller": "did:plc:yk4dd2qkboz2yv6tpubpc6co",
+      "publicKeyMultibase": "zQYEBzXeuTM9UR3rfvNag6L3RNAs5pQZyYPsomTsgQhsxLdEgCrPTLgFna8yqCnxPpNT7DBk6Ym3dgPKNu86vt9GR"
+    }
+  ],
+  "service": [
+    {
+      "id": "#atproto_pds",
+      "type": "AtprotoPersonalDataServer",
+      "serviceEndpoint": "https://bsky.social"
+    }
+  ]
+}`
+    const resolver = new DidResolver({})
+    const doc = resolver.validateDidDoc(did, JSON.parse(docJson))
+    const atpData = ensureAtpDocument(doc)
+    expect(atpData.did).toEqual(did)
+    expect(atpData.handle).toEqual('dholms.xyz')
+    expect(atpData.pds).toEqual('https://bsky.social')
+    expect(atpData.signingKey).toEqual(
+      'did:key:zQ3shXjHeiBuRCKmM36cuYnm7YEMzhGnCmCyW92sRJ9pribSF',
+    )
+  })
+
+  it('parses newer Multikey DID format, extracts atpData', async () => {
+    const did = 'did:plc:yk4dd2qkboz2yv6tpubpc6co'
+    const docJson = `{
+  "@context": [
+    "https://www.w3.org/ns/did/v1",
+    "https://w3id.org/security/multikey/v1",
+    "https://w3id.org/security/suites/secp256k1-2019/v1"
+  ],
+  "id": "did:plc:yk4dd2qkboz2yv6tpubpc6co",
+  "alsoKnownAs": [
+    "at://dholms.xyz"
+  ],
+  "verificationMethod": [
+    {
+      "id": "did:plc:yk4dd2qkboz2yv6tpubpc6co#atproto",
+      "type": "Multikey",
+      "controller": "did:plc:yk4dd2qkboz2yv6tpubpc6co",
+      "publicKeyMultibase": "zQ3shXjHeiBuRCKmM36cuYnm7YEMzhGnCmCyW92sRJ9pribSF"
+    }
+  ],
+  "service": [
+    {
+      "id": "#atproto_pds",
+      "type": "AtprotoPersonalDataServer",
+      "serviceEndpoint": "https://bsky.social"
+    }
+  ]
+}`
+    const resolver = new DidResolver({})
+    const doc = resolver.validateDidDoc(did, JSON.parse(docJson))
+    const atpData = ensureAtpDocument(doc)
+    expect(atpData.did).toEqual(did)
+    expect(atpData.handle).toEqual('dholms.xyz')
+    expect(atpData.pds).toEqual('https://bsky.social')
+    expect(atpData.signingKey).toEqual(
+      'did:key:zQ3shXjHeiBuRCKmM36cuYnm7YEMzhGnCmCyW92sRJ9pribSF',
+    )
+  })
+})

package/tsconfig.build.json

@@ -1,4 +1,4 @@
 {
   "extends": "./tsconfig.json",
   "exclude": ["**/*.spec.ts", "**/*.test.ts"]
-}
+}

package/tsconfig.json

@@ -5,9 +5,9 @@
     "outDir": "./dist", // Your outDir,
     "emitDeclarationOnly": true
   },
-  "include": ["./src","__tests__/**/**.ts"],
+  "include": ["./src", "__tests__/**/**.ts"],
   "references": [
     { "path": "../common/tsconfig.build.json" },
-    { "path": "../crypto/tsconfig.build.json" },
+    { "path": "../crypto/tsconfig.build.json" }
   ]
-}
+}

package/dist/atp-did.d.ts

@@ -1,14 +0,0 @@
-import { DIDDocument } from 'did-resolver';
-export declare type AtpData = {
-    did: string;
-    signingKey: string;
-    recoveryKey: string;
-    handle: string;
-    atpPds: string;
-};
-export declare const getDid: (doc: DIDDocument) => string;
-export declare const getKey: (doc: DIDDocument, id: string) => string | undefined;
-export declare const getHandle: (doc: DIDDocument) => string | undefined;
-export declare const getAtpPds: (doc: DIDDocument) => string | undefined;
-export declare const parseToAtpDocument: (doc: DIDDocument) => Partial<AtpData>;
-export declare const ensureAtpDocument: (doc: DIDDocument) => AtpData;

package/dist/atproto-data.d.ts

@@ -1,7 +0,0 @@
-import { DidDocument, AtprotoData } from './types';
-export declare const getDid: (doc: DidDocument) => string;
-export declare const getKey: (doc: DidDocument) => string | undefined;
-export declare const getHandle: (doc: DidDocument) => string | undefined;
-export declare const getPds: (doc: DidDocument) => string | undefined;
-export declare const parseToAtprotoDocument: (doc: DidDocument) => Partial<AtprotoData>;
-export declare const ensureAtpDocument: (doc: DidDocument) => AtprotoData;

package/dist/base-resolver.d.ts

@@ -1,16 +0,0 @@
-import { AtprotoData, DidDocument } from './types';
-import { DidCache } from './did-cache';
-export declare abstract class BaseResolver {
-    cache?: DidCache | undefined;
-    constructor(cache?: DidCache | undefined);
-    abstract resolveDidNoCheck(did: string): Promise<unknown | null>;
-    validateDidDoc(did: string, val: unknown): DidDocument;
-    resolveDidNoCache(did: string): Promise<DidDocument | null>;
-    refreshCache(did: string): Promise<void>;
-    resolveDid(did: string, forceRefresh?: boolean): Promise<DidDocument | null>;
-    ensureResolveDid(did: string, forceRefresh?: boolean): Promise<DidDocument>;
-    resolveAtprotoData(did: string, forceRefresh?: boolean): Promise<AtprotoData>;
-    resolveAtprotoKey(did: string, forceRefresh?: boolean): Promise<string>;
-    verifySignature(did: string, data: Uint8Array, sig: Uint8Array, forceRefresh?: boolean): Promise<boolean>;
-}
-export default BaseResolver;

package/dist/did/logger.d.ts

@@ -1,2 +0,0 @@
-export declare const logger: import("pino").default.Logger<import("pino").default.LoggerOptions>;
-export default logger;

package/dist/did-cache.d.ts

@@ -1,8 +0,0 @@
-import { CacheResult, DidDocument } from './types';
-export declare abstract class DidCache {
-    abstract cacheDid(did: string, doc: DidDocument): Promise<void>;
-    abstract checkCache(did: string): Promise<CacheResult | null>;
-    abstract refreshCache(did: string, getDoc: () => Promise<DidDocument | null>): Promise<void>;
-    abstract clearEntry(did: string): Promise<void>;
-    abstract clear(): Promise<void>;
-}

package/dist/identity-resolver.d.ts

@@ -1,8 +0,0 @@
-import { HandleResolver } from './handle';
-import DidResolver from './did/did-resolver';
-import { IdentityResolverOpts } from './types';
-export declare class IdentityResolver {
-    handle: HandleResolver;
-    did: DidResolver;
-    constructor(opts?: Partial<IdentityResolverOpts>);
-}

package/dist/logger.d.ts

@@ -1,2 +0,0 @@
-export declare const logger: import("pino").default.Logger<import("pino").default.LoggerOptions>;
-export default logger;

package/dist/memory-cache.d.ts

@@ -1,18 +0,0 @@
-import { DidCache } from './did-cache';
-import { CacheResult, DidDocument } from './types';
-declare type CacheVal = {
-    doc: DidDocument;
-    updatedAt: number;
-};
-export declare class MemoryCache extends DidCache {
-    staleTTL: number;
-    maxTTL: number;
-    constructor(staleTTL?: number, maxTTL?: number);
-    cache: Map<string, CacheVal>;
-    cacheDid(did: string, doc: DidDocument): Promise<void>;
-    refreshCache(did: string, getDoc: () => Promise<DidDocument | null>): Promise<void>;
-    checkCache(did: string): Promise<CacheResult | null>;
-    clearEntry(did: string): Promise<void>;
-    clear(): Promise<void>;
-}
-export {};

package/dist/plc-resolver.d.ts

@@ -1,9 +0,0 @@
-import BaseResolver from './base-resolver';
-import { PlcResolverOpts } from './types';
-import { DidCache } from './did-cache';
-export declare class DidPlcResolver extends BaseResolver {
-    opts: PlcResolverOpts;
-    cache?: DidCache | undefined;
-    constructor(opts: PlcResolverOpts, cache?: DidCache | undefined);
-    resolveDidNoCheck(did: string): Promise<unknown>;
-}

package/dist/resolver.d.ts

@@ -1,9 +0,0 @@
-import { DidResolverOpts } from './types';
-import BaseResolver from './base-resolver';
-import { DidCache } from './did-cache';
-export declare class DidResolver extends BaseResolver {
-    methods: Record<string, BaseResolver>;
-    constructor(opts?: Partial<DidResolverOpts>, cache?: DidCache);
-    resolveDidNoCheck(did: string): Promise<unknown>;
-}
-export default DidResolver;

package/dist/src/atp-did.d.ts

@@ -1,14 +0,0 @@
-import { DIDDocument } from 'did-resolver';
-export declare type AtpData = {
-    did: string;
-    signingKey: string;
-    recoveryKey: string;
-    handle: string;
-    atpPds: string;
-};
-export declare const getDid: (doc: DIDDocument) => string;
-export declare const getKey: (doc: DIDDocument, id: string) => string | undefined;
-export declare const getHandle: (doc: DIDDocument) => string | undefined;
-export declare const getAtpPds: (doc: DIDDocument) => string | undefined;
-export declare const parseToAtpDocument: (doc: DIDDocument) => Partial<AtpData>;
-export declare const ensureAtpDocument: (doc: DIDDocument) => AtpData;

package/dist/src/errors.d.ts

@@ -1,5 +0,0 @@
-import { DIDResolutionResult } from 'did-resolver';
-export declare const error: (errorType: string) => DIDResolutionResult;
-export declare const notFound: () => DIDResolutionResult;
-export declare const invalidDid: () => DIDResolutionResult;
-export declare const unsupported: () => DIDResolutionResult;

package/dist/src/index.d.ts

@@ -1,4 +0,0 @@
-export * as web from './web-resolver';
-export * as plc from './plc-resolver';
-export * from './resolver';
-export * from './atp-did';

package/dist/src/logger.d.ts

@@ -1,2 +0,0 @@
-export declare const logger: import("pino").default.Logger<import("pino").default.LoggerOptions>;
-export default logger;

package/dist/src/plc/resolver.d.ts

@@ -1,6 +0,0 @@
-import { DIDResolver } from 'did-resolver';
-export declare type PlcResolverOptions = {
-    timeout: number;
-    plcUrl: string;
-};
-export declare const makeResolver: (opts: PlcResolverOptions) => DIDResolver;

package/dist/src/plc-resolver.d.ts

@@ -1,6 +0,0 @@
-import { DIDResolver } from 'did-resolver';
-export declare type PlcResolverOptions = {
-    timeout: number;
-    plcUrl: string;
-};
-export declare const makeResolver: (opts: PlcResolverOptions) => DIDResolver;

package/dist/src/resolver.d.ts

@@ -1,14 +0,0 @@
-import { Resolver, DIDDocument, DIDResolutionOptions, DIDResolutionResult } from 'did-resolver';
-import * as atpDid from './atp-did';
-export declare type DidResolverOptions = {
-    timeout: number;
-    plcUrl: string;
-};
-export declare class DidResolver {
-    resolver: Resolver;
-    constructor(opts?: Partial<DidResolverOptions>);
-    resolveDid(did: string, options?: DIDResolutionOptions): Promise<DIDResolutionResult>;
-    ensureResolveDid(did: string, options?: DIDResolutionOptions): Promise<DIDDocument>;
-    resolveAtpData(did: string): Promise<atpDid.AtpData>;
-}
-export declare const resolver: DidResolver;

package/dist/src/web/db.d.ts

@@ -1,17 +0,0 @@
-import { DIDDocument } from 'did-resolver';
-interface DidStore {
-    put(key: string, val: string): Promise<void>;
-    del(key: string): Promise<void>;
-    get(key: string): Promise<string>;
-}
-export declare class DidWebDb {
-    private store;
-    constructor(store: DidStore);
-    static persistent(location?: string): DidWebDb;
-    static memory(): DidWebDb;
-    put(didPath: string, didDoc: DIDDocument): Promise<void>;
-    get(didPath: string): Promise<DIDDocument | null>;
-    has(didPath: string): Promise<boolean>;
-    del(didPath: string): Promise<void>;
-}
-export default DidWebDb;

package/dist/src/web/resolver.d.ts

@@ -1,6 +0,0 @@
-import { DIDResolver } from 'did-resolver';
-export declare const DOC_PATH = "/.well-known/did.json";
-export declare type WebResolverOptions = {
-    timeout: number;
-};
-export declare const makeResolver: (opts: WebResolverOptions) => DIDResolver;

package/dist/src/web/server.d.ts

@@ -1,18 +0,0 @@
-/// <reference types="node" />
-import express from 'express';
-import http from 'http';
-import { DIDDocument } from 'did-resolver';
-import DidWebDb from './db';
-export declare class DidWebServer {
-    port: number;
-    private _db;
-    _app: express.Application;
-    _httpServer: http.Server | null;
-    constructor(_app: express.Application, _db: DidWebDb, port: number);
-    static create(db: DidWebDb, port: number): DidWebServer;
-    getByPath(didPath?: string): Promise<DIDDocument | null>;
-    getById(did?: string): Promise<DIDDocument | null>;
-    put(didDoc: DIDDocument): Promise<void>;
-    delete(didOrDoc: string | DIDDocument): Promise<void>;
-    close(): Promise<void>;
-}

package/dist/src/web-resolver.d.ts

@@ -1,6 +0,0 @@
-import { DIDResolver } from 'did-resolver';
-export declare const DOC_PATH = "/.well-known/did.json";
-export declare type WebResolverOptions = {
-    timeout: number;
-};
-export declare const makeResolver: (opts: WebResolverOptions) => DIDResolver;