oxirs-cluster 0.2.4

Raft-backed distributed dataset for high availability and horizontal scaling
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
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
//! Byzantine fault-tolerant network layer
//!
//! This module provides secure network communication for BFT consensus,
//! including message authentication, ordering, and Byzantine node detection.

use crate::bft::{BftConsensus, BftMessage};
use crate::network::{NetworkService, RpcMessage};
use crate::{ClusterError, Result};
use ed25519_dalek::{Signature, Signer, SigningKey, Verifier, VerifyingKey};
// Note: OsRng used via fully qualified path to avoid scirs2-core re-export conflict
use serde::{Deserialize, Serialize};
use std::collections::HashMap;
use std::sync::Arc;
use tokio::sync::{mpsc, RwLock};
use tokio::time::{interval, Duration};
use tracing::{debug, error, info, warn};

/// BFT network message wrapper with authentication
#[derive(Debug, Clone, Serialize, Deserialize)]
pub struct AuthenticatedMessage {
    /// The actual BFT message
    pub message: BftMessage,
    /// Sender node ID
    pub sender: String,
    /// Message sequence number for ordering
    pub sequence: u64,
    /// Cryptographic signature
    pub signature: Vec<u8>,
    /// Timestamp for freshness
    pub timestamp: u64,
}

/// BFT network service for secure communication
pub struct BftNetworkService {
    /// Node identifier
    node_id: String,
    /// BFT consensus engine
    consensus: Arc<BftConsensus>,
    /// Network service for transport
    network: Arc<NetworkService>,
    /// Message sequence counter
    sequence_counter: Arc<RwLock<u64>>,
    /// Message cache for duplicate detection
    message_cache: Arc<RwLock<MessageCache>>,
    /// Peer public keys
    peer_keys: Arc<RwLock<HashMap<String, VerifyingKey>>>,
    /// Message channel sender
    tx: mpsc::Sender<AuthenticatedMessage>,
    /// Message channel receiver
    rx: Arc<RwLock<mpsc::Receiver<AuthenticatedMessage>>>,
    /// Node's Ed25519 keypair for signing
    keypair: SigningKey,
}

/// Message cache for duplicate detection and ordering
struct MessageCache {
    /// Received messages by sender and sequence
    messages: HashMap<(String, u64), AuthenticatedMessage>,
    /// Highest sequence number per sender
    highest_seq: HashMap<String, u64>,
    /// Cache size limit
    max_size: usize,
}

impl MessageCache {
    fn new(max_size: usize) -> Self {
        MessageCache {
            messages: HashMap::new(),
            highest_seq: HashMap::new(),
            max_size,
        }
    }

    /// Check if message is duplicate or out of order
    fn is_duplicate_or_old(&self, sender: &str, sequence: u64) -> bool {
        if let Some(&highest) = self.highest_seq.get(sender) {
            sequence <= highest
        } else {
            false
        }
    }

    /// Add message to cache
    fn add_message(&mut self, msg: AuthenticatedMessage) {
        let key = (msg.sender.clone(), msg.sequence);
        self.messages.insert(key, msg.clone());

        // Update highest sequence
        self.highest_seq
            .entry(msg.sender.clone())
            .and_modify(|seq| *seq = (*seq).max(msg.sequence))
            .or_insert(msg.sequence);

        // Evict old messages if cache is full
        if self.messages.len() > self.max_size {
            self.evict_oldest();
        }
    }

    /// Evict oldest messages from cache
    fn evict_oldest(&mut self) {
        let to_remove = self.messages.len() - self.max_size;
        let mut entries: Vec<_> = self
            .messages
            .iter()
            .map(|(k, v)| (k.clone(), v.timestamp))
            .collect();
        entries.sort_by_key(|(_, ts)| *ts);

        for (key, _) in entries.iter().take(to_remove) {
            self.messages.remove(key);
        }
    }
}

impl BftNetworkService {
    /// Create a new BFT network service with generated keypair
    pub fn new(
        node_id: String,
        consensus: Arc<BftConsensus>,
        network: Arc<NetworkService>,
    ) -> Self {
        let (tx, rx) = mpsc::channel(1000);

        // Generate a new Ed25519 keypair for this node
        // Note: ed25519-dalek 2.x doesn't have generate() method, use from_bytes
        // Use rand::random() to avoid scirs2-core OsRng re-export conflict
        let seed_bytes: [u8; 32] = rand::random();
        let keypair = SigningKey::from_bytes(&seed_bytes);

        BftNetworkService {
            node_id,
            consensus,
            network,
            sequence_counter: Arc::new(RwLock::new(0)),
            message_cache: Arc::new(RwLock::new(MessageCache::new(10000))),
            peer_keys: Arc::new(RwLock::new(HashMap::new())),
            tx,
            rx: Arc::new(RwLock::new(rx)),
            keypair,
        }
    }

