@dxos/protocols 0.4.10-main.c42bfdb → 0.4.10-main.c75170d

package/dist/esm/src/proto/gen/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/proto/gen/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AA8DhE,OAAO,aAAa,MAAM,kBAAkB,CAAC;AA4hB7C,MAAM,CAAC,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,8hsGAA8hsG,CAAC,CAAC,CAAC;AACvlsG,MAAM,CAAC,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAkB,UAAU,EAAE,aAAa,CAAC,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../../../src/proto/gen/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,sBAAsB,CAAC;AA8DhE,OAAO,aAAa,MAAM,kBAAkB,CAAC;AA6hB7C,MAAM,CAAC,MAAM,UAAU,GAAG,gBAAgB,CAAC,IAAI,CAAC,KAAK,CAAC,mmuGAAmmuG,CAAC,CAAC,CAAC;AAC5puG,MAAM,CAAC,MAAM,MAAM,GAAG,MAAM,CAAC,QAAQ,CAAkB,UAAU,EAAE,aAAa,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dxos/protocols",
-  "version": "0.4.10-main.c42bfdb",
+  "version": "0.4.10-main.c75170d",
   "description": "Protobuf definitions for DXOS protocols.",
   "homepage": "https://dxos.org",
   "bugs": "https://github.com/dxos/dxos/issues",
