@dxos/credentials 0.8.4-main.fffef41 → 0.9.0

package/docs/README.md

@@ -84,20 +84,20 @@ dxos/mesh-protocol --> dxos/codec-protobuf
 
 ## Dependencies
 
-| Module | Direct |
-|---|---|
-| [`@dxos/async`](../../../../common/async/docs/README.md) | ✓ |
-| [`@dxos/codec-protobuf`](../../../../common/codec-protobuf/docs/README.md) | ✓ |
-| [`@dxos/context`](../../../../common/context/docs/README.md) |  |
-| [`@dxos/crypto`](../../../../common/crypto/docs/README.md) | ✓ |
-| [`@dxos/debug`](../../../../common/debug/docs/README.md) | ✓ |
-| [`@dxos/feed-store`](../../../../common/feed-store/docs/README.md) | ✓ |
-| [`@dxos/hypercore`](../../../../common/hypercore/docs/README.md) |  |
-| [`@dxos/keyring`](../../keyring/docs/README.md) | ✓ |
-| [`@dxos/keys`](../../../../common/keys/docs/README.md) | ✓ |
-| [`@dxos/log`](../../../../common/log/docs/README.md) | ✓ |
-| [`@dxos/mesh-protocol`](../../../mesh/mesh-protocol/docs/README.md) | ✓ |
-| [`@dxos/protocols`](../../../protocols/docs/README.md) | ✓ |
-| [`@dxos/random-access-storage`](../../../../common/random-access-storage/docs/README.md) |  |
-| [`@dxos/timeframe`](../../../../common/timeframe/docs/README.md) |  |
-| [`@dxos/util`](../../../../common/util/docs/README.md) | ✓ |
+| Module                                                                                   | Direct  |
+| ---------------------------------------------------------------------------------------- | ------- |
+| [`@dxos/async`](../../../../common/async/docs/README.md)                                 | ✓ |
+| [`@dxos/codec-protobuf`](../../../../common/codec-protobuf/docs/README.md)               | ✓ |
+| [`@dxos/context`](../../../../common/context/docs/README.md)                             |         |
+| [`@dxos/crypto`](../../../../common/crypto/docs/README.md)                               | ✓ |
+| [`@dxos/debug`](../../../../common/debug/docs/README.md)                                 | ✓ |
+| [`@dxos/feed-store`](../../../../common/feed-store/docs/README.md)                       | ✓ |
+| [`@dxos/hypercore`](../../../../common/hypercore/docs/README.md)                         |         |
+| [`@dxos/keyring`](../../keyring/docs/README.md)                                          | ✓ |
+| [`@dxos/keys`](../../../../common/keys/docs/README.md)                                   | ✓ |
+| [`@dxos/log`](../../../../common/log/docs/README.md)                                     | ✓ |
+| [`@dxos/mesh-protocol`](../../../mesh/mesh-protocol/docs/README.md)                      | ✓ |
+| [`@dxos/protocols`](../../../protocols/docs/README.md)                                   | ✓ |
+| [`@dxos/random-access-storage`](../../../../common/random-access-storage/docs/README.md) |         |
+| [`@dxos/timeframe`](../../../../common/timeframe/docs/README.md)                         |         |
+| [`@dxos/util`](../../../../common/util/docs/README.md)                                   | ✓ |

package/moon.yml

@@ -1,4 +1,4 @@
-type: library
+layer: library
 language: typescript
 tags:
   - ts-build
@@ -9,3 +9,4 @@ tasks:
     args:
       - '--entryPoint=src/index.ts'
       - '--injectGlobals'
+      - '--platform=neutral'

package/package.json

@@ -1,40 +1,39 @@
 {
   "name": "@dxos/credentials",
-  "version": "0.8.4-main.fffef41",
+  "version": "0.9.0",
   "description": "DXOS Credentials",
   "homepage": "https://github.com/dxos/dxos/tree/main/packages/core/halo/credentials#readme",
   "bugs": "https://github.com/dxos/dxos/issues",
-  "repository": "github:dxos/dxos",
-  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/dxos/dxos"
+  },
+  "license": "FSL-1.1-Apache-2.0",
   "author": "info@dxos.org",
