@massalabs/gossip-sdk 0.0.2-dev.20260128111120 → 0.0.2-dev.20260128162527

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,68 +1,164 @@
1
1
  /* tslint:disable */
2
2
  /* eslint-disable */
3
3
  export const memory: WebAssembly.Memory;
4
+ export const __wbg_announcementresult_free: (a: number, b: number) => void;
5
+ export const __wbg_encryptionkey_free: (a: number, b: number) => void;
6
+ export const __wbg_nonce_free: (a: number, b: number) => void;
7
+ export const __wbg_receivemessageoutput_free: (a: number, b: number) => void;
8
+ export const __wbg_sendmessageoutput_free: (a: number, b: number) => void;
4
9
  export const __wbg_sessionconfig_free: (a: number, b: number) => void;
5
- export const sessionconfig_new: (a: number, b: number, c: number, d: number, e: number, f: number, g: bigint) => number;
6
- export const sessionconfig_new_default: () => number;
10
+ export const __wbg_sessionmanagerwrapper_free: (a: number, b: number) => void;
11
+ export const __wbg_userkeys_free: (a: number, b: number) => void;
7
12
  export const __wbg_userpublickeys_free: (a: number, b: number) => void;
8
- export const userpublickeys_derive_id: (a: number) => [number, number];
9
- export const userpublickeys_dsa_verification_key: (a: number) => [number, number];
10
- export const userpublickeys_kem_public_key: (a: number) => [number, number];
11
- export const userpublickeys_massa_public_key: (a: number) => [number, number];
12
- export const userpublickeys_to_bytes: (a: number) => [number, number, number, number];
13
- export const userpublickeys_from_bytes: (a: number, b: number) => [number, number, number];
14
13
  export const __wbg_usersecretkeys_free: (a: number, b: number) => void;
15
- export const usersecretkeys_to_bytes: (a: number) => [number, number, number, number];
16
- export const usersecretkeys_from_bytes: (a: number, b: number) => [number, number, number];
17
- export const usersecretkeys_dsa_signing_key: (a: number) => [number, number];
18
- export const usersecretkeys_kem_secret_key: (a: number) => [number, number];
19
- export const usersecretkeys_massa_secret_key: (a: number) => [number, number];
20
- export const __wbg_userkeys_free: (a: number, b: number) => void;
21
- export const userkeys_public_keys: (a: number) => [number, number, number];
22
- export const userkeys_secret_keys: (a: number) => [number, number, number];
23
- export const generate_user_keys: (a: number, b: number) => [number, number, number];
24
- export const __wbg_encryptionkey_free: (a: number, b: number) => void;
14
+ export const aead_decrypt: (
15
+ a: number,
16
+ b: number,
17
+ c: number,
18
+ d: number,
19
+ e: number,
20
+ f: number
21
+ ) => [number, number];
22
+ export const aead_encrypt: (
23
+ a: number,
24
+ b: number,
25
+ c: number,
26
+ d: number,
27
+ e: number,
28
+ f: number
29
+ ) => [number, number];
30
+ export const announcementresult_announcer_public_keys: (a: number) => number;
31
+ export const announcementresult_timestamp: (a: number) => number;
32
+ export const announcementresult_user_data: (a: number) => [number, number];
33
+ export const encryptionkey_from_bytes: (
34
+ a: number,
35
+ b: number
36
+ ) => [number, number, number];
37
+ export const encryptionkey_from_seed: (
38
+ a: number,
39
+ b: number,
40
+ c: number,
41
+ d: number
42
+ ) => [number, number, number];
25
43
  export const encryptionkey_generate: () => number;
26
- export const encryptionkey_from_seed: (a: number, b: number, c: number, d: number) => [number, number, number];
27
- export const encryptionkey_from_bytes: (a: number, b: number) => [number, number, number];
28
44
  export const encryptionkey_to_bytes: (a: number) => [number, number];
