iridium_server 0.1.0

TDS 7.4 server for Iridium SQL
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
use super::packet::PacketBuilder;
use super::type_mapping::{
    value_to_wire_bytes, TypeInfo, BIGBINARYTYPE, BIGCHARTYPE, BIGVARBINARYTYPE, BIGVARCHARTYPE,
    NCHARTYPE, NVARCHARTYPE,
};
use iridium_core::types::Value;

pub const COLMETADATA_TOKEN: u8 = 0x81;
pub const ROW_TOKEN: u8 = 0xD1;
pub const DONE_TOKEN: u8 = 0xFD;
pub const DONEINPROC_TOKEN: u8 = 0xFF;
pub const DONEPROC_TOKEN: u8 = 0xFE;
pub const ERROR_TOKEN: u8 = 0xAA;
pub const INFO_TOKEN: u8 = 0xAB;
pub const LOGINACK_TOKEN: u8 = 0xAD;
pub const ENVCHANGE_TOKEN: u8 = 0xE3;
pub const FEATUREEXTACK_TOKEN: u8 = 0xAE;
pub const RETURNSTATUS_TOKEN: u8 = 0x79;
pub const OUTPUT_PARAM_TOKEN: u8 = 0x80;

pub const DONE_FINAL: u16 = 0x0000;
pub const DONE_MORE: u16 = 0x0001;
pub const DONE_ERROR: u16 = 0x0002;
pub const DONE_COUNT: u16 = 0x0010;
pub const DONE_ATTN: u16 = 0x0020;

pub const ENVCHANGE_PACKET_SIZE: u8 = 0x04;
pub const ENVCHANGE_DATABASE: u8 = 0x01;
pub const ENVCHANGE_LANGUAGE_TYPE: u8 = 0x02;
pub const ENVCHANGE_COLLATION: u8 = 0x07;

fn truncate_string_value(s: &str, max_chars: usize) -> String {
    if max_chars == 0 {
        String::new()
    } else {
        s.chars().take(max_chars).collect()
    }
}

fn apply_textsize(value: &Value, ti: &TypeInfo, textsize: usize) -> Value {
    if value.is_null() {
        return match value {
            Value::Char(s) => Value::Char(s.clone()),
            Value::VarChar(s) => Value::VarChar(s.clone()),
            Value::NChar(s) => Value::NChar(s.clone()),
            Value::NVarChar(s) => Value::NVarChar(s.clone()),
            Value::Binary(v) => Value::Binary(v.clone()),
            Value::VarBinary(v) => Value::VarBinary(v.clone()),
            _ => value.clone(),
        };
    }

    match value {
        Value::Char(s) if ti.tds_type == BIGCHARTYPE => {
            Value::VarChar(truncate_string_value(s, textsize))
        }
        Value::VarChar(s) if ti.tds_type == BIGVARCHARTYPE => {
            Value::VarChar(truncate_string_value(s, textsize))
        }
        Value::NChar(s) if ti.tds_type == NCHARTYPE => {
            let max_chars = textsize / 2;
            Value::NVarChar(truncate_string_value(s, max_chars))
        }
        Value::NVarChar(s) if ti.tds_type == NVARCHARTYPE => {
            let max_chars = textsize / 2;
            Value::NVarChar(truncate_string_value(s, max_chars))
        }
        Value::Binary(v) if ti.tds_type == BIGBINARYTYPE => {
            let mut bytes = v.clone();
            if bytes.len() > textsize {
                bytes.truncate(textsize);
            }
            Value::VarBinary(bytes)
        }
        Value::VarBinary(v) if ti.tds_type == BIGVARBINARYTYPE => {
            let mut bytes = v.clone();
            if bytes.len() > textsize {
                bytes.truncate(textsize);
            }
            Value::VarBinary(bytes)
        }
        _ => value.clone(),
    }
}

pub fn write_colmetadata(b: &mut PacketBuilder, columns: &[String], types: &[TypeInfo]) {
    b.put_u8(COLMETADATA_TOKEN);
    b.put_u16_le(columns.len() as u16);

    for (i, col_name) in columns.iter().enumerate() {
        let ti = if i < types.len() {
            &types[i]
        } else {
            // Fallback
            &TypeInfo {
                tds_type: super::type_mapping::NVARCHARTYPE,
                length_prefix: vec![0x00, 0xFF],
                collation: Some(super::type_mapping::DEFAULT_COLLATION),
                scale: None,
                precision: None,
                flags: 0x0001,
            }
        };

        // UserType: 4 bytes (ULONG)
        b.put_u32_le(0);

        // Flags: 2 bytes (USHORT LE)
        b.put_u16_le(ti.flags);

        // TYPE_INFO
        b.put_u8(ti.tds_type);
        b.put_bytes(&ti.length_prefix);

        // Collation for char types
        if let Some(collation) = &ti.collation {
            b.put_bytes(collation);
        }

        // TYPE_INFO tail:
        // - DECIMAL/NUMERIC: precision + scale
        // - TIME/DATETIME2: scale
        if let Some(precision) = ti.precision {
            b.put_u8(precision);
            b.put_u8(ti.scale.unwrap_or(0));
        } else if let Some(scale) = ti.scale {
            b.put_u8(scale);
        }

        // Column name: B_VARCHAR (UTF-16LE)
        b.put_b_vchar_utf16(col_name);
    }
}

