bsv-rs 0.3.5

BSV blockchain SDK for Rust - primitives, script, transactions, and more
Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
//! Session management for concurrent peer sessions.
//!
//! The `SessionManager` handles multiple concurrent sessions per peer identity,
//! using dual indexing by session nonce (unique) and identity key (multiple per peer).

use crate::auth::types::PeerSession;
use crate::{Error, Result};
use std::collections::{HashMap, HashSet};

/// Manages multiple concurrent sessions per peer identity.
///
/// Sessions are indexed by both session nonce (unique) and
/// identity key (multiple sessions per identity allowed).
///
/// # Session Lookup
///
/// When looking up a session by identifier:
/// 1. First tries to match as a session nonce (exact match)
/// 2. If not found, tries as an identity key (returns "best" session)
///
/// The "best" session is selected by:
/// 1. Prefer authenticated sessions over unauthenticated
/// 2. Among same auth status, prefer most recently updated
#[derive(Debug, Default)]
pub struct SessionManager {
    /// Primary index: session_nonce -> session
    session_nonce_to_session: HashMap<String, PeerSession>,
    /// Secondary index: identity_key_hex -> set of session_nonces
    identity_key_to_nonces: HashMap<String, HashSet<String>>,
}

impl SessionManager {
    /// Creates a new session manager.
    pub fn new() -> Self {
        Self::default()
    }

    /// Adds a new session to the manager.
    ///
    /// # Errors
    ///
    /// Returns an error if:
    /// - The session has no nonce
    /// - A session with the same nonce already exists
    pub fn add_session(&mut self, session: PeerSession) -> Result<()> {
        let nonce = session
            .session_nonce
            .as_ref()
            .ok_or_else(|| Error::AuthError("Session must have a nonce".into()))?;

        if self.session_nonce_to_session.contains_key(nonce) {
            return Err(Error::AuthError(format!(
                "Session nonce already exists: {}",
                nonce
            )));
        }

        // Add to secondary index if identity key exists
        if let Some(ref identity_key) = session.peer_identity_key {
            let key_hex = identity_key.to_hex();
            self.identity_key_to_nonces
                .entry(key_hex)
                .or_default()
                .insert(nonce.clone());
        }

        self.session_nonce_to_session.insert(nonce.clone(), session);
        Ok(())
    }

    /// Updates an existing session.
    ///
    /// If the session's nonce doesn't exist in the manager, this is a no-op.
    /// If the identity key changed, updates the secondary index.
    pub fn update_session(&mut self, session: PeerSession) {
        if let Some(ref nonce) = session.session_nonce {
            // Check if session exists
            if let Some(old_session) = self.session_nonce_to_session.get(nonce) {
                // Handle identity key change in secondary index
                let old_key_hex = old_session.peer_identity_key.as_ref().map(|k| k.to_hex());
                let new_key_hex = session.peer_identity_key.as_ref().map(|k| k.to_hex());

                if old_key_hex != new_key_hex {
                    // Remove from old identity key index
                    if let Some(old_hex) = old_key_hex {
                        if let Some(nonces) = self.identity_key_to_nonces.get_mut(&old_hex) {
                            nonces.remove(nonce);
                            if nonces.is_empty() {
                                self.identity_key_to_nonces.remove(&old_hex);
                            }
                        }
                    }

                    // Add to new identity key index
                    if let Some(new_hex) = new_key_hex {
                        self.identity_key_to_nonces
                            .entry(new_hex)
                            .or_default()
                            .insert(nonce.clone());
                    }
                }

                // Update the session
                self.session_nonce_to_session.insert(nonce.clone(), session);
            }
        }
    }

    /// Gets a session by nonce or identity key.
    ///
    /// If the identifier matches a session nonce, returns that session.
    /// If it matches an identity key, returns the "best" session for that peer
    /// (most recent authenticated session, or most recent unauthenticated).
    pub fn get_session(&self, identifier: &str) -> Option<&PeerSession> {
        // First, try as session nonce
        if let Some(session) = self.session_nonce_to_session.get(identifier) {
            return Some(session);
        }

        // Then, try as identity key
        if let Some(nonces) = self.identity_key_to_nonces.get(identifier) {
            return self.select_best_session(nonces);
        }

        None
    }

    /// Gets a mutable session by session nonce.
    pub fn get_session_mut(&mut self, session_nonce: &str) -> Option<&mut PeerSession> {
        self.session_nonce_to_session.get_mut(session_nonce)
    }

