-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathclient.rs
More file actions
1394 lines (1213 loc) · 51.5 KB
/
client.rs
File metadata and controls
1394 lines (1213 loc) · 51.5 KB
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
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
//! SMB2 client — manages TCP connections and speaks the protocol.
use bytes::Buf;
use std::io;
use std::sync::Arc;
use std::sync::atomic::{AtomicBool, AtomicU64, Ordering};
use std::time::Duration;
use tokio::io::{AsyncReadExt, AsyncWriteExt};
use tokio::net::TcpStream;
use tokio::sync::Mutex;
use bytes::{BufMut, BytesMut};
/// Timeout for a single SMB response read. Prevents indefinite mutex hold when
/// the SMB server is slow or unresponsive under heavy load.
const SMB_READ_TIMEOUT: Duration = Duration::from_secs(30);
/// Timeout for the initial TCP handshake to the SMB server. Without this,
/// a server that drops SYNs leaves the OS waiting ~75-90s, which stalls
/// pool initialization past any sensible CI window.
const SMB_CONNECT_TIMEOUT: Duration = Duration::from_secs(15);
use super::auth;
use super::protocol::*;
/// Configuration for connecting to an SMB server.
#[derive(Debug, Clone)]
pub struct SmbConfig {
pub server: String,
pub port: u16,
pub username: String,
pub password: String,
pub domain: String,
pub workstation: String,
/// Cap for standalone read/write I/O (0 = use DEFAULT_MAX_IO).
pub max_io_size: u32,
}
impl SmbConfig {
pub fn share_path(&self, share: &str) -> String {
format!("\\\\{}\\{}", self.server, share)
}
}
/// Default I/O cap for standalone (non-compound) read/write operations.
/// Many NAS servers advertise multi-MB maximums in negotiate but fail at sizes
/// well below the advertised limit. 64 KB is the safe conservative default;
/// override via `SPICEIO_SMB_MAX_IO` for servers that handle larger I/O
/// (e.g., Windows Server, enterprise NAS). Even at 64 KB the connection pool
/// and pipelined reads still deliver major throughput gains.
const DEFAULT_MAX_IO: u32 = 65536;
/// An authenticated SMB2 session.
pub struct SmbClient {
stream: Mutex<TcpStream>,
message_id: AtomicU64,
session_id: u64,
config: SmbConfig,
/// Effective max read size for standalone (non-compound) reads.
pub max_read_size: u32,
/// Effective max write size for standalone (non-compound) writes.
pub max_write_size: u32,
/// Capped max for compound operations (64KB — some NAS servers reject
/// larger payloads inside compound requests).
pub compound_max_read_size: u32,
pub compound_max_write_size: u32,
/// 16-byte client GUID
client_guid: [u8; 16],
/// SMB 3.1.1 signing key (derived after auth)
signing_key: Option<[u8; 16]>,
/// Set on read timeout — connection framing is desynchronized.
poisoned: AtomicBool,
}
impl SmbClient {
/// Connect to the SMB server and authenticate.
pub async fn connect(config: SmbConfig) -> io::Result<Arc<Self>> {
let addr = format!("{}:{}", config.server, config.port);
let stream =
match tokio::time::timeout(SMB_CONNECT_TIMEOUT, TcpStream::connect(&addr)).await {
Ok(Ok(s)) => {
crate::slog!("[spiceio] smb tcp connected: {addr}");
s
}
Ok(Err(e)) => {
crate::serr!("[spiceio] smb tcp connect failed: {addr}: {e}");
return Err(e);
}
Err(_) => {
let msg = format!(
"smb tcp connect timed out after {}s: {addr}",
SMB_CONNECT_TIMEOUT.as_secs()
);
crate::serr!("[spiceio] {msg}");
return Err(io::Error::new(io::ErrorKind::TimedOut, msg));
}
};
stream.set_nodelay(true)?;
// Enlarge socket buffers to 1 MB for large read/write throughput.
{
use std::os::fd::AsRawFd;
unsafe extern "C" {
fn setsockopt(
socket: i32,
level: i32,
option_name: i32,
option_value: *const u8,
option_len: u32,
) -> i32;
}
const SOL_SOCKET: i32 = 0xffff;
const SO_SNDBUF: i32 = 0x1001;
const SO_RCVBUF: i32 = 0x1002;
let fd = stream.as_raw_fd();
let buf_size: i32 = 4 * 1024 * 1024;
let ptr = std::ptr::from_ref(&buf_size).cast();
let len = size_of::<i32>() as u32;
unsafe {
setsockopt(fd, SOL_SOCKET, SO_SNDBUF, ptr, len);
setsockopt(fd, SOL_SOCKET, SO_RCVBUF, ptr, len);
}
}
let mut client_guid = [0u8; 16];
unsafe extern "C" {
fn arc4random_buf(buf: *mut u8, nbytes: usize);
}
unsafe {
arc4random_buf(client_guid.as_mut_ptr(), 16);
}
// Use a temporary non-Arc client for the handshake, then wrap in Arc.
let mut client = Self {
stream: Mutex::new(stream),
message_id: AtomicU64::new(0),
session_id: 0,
config,
max_read_size: 65536,
max_write_size: 65536,
compound_max_read_size: 65536,
compound_max_write_size: 65536,
client_guid,
signing_key: None,
poisoned: AtomicBool::new(false),
};
client.negotiate_and_auth().await?;
Ok(Arc::new(client))
}
/// Whether this connection has been poisoned by a timeout.
pub fn is_poisoned(&self) -> bool {
self.poisoned.load(Ordering::Relaxed)
}
fn next_message_id(&self) -> u64 {
self.message_id.fetch_add(1, Ordering::Relaxed)
}
/// Read exactly `buf.len()` bytes from the stream with a timeout.
///
/// On timeout the stream framing is desynchronized, so we poison the
/// connection (all future operations fail fast) and drop the underlying
/// socket to fully close both halves.
async fn read_exact_timeout(&self, stream: &mut TcpStream, buf: &mut [u8]) -> io::Result<()> {
if self.poisoned.load(Ordering::Relaxed) {
return Err(io::Error::new(
io::ErrorKind::BrokenPipe,
"SMB connection poisoned by previous timeout",
));
}
match tokio::time::timeout(SMB_READ_TIMEOUT, stream.read_exact(buf)).await {
Ok(result) => result.map(|_| ()),
Err(_) => {
self.poisoned.store(true, Ordering::Relaxed);
// Drop the socket to fully close both halves.
let _ = stream.shutdown().await;
Err(io::Error::new(
io::ErrorKind::TimedOut,
"SMB server read timed out; connection poisoned",
))
}
}
}
/// Send a packet and receive a response, also returning the raw SMB2 response bytes
/// (without NetBIOS header) for preauth hash computation.
async fn send_recv_raw(&self, packet: &[u8]) -> io::Result<(Header, Vec<u8>, Vec<u8>)> {
let (header, body, raw) = self.send_recv_inner(packet).await?;
Ok((header, body, raw))
}
async fn send_recv(&self, packet: &[u8]) -> io::Result<(Header, Vec<u8>)> {
let (header, body, _raw) = self.send_recv_inner(packet).await?;
Ok((header, body))
}
async fn send_recv_inner(&self, packet: &[u8]) -> io::Result<(Header, Vec<u8>, Vec<u8>)> {
let mut stream = self.stream.lock().await;
// Sign the packet if we have a signing key. We need a writable buffer
// to sign in-place; `BytesMut::from(&[u8])` is one alloc + one copy
// (same cost as the previous `to_vec`, but expressed as a typed buffer
// that mirrors what the pipelined paths do).
if let Some(ref key) = self.signing_key {
let mut signed = BytesMut::from(packet);
sign_packet(&mut signed, key);
stream.write_all(&signed).await?;
} else {
stream.write_all(packet).await?;
}
stream.flush().await?;
// Read responses, looping past STATUS_PENDING interim responses
loop {
let mut len_buf = [0u8; 4];
self.read_exact_timeout(&mut stream, &mut len_buf).await?;
let msg_len = u32::from_be_bytes(len_buf) as usize;
if !(SMB2_HEADER_SIZE..=16 * 1024 * 1024).contains(&msg_len) {
crate::serr!("[spiceio] smb invalid message length: {msg_len}");
return Err(io::Error::new(
io::ErrorKind::InvalidData,
format!("invalid SMB2 message length: {msg_len}"),
));
}
let mut msg = vec![0u8; msg_len];
self.read_exact_timeout(&mut stream, &mut msg).await?;
let header = Header::decode(&msg).ok_or_else(|| {
crate::serr!("[spiceio] smb invalid header");
io::Error::new(io::ErrorKind::InvalidData, "invalid SMB2 header")
})?;
// STATUS_PENDING (0x00000103): server is still processing, wait for real response
if header.status == 0x0000_0103 {
continue;
}
let body = msg[SMB2_HEADER_SIZE..].to_vec();
return Ok((header, body, msg));
}
}
/// Perform negotiate + session setup (NTLM auth) with signing key derivation.
async fn negotiate_and_auth(&mut self) -> io::Result<()> {
// Preauth integrity hash — tracks all handshake messages for key derivation
let mut preauth_hash = [0u8; 64];
// ── Step 1: Negotiate ──
let msg_id = self.next_message_id();
let hdr = Header::new(Command::Negotiate, msg_id);
let packet = build_request(&hdr, |buf| {
encode_negotiate_request(buf, &self.client_guid);
});
// Hash the negotiate request (SMB2 message, skip 4-byte NetBIOS header)
update_preauth_hash(&mut preauth_hash, &packet[4..]);
let (resp_hdr, resp_body, resp_raw) = self.send_recv_raw(&packet).await?;
if NtStatus::from_u32(resp_hdr.status).is_error() {
crate::serr!("[spiceio] smb negotiate failed: 0x{:08X}", resp_hdr.status);
return Err(io::Error::new(
io::ErrorKind::ConnectionRefused,
format!("negotiate failed: status=0x{:08X}", resp_hdr.status),
));
}
// Hash the negotiate response
update_preauth_hash(&mut preauth_hash, &resp_raw);
let neg_resp = decode_negotiate_response(&resp_body).ok_or_else(|| {
crate::serr!("[spiceio] smb invalid negotiate response");
io::Error::new(io::ErrorKind::InvalidData, "invalid negotiate response")
})?;
let io_cap = if self.config.max_io_size > 0 {
self.config.max_io_size
} else {
DEFAULT_MAX_IO
};
crate::slog!(
"[spiceio] negotiated SMB 0x{:04X}, server_max={}K io_cap={}K",
neg_resp.dialect_revision,
neg_resp.max_read_size / 1024,
io_cap / 1024,
);
// ── Step 2: Session Setup (NTLM Negotiate) ──
let ntlm_negotiate = auth::build_negotiate_message();
let spnego_negotiate = auth::wrap_spnego_negotiate(&ntlm_negotiate);
let msg_id = self.next_message_id();
let mut hdr = Header::new(Command::SessionSetup, msg_id);
let packet = build_request(&hdr, |buf| {
encode_session_setup_request(buf, &spnego_negotiate);
});
// Hash session setup request 1
update_preauth_hash(&mut preauth_hash, &packet[4..]);
let (resp_hdr, resp_body, resp_raw) = self.send_recv_raw(&packet).await?;
// Hash session setup response 1
update_preauth_hash(&mut preauth_hash, &resp_raw);
let sess_resp = decode_session_setup_response(&resp_hdr, &resp_body).ok_or_else(|| {
crate::serr!("[spiceio] smb invalid session setup response");
io::Error::new(io::ErrorKind::InvalidData, "invalid session setup response")
})?;
// Parse NTLM challenge from SPNEGO wrapper
let challenge_data = auth::unwrap_spnego(&sess_resp.security_buffer);
let challenge = auth::parse_challenge_message(challenge_data).ok_or_else(|| {
crate::serr!("[spiceio] smb invalid NTLM challenge");
io::Error::new(io::ErrorKind::InvalidData, "invalid NTLM challenge")
})?;
// ── Step 3: Session Setup (NTLM Auth) ──
let (ntlm_auth, session_base_key) = auth::build_authenticate_message(
&challenge,
&self.config.username,
&self.config.password,
&self.config.domain,
&self.config.workstation,
);
let spnego_auth = auth::wrap_spnego_auth(&ntlm_auth);
let msg_id = self.next_message_id();
hdr = Header::new(Command::SessionSetup, msg_id);
hdr.session_id = sess_resp.session_id;
let packet = build_request(&hdr, |buf| {
encode_session_setup_request(buf, &spnego_auth);
});
// Hash session setup request 2 (this is the final hash for key derivation)
update_preauth_hash(&mut preauth_hash, &packet[4..]);
let (resp_hdr, ..) = self.send_recv_raw(&packet).await?;
if NtStatus::from_u32(resp_hdr.status).is_error() {
crate::serr!("[spiceio] smb auth failed: 0x{:08X}", resp_hdr.status);
return Err(io::Error::new(
io::ErrorKind::PermissionDenied,
format!("authentication failed: status=0x{:08X}", resp_hdr.status),
));
}
// Derive the signing key
let signing_key = auth::derive_signing_key(&session_base_key, &preauth_hash);
crate::slog!("[spiceio] authenticated, signing key derived");
self.session_id = resp_hdr.session_id;
// Cap standalone I/O by: min(server_advertised, max_transact, configured_cap).
// Many NAS servers advertise multi-MB limits but fail at much smaller sizes.
let transact = neg_resp.max_transact_size;
let io_cap = if self.config.max_io_size > 0 {
self.config.max_io_size
} else {
DEFAULT_MAX_IO
};
// Substitute io_cap for any negotiated value that's 0. A buggy or
// misconfigured server can advertise max_read_size/max_write_size/
// max_transact_size = 0; if we let that propagate, every downstream
// pipeline call ends up doing `remaining.div_ceil(0)` and panics the
// request task — that's the failure mode behind sccache "Connection
// refused" against a long-running spiceio.
let nonzero = |v: u32, name: &str| -> u32 {
if v == 0 {
crate::serr!("[spiceio] smb negotiated {name}=0 — substituting io_cap={io_cap}");
io_cap
} else {
v
}
};
let neg_read = nonzero(neg_resp.max_read_size, "max_read_size");
let neg_write = nonzero(neg_resp.max_write_size, "max_write_size");
let neg_transact = nonzero(transact, "max_transact_size");
self.max_read_size = neg_read.min(neg_transact).min(io_cap);
self.max_write_size = neg_write.min(neg_transact).min(io_cap);
// Cap at 64KB for compound requests — some NAS servers reject larger
// payloads inside compound (chained) operations.
self.compound_max_read_size = self.max_read_size.min(65536);
self.compound_max_write_size = self.max_write_size.min(65536);
self.signing_key = Some(signing_key);
Ok(())
}
/// Connect to a share (Tree Connect).
pub async fn tree_connect(&self, share: &str) -> io::Result<u32> {
let path = self.config.share_path(share);
let msg_id = self.next_message_id();
let mut hdr = Header::new(Command::TreeConnect, msg_id);
hdr.session_id = self.session_id;
let packet = build_request(&hdr, |buf| {
encode_tree_connect_request(buf, &path);
});
let (resp_hdr, _resp_body) = self.send_recv(&packet).await?;
let status = NtStatus::from_u32(resp_hdr.status);
if status.is_error() {
crate::serr!(
"[spiceio] smb tree connect failed: '{}': 0x{:08X}",
share,
resp_hdr.status
);
return Err(io::Error::new(
io::ErrorKind::NotFound,
format!(
"tree connect to '{}' failed: 0x{:08X}",
share, resp_hdr.status
),
));
}
crate::slog!(
"[spiceio] smb tree connected: \\\\{}\\{}",
self.config.server,
share
);
Ok(resp_hdr.tree_id)
}
/// Open a file or directory.
pub async fn create(
&self,
tree_id: u32,
path: &str,
desired_access: u32,
share_access: u32,
create_disposition: u32,
create_options: u32,
) -> io::Result<CreateResponse> {
let msg_id = self.next_message_id();
let mut hdr = Header::new(Command::Create, msg_id);
hdr.session_id = self.session_id;
hdr.tree_id = tree_id;
let packet = build_request(&hdr, |buf| {
encode_create_request(
buf,
path,
desired_access,
share_access,
create_disposition,
create_options,
);
});
let (resp_hdr, resp_body) = self.send_recv(&packet).await?;
let status = NtStatus::from_u32(resp_hdr.status);
if status.is_error() {
return Err(smb_status_to_io_error(resp_hdr.status, path));
}
decode_create_response(&resp_body).ok_or_else(|| {
crate::serr!("[spiceio] smb invalid create response: {path}");
io::Error::new(io::ErrorKind::InvalidData, "invalid create response")
})
}
/// Close a file handle.
pub async fn close(&self, tree_id: u32, file_id: &[u8; 16]) -> io::Result<()> {
let msg_id = self.next_message_id();
let mut hdr = Header::new(Command::Close, msg_id);
hdr.session_id = self.session_id;
hdr.tree_id = tree_id;
let packet = build_request(&hdr, |buf| {
encode_close_request(buf, file_id);
});
let (resp_hdr, _) = self.send_recv(&packet).await?;
let status = NtStatus::from_u32(resp_hdr.status);
if status.is_error() {
crate::serr!("[spiceio] smb close failed: 0x{:08X}", resp_hdr.status);
return Err(io::Error::other(format!(
"close failed: 0x{:08X}",
resp_hdr.status
)));
}
Ok(())
}
/// Read from an open file.
pub async fn read(
&self,
tree_id: u32,
file_id: &[u8; 16],
offset: u64,
length: u32,
) -> io::Result<bytes::Bytes> {
let msg_id = self.next_message_id();
let mut hdr = Header::new(Command::Read, msg_id).with_credit_charge(length);
hdr.session_id = self.session_id;
hdr.tree_id = tree_id;
let packet = build_request(&hdr, |buf| {
encode_read_request(buf, file_id, offset, length);
});
let (resp_hdr, resp_body) = self.send_recv(&packet).await?;
let status = NtStatus::from_u32(resp_hdr.status);
if status == NtStatus::EndOfFile {
return Ok(bytes::Bytes::new());
}
if status.is_error() {
crate::serr!("[spiceio] smb read failed: 0x{:08X}", resp_hdr.status);
return Err(io::Error::other(format!(
"read failed: 0x{:08X}",
resp_hdr.status
)));
}
decode_read_response_owned(resp_body).ok_or_else(|| {
crate::serr!("[spiceio] smb invalid read response");
io::Error::new(io::ErrorKind::InvalidData, "invalid read response")
})
}
/// Pipelined read: send `count` read requests, then receive all responses.
///
/// Holds the stream lock for the entire batch, eliminating per-request
/// round-trip latency. Returns chunks in offset order. Stops early on EOF.
///
/// Coalesces all request packets into a single contiguous buffer and signs
/// each in-place — one allocation, one `write_all` syscall for the whole
/// batch of request headers (only the responses carry bulk data).
///
/// Responses may arrive out of order (SMB2 does not guarantee response
/// ordering). Each response is matched to its request slot via message_id.
pub async fn pipelined_read(
&self,
tree_id: u32,
file_id: &[u8; 16],
start_offset: u64,
chunk_size: u32,
count: usize,
) -> io::Result<Vec<bytes::Bytes>> {
if count == 0 {
return Ok(Vec::new());
}
// Defensive guard: a zero `chunk_size` would panic later on
// `remaining.div_ceil(chunk_size as u64)` in callers, and would
// make this function issue `count` duplicate reads at the same
// offset. Callers are expected to have validated already, but
// we treat this as a hard error rather than UB.
if chunk_size == 0 {
return Err(io::Error::new(
io::ErrorKind::InvalidInput,
"pipelined_read called with chunk_size = 0",
));
}
// Allocate message IDs in a contiguous batch so we can map
// response.message_id → slot index via simple subtraction.
let base_msg_id = self.message_id.fetch_add(count as u64, Ordering::Relaxed);
// Each request: 4 (NetBIOS length) + SMB2_HEADER_SIZE (64) + 49
// (read request fixed part incl. 1-byte buffer pad).
const READ_REQUEST_FIXED: usize = 49;
let per_packet = 4 + SMB2_HEADER_SIZE + READ_REQUEST_FIXED;
let mut buf = BytesMut::with_capacity(per_packet * count);
let mut packet_starts: Vec<usize> = Vec::with_capacity(count + 1);
for i in 0..count {
packet_starts.push(buf.len());
let offset = start_offset + (i as u64) * (chunk_size as u64);
let msg_id = base_msg_id + i as u64;
let mut hdr = Header::new(Command::Read, msg_id).with_credit_charge(chunk_size);
hdr.session_id = self.session_id;
hdr.tree_id = tree_id;
let packet_smb_total = SMB2_HEADER_SIZE + READ_REQUEST_FIXED;
buf.put_u32((packet_smb_total as u32) & 0x00FF_FFFF);
hdr.encode(&mut buf);
encode_read_request(&mut buf, file_id, offset, chunk_size);
}
packet_starts.push(buf.len());
if let Some(ref key) = self.signing_key {
for i in 0..count {
let start = packet_starts[i];
let end = packet_starts[i + 1];
sign_packet(&mut buf[start..end], key);
}
}
let mut stream = self.stream.lock().await;
stream.write_all(&buf).await?;
stream.flush().await?;
// Receive responses into ordered slots (handles out-of-order delivery).
let mut slots: Vec<Option<bytes::Bytes>> = (0..count).map(|_| None).collect();
let mut received = 0usize;
let mut eof_after = count; // trim to this length on EOF
while received < count {
let mut len_buf = [0u8; 4];
self.read_exact_timeout(&mut stream, &mut len_buf).await?;
let msg_len = u32::from_be_bytes(len_buf) as usize;
if !(SMB2_HEADER_SIZE..=16 * 1024 * 1024).contains(&msg_len) {
return Err(io::Error::new(
io::ErrorKind::InvalidData,
format!("invalid SMB2 message length: {msg_len}"),
));
}
let mut msg = vec![0u8; msg_len];
self.read_exact_timeout(&mut stream, &mut msg).await?;
let header = Header::decode(&msg)
.ok_or_else(|| io::Error::new(io::ErrorKind::InvalidData, "invalid SMB2 header"))?;
// Skip STATUS_PENDING interim responses
if header.status == 0x0000_0103 {
continue;
}
let slot = (header.message_id.wrapping_sub(base_msg_id)) as usize;
if slot >= count {
return Err(io::Error::new(
io::ErrorKind::InvalidData,
format!(
"unexpected message_id {} (base={}, count={})",
header.message_id, base_msg_id, count
),
));
}
let status = NtStatus::from_u32(header.status);
if status == NtStatus::EndOfFile {
// This slot and all later slots are past EOF
eof_after = eof_after.min(slot);
received += 1;
continue;
}
if status.is_error() {
return Err(io::Error::other(format!(
"pipelined read failed: 0x{:08X}",
header.status
)));
}
// Zero-copy: hand the full `msg` Vec to the decoder, which slices
// into it as `Bytes` without an extra body copy. For 64KB chunks
// pipelined 64 deep this saves ~4 MiB of memcpy per batch.
let data = decode_read_response_from_msg(msg).ok_or_else(|| {
io::Error::new(io::ErrorKind::InvalidData, "invalid read response")
})?;
slots[slot] = Some(data);
received += 1;
}
// Collect in order, stopping at EOF boundary
Ok(slots
.into_iter()
.take(eof_after)
.map(|s| s.unwrap_or_default())
.collect())
}
/// Write to an open file.
pub async fn write(
&self,
tree_id: u32,
file_id: &[u8; 16],
offset: u64,
data: &[u8],
) -> io::Result<u32> {
let msg_id = self.next_message_id();
let mut hdr = Header::new(Command::Write, msg_id).with_credit_charge(data.len() as u32);
hdr.session_id = self.session_id;
hdr.tree_id = tree_id;
let packet = build_request(&hdr, |buf| {
encode_write_request(buf, file_id, offset, data);
});
let (resp_hdr, resp_body) = self.send_recv(&packet).await?;
// Check raw status: high two bits indicate severity
// 0x00 = success, 0x40 = info, 0x80 = warning, 0xC0 = error
if resp_hdr.status & 0xC000_0000 == 0xC000_0000 {
crate::serr!(
"[spiceio] smb write failed: 0x{:08X} offset={} len={}",
resp_hdr.status,
offset,
data.len()
);
return Err(io::Error::other(format!(
"write failed: status=0x{:08X} offset={} len={}",
resp_hdr.status,
offset,
data.len()
)));
}
decode_write_response(&resp_body).ok_or_else(|| {
crate::serr!("[spiceio] smb invalid write response");
io::Error::new(io::ErrorKind::InvalidData, "invalid write response")
})
}
/// Pipelined write: send `chunks` write requests in a batch, then receive
/// all responses. Holds the stream lock for the entire batch, eliminating
/// per-request round-trip latency. Returns total bytes written.
///
/// Coalesces all packets into a single contiguous buffer and signs each
/// in-place — one allocation, one `write_all` syscall for the whole batch.
/// Responses may arrive out of order; each is matched by message_id.
pub async fn pipelined_write(
&self,
tree_id: u32,
file_id: &[u8; 16],
start_offset: u64,
chunks: &[&[u8]],
) -> io::Result<u64> {
if chunks.is_empty() {
return Ok(0);
}
let n = chunks.len();
let base_msg_id = self.message_id.fetch_add(n as u64, Ordering::Relaxed);
// Each packet: 4 (NetBIOS length) + SMB2_HEADER_SIZE (64) + 48
// (write request fixed part) + chunk data.
const WRITE_REQUEST_FIXED: usize = 48;
let total_bytes: usize = chunks
.iter()
.map(|c| 4 + SMB2_HEADER_SIZE + WRITE_REQUEST_FIXED + c.len())
.sum();
let mut buf = BytesMut::with_capacity(total_bytes);
let mut packet_starts: Vec<usize> = Vec::with_capacity(n + 1);
let mut offset = start_offset;
for (i, chunk) in chunks.iter().enumerate() {
packet_starts.push(buf.len());
let msg_id = base_msg_id + i as u64;
let mut hdr =
Header::new(Command::Write, msg_id).with_credit_charge(chunk.len() as u32);
hdr.session_id = self.session_id;
hdr.tree_id = tree_id;
let packet_smb_total = SMB2_HEADER_SIZE + WRITE_REQUEST_FIXED + chunk.len();
buf.put_u32((packet_smb_total as u32) & 0x00FF_FFFF);
hdr.encode(&mut buf);
encode_write_request(&mut buf, file_id, offset, chunk);
offset += chunk.len() as u64;
}
packet_starts.push(buf.len());
// Sign each packet in-place. We pre-allocated exact capacity, so the
// earlier slices are still valid (no realloc could have moved them).
if let Some(ref key) = self.signing_key {
for i in 0..n {
let start = packet_starts[i];
let end = packet_starts[i + 1];
sign_packet(&mut buf[start..end], key);
}
}
let mut stream = self.stream.lock().await;
stream.write_all(&buf).await?;
stream.flush().await?;
// Receive all responses (handles out-of-order delivery)
let mut total_written = 0u64;
let mut received = 0usize;
while received < n {
let mut len_buf = [0u8; 4];
self.read_exact_timeout(&mut stream, &mut len_buf).await?;
let msg_len = u32::from_be_bytes(len_buf) as usize;
if !(SMB2_HEADER_SIZE..=16 * 1024 * 1024).contains(&msg_len) {
return Err(io::Error::new(
io::ErrorKind::InvalidData,
format!("invalid SMB2 message length: {msg_len}"),
));
}
let mut msg = vec![0u8; msg_len];
self.read_exact_timeout(&mut stream, &mut msg).await?;
let header = Header::decode(&msg)
.ok_or_else(|| io::Error::new(io::ErrorKind::InvalidData, "invalid SMB2 header"))?;
if header.status == 0x0000_0103 {
continue;
}
if header.status & 0xC000_0000 == 0xC000_0000 {
return Err(io::Error::other(format!(
"pipelined write failed: 0x{:08X}",
header.status
)));
}
let body = &msg[SMB2_HEADER_SIZE..];
let written = decode_write_response(body).ok_or_else(|| {
io::Error::new(io::ErrorKind::InvalidData, "invalid write response")
})?;
total_written += written as u64;
received += 1;
}
Ok(total_written)
}
/// Rename a file using SET_INFO with FileRenameInformation.
pub async fn rename(
&self,
tree_id: u32,
file_id: &[u8; 16],
new_path: &str,
replace_if_exists: bool,
) -> io::Result<()> {
let msg_id = self.next_message_id();
let mut hdr = Header::new(Command::SetInfo, msg_id);
hdr.session_id = self.session_id;
hdr.tree_id = tree_id;
let packet = build_request(&hdr, |buf| {
encode_set_info_rename(buf, file_id, new_path, replace_if_exists);
});
let (resp_hdr, _) = self.send_recv(&packet).await?;
if resp_hdr.status & 0xC000_0000 == 0xC000_0000 {
crate::serr!(
"[spiceio] smb rename failed: 0x{:08X} -> {}",
resp_hdr.status,
new_path
);
return Err(io::Error::other(format!(
"rename failed: status=0x{:08X} -> {}",
resp_hdr.status, new_path
)));
}
Ok(())
}
/// List directory contents.
pub async fn query_directory(
&self,
tree_id: u32,
file_id: &[u8; 16],
pattern: &str,
) -> io::Result<Vec<DirectoryEntry>> {
let mut all_entries = Vec::new();
let mut first = true;
loop {
let msg_id = self.next_message_id();
let mut hdr = Header::new(Command::QueryDirectory, msg_id);
hdr.session_id = self.session_id;
hdr.tree_id = tree_id;
let restart = first;
first = false;
let packet = build_request(&hdr, |buf| {
encode_query_directory_request(
buf,
file_id,
pattern,
FILE_ID_BOTH_DIRECTORY_INFORMATION,
restart,
);
});
let (resp_hdr, resp_body) = self.send_recv(&packet).await?;
let status = NtStatus::from_u32(resp_hdr.status);
if status == NtStatus::NoMoreFiles {
break;
}
if status.is_error() {
crate::serr!(
"[spiceio] smb query directory failed: 0x{:08X}",
resp_hdr.status
);
return Err(io::Error::other(format!(
"query directory failed: 0x{:08X}",
resp_hdr.status
)));
}
// Parse the output buffer from the response body
if resp_body.len() >= 9 {
let buf_offset = (&resp_body[2..4] as &[u8]).get_u16_le() as usize;
let buf_length = (&resp_body[4..8] as &[u8]).get_u32_le() as usize;
let start = buf_offset.saturating_sub(SMB2_HEADER_SIZE);
let end = (start + buf_length).min(resp_body.len());
if start < end {
let entries = parse_directory_entries(&resp_body[start..end]);
all_entries.extend(entries);
}
}
}
Ok(all_entries)
}
// ── Compound operations (multiple SMB ops in one round trip) ────────
/// Send a compound request and parse the compound response.
///
/// Caller sets `SMB2_FLAGS_RELATED` on related-chain requests.
/// This method handles `NextCommand` offsets, signing, and framing.
async fn send_compound(
&self,
requests: Vec<(Header, BytesMut)>,
) -> io::Result<Vec<(Header, Vec<u8>)>> {
let n = requests.len();
// Padded message sizes (8-byte aligned except last).
let sizes: Vec<usize> = requests
.iter()
.enumerate()
.map(|(i, (_, body))| {
let raw = SMB2_HEADER_SIZE + body.len();
if i < n - 1 {
raw + (8 - raw % 8) % 8
} else {
raw
}
})
.collect();
let total: usize = sizes.iter().sum();
let mut buf = BytesMut::with_capacity(4 + total);
buf.put_u32((total as u32) & 0x00FF_FFFF); // NetBIOS length (big-endian, masked to 24 bits)
for (i, (mut header, body)) in requests.into_iter().enumerate() {
let body_len = body.len();
header.next_command = if i < n - 1 { sizes[i] as u32 } else { 0 };
let msg_start = buf.len();
header.encode(&mut buf);
buf.put_slice(&body);
// Pad to 8-byte alignment
let pad = sizes[i] - SMB2_HEADER_SIZE - body_len;
if pad > 0 {
buf.extend_from_slice(&[0u8; 7][..pad]);
}
// Sign this message
if let Some(ref key) = self.signing_key {
sign_message(&mut buf[msg_start..msg_start + sizes[i]], key);
}
}
// Send and receive under the stream lock
let mut stream = self.stream.lock().await;
stream.write_all(&buf).await?;
stream.flush().await?;
// Read response frames, skipping STATUS_PENDING interim responses
loop {
let mut len_buf = [0u8; 4];
self.read_exact_timeout(&mut stream, &mut len_buf).await?;
let msg_len = u32::from_be_bytes(len_buf) as usize;
if !(SMB2_HEADER_SIZE..=16 * 1024 * 1024).contains(&msg_len) {
crate::serr!("[spiceio] smb invalid message length: {msg_len}");
return Err(io::Error::new(
io::ErrorKind::InvalidData,
format!("invalid SMB2 message length: {msg_len}"),
));
}
let mut msg = vec![0u8; msg_len];
self.read_exact_timeout(&mut stream, &mut msg).await?;
// Single STATUS_PENDING interim — skip
if let Some(h) = Header::decode(&msg)
&& h.status == 0x0000_0103
&& h.next_command == 0
{
continue;
}
return Ok(parse_compound_response(&msg));
}
}
/// Compound Create + Close (1 round trip). Returns create and close
/// metadata. Used for head_object and delete_object.
pub async fn create_close(
&self,
tree_id: u32,
path: &str,
desired_access: u32,
share_access: u32,
create_disposition: u32,