    /// Create a new BFT network service with provided keypair
    pub fn with_keypair(
        node_id: String,
        consensus: Arc<BftConsensus>,
        network: Arc<NetworkService>,
        keypair: SigningKey,
    ) -> Self {
        let (tx, rx) = mpsc::channel(1000);

        BftNetworkService {
            node_id,
            consensus,
            network,
            sequence_counter: Arc::new(RwLock::new(0)),
            message_cache: Arc::new(RwLock::new(MessageCache::new(10000))),
            peer_keys: Arc::new(RwLock::new(HashMap::new())),
            tx,
            rx: Arc::new(RwLock::new(rx)),
            keypair,
        }
    }

    /// Get the node's public key
    pub fn public_key(&self) -> VerifyingKey {
        self.keypair.verifying_key()
    }

    /// Get the node's public key as bytes
    pub fn public_key_bytes(&self) -> [u8; 32] {
        self.keypair.verifying_key().to_bytes()
    }

    /// Register a peer's public key
    pub async fn register_peer(&self, peer_id: String, public_key: VerifyingKey) -> Result<()> {
        let mut keys = self.peer_keys.write().await;
        keys.insert(peer_id.clone(), public_key);

        // Also register with consensus engine
        self.consensus.register_node(peer_id, public_key)?;

        Ok(())
    }

    /// Start the BFT network service
    pub async fn start(self: Arc<Self>) -> Result<()> {
        // Start message processor
        let processor = self.clone();
        tokio::spawn(async move {
            processor.process_messages().await;
        });

        // Start heartbeat sender
        let heartbeat = self.clone();
        tokio::spawn(async move {
            heartbeat.send_heartbeats().await;
        });

        // Start view change monitor
        let monitor = self.clone();
        tokio::spawn(async move {
            monitor.monitor_view_changes().await;
        });

        Ok(())
    }

    /// Process incoming messages
    async fn process_messages(self: Arc<Self>) {
        let mut rx = self.rx.write().await;

        while let Some(auth_msg) = rx.recv().await {
            match self.handle_authenticated_message(auth_msg).await {
                Ok(_) => {}
                Err(e) => error!("Failed to handle message: {}", e),
            }
        }
    }

    /// Handle an authenticated message
    async fn handle_authenticated_message(&self, auth_msg: AuthenticatedMessage) -> Result<()> {
        // Check message freshness (5 minute window)
        let current_time = std::time::SystemTime::now()
            .duration_since(std::time::UNIX_EPOCH)
            .expect("SystemTime should be after UNIX_EPOCH")
            .as_secs();

        if current_time > auth_msg.timestamp + 300 {
            return Err(ClusterError::Network("Message too old".to_string()));
        }

        // Check for duplicates
        let mut cache = self.message_cache.write().await;
        if cache.is_duplicate_or_old(&auth_msg.sender, auth_msg.sequence) {
            debug!("Duplicate or old message from {}", auth_msg.sender);
            return Ok(());
        }

        // Verify signature
        if !self.verify_message_signature(&auth_msg).await? {
            warn!("Invalid signature from {}", auth_msg.sender);
            return Err(ClusterError::Network("Invalid signature".to_string()));
        }

        // Add to cache
        cache.add_message(auth_msg.clone());
        drop(cache);

        // Pass to consensus engine
        self.consensus
            .handle_message(auth_msg.message, &auth_msg.sender)?;

        Ok(())
    }

    /// Send a BFT message to all peers
    pub async fn broadcast(&self, message: BftMessage) -> Result<()> {
        let auth_msg = self.create_authenticated_message(message).await?;

        // Serialize the message
        let data = serde_json::to_vec(&auth_msg)
            .map_err(|e| ClusterError::Network(format!("Serialization error: {e}")))?;

        // Broadcast through network service
        self.network.broadcast(RpcMessage::Bft { data }).await?;

        Ok(())
    }

    /// Send a BFT message to a specific peer
    pub async fn send_to(&self, peer_id: &str, message: BftMessage) -> Result<()> {
        let auth_msg = self.create_authenticated_message(message).await?;

        // Serialize the message
        let data = serde_json::to_vec(&auth_msg)
            .map_err(|e| ClusterError::Network(format!("Serialization error: {e}")))?;

        // Send through network service
        self.network
            .send_to(peer_id, RpcMessage::Bft { data })
            .await?;

        Ok(())
    }