    /// Removes a session from the manager.
    pub fn remove_session(&mut self, session: &PeerSession) {
        if let Some(ref nonce) = session.session_nonce {
            self.session_nonce_to_session.remove(nonce);

            // Remove from secondary index
            if let Some(ref identity_key) = session.peer_identity_key {
                let key_hex = identity_key.to_hex();
                if let Some(nonces) = self.identity_key_to_nonces.get_mut(&key_hex) {
                    nonces.remove(nonce);
                    if nonces.is_empty() {
                        self.identity_key_to_nonces.remove(&key_hex);
                    }
                }
            }
        }
    }

    /// Removes a session by its nonce.
    pub fn remove_by_nonce(&mut self, session_nonce: &str) {
        if let Some(session) = self.session_nonce_to_session.remove(session_nonce) {
            // Remove from secondary index
            if let Some(ref identity_key) = session.peer_identity_key {
                let key_hex = identity_key.to_hex();
                if let Some(nonces) = self.identity_key_to_nonces.get_mut(&key_hex) {
                    nonces.remove(session_nonce);
                    if nonces.is_empty() {
                        self.identity_key_to_nonces.remove(&key_hex);
                    }
                }
            }
        }
    }

    /// Checks if a session exists for the given identifier.
    pub fn has_session(&self, identifier: &str) -> bool {
        self.get_session(identifier).is_some()
    }

    /// Returns the number of sessions.
    pub fn len(&self) -> usize {
        self.session_nonce_to_session.len()
    }

    /// Returns true if there are no sessions.
    pub fn is_empty(&self) -> bool {
        self.session_nonce_to_session.is_empty()
    }

    /// Gets all sessions for an identity key.
    pub fn get_sessions_for_identity(&self, identity_key_hex: &str) -> Vec<&PeerSession> {
        self.identity_key_to_nonces
            .get(identity_key_hex)
            .map(|nonces| {
                nonces
                    .iter()
                    .filter_map(|n| self.session_nonce_to_session.get(n))
                    .collect()
            })
            .unwrap_or_default()
    }

    /// Returns an iterator over all sessions.
    pub fn iter(&self) -> impl Iterator<Item = &PeerSession> {
        self.session_nonce_to_session.values()
    }

    /// Clears all sessions.
    pub fn clear(&mut self) {
        self.session_nonce_to_session.clear();
        self.identity_key_to_nonces.clear();
    }

    /// Selects the "best" session from a set of nonces.
    ///
    /// Prefers authenticated sessions, then most recently updated.
    fn select_best_session(&self, nonces: &HashSet<String>) -> Option<&PeerSession> {
        let mut best: Option<&PeerSession> = None;

        for nonce in nonces {
            if let Some(session) = self.session_nonce_to_session.get(nonce) {
                best = match best {
                    None => Some(session),
                    Some(current) => {
                        // Prefer authenticated over unauthenticated
                        if session.is_authenticated && !current.is_authenticated {
                            Some(session)
                        } else if !session.is_authenticated && current.is_authenticated {
                            Some(current)
                        } else if session.last_update > current.last_update {
                            // Same auth status: prefer more recent
                            Some(session)
                        } else {
                            Some(current)
                        }
                    }
                };
            }
        }

        best
    }