-  "sideEffects": true,
+  "sideEffects": false,
   "type": "module",
   "exports": {
     ".": {
       "source": "./src/index.ts",
       "types": "./dist/types/src/index.d.ts",
-      "browser": "./dist/lib/browser/index.mjs",
-      "node": "./dist/lib/node-esm/index.mjs"
+      "default": "./dist/lib/neutral/index.mjs"
     }
   },
   "types": "dist/types/src/index.d.ts",
-  "typesVersions": {
-    "*": {}
-  },
   "dependencies": {
     "bip39": "^3.1.0",
     "json-stable-stringify": "^1.3.0",
-    "@dxos/async": "0.8.4-main.fffef41",
-    "@dxos/context": "0.8.4-main.fffef41",
-    "@dxos/crypto": "0.8.4-main.fffef41",
-    "@dxos/invariant": "0.8.4-main.fffef41",
-    "@dxos/keyring": "0.8.4-main.fffef41",
-    "@dxos/log": "0.8.4-main.fffef41",
-    "@dxos/protocols": "0.8.4-main.fffef41",
-    "@dxos/timeframe": "0.8.4-main.fffef41",
-    "@dxos/keys": "0.8.4-main.fffef41",
-    "@dxos/util": "0.8.4-main.fffef41",
-    "@dxos/node-std": "0.8.4-main.fffef41"
+    "@dxos/context": "0.9.0",
+    "@dxos/async": "0.9.0",
+    "@dxos/crypto": "0.9.0",
+    "@dxos/invariant": "0.9.0",
+    "@dxos/keyring": "0.9.0",
+    "@dxos/keys": "0.9.0",
+    "@dxos/log": "0.9.0",
+    "@dxos/node-std": "0.9.0",
+    "@dxos/timeframe": "0.9.0",
+    "@dxos/protocols": "0.9.0",
+    "@dxos/util": "0.9.0"
   },
   "publishConfig": {
     "access": "public"

package/src/credentials/credential-factory.ts

@@ -11,14 +11,14 @@ import { type Chain, type Credential } from '@dxos/protocols/proto/dxos/halo/cre
 import { getCredentialProofPayload } from './signing';
 import { SIGNATURE_TYPE_ED25519, verifyChain } from './verifier';
 
-export type CreateCredentialSignerParams = {
+export type CreateCredentialSignerProps = {
   subject: PublicKey;
   assertion: TypedMessage;
   nonce?: Uint8Array;
   parentCredentialIds?: PublicKey[];
 };
 
-export type CreateCredentialParams = {
+export type CreateCredentialProps = {
   signer: Signer;
   issuer: PublicKey;
   signingKey?: PublicKey;
@@ -44,7 +44,7 @@ export const createCredential = async ({
   chain,
   nonce,
   parentCredentialIds,
-}: CreateCredentialParams): Promise<Credential> => {
+}: CreateCredentialProps): Promise<Credential> => {
   invariant(assertion['@type'], 'Invalid assertion.');
   invariant(!!signingKey === !!chain, 'Chain must be provided if and only if the signing key differs from the issuer.');
   if (chain) {
@@ -93,7 +93,7 @@ export const createCredentialMessage = (credential: Credential) => {
 // TODO(burdon): Vs. Signer.
 export interface CredentialSigner {
   getIssuer(): PublicKey;
-  createCredential: (params: CreateCredentialSignerParams) => Promise<Credential>;
+  createCredential: (params: CreateCredentialSignerProps) => Promise<Credential>;
 }
 
 /**

package/src/credentials/credential-generator.ts

@@ -10,6 +10,7 @@ import {
   AdmittedFeed,
   type Credential,
   type DeviceProfileDocument,
+  MembershipPolicy,
   type ProfileDocument,
   SpaceMember,
 } from '@dxos/protocols/proto/dxos/halo/credentials';
@@ -38,6 +39,7 @@ export class CredentialGenerator {
     spaceKey: PublicKey,
     controlKey: PublicKey,
     creatorProfile?: ProfileDocument,
+    membershipPolicy: MembershipPolicy = MembershipPolicy.INVITE,
   ): Promise<Credential[]> {
     return [
       await createCredential({
@@ -47,6 +49,7 @@ export class CredentialGenerator {
         assertion: {
           '@type': 'dxos.halo.credentials.SpaceGenesis',
           spaceKey,
+          membershipPolicy,
         },
       }),
 
@@ -221,6 +224,7 @@ export const createAdmissionCredentials = async (
   membershipChainHeads: PublicKey[] = [],
   profile?: ProfileDocument,
   invitationCredentialId?: PublicKey,
+  tags?: string[],
 ): Promise<FeedMessage.Payload[]> => {
   const credentials = await Promise.all([
     await signer.createCredential({
@@ -233,6 +237,7 @@ export const createAdmissionCredentials = async (
         profile,
         genesisFeedKey,
         invitationCredentialId,
+        tags: tags ?? [],
       },
     }),
   ]);

package/src/credentials/signing.ts

@@ -27,6 +27,32 @@ export const getCredentialProofPayload = (credential: Credential): Uint8Array =>
   }
   delete copy.id; // ID is not part of the signature payload.
 
+  // Normalize proto3-default values in the assertion to avoid serialization asymmetry.
+  // Proto3 omits fields equal to their default on the wire (empty arrays, 0, "", false),
+  // and our codec doesn't restore defaults on decode — so after a round-trip the field
+  // is absent. The signing payload must pre-strip these defaults (plus `null`/`undefined`,
+  // which the canonical stringify replacer also drops) so signer and verifier produce the
+  // same canonical bytes regardless of whether the field was explicitly set to its default.
+  // Clone subject + assertion so we don't mutate the caller's credential.
+  const originalAssertion = copy.subject?.assertion;
+  if (originalAssertion) {
+    const normalizedAssertion: Record<string, any> = { ...originalAssertion };
+    for (const key of Object.keys(normalizedAssertion)) {
+      const val = normalizedAssertion[key];
+      if (
+        val === undefined ||
+        val === null ||
+        val === 0 ||
+        val === '' ||
+        val === false ||
+        (Array.isArray(val) && val.length === 0)
+      ) {
+        delete normalizedAssertion[key];
+      }
+    }
+    copy.subject = { ...copy.subject, assertion: normalizedAssertion as typeof originalAssertion };
+  }
+
   return Buffer.from(canonicalStringify(copy));
 };
 

package/src/presentations/json-encoding.test.ts

@@ -3,7 +3,6 @@
 //
 
 import { inspect } from 'util';
-
 import { describe, test } from 'vitest';
 
 import { randomBytes } from '@dxos/crypto';
@@ -13,7 +12,6 @@ import { PresentationSchema } from '@dxos/protocols/buf/dxos/halo/credentials_pb
 import { schema } from '@dxos/protocols/proto';
 
 import { createCredential } from '../credentials';
-
 import { signPresentation } from './presentation';
 
 describe('json encoding', () => {

package/src/presentations/presentation.ts

@@ -7,7 +7,6 @@ import { type PublicKey } from '@dxos/keys';
 import { type Chain, type Presentation, type Proof } from '@dxos/protocols/proto/dxos/halo/credentials';
 
 import { SIGNATURE_TYPE_ED25519 } from '../credentials';
-
 import { getPresentationProofPayload } from './signing';
 
 // TODO(burdon): Rename createPresentation?

package/src/presentations/verifier.test.ts

@@ -10,7 +10,6 @@ import { PublicKey } from '@dxos/keys';
 import { type Chain, SpaceMember } from '@dxos/protocols/proto/dxos/halo/credentials';
 
 import { createCredential } from '../credentials';
-
 import { signPresentation } from './presentation';
 import { verifyPresentation, verifyPresentationSignature } from './verifier';
 

package/src/presentations/verifier.ts

@@ -6,7 +6,6 @@ import { verifySignature } from '@dxos/crypto';
 import { type Presentation, type Proof } from '@dxos/protocols/proto/dxos/halo/credentials';
 
 import { SIGNATURE_TYPE_ED25519, type VerificationResult, verifyChain, verifyCredential } from '../credentials';
-
 import { getPresentationProofPayload } from './signing';
 
 export const verifyPresentation = async (presentation: Presentation): Promise<VerificationResult> => {

package/src/processor/device-state-machine.ts

@@ -10,10 +10,9 @@ import { type Chain, type Credential, type DeviceProfileDocument } from '@dxos/p
 import { ComplexMap } from '@dxos/util';
 
 import { getCredentialAssertion, isValidAuthorizedDeviceCredential } from '../credentials';
-
 import { type CredentialProcessor } from './credential-processor';
 
-export type DeviceStateMachineParams = {
+export type DeviceStateMachineProps = {
   identityKey: PublicKey;
   deviceKey: PublicKey;
   onUpdate?: () => void;
@@ -30,7 +29,7 @@ export class DeviceStateMachine implements CredentialProcessor {
 
   public deviceCredentialChain?: Chain;
 
-  constructor(private readonly _params: DeviceStateMachineParams) {}
+  constructor(private readonly _params: DeviceStateMachineProps) {}
 
   async processCredential(credential: Credential): Promise<void> {
     log('processing credential...', {

package/src/processor/profile-state-machine.ts

@@ -7,10 +7,9 @@ import { log } from '@dxos/log';
 import { type Credential, type ProfileDocument } from '@dxos/protocols/proto/dxos/halo/credentials';
 
 import { getCredentialAssertion } from '../credentials';
-
 import { type CredentialProcessor } from './credential-processor';
 
-export type ProfileStateMachineParams = {
+export type ProfileStateMachineProps = {
   identityKey: PublicKey;
   onUpdate?: () => void;
 };
@@ -22,7 +21,7 @@ export class ProfileStateMachine implements CredentialProcessor {
   // TODO(burdon): Return values via getter.
   public profile?: ProfileDocument;
 
-  constructor(private readonly _params: ProfileStateMachineParams) {}
+  constructor(private readonly _params: ProfileStateMachineProps) {}
 
   async processCredential(credential: Credential): Promise<void> {
     const assertion = getCredentialAssertion(credential);

package/src/state-machine/invitation-state-machine.test.ts

@@ -16,7 +16,6 @@ import {
   createCredentialSignerWithKey,
   createDelegatedSpaceInvitationCredential,
 } from '../credentials';
-
 import { InvitationStateMachine } from './invitation-state-machine';
 
 describe('InvitationStateMachine', () => {

package/src/state-machine/member-state-machine.test.ts

@@ -10,7 +10,6 @@ import { SpaceMember } from '@dxos/protocols/proto/dxos/halo/credentials';
 import { range } from '@dxos/util';
 
 import { createAdmissionCredentials, createCredentialSignerWithKey } from '../credentials';
-
 import { MemberStateMachine } from './member-state-machine';
 
 const keyring = new Keyring();

package/src/state-machine/space-state-machine.test.ts

@@ -6,10 +6,9 @@ import { describe, expect, test } from 'vitest';
 
 import { Keyring } from '@dxos/keyring';
 import { type PublicKey } from '@dxos/keys';
-import { AdmittedFeed, type Chain, SpaceMember } from '@dxos/protocols/proto/dxos/halo/credentials';
+import { AdmittedFeed, type Chain, MembershipPolicy, SpaceMember } from '@dxos/protocols/proto/dxos/halo/credentials';
 
 import { createCredential, verifyCredential } from '../credentials';
-
 import { SpaceStateMachine } from './space-state-machine';
 
 describe('SpaceStateMachine', () => {
@@ -30,6 +29,7 @@ describe('SpaceStateMachine', () => {
           assertion: {
             '@type': 'dxos.halo.credentials.SpaceGenesis',
             spaceKey: space,
+            membershipPolicy: MembershipPolicy.INVITE,
           },
           signer: keyring,
         }),
@@ -130,6 +130,7 @@ describe('SpaceStateMachine', () => {
           assertion: {
             '@type': 'dxos.halo.credentials.SpaceGenesis',
             spaceKey: space,
+            membershipPolicy: MembershipPolicy.INVITE,
           },
           signer: keyring,
         }),
@@ -211,6 +212,60 @@ describe('SpaceStateMachine', () => {
     expect(spaceState.credentials).toHaveLength(3);
   });
 
+  test('space genesis with tags', async () => {
+    const keyring = new Keyring();
+    const space = await keyring.createKey();
+    const identity = await keyring.createKey();
+    const feed = await keyring.createKey();
+
+    const spaceState = new SpaceStateMachine(space);
+
+    expect(spaceState.tags).toEqual([]);
+
+    expect(
+      await spaceState.process(
+        await createCredential({
+          issuer: space,
+          subject: space,
+          assertion: {
+            '@type': 'dxos.halo.credentials.SpaceGenesis',
+            spaceKey: space,
+            tags: ['personal', 'test'],
+            membershipPolicy: MembershipPolicy.INVITE,
+          },
+          signer: keyring,
+        }),
+        { sourceFeed: feed },
+      ),
+    ).toEqual(true);
+
+    expect(spaceState.tags).toEqual(['personal', 'test']);
+  });
+
+  test('space genesis without tags returns empty array', async () => {
+    const keyring = new Keyring();
+    const space = await keyring.createKey();
+    const feed = await keyring.createKey();
+
+    const spaceState = new SpaceStateMachine(space);
+
+    await spaceState.process(
+      await createCredential({
+        issuer: space,
+        subject: space,
+        assertion: {
+          '@type': 'dxos.halo.credentials.SpaceGenesis',
+          spaceKey: space,
+          membershipPolicy: MembershipPolicy.INVITE,
+        },
+        signer: keyring,
+      }),
+      { sourceFeed: feed },
+    );
+
+    expect(spaceState.tags).toEqual([]);
+  });
+
   test('storing device credentials and building a chain', async () => {
     const keyring = new Keyring();
     const haloSpace = await keyring.createKey();
@@ -230,6 +285,7 @@ describe('SpaceStateMachine', () => {
           assertion: {
             '@type': 'dxos.halo.credentials.SpaceGenesis',
             spaceKey: haloSpace,
+            membershipPolicy: MembershipPolicy.INVITE,
           },
           signer: keyring,
         }),
@@ -339,4 +395,189 @@ describe('SpaceStateMachine', () => {
 
     expect(await verifyCredential(credential)).toEqual({ kind: 'pass' });
   });
+
+  test('space genesis with membership policy', async () => {
+    const keyring = new Keyring();
+    const space = await keyring.createKey();
+    const feed = await keyring.createKey();
+
+    const spaceState = new SpaceStateMachine(space);
+
+    await spaceState.process(
+      await createCredential({
+        issuer: space,
+        subject: space,
+        assertion: {
+          '@type': 'dxos.halo.credentials.SpaceGenesis',
+          spaceKey: space,
+          membershipPolicy: MembershipPolicy.LOCKED,
+        },
+        signer: keyring,
+      }),
+      { sourceFeed: feed },
+    );
+
+    expect(spaceState.membershipPolicy).toEqual(MembershipPolicy.LOCKED);
+  });
+
+  test('space genesis without membership policy defaults to INVITE', async () => {
+    const keyring = new Keyring();
+    const space = await keyring.createKey();
+    const feed = await keyring.createKey();
+
+    const spaceState = new SpaceStateMachine(space);
+
+    // MembershipPolicy.INVITE is the proto zero-value default.
+    // Existing spaces without the field will have this value.
+    await spaceState.process(
+      await createCredential({
+        issuer: space,
+        subject: space,
+        assertion: {
+          '@type': 'dxos.halo.credentials.SpaceGenesis',
+          spaceKey: space,
+          membershipPolicy: MembershipPolicy.INVITE,
+        },
+        signer: keyring,
+      }),
+      { sourceFeed: feed },
+    );
+
+    expect(spaceState.membershipPolicy).toEqual(MembershipPolicy.INVITE);
+  });
+
+  test('locked space rejects new members', async ({ expect }) => {
+    const keyring = new Keyring();
+    const space = await keyring.createKey();
+    const identity = await keyring.createKey();
+    const identity2 = await keyring.createKey();
+    const feed = await keyring.createKey();
+
+    const spaceState = new SpaceStateMachine(space);
+
+    await spaceState.process(
+      await createCredential({
+        issuer: space,
+        subject: space,
+        assertion: {
+          '@type': 'dxos.halo.credentials.SpaceGenesis',
+          spaceKey: space,
+          membershipPolicy: MembershipPolicy.LOCKED,
+        },
+        signer: keyring,
+      }),
+      { sourceFeed: feed },
+    );
+
+    await spaceState.process(
+      await createCredential({
+        issuer: space,
+        subject: identity,
+        assertion: {
+          '@type': 'dxos.halo.credentials.SpaceMember',
+          spaceKey: space,
+          role: SpaceMember.Role.OWNER,
+          genesisFeedKey: feed,
+        },
+        signer: keyring,
+      }),
+      { sourceFeed: feed },
+    );
+
+    // Attempt to add a second member — should be rejected.
+    expect(
+      await spaceState.process(
+        await createCredential({
+          issuer: space,
+          subject: identity2,
+          assertion: {
+            '@type': 'dxos.halo.credentials.SpaceMember',
+            spaceKey: space,
+            role: SpaceMember.Role.EDITOR,
+            genesisFeedKey: feed,
+          },
+          signer: keyring,
+        }),
+        { sourceFeed: feed },
+      ),
+    ).toEqual(false);
+
+    expect(spaceState.members.size).toEqual(1);
+  });
+
+  test('locked space allows admitted feeds for existing members', async ({ expect }) => {
+    const keyring = new Keyring();
+    const space = await keyring.createKey();
+    const identity = await keyring.createKey();
+    const device = await keyring.createKey();
+    const feed = await keyring.createKey();
+    const newFeed = await keyring.createKey();
+
+    const spaceState = new SpaceStateMachine(space);
+
+    await spaceState.process(
+      await createCredential({
+        issuer: space,
+        subject: space,
+        assertion: {
+          '@type': 'dxos.halo.credentials.SpaceGenesis',
+          spaceKey: space,
+          membershipPolicy: MembershipPolicy.LOCKED,
+        },
+        signer: keyring,
+      }),
+      { sourceFeed: feed },
+    );
+
+    await spaceState.process(
+      await createCredential({
+        issuer: space,
+        subject: identity,
+        assertion: {
+          '@type': 'dxos.halo.credentials.SpaceMember',
+          spaceKey: space,
+          role: SpaceMember.Role.OWNER,
+          genesisFeedKey: feed,
+        },
+        signer: keyring,
+      }),
+      { sourceFeed: feed },
+    );
+
+    const chain: Chain = {
+      credential: await createCredential({
+        assertion: {
+          '@type': 'dxos.halo.credentials.AuthorizedDevice',
+          deviceKey: device,
+          identityKey: identity,
+        },
+        subject: device,
+        issuer: identity,
+        signer: keyring,
+      }),
+    };
+
+    // AdmittedFeed should still work on locked space.
+    expect(
+      await spaceState.process(
+        await createCredential({
+          issuer: identity,
+          subject: newFeed,
+          assertion: {
+            '@type': 'dxos.halo.credentials.AdmittedFeed',
+            spaceKey: space,
+            identityKey: identity,
+            deviceKey: device,
+            designation: AdmittedFeed.Designation.CONTROL,
+          },
+          signer: keyring,
+          signingKey: device,
+          chain,
+        }),
+        { sourceFeed: feed },
+      ),
+    ).toEqual(true);
+
+    expect(spaceState.feeds.size).toEqual(1);
+  });
 });