29
- export const __wbg_nonce_free: (a: number, b: number) => void;
45
+ export const generate_user_keys: (
46
+ a: number,
47
+ b: number
48
+ ) => [number, number, number];
49
+ export const nonce_from_bytes: (
50
+ a: number,
51
+ b: number
52
+ ) => [number, number, number];
30
53
  export const nonce_generate: () => number;
31
- export const nonce_from_bytes: (a: number, b: number) => [number, number, number];
32
54
  export const nonce_to_bytes: (a: number) => [number, number];
33
- export const aead_encrypt: (a: number, b: number, c: number, d: number, e: number, f: number) => [number, number];
34
- export const aead_decrypt: (a: number, b: number, c: number, d: number, e: number, f: number) => [number, number];
35
- export const __wbg_sendmessageoutput_free: (a: number, b: number) => void;
36
- export const sendmessageoutput_seeker: (a: number) => [number, number];
37
- export const sendmessageoutput_data: (a: number) => [number, number];
38
- export const __wbg_receivemessageoutput_free: (a: number, b: number) => void;
39
- export const __wbg_announcementresult_free: (a: number, b: number) => void;
40
- export const announcementresult_announcer_public_keys: (a: number) => number;
41
- export const announcementresult_timestamp: (a: number) => number;
42
- export const announcementresult_user_data: (a: number) => [number, number];
55
+ export const receivemessageoutput_acknowledged_seekers: (a: number) => any;
43
56
  export const receivemessageoutput_message: (a: number) => [number, number];
44
57
  export const receivemessageoutput_timestamp: (a: number) => number;
45
- export const receivemessageoutput_acknowledged_seekers: (a: number) => any;
46
58
  export const receivemessageoutput_user_id: (a: number) => [number, number];
47
- export const __wbg_sessionmanagerwrapper_free: (a: number, b: number) => void;
59
+ export const sendmessageoutput_data: (a: number) => [number, number];
60
+ export const sendmessageoutput_seeker: (a: number) => [number, number];
61
+ export const sessionconfig_new: (
62
+ a: number,
63
+ b: number,
64
+ c: number,
65
+ d: number,
66
+ e: number,
67
+ f: number,
68
+ g: bigint
69
+ ) => number;
70
+ export const sessionconfig_new_default: () => number;
71
+ export const sessionmanagerwrapper_establish_outgoing_session: (
72
+ a: number,
73
+ b: number,
74
+ c: number,
75
+ d: number,
76
+ e: number,
77
+ f: number
78
+ ) => [number, number];
79
+ export const sessionmanagerwrapper_feed_incoming_announcement: (
80
+ a: number,
81
+ b: number,
82
+ c: number,
83
+ d: number,
84
+ e: number
85
+ ) => number;
86
+ export const sessionmanagerwrapper_feed_incoming_message_board_read: (
87
+ a: number,
88
+ b: number,
89
+ c: number,
90
+ d: number,
91
+ e: number,
92
+ f: number
93
+ ) => number;
94
+ export const sessionmanagerwrapper_from_encrypted_blob: (
95
+ a: number,
96
+ b: number,
97
+ c: number
98
+ ) => [number, number, number];
99
+ export const sessionmanagerwrapper_get_message_board_read_keys: (
100
+ a: number
101
+ ) => any;
48
102
  export const sessionmanagerwrapper_new: (a: number) => number;
49
- export const sessionmanagerwrapper_from_encrypted_blob: (a: number, b: number, c: number) => [number, number, number];
50
- export const sessionmanagerwrapper_to_encrypted_blob: (a: number, b: number) => [number, number, number, number];
51
- export const sessionmanagerwrapper_establish_outgoing_session: (a: number, b: number, c: number, d: number, e: number, f: number) => [number, number];
52
- export const sessionmanagerwrapper_feed_incoming_announcement: (a: number, b: number, c: number, d: number, e: number) => number;
53
- export const sessionmanagerwrapper_get_message_board_read_keys: (a: number) => any;
54
- export const sessionmanagerwrapper_send_message: (a: number, b: number, c: number, d: number, e: number) => [number, number, number];
55
- export const sessionmanagerwrapper_feed_incoming_message_board_read: (a: number, b: number, c: number, d: number, e: number, f: number) => number;
103
+ export const sessionmanagerwrapper_peer_discard: (
104
+ a: number,
105
+ b: number,
106
+ c: number
107
+ ) => [number, number];
56
108
  export const sessionmanagerwrapper_peer_list: (a: number) => any;