    /// Removes sessions that haven't been updated in the given duration.
    ///
    /// Returns the number of sessions removed.
    pub fn prune_stale_sessions(&mut self, max_age_ms: u64) -> usize {
        let now = crate::auth::types::current_time_ms();
        let cutoff = now.saturating_sub(max_age_ms);

        let stale_nonces: Vec<String> = self
            .session_nonce_to_session
            .iter()
            .filter(|(_, session)| session.last_update < cutoff)
            .map(|(nonce, _)| nonce.clone())
            .collect();

        let count = stale_nonces.len();
        for nonce in stale_nonces {
            self.remove_by_nonce(&nonce);
        }

        count
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::auth::types::current_time_ms;
    use crate::primitives::PrivateKey;

    fn make_session(
        nonce: &str,
        identity_key: Option<&crate::primitives::PublicKey>,
    ) -> PeerSession {
        PeerSession {
            session_nonce: Some(nonce.to_string()),
            peer_identity_key: identity_key.cloned(),
            last_update: current_time_ms(),
            ..Default::default()
        }
    }

    #[test]
    fn test_add_and_get_session() {
        let mut mgr = SessionManager::new();
        let key = PrivateKey::random().public_key();

        let session = make_session("nonce123", Some(&key));
        mgr.add_session(session).unwrap();

        // Find by nonce
        assert!(mgr.get_session("nonce123").is_some());

        // Find by identity key
        assert!(mgr.get_session(&key.to_hex()).is_some());

        // Not found
        assert!(mgr.get_session("nonexistent").is_none());
    }

    #[test]
    fn test_duplicate_nonce_rejected() {
        let mut mgr = SessionManager::new();
        let key = PrivateKey::random().public_key();

        let session1 = make_session("nonce123", Some(&key));
        let session2 = make_session("nonce123", Some(&key));

        mgr.add_session(session1).unwrap();
        assert!(mgr.add_session(session2).is_err());
    }

    #[test]
    fn test_session_without_nonce_rejected() {
        let mut mgr = SessionManager::new();
        let session = PeerSession::new();
        assert!(mgr.add_session(session).is_err());
    }

    #[test]
    fn test_prefers_authenticated() {
        let mut mgr = SessionManager::new();
        let key = PrivateKey::random().public_key();

        // Add unauthenticated session (newer)
        let mut s1 = make_session("nonce1", Some(&key));
        s1.is_authenticated = false;
        s1.last_update = current_time_ms() + 1000;
        mgr.add_session(s1).unwrap();

        // Add authenticated session (older)
        let mut s2 = make_session("nonce2", Some(&key));
        s2.is_authenticated = true;
        s2.last_update = current_time_ms();
        mgr.add_session(s2).unwrap();

        // Should prefer authenticated even though older
        let session = mgr.get_session(&key.to_hex()).unwrap();
        assert!(session.is_authenticated);
        assert_eq!(session.session_nonce.as_deref(), Some("nonce2"));
    }

    #[test]
    fn test_prefers_newer_when_same_auth_status() {
        let mut mgr = SessionManager::new();
        let key = PrivateKey::random().public_key();

        // Add older session
        let mut s1 = make_session("nonce1", Some(&key));
        s1.is_authenticated = true;
        s1.last_update = current_time_ms();
        mgr.add_session(s1).unwrap();

        // Add newer session
        let mut s2 = make_session("nonce2", Some(&key));
        s2.is_authenticated = true;
        s2.last_update = current_time_ms() + 1000;
        mgr.add_session(s2).unwrap();

        // Should prefer newer
        let session = mgr.get_session(&key.to_hex()).unwrap();
        assert_eq!(session.session_nonce.as_deref(), Some("nonce2"));
    }

    #[test]
    fn test_update_session() {
        let mut mgr = SessionManager::new();
        let key = PrivateKey::random().public_key();

        let session = make_session("nonce123", Some(&key));
        mgr.add_session(session).unwrap();

        // Update authentication status
        let mut updated = mgr.get_session("nonce123").unwrap().clone();
        updated.is_authenticated = true;
        mgr.update_session(updated);

        let session = mgr.get_session("nonce123").unwrap();
        assert!(session.is_authenticated);
    }

    #[test]
    fn test_remove_session() {
        let mut mgr = SessionManager::new();
        let key = PrivateKey::random().public_key();

        let session = make_session("nonce123", Some(&key));
        mgr.add_session(session.clone()).unwrap();
        assert!(mgr.has_session("nonce123"));
        assert!(mgr.has_session(&key.to_hex()));

        mgr.remove_session(&session);
        assert!(!mgr.has_session("nonce123"));
        assert!(!mgr.has_session(&key.to_hex()));
    }

    #[test]
    fn test_remove_by_nonce() {
        let mut mgr = SessionManager::new();
        let key = PrivateKey::random().public_key();

        let session = make_session("nonce123", Some(&key));
        mgr.add_session(session).unwrap();

        mgr.remove_by_nonce("nonce123");
        assert!(!mgr.has_session("nonce123"));
    }

    #[test]
    fn test_multiple_sessions_per_identity() {
        let mut mgr = SessionManager::new();
        let key = PrivateKey::random().public_key();

        let s1 = make_session("nonce1", Some(&key));
        let s2 = make_session("nonce2", Some(&key));
        let s3 = make_session("nonce3", Some(&key));

        mgr.add_session(s1).unwrap();
        mgr.add_session(s2).unwrap();
        mgr.add_session(s3).unwrap();

        let sessions = mgr.get_sessions_for_identity(&key.to_hex());
        assert_eq!(sessions.len(), 3);
    }

    #[test]
    fn test_len_and_is_empty() {
        let mut mgr = SessionManager::new();
        assert!(mgr.is_empty());
        assert_eq!(mgr.len(), 0);

        let session = make_session("nonce123", None);
        mgr.add_session(session).unwrap();
        assert!(!mgr.is_empty());
        assert_eq!(mgr.len(), 1);
    }

    #[test]
    fn test_clear() {
        let mut mgr = SessionManager::new();
        let key = PrivateKey::random().public_key();

        mgr.add_session(make_session("nonce1", Some(&key))).unwrap();
        mgr.add_session(make_session("nonce2", Some(&key))).unwrap();

        assert_eq!(mgr.len(), 2);
        mgr.clear();
        assert!(mgr.is_empty());
    }
}