@@ -33,10 +33,10 @@
     "src"
   ],
   "dependencies": {
-    "@dxos/codec-protobuf": "0.4.10-main.c42bfdb",
-    "@dxos/keys": "0.4.10-main.c42bfdb",
-    "@dxos/timeframe": "0.4.10-main.c42bfdb",
-    "@dxos/invariant": "0.4.10-main.c42bfdb"
+    "@dxos/invariant": "0.4.10-main.c75170d",
+    "@dxos/keys": "0.4.10-main.c75170d",
+    "@dxos/timeframe": "0.4.10-main.c75170d",
+    "@dxos/codec-protobuf": "0.4.10-main.c75170d"
   },
   "devDependencies": {
     "glob": "~7.1.6"

package/src/indexing.ts

@@ -2,15 +2,16 @@
 // Copyright 2024 DXOS.org
 //
 
-// TODO(dmaretskyi): Rename ObjectPointer{Decoded/Encoded}.
-export type IdDecoded = {
+export type ObjectPointerDecoded = {
   documentId: string;
   objectId: string;
 };
 
+export type ObjectPointerEncoded = string;
+
 export const idCodec = {
-  encode: ({ documentId, objectId }: IdDecoded) => `${documentId}|${objectId}`,
-  decode: (id: string): IdDecoded => {
+  encode: ({ documentId, objectId }: ObjectPointerDecoded): ObjectPointerEncoded => `${documentId}|${objectId}`,
+  decode: (id: ObjectPointerEncoded): ObjectPointerDecoded => {
     const [documentId, objectId] = id.split('|');
     return { documentId, objectId };
   },

package/src/proto/dxos/client/services.proto

@@ -405,9 +405,12 @@ message Invitation {
   enum Type {
     /// Requires both to be online to complete key exchange.
     INTERACTIVE = 0;
-    /// Guest's identity key is known; invitation can be accepted by any valid peer.
-    OFFLINE = 1;
-    /// Multiple-use interactive invitation.
+    /// Invitation can be accepted by any valid peer.
+    DELEGATED = 1;
+    /**
+     * Multi-use interactive invitations.
+     * @deprecated use multiUse flag with type=interactive instead.
+     */
     MULTIUSE = 2;
   }
 
@@ -422,6 +425,9 @@ message Invitation {
 
     /// Guest should call `Authenticate` with the shared secret.
     SHARED_SECRET = 1;
+
+    /// Guest should prove they possess a private key corresponding to the known public key recorded in an invitation.
+    KNOWN_PUBLIC_KEY = 2;
   }
 
   enum State {
@@ -480,6 +486,17 @@ message Invitation {
   // TODO(nf): some feedback mechanism or GC for immortal invitations?
   // TODO(nf): should the creator have a way to make an invitation last as long as the client? this was the previous behavior.
   optional int32 lifetime = 14;
+
+  /// Whether an invitation can be used multiple times.
+  optional bool multi_use = 15;
+
+  /// Guest's keypair required for AuthMethod.KNOWN_PUBLIC_KEY.
+  optional AdmissionKeypair guest_keypair = 16;
+}
+
+message AdmissionKeypair {
+  dxos.keys.PublicKey public_key = 1;
+  optional dxos.keys.PrivateKey private_key = 2;
 }
 
 message AcceptInvitationRequest {
@@ -534,7 +551,6 @@ service InvitationsService {
   rpc Authenticate(AuthenticationRequest) returns (google.protobuf.Empty);
   rpc CancelInvitation(CancelInvitationRequest) returns (google.protobuf.Empty);
   rpc QueryInvitations(google.protobuf.Empty) returns (stream QueryInvitationsResponse);
-  rpc LoadPersistentInvitations(google.protobuf.Empty) returns (LoadPersistentInvitationsResponse);
 }
 
 //

package/src/proto/dxos/config.proto

@@ -131,9 +131,13 @@ message Runtime {
     /// Location of the remote client host.
     // TODO(burdon): Rename vault_endpoint (generalize http/ws; drop vault.html).
     optional string remote_source = 6;
-    
+
+    // Authenticate via `Sec-WebSocket-Protocol` header hack.
+    optional string remote_source_authentication_token = 8;
+
     /// Connect to and serve client services to a remote proxy.
     optional string devtools_proxy = 7;
+
   }
 
   message App {

package/src/proto/dxos/halo/invitations.proto

@@ -33,12 +33,19 @@ message IntroductionRequest {
 message IntroductionResponse {
   dxos.client.services.Invitation.AuthMethod auth_method = 1;
 
+  /// Present when auth_method is KNOWN_PUBLIC_KEY.
+  optional bytes challenge = 2;
+
   /// Only present for testing invitation types.
   optional dxos.keys.PublicKey space_key = 100;
 }
 
 message AuthenticationRequest {
-  string auth_code = 1;
+  /// Present when auth_method is SHARED_SECRET.
+  optional string auth_code = 1;
+
+  /// Present when auth_method is KNOWN_PUBLIC_KEY.
+  optional bytes signed_challenge = 2;
 }
 
 message AuthenticationResponse {
@@ -47,6 +54,7 @@ message AuthenticationResponse {
     INVALID_OTP = 1;
     INVALID_OPT_ATTEMPTS = 2;
     INTERNAL_ERROR = 3;
+    INVALID_SIGNATURE = 4;
   }
 
   optional Status status = 1;

package/src/proto/dxos/mesh/swarm.proto

@@ -9,14 +9,19 @@ import "dxos/keys.proto";
 
 package dxos.mesh.swarm;
 
+/**
+ * Use for:
+ * - Initial peer discovery (initiate session id between two peers).
+ * - RTC negotiation (SDP offer/answer and ICE).
+ */
 message SwarmMessage {
-  /// Swarm identefier.
+  /// Swarm identifier.
   dxos.keys.PublicKey topic = 3;
   /// Unique connection identifier.
   dxos.keys.PublicKey session_id = 4;
   /// Message payload.
   MessageData data = 5;
-  /// Unique message identifier. Used for Acknolegment and matching Anwers to Offers.
+  /// Unique message identifier. Used for ACK and matching Answers to Offers.
   dxos.keys.PublicKey message_id = 6;
 }
 
@@ -29,7 +34,6 @@ message MessageData {
      * @deprecated Use SignalBatch instead.
      */
     Signal signal = 3;
-    
     SignalBatch signal_batch = 4;
   }
 }
@@ -43,6 +47,10 @@ message Answer {
   optional dxos.keys.PublicKey offer_message_id = 2;
 }
 
+//
+// RTC messages.
+//
+
 message Signal {
   google.protobuf.Struct payload = 1;
 }

package/src/proto/gen/dxos/client/services.ts

@@ -925,6 +925,20 @@ export interface Invitation {
      *   - proto3_optional = true
      */
     lifetime?: number;
+    /**
+     * Whether an invitation can be used multiple times.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    multiUse?: boolean;
+    /**
+     * Guest's keypair required for AuthMethod.KNOWN_PUBLIC_KEY.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    guestKeypair?: AdmissionKeypair;
 }
 export namespace Invitation {
     /**
@@ -933,7 +947,7 @@ export namespace Invitation {
      */
     export enum Type {
         INTERACTIVE = 0,
-        OFFLINE = 1,
+        DELEGATED = 1,
         MULTIUSE = 2
     }
     /**
@@ -950,7 +964,8 @@ export namespace Invitation {
      */
     export enum AuthMethod {
         NONE = 0,
-        SHARED_SECRET = 1
+        SHARED_SECRET = 1,
+        KNOWN_PUBLIC_KEY = 2
     }
     /**
      * Defined in:
@@ -969,6 +984,18 @@ export namespace Invitation {
         EXPIRED = 9
     }
 }
+/**
+ * Defined in:
+ *   {@link file://./../../../dxos/client/services.proto}
+ */
+export interface AdmissionKeypair {
+    publicKey: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
+    /**
+     * Options:
+     *   - proto3_optional = true
+     */
+    privateKey?: ReturnType<(typeof substitutions)["dxos.keys.PrivateKey"]["decode"]>;
+}
 /**
  * Defined in:
  *   {@link file://./../../../dxos/client/services.proto}
@@ -1055,7 +1082,6 @@ export interface InvitationsService {
     authenticate: (request: AuthenticationRequest, options?: RequestOptions) => Promise<void>;
     cancelInvitation: (request: CancelInvitationRequest, options?: RequestOptions) => Promise<void>;
     queryInvitations: (request: void, options?: RequestOptions) => Stream<QueryInvitationsResponse>;
-    loadPersistentInvitations: (request: void, options?: RequestOptions) => Promise<LoadPersistentInvitationsResponse>;
 }
 /**
  * Defined in:

package/src/proto/gen/dxos/config.ts

@@ -291,6 +291,11 @@ export namespace Runtime {
          *   - proto3_optional = true
          */
         remoteSource?: string;
+        /**
+         * Options:
+         *   - proto3_optional = true
+         */
+        remoteSourceAuthenticationToken?: string;
         /**
          * Connect to and serve client services to a remote proxy.
          *

package/src/proto/gen/dxos/halo/invitations.ts

@@ -104,6 +104,13 @@ export interface IntroductionRequest {
  */
 export interface IntroductionResponse {
     authMethod: dxos_client_services.Invitation.AuthMethod;
+    /**
+     * Present when auth_method is KNOWN_PUBLIC_KEY.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    challenge?: Uint8Array;
     /**
      * Only present for testing invitation types.
      *
@@ -117,7 +124,20 @@ export interface IntroductionResponse {
  *   {@link file://./../../../dxos/halo/invitations.proto}
  */
 export interface AuthenticationRequest {
-    authCode: string;
+    /**
+     * Present when auth_method is SHARED_SECRET.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    authCode?: string;
+    /**
+     * Present when auth_method is KNOWN_PUBLIC_KEY.
+     *
+     * Options:
+     *   - proto3_optional = true
+     */
+    signedChallenge?: Uint8Array;
 }
 /**
  * Defined in:
@@ -139,7 +159,8 @@ export namespace AuthenticationResponse {
         OK = 0,
         INVALID_OTP = 1,
         INVALID_OPT_ATTEMPTS = 2,
-        INTERNAL_ERROR = 3
+        INTERNAL_ERROR = 3,
+        INVALID_SIGNATURE = 4
     }
 }
 /**

package/src/proto/gen/dxos/mesh/swarm.ts

@@ -61,12 +61,16 @@ import * as example_testing_data from "../../example/testing/data";
 import * as example_testing_rpc from "../../example/testing/rpc";
 import * as google_protobuf from "../../google/protobuf";
 /**
+ * Use for:
+ * - Initial peer discovery (initiate session id between two peers).
+ * - RTC negotiation (SDP offer/answer and ICE).
+ *
  * Defined in:
  *   {@link file://./../../../dxos/mesh/swarm.proto}
  */
 export interface SwarmMessage {
     /**
-     * Swarm identefier.
+     * Swarm identifier.
      */
     topic: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
     /**
@@ -78,7 +82,7 @@ export interface SwarmMessage {
      */
     data: MessageData;
     /**
-     * Unique message identifier. Used for Acknolegment and matching Anwers to Offers.
+     * Unique message identifier. Used for ACK and matching Answers to Offers.
      */
     messageId: ReturnType<(typeof substitutions)["dxos.keys.PublicKey"]["decode"]>;
 }