    /// Create an authenticated message
    async fn create_authenticated_message(
        &self,
        message: BftMessage,
    ) -> Result<AuthenticatedMessage> {
        // Increment sequence counter
        let mut seq = self.sequence_counter.write().await;
        *seq += 1;
        let sequence = *seq;

        // Get current timestamp
        let timestamp = std::time::SystemTime::now()
            .duration_since(std::time::UNIX_EPOCH)
            .expect("SystemTime should be after UNIX_EPOCH")
            .as_secs();

        // Create message without signature
        let mut auth_msg = AuthenticatedMessage {
            message,
            sender: self.node_id.clone(),
            sequence,
            signature: vec![],
            timestamp,
        };

        // Sign the message
        let msg_bytes = serde_json::to_vec(&auth_msg)
            .map_err(|e| ClusterError::Network(format!("Serialization error: {e}")))?;

        // Sign the message with node's private key
        let signature = self.keypair.sign(&msg_bytes);
        auth_msg.signature = signature.to_bytes().to_vec();

        Ok(auth_msg)
    }

    /// Verify message signature
    async fn verify_message_signature(&self, auth_msg: &AuthenticatedMessage) -> Result<bool> {
        // Get sender's public key
        let peer_keys = self.peer_keys.read().await;
        let public_key = match peer_keys.get(&auth_msg.sender) {
            Some(key) => key,
            None => {
                warn!("No public key found for peer: {}", auth_msg.sender);
                return Ok(false);
            }
        };

        // Create message without signature for verification
        let mut msg_for_verification = auth_msg.clone();
        msg_for_verification.signature = vec![];

        // Serialize message for verification
        let msg_bytes = match serde_json::to_vec(&msg_for_verification) {
            Ok(bytes) => bytes,
            Err(e) => {
                error!("Failed to serialize message for verification: {}", e);
                return Ok(false);
            }
        };

        // Convert signature bytes to signature
        // ed25519-dalek 2.x requires exactly 64 bytes
        if auth_msg.signature.len() != 64 {
            warn!(
                "Invalid signature length from {}: expected 64, got {}",
                auth_msg.sender,
                auth_msg.signature.len()
            );
            return Ok(false);
        }

        let mut signature_bytes = [0u8; 64];
        signature_bytes.copy_from_slice(&auth_msg.signature);
        let signature = ed25519_dalek::Signature::from_bytes(&signature_bytes);

        // Verify the signature
        match public_key.verify(&msg_bytes, &signature) {
            Ok(_) => {
                debug!("Signature verification successful for {}", auth_msg.sender);
                Ok(true)
            }
            Err(e) => {
                warn!(
                    "Signature verification failed for {}: {}",
                    auth_msg.sender, e
                );
                Ok(false)
            }
        }
    }

    /// Send periodic heartbeats
    async fn send_heartbeats(&self) {
        let mut interval = interval(Duration::from_secs(1));

        loop {
            interval.tick().await;

            // Only send heartbeats if we're the primary
            match self.consensus.is_primary() {
                Ok(true) => {
                    let heartbeat = BftMessage::Request {
                        client_id: format!("{}-heartbeat", self.node_id),
                        operation: b"HEARTBEAT".to_vec(),
                        timestamp: std::time::SystemTime::now()
                            .duration_since(std::time::UNIX_EPOCH)
                            .expect("SystemTime should be after UNIX_EPOCH")
                            .as_secs(),
                        signature: None,
                    };

                    if let Err(e) = self.broadcast(heartbeat).await {
                        warn!("Failed to send heartbeat: {}", e);
                    }
                }
                _ => {}
            }
        }
    }

    /// Monitor for view changes
    async fn monitor_view_changes(&self) {
        let mut interval = interval(Duration::from_secs(5));

        loop {
            interval.tick().await;

            // Check if view change is needed
            match self.consensus.check_view_timeout() {
                Ok(true) => {
                    info!("View change timeout detected");

                    // Initiate view change
                    if let Err(e) = self.initiate_view_change().await {
                        error!("Failed to initiate view change: {}", e);
                    }
                }
                _ => {}
            }
        }
    }