57
- export const sessionmanagerwrapper_peer_session_status: (a: number, b: number, c: number) => [number, number, number];
58
- export const sessionmanagerwrapper_peer_discard: (a: number, b: number, c: number) => [number, number];
109
+ export const sessionmanagerwrapper_peer_session_status: (
110
+ a: number,
111
+ b: number,
112
+ c: number
113
+ ) => [number, number, number];
59
114
  export const sessionmanagerwrapper_refresh: (a: number) => any;
115
+ export const sessionmanagerwrapper_send_message: (
116
+ a: number,
117
+ b: number,
118
+ c: number,
119
+ d: number,
120
+ e: number
121
+ ) => [number, number, number];
122
+ export const sessionmanagerwrapper_to_encrypted_blob: (
123
+ a: number,
124
+ b: number
125
+ ) => [number, number, number, number];
126
+ export const userkeys_public_keys: (a: number) => [number, number, number];
127
+ export const userkeys_secret_keys: (a: number) => [number, number, number];
128
+ export const userpublickeys_derive_id: (a: number) => [number, number];
129
+ export const userpublickeys_dsa_verification_key: (
130
+ a: number
131
+ ) => [number, number];
132
+ export const userpublickeys_from_bytes: (
133
+ a: number,
134
+ b: number
135
+ ) => [number, number, number];
136
+ export const userpublickeys_kem_public_key: (a: number) => [number, number];
137
+ export const userpublickeys_massa_public_key: (a: number) => [number, number];
138
+ export const userpublickeys_to_bytes: (
139
+ a: number
140
+ ) => [number, number, number, number];
141
+ export const usersecretkeys_dsa_signing_key: (a: number) => [number, number];
142
+ export const usersecretkeys_from_bytes: (
143
+ a: number,
144
+ b: number
145
+ ) => [number, number, number];
146
+ export const usersecretkeys_kem_secret_key: (a: number) => [number, number];
147
+ export const usersecretkeys_massa_secret_key: (a: number) => [number, number];
148
+ export const usersecretkeys_to_bytes: (
149
+ a: number
150
+ ) => [number, number, number, number];
60
151
  export const start: () => void;
61
152
  export const __wbindgen_exn_store: (a: number) => void;
62
153
  export const __externref_table_alloc: () => number;
63
154
  export const __wbindgen_export_2: WebAssembly.Table;
64
155
  export const __wbindgen_free: (a: number, b: number, c: number) => void;
65
156
  export const __wbindgen_malloc: (a: number, b: number) => number;
66
- export const __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;
157
+ export const __wbindgen_realloc: (
158
+ a: number,
159
+ b: number,
160
+ c: number,
161
+ d: number
162
+ ) => number;
67
163
  export const __externref_table_dealloc: (a: number) => void;
68
164
  export const __wbindgen_start: () => void;
@@ -12,4 +12,4 @@
12
12
  "sideEffects": [
13
13
  "./snippets/*"
14
14
  ]