pub fn write_row(b: &mut PacketBuilder, row: &[Value], types: &[TypeInfo], textsize: usize) {
    b.put_u8(ROW_TOKEN);
    for (i, value) in row.iter().enumerate() {
        let ti = &types[i];
        let truncated = apply_textsize(value, ti, textsize);
        b.put_bytes(&value_to_wire_bytes(&truncated, ti));
    }
}

pub fn write_done(b: &mut PacketBuilder, status: u16, cur_cmd: u16, row_count: u64) {
    b.put_u8(DONE_TOKEN);
    b.put_u16_le(status);
    b.put_u16_le(cur_cmd);
    b.put_u64_le(row_count);
}

pub fn write_done_in_proc(b: &mut PacketBuilder, status: u16, cur_cmd: u16, row_count: u64) {
    b.put_u8(DONEINPROC_TOKEN);
    b.put_u16_le(status);
    b.put_u16_le(cur_cmd);
    b.put_u64_le(row_count);
}

pub fn write_doneproc(b: &mut PacketBuilder, status: u16, cur_cmd: u16, row_count: u64) {
    b.put_u8(DONEPROC_TOKEN);
    b.put_u16_le(status);
    b.put_u16_le(cur_cmd);
    b.put_u64_le(row_count);
}

pub fn write_returnstatus(b: &mut PacketBuilder, status: i32) {
    b.put_u8(RETURNSTATUS_TOKEN);
    b.put_i32_le(status);
}

/// Write an OUTPUT parameter token (0x80) for an integer value.
/// Used by cursor RPC to return the cursor handle as an output parameter.
pub fn write_output_int(b: &mut PacketBuilder, param_name: &str, value: i32) {
    b.put_u8(OUTPUT_PARAM_TOKEN);

    // Param name (B_VARCHAR, length-prefixed with single byte)
    let name_bytes: Vec<u16> = param_name.encode_utf16().collect();
    b.put_u8(name_bytes.len() as u8);
    for ch in name_bytes {
        b.put_u16_le(ch);
    }

    // STATUS byte (0x00 = RETURN value)
    b.put_u8(0x00);

    // Type info: INTN (type 0x26), 4 bytes max
    b.put_u8(0x26); // INTN
    b.put_u8(0x04); // max length = 4

    // Collation (5 bytes) - for INTN we can use zeroes
    b.put_u8(0x00);
    b.put_u8(0x00);
    b.put_u8(0x00);
    b.put_u8(0x00);
    b.put_u8(0x00);

    // Actual length (1 byte) + value (4 bytes LE)
    b.put_u8(0x04);
    b.put_i32_le(value);
}

#[allow(clippy::too_many_arguments)]
pub fn write_error(
    b: &mut PacketBuilder,
    number: i32,
    state: u8,
    class: u8,
    message: &str,
    server_name: &str,
    proc_name: &str,
    line_number: i32,
) {
    // First, build the data portion to know its length
    let mut data_b = PacketBuilder::new();
    data_b.put_i32_le(number);
    data_b.put_u8(state);
    data_b.put_u8(class);
    data_b.put_us_vchar_utf16(message);
    data_b.put_b_vchar_utf16(server_name);
    data_b.put_b_vchar_utf16(proc_name);
    data_b.put_i32_le(line_number);

    let data_bytes = data_b.as_bytes();

    b.put_u8(ERROR_TOKEN);
    b.put_u16_le(data_bytes.len() as u16);
    b.put_bytes(data_bytes);
}

pub fn write_envchange_packet_size(b: &mut PacketBuilder, new_size: u16, old_size: u16) {
    b.put_u8(ENVCHANGE_TOKEN);

    let new_val = format!("{}", new_size);
    let old_val = format!("{}", old_size);

    // Length = 1 (type) + 1 (new_len) + new_val.utf16_bytes + 1 (old_len) + old_val.utf16_bytes
    let new_utf16_bytes = new_val.len() * 2;
    let old_utf16_bytes = old_val.len() * 2;
    let total_len = 1 + 1 + new_utf16_bytes + 1 + old_utf16_bytes;
    b.put_u16_le(total_len as u16);

    b.put_u8(ENVCHANGE_PACKET_SIZE);

    // New value: B_VARCHAR (char count)
    b.put_u8(new_val.len() as u8);
    b.put_utf16le(&new_val);

    // Old value
    b.put_u8(old_val.len() as u8);
    b.put_utf16le(&old_val);
}