    /// Initiate a view change
    async fn initiate_view_change(&self) -> Result<()> {
        let current_view = self.consensus.current_view()?;
        let new_view = current_view + 1;

        info!("Initiating view change to view {}", new_view);

        // Collect prepared messages from consensus
        let prepared_messages = self.consensus.collect_prepared_messages()?;

        info!(
            "Collected {} prepared messages for view change",
            prepared_messages.len()
        );

        // Create view change message
        let view_change = BftMessage::ViewChange {
            new_view,
            node_id: self.node_id.clone(),
            prepared_messages,
            signature: vec![],
        };

        // Broadcast view change
        self.broadcast(view_change).await?;

        Ok(())
    }

    /// Handle incoming network messages
    pub async fn handle_network_message(&self, data: Vec<u8>) -> Result<()> {
        // Deserialize the authenticated message
        let auth_msg: AuthenticatedMessage = serde_json::from_slice(&data)
            .map_err(|e| ClusterError::Network(format!("Deserialization error: {e}")))?;

        // Send to processing channel
        self.tx
            .send(auth_msg)
            .await
            .map_err(|e| ClusterError::Network(format!("Channel send error: {e}")))?;

        Ok(())
    }

    /// Remove a peer's public key (e.g., when a node is detected as Byzantine)
    pub async fn remove_peer(&self, peer_id: &str) -> Result<()> {
        let mut keys = self.peer_keys.write().await;
        keys.remove(peer_id);

        info!("Removed public key for peer: {}", peer_id);
        Ok(())
    }

    /// Get list of trusted peers
    pub async fn get_trusted_peers(&self) -> Vec<String> {
        let keys = self.peer_keys.read().await;
        keys.keys().cloned().collect()
    }

    /// Verify a standalone signature (for external verification)
    pub fn verify_signature(
        &self,
        message: &[u8],
        signature: &[u8],
        public_key: &VerifyingKey,
    ) -> Result<bool> {
        // ed25519-dalek 2.x requires exactly 64 bytes
        if signature.len() != 64 {
            return Ok(false);
        }

        let mut signature_bytes = [0u8; 64];
        signature_bytes.copy_from_slice(signature);
        let signature = Signature::from_bytes(&signature_bytes);

        match public_key.verify(message, &signature) {
            Ok(_) => Ok(true),
            Err(_) => Ok(false),
        }
    }

    /// Sign a message with the node's private key
    pub fn sign_message(&self, message: &[u8]) -> Vec<u8> {
        let signature = self.keypair.sign(message);
        signature.to_bytes().to_vec()
    }

    /// Check if a peer is trusted (has a registered public key)
    pub async fn is_peer_trusted(&self, peer_id: &str) -> bool {
        let keys = self.peer_keys.read().await;
        keys.contains_key(peer_id)
    }
}

/// BFT metrics for monitoring
#[derive(Debug, Clone, Default)]
pub struct BftMetrics {
    /// Total messages sent
    pub messages_sent: u64,
    /// Total messages received
    pub messages_received: u64,
    /// Invalid signatures detected
    pub invalid_signatures: u64,
    /// Byzantine nodes detected
    pub byzantine_nodes_detected: u64,
    /// View changes initiated
    pub view_changes: u64,
    /// Successful consensus rounds
    pub consensus_rounds: u64,
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_message_cache() {
        let mut cache = MessageCache::new(100);

        // Test duplicate detection
        let msg = AuthenticatedMessage {
            message: BftMessage::Request {
                client_id: "test".to_string(),
                operation: vec![1, 2, 3],
                timestamp: 1000,
                signature: None,
            },
            sender: "node1".to_string(),
            sequence: 1,
            signature: vec![],
            timestamp: 1000,
        };

        assert!(!cache.is_duplicate_or_old("node1", 1));
        cache.add_message(msg.clone());
        assert!(cache.is_duplicate_or_old("node1", 1));
        assert!(!cache.is_duplicate_or_old("node1", 2));
    }

    #[test]
    fn test_cache_eviction() {
        let mut cache = MessageCache::new(2);

        // Add messages to fill cache
        for i in 0..3 {
            let msg = AuthenticatedMessage {
                message: BftMessage::Request {
                    client_id: format!("test{}", i),
                    operation: vec![i as u8],
                    timestamp: i as u64,
                    signature: None,
                },
                sender: format!("node{}", i),
                sequence: 1,
                signature: vec![],
                timestamp: i as u64,
            };
            cache.add_message(msg);
        }

        // Cache should only have 2 messages
        assert_eq!(cache.messages.len(), 2);

        // Oldest message should be evicted
        assert!(!cache.messages.contains_key(&("node0".to_string(), 1)));
    }
}