15
- }
15
+ }
@@ -0,0 +1,281 @@
1
+ # Gossip WASM - WebAssembly Bindings
2
+
3
+ This crate provides WebAssembly bindings for the Gossip secure messaging system, exposing the SessionManager and Auth facilities to JavaScript/TypeScript applications.
4
+
5
+ ## Features
6
+
7
+ - **Session Management**: Create, persist, and manage encrypted messaging sessions
8
+ - **Authentication**: Generate and manage cryptographic keys from passphrases
9
+ - **Post-Quantum Security**: Uses ML-KEM and ML-DSA for quantum-resistant cryptography
10
+ - **Encrypted State**: Secure serialization and deserialization of session state
11
+ - **Seeker-based Addressing**: Messages use hashed Massa public keys for efficient lookups
12
+
13
+ ## Building
14
+
15
+ ### Prerequisites
16
+
17
+ - Rust toolchain with `wasm32-unknown-unknown` target
18
+ - wasm-pack (optional, for generating npm package)
19
+
20
+ ### Build with Cargo
21
+
22
+ ```bash
23
+ cargo build --target wasm32-unknown-unknown --release
24
+ ```
25
+
26
+ The compiled WASM module will be at:
27
+
28
+ ```
29
+ ../target/wasm32-unknown-unknown/release/gossip_wasm.wasm
30
+ ```
31
+
32
+ ### Build with wasm-pack
33
+
34
+ For a complete npm-ready package with TypeScript definitions:
35
+
36
+ ```bash
37
+ wasm-pack build --target web
38
+ ```
39
+
40
+ ## Usage
41
+
42
+ ### JavaScript/TypeScript
43
+
44
+ ```typescript
45
+ import init, {
46
+ SessionManagerWrapper,
47
+ SessionConfig,
48
+ generate_user_keys,
49
+ EncryptionKey,
50
+ } from './gossip_wasm';
51
+
52
+ // Initialize WASM
53
+ await init();
54
+
55
+ // Generate user keys from passphrase
56
+ const keys = generate_user_keys('my secure passphrase');
57
+ const publicKeys = keys.public_keys();
58
+ const secretKeys = keys.secret_keys();
59
+ const userId = publicKeys.derive_id();
60
+
61
+ // Create session manager with default configuration
62
+ const config = SessionConfig.new_default();
63
+ const manager = new SessionManagerWrapper(config);
64
+
65
+ // Establish session with peer
66
+ const peerKeys = generate_user_keys('peer passphrase');
67
+ const userData = new TextEncoder().encode('contact_request'); // Optional user data
68
+ const announcement = manager.establish_outgoing_session(
69
+ peerKeys.public_keys(),
70
+ publicKeys,
71
+ secretKeys,
72
+ userData
73
+ );
74
+ // Publish announcement to blockchain...
75
+
76
+ // Feed incoming announcement from peer
77
+ const result = manager.feed_incoming_announcement(
78
+ announcementBytes,
79
+ publicKeys,
80
+ secretKeys
81
+ );
82
+ if (result) {
83
+ console.log('Announcer public keys:', result.announcer_public_keys);
84
+ console.log('Timestamp:', result.timestamp);
85
+ console.log('User data:', new TextDecoder().decode(result.user_data));
86
+ }
87
+
88
+ // Send a message (raw bytes)
89
+ const messageBytes = new TextEncoder().encode('Hello!');
90
+ const peerId = peerKeys.public_keys().derive_id();
91
+ const sendOutput = manager.send_message(peerId, messageBytes);
92
+ if (sendOutput) {
93
+ // Publish sendOutput.seeker and sendOutput.data to blockchain
94
+ console.log('Seeker:', sendOutput.seeker);
95
+ console.log('Data length:', sendOutput.data.length);
96
+ }
97
+
98
+ // Check for incoming messages
99
+ const seekers = manager.get_message_board_read_keys();
100
+ for (let i = 0; i < seekers.length; i++) {
101
+ const seeker = seekers.get(i);
102
+ // Read from blockchain using seeker...
103
+ const received = manager.feed_incoming_message_board_read(
104
+ seeker,
105
+ data, // encrypted message data
106
+ secretKeys
107
+ );
108
+ if (received) {
109
+ console.log('Received:', new TextDecoder().decode(received.message));
110
+ console.log('Timestamp:', received.timestamp);
111
+ // Check acknowledged seekers
112
+ const acks = received.acknowledged_seekers;
113
+ for (let j = 0; j < acks.length; j++) {
114
+ console.log('Acknowledged:', acks.get(j));
115
+ }
116
+ }
117
+ }
118
+
119
+ // Persist session state
120
+ const encryptionKey = EncryptionKey.generate();
121
+ const encrypted = manager.to_encrypted_blob(encryptionKey);
122
+ // Save encrypted blob to storage...
123
+
124
+ // Restore session state
125
+ const restored = SessionManagerWrapper.from_encrypted_blob(
126
+ encrypted,
127
+ encryptionKey
128
+ );
129
+ ```
130
+
131
+ ### Custom Configuration
132
+
133
+ ```typescript
134
+ const config = new SessionConfig(
135
+ 604800000, // max_incoming_announcement_age_millis (1 week)
136
+ 60000, // max_incoming_announcement_future_millis (1 minute)
137
+ 604800000, // max_incoming_message_age_millis (1 week)
138
+ 60000, // max_incoming_message_future_millis (1 minute)
139
+ 604800000, // max_session_inactivity_millis (1 week)
140
+ 86400000, // keep_alive_interval_millis (1 day)
141
+ 10000 // max_session_lag_length
142
+ );
143
+ ```
144
+
145
+ ## API Reference
146
+
147
+ ### AEAD Encryption Functions
148
+
149
+ Direct access to AES-256-SIV authenticated encryption:
150
+
151
+ - `aead_encrypt(key: EncryptionKey, nonce: Nonce, plaintext: Uint8Array, aad: Uint8Array)`: Encrypt data
152
+ - `aead_decrypt(key: EncryptionKey, nonce: Nonce, ciphertext: Uint8Array, aad: Uint8Array)`: Decrypt data
153
+
154
+ #### AEAD Example
155
+
156
+ ```typescript
157
+ import {
158
+ EncryptionKey,
159
+ Nonce,
160
+ aead_encrypt,
161
+ aead_decrypt,
162
+ } from './gossip_wasm';
163
+
164
+ // Generate key and nonce
165
+ const key = EncryptionKey.generate();
166
+ const nonce = Nonce.generate();
167
+
168
+ // Encrypt some data
169
+ const plaintext = new TextEncoder().encode('Secret message');
170
+ const aad = new TextEncoder().encode('context info'); // Additional authenticated data
171
+ const ciphertext = aead_encrypt(key, nonce, plaintext, aad);
172
+
173
+ // Decrypt
174
+ const decrypted = aead_decrypt(key, nonce, ciphertext, aad);
175
+ if (decrypted) {
176
+ console.log('Success:', new TextDecoder().decode(decrypted));
177
+ } else {
178
+ console.error('Decryption failed - tampering detected!');
179
+ }
180
+ ```
181
+
182
+ **Security Notes:**
183
+
184
+ - Nonces should be unique per encryption (16 bytes)
185
+ - AAD (Additional Authenticated Data) is authenticated but NOT encrypted
186
+ - AES-SIV is nonce-misuse resistant - reusing nonces only leaks if plaintexts are identical
187
+ - Keys are 64 bytes (512 bits) for AES-256-SIV
188
+
189
+ ### SessionManagerWrapper
190
+
191
+ Main class for managing messaging sessions.
192
+
193
+ - `new(config: SessionConfig)`: Create new session manager
194
+ - `from_encrypted_blob(blob: Uint8Array, key: EncryptionKey)`: Restore from encrypted state
195
+ - `to_encrypted_blob(key: EncryptionKey)`: Serialize to encrypted blob
196
+ - `establish_outgoing_session(peer_pk, our_pk, our_sk, user_data: Uint8Array)`: Initiate session with peer, including optional user data (returns announcement bytes)
197
+ - `feed_incoming_announcement(bytes, our_pk, our_sk)`: Process incoming announcement (returns AnnouncementResult with announcer's public keys and user data, or undefined)
198
+ - `send_message(peer_id: Uint8Array, message_contents: Uint8Array)`: Send raw message bytes to peer
199
+ - `feed_incoming_message_board_read(seeker, data, our_sk)`: Process incoming messages
200
+ - `get_message_board_read_keys()`: Get seekers to monitor for incoming messages
201
+ - `peer_list()`: Get all peer IDs
202
+ - `peer_session_status(peer_id: Uint8Array)`: Get session status
203
+ - `peer_discard(peer_id: Uint8Array)`: Remove peer
204
+ - `refresh()`: Refresh sessions and get keep-alive announcement list
205
+
206
+ ### AnnouncementResult
207
+
208
+ Result from processing an incoming announcement:
209
+
210
+ - `announcer_public_keys(): UserPublicKeys`: The public keys of the peer who sent the announcement
211
+ - `timestamp(): number`: Unix timestamp in milliseconds when the announcement was created
212
+ - `user_data(): Uint8Array`: Arbitrary user data embedded in the announcement (can be empty)
213
+
214
+ **Use Cases for User Data:**
215
+
216
+ - Contact requests with metadata
217
+ - Version information
218
+ - Application-specific handshake data
219
+ - Display names or profile information
220
+ - Protocol negotiation parameters
221
+
222
+ **⚠️ Security Warning:**
223
+
224
+ The user_data in announcements has **reduced security compared to regular messages**:
225
+
226
+ - ✅ **Plausible deniability preserved**: The user_data is not cryptographically signed, so the sender can deny specific content
227
+ - ❌ **No post-compromise secrecy**: If long-term keys are compromised, past announcements can be decrypted
228
+
229
+ **Recommendation**: Use user_data for non-highly-sensitive metadata. Send truly sensitive information through regular messages after the session is established.
230
+
231
+ ### SendMessageOutput
232
+
233
+ Output from sending a message:
234
+
235
+ - `seeker(): Uint8Array`: Database key for message lookup on message board
236
+ - `data(): Uint8Array`: Encrypted message data to publish
237
+ - `timestamp(): number`: Message timestamp (milliseconds since Unix epoch)
238
+
239
+ ### ReceiveMessageOutput
240
+
241
+ Output from receiving a message:
242
+
243
+ - `message(): Uint8Array`: Decrypted message contents
244
+ - `timestamp(): number`: Message timestamp (milliseconds since Unix epoch)
245
+ - `acknowledged_seekers()`: Array of seekers that were acknowledged
246
+
247
+ ### Auth Functions
248
+
249
+ - `generate_user_keys(passphrase: string)`: Generate keys from passphrase using password KDF
250
+
251
+ ### Other Classes
252
+
253
+ - `SessionConfig`: Session manager configuration
254
+ - `EncryptionKey`: AES-256-SIV key (64 bytes)
255
+ - `generate()`: Generate random key
256
+ - `from_bytes(bytes: Uint8Array)`: Create from bytes
257
+ - `to_bytes()`: Get raw bytes
258
+ - `Nonce`: AES-256-SIV nonce (16 bytes)
259
+ - `generate()`: Generate random nonce
260
+ - `from_bytes(bytes: Uint8Array)`: Create from bytes
261
+ - `to_bytes()`: Get raw bytes
262
+ - `UserPublicKeys`: User's public keys
263
+ - `derive_id()`: Get user ID (32 bytes)
264
+ - `to_bytes()`: Serialize to bytes
265
+ - `UserSecretKeys`: User's secret keys
266
+ - `SessionStatus`: Enum for session states (Active, Inactive, etc.)
267
+
268
+ ## Architecture
269
+
270
+ The Gossip system uses a multi-layer architecture:
271
+
272
+ 1. **Crypto Primitives**: ML-KEM (post-quantum KEM), ML-DSA (post-quantum signatures), AES-SIV (AEAD)
273
+ 2. **Agraphon Protocol**: Double-ratchet encryption with forward secrecy and post-compromise security
274
+ 3. **Session Layer**: Manages Agraphon sessions with seeker-based addressing using hashed Massa public keys
275
+ 4. **Session Manager**: High-level API for multi-peer messaging with session lifecycle management
276
+
277
+ Messages are identified by "seekers" - database keys derived from hashing ephemeral Massa public keys. This allows:
278
+
279
+ - Efficient message lookup on public message boards
280
+ - Privacy (seekers don't reveal sender/recipient identity)
281
+ - Unlinkability (each message uses a fresh keypair)