pub fn write_envchange_database(b: &mut PacketBuilder, new_db: &str, old_db: &str) {
    b.put_u8(ENVCHANGE_TOKEN);

    let new_utf16_bytes = new_db.len() * 2;
    let old_utf16_bytes = old_db.len() * 2;
    let total_len = 1 + 1 + new_utf16_bytes + 1 + old_utf16_bytes;
    b.put_u16_le(total_len as u16);

    b.put_u8(ENVCHANGE_DATABASE);

    b.put_u8(new_db.len() as u8);
    b.put_utf16le(new_db);

    b.put_u8(old_db.len() as u8);
    b.put_utf16le(old_db);
}

pub fn write_envchange_collation(b: &mut PacketBuilder) {
    b.put_u8(ENVCHANGE_TOKEN);

    // Latin1_General_CI_AS: LCID=0x0409, flags=0x0000, sortId=0x00
    let collation = [0x09, 0x04, 0x00, 0x00, 0x00];

    let total_len = 1 + 1 + 5 + 1 + 5;
    b.put_u16_le(total_len as u16);

    b.put_u8(ENVCHANGE_COLLATION);

    b.put_u8(5); // new value length
    b.put_bytes(&collation);

    b.put_u8(5); // old value length
    b.put_bytes(&collation);
}

pub fn write_envchange_language(b: &mut PacketBuilder, new_lang: &str, old_lang: &str) {
    b.put_u8(ENVCHANGE_TOKEN);

    let new_utf16_bytes = new_lang.len() * 2;
    let old_utf16_bytes = old_lang.len() * 2;
    let total_len = 1 + 1 + new_utf16_bytes + 1 + old_utf16_bytes;
    b.put_u16_le(total_len as u16);

    b.put_u8(ENVCHANGE_LANGUAGE_TYPE);

    b.put_u8(new_lang.len() as u8);
    b.put_utf16le(new_lang);

    b.put_u8(old_lang.len() as u8);
    b.put_utf16le(old_lang);
}

#[allow(clippy::too_many_arguments)]
pub fn write_info(
    b: &mut PacketBuilder,
    number: i32,
    state: u8,
    class: u8,
    message: &str,
    server_name: &str,
    proc_name: &str,
    line_number: i32,
) {
    let mut data_b = PacketBuilder::new();
    data_b.put_i32_le(number);
    data_b.put_u8(state);
    data_b.put_u8(class);
    data_b.put_us_vchar_utf16(message);
    data_b.put_b_vchar_utf16(server_name);
    data_b.put_b_vchar_utf16(proc_name);
    data_b.put_i32_le(line_number);

    let data_bytes = data_b.as_bytes();

    b.put_u8(INFO_TOKEN);
    b.put_u16_le(data_bytes.len() as u16);
    b.put_bytes(data_bytes);
}

pub fn write_loginack(b: &mut PacketBuilder, tds_version: u32) {
    // Build the data portion first
    let mut data_b = PacketBuilder::new();
    data_b.put_u8(0x01); // Interface: SQL_TSQL
    data_b.put_u32_be(tds_version); // TDS version (BE)

    let prog_name = "Microsoft SQL Server";
    data_b.put_u8(prog_name.encode_utf16().count() as u8); // ProgNameLen
    data_b.put_utf16le(prog_name); // ProgName

    // Version: 16.0.4105.1 (SQL Server 2022-ish)
    data_b.put_u8(16); // MajorVer
    data_b.put_u8(0); // MinorVer
    data_b.put_u16_le(0x1009); // BuildNum (4105)

    let data_bytes = data_b.as_bytes();

    b.put_u8(LOGINACK_TOKEN);
    b.put_u16_le(data_bytes.len() as u16);
    b.put_bytes(data_bytes);
}

pub fn write_result_set(
    b: &mut PacketBuilder,
    columns: &[String],
    types: &[TypeInfo],
    rows: &[Vec<Value>],
    cur_cmd: u16,
    textsize: usize,
) {
    write_colmetadata(b, columns, types);

    for row in rows {
        write_row(b, row, types, textsize);
    }

    write_done(b, DONE_COUNT, cur_cmd, rows.len() as u64);
}

#[cfg(test)]
mod tests {
    use super::*;
    use crate::tds::type_mapping::value_to_type_info;

    #[test]
    fn write_row_truncates_varchar_payload() {
        let mut b = PacketBuilder::new();
        let row = vec![Value::VarChar("hello".to_string())];
        let types = vec![value_to_type_info(&row[0])];

        write_row(&mut b, &row, &types, 3);

        let bytes = b.as_bytes();
        assert_eq!(bytes[0], ROW_TOKEN);
        assert!(bytes
            .windows(5)
            .any(|w| w == [0x03, 0x00, b'h', b'e', b'l']));
    }

    #[test]
    fn write_row_truncates_varbinary_payload() {
        let mut b = PacketBuilder::new();
        let row = vec![Value::VarBinary(vec![0x01, 0x02, 0x03, 0x04])];
        let types = vec![value_to_type_info(&row[0])];

        write_row(&mut b, &row, &types, 2);

        let bytes = b.as_bytes();
        assert_eq!(bytes[0], ROW_TOKEN);
        assert!(bytes.windows(4).any(|w| w == [0x02, 0x00, 0x01, 0x02]));
    }
}