Ssh packet

  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
use "buffered"
use "../ssh_error"
use "../ssh_crypto"

class SshPacketWriter
  var _sequence_number: U32 = 0
  var _is_aead: Bool = false
  // Per-packet GCM: key + 12-byte IV (last 8 bytes incremented per packet)
  var _gcm_key: (Array[U8] val | None) = None
  var _gcm_iv: (Array[U8] ref | None) = None
  // Stream cipher (CTR/CBC): persistent context + MAC key
  var _stream_ctx: (SshCipherContext | None) = None
  var _mac_key: (Array[U8] val | None) = None
  var _mac_len: USize = 0
  var _use_sha512: Bool = false
  // Legacy single-shot context (for tests)
  var _encrypt_ctx: (SshCipherContext | None) = None

  fun ref set_encrypt_ctx(ctx: SshCipherContext, is_aead: Bool = true) =>
    _encrypt_ctx = ctx
    _is_aead = is_aead

  fun ref set_gcm_params(key: Array[U8] val, iv: Array[U8] val) =>
    """
    Set up per-packet GCM encryption. A fresh cipher context is created per
    packet. iv must be 12 bytes. The last 8 bytes are incremented per packet.
    """
    _gcm_key = key
    let iv_copy = Array[U8].create(12)
    for b in iv.values() do iv_copy.push(b) end
    _gcm_iv = iv_copy
    _is_aead = true

  fun ref set_stream_cipher(ctx: SshCipherContext, mac_key: Array[U8] val,
    mac_len: USize, use_sha512: Bool = false)
  =>
    """
    Set up streaming encryption (CTR/CBC) with HMAC. The cipher context
    persists across packets. MAC is HMAC-SHA256 or HMAC-SHA512.
    """
    _stream_ctx = ctx
    _mac_key = mac_key
    _mac_len = mac_len
    _use_sha512 = use_sha512
    _is_aead = false

  fun ref clear_encrypt_ctx() =>
    _encrypt_ctx = None
    _gcm_key = None
    _gcm_iv = None
    _stream_ctx = None
    _mac_key = None

  fun ref write(payload: Array[U8] val, block_size: USize = 8): Array[U8] iso^ =>
    """
    Frame a payload into an SSH binary packet.
    Returns the complete packet bytes ready for TCP.
    """
    // Calculate padding:
    // packet_length = 1 (padding_length field) + payload.size() + padding
    // padding must be >= 4 and < 256
    //
    // Alignment depends on cipher mode:
    // - Plaintext / non-AEAD: (4 + packet_length) must be multiple of block_size
    //   because the packet_length field is encrypted along with the body
    // - AEAD (GCM): packet_length itself must be multiple of block_size
    //   because the 4-byte length is plaintext AAD, not part of the encrypted block
    let actual_padding = if _is_aead then
      // AEAD: align packet_length to block_size
      let min_pkt_len = 1 + payload.size() + 4  // with minimum 4 padding
      let rem = min_pkt_len % block_size
      if rem == 0 then USize(4) else 4 + (block_size - rem) end
    else
      // Plaintext / non-AEAD: align (4 + packet_length) to block_size
      let min_pkt_len = 1 + payload.size() + 4
      let total = 4 + min_pkt_len
      let rem = total % block_size
      if rem == 0 then USize(4) else 4 + (block_size - rem) end
    end

    let packet_length = (1 + payload.size() + actual_padding).u32()

    let result = recover iso
      let w = Writer
      w.u32_be(packet_length)
      w.u8(actual_padding.u8())
      w.write(payload)
      let pad = SshRandom.random_bytes(actual_padding)
      w.write(consume pad)
      let chunks = w.done()
      let buf = Array[U8].create(4 + packet_length.usize())
      for chunk in (consume chunks).values() do
        match chunk
        | let a: Array[U8] val => for b in a.values() do buf.push(b) end
        | let s: String => for b in s.values() do buf.push(b) end
        end
      end
      buf
    end

    _sequence_number = _sequence_number + 1

    // Per-packet GCM: create a fresh cipher context with the current IV,
    // then increment the IV's last 8 bytes for the next packet.
    // This matches OpenSSH's EVP_CTRL_GCM_IV_GEN behavior.
    match (_gcm_key, _gcm_iv)
    | (let key: Array[U8] val, let gcm_iv: Array[U8] ref) =>
      let plaintext: Array[U8] val = consume result
      // Snapshot the current IV as iso then consume to val
      let iv_iso = recover iso Array[U8].create(12) end
      for b in gcm_iv.values() do iv_iso.push(b) end
      let iv: Array[U8] val = consume iv_iso
      // Increment the last 8 bytes of the mutable IV for the next packet
      _increment_iv(gcm_iv)
      let pt_r = Reader
      pt_r.append(plaintext)
      try
        let pkt_len_bytes: Array[U8] val = pt_r.block(4)?
        let body: Array[U8] val = pt_r.block(plaintext.size() - 4)?
        let ctx = if key.size() <= 16 then
          SshCipherContext.aes_128_gcm(key, iv, true)?
        else
          SshCipherContext.aes_256_gcm(key, iv, true)?
        end
        try ctx.set_aad(pkt_len_bytes)? end
        let encrypted = ctx.encrypt(body, true)
        let gcm_tag = match ctx.tag_value()
        | let t: Array[U8] val => t
        | None => recover val Array[U8] end
        end
        let out = recover iso Array[U8](4 + encrypted.size() + gcm_tag.size()) end
        out.append(pkt_len_bytes)
        out.append(encrypted)
        out.append(gcm_tag)
        return consume out
      else
        // Cipher creation failed, return plaintext (should not happen)
        return recover iso
          let out = Array[U8].create(plaintext.size())
          for b in plaintext.values() do out.push(b) end
          out
        end
      end
    end

    // Stream cipher (CTR/CBC) with HMAC
    match (_stream_ctx, _mac_key)
    | (let ctx: SshCipherContext, let mkey: Array[U8] val) =>
      let plaintext: Array[U8] val = consume result
      // HMAC(key, sequence_number_BE || unencrypted_packet)
      let mac_w = Writer
      mac_w.u32_be(_sequence_number - 1)  // already incremented
      mac_w.write(plaintext)
      let mac_input = _flatten_writer(consume mac_w)
      let mac = if _use_sha512 then
        SshMac.compute_sha512(mkey, mac_input)
      else
        SshMac.compute_sha256(mkey, mac_input)
      end
      // Encrypt entire packet (including packet_length)
      let encrypted = ctx.encrypt_stream(plaintext)
      let out = recover iso Array[U8](encrypted.size() + _mac_len) end
      out.append(encrypted)
      out.append(mac, 0, _mac_len)
      return consume out
    end

    // Legacy single-shot context (for encrypted packet tests)
    match _encrypt_ctx
    | let ctx: SshCipherContext =>
      if _is_aead then
        let plaintext: Array[U8] val = consume result
        try
          let pt_r = Reader
          pt_r.append(plaintext)
          let pkt_len_bytes: Array[U8] val = pt_r.block(4)?
          let body: Array[U8] val = pt_r.block(plaintext.size() - 4)?
          ctx.set_aad(pkt_len_bytes)?
          let encrypted = ctx.encrypt(body, true)
          let gcm_tag = match ctx.tag_value()
          | let t: Array[U8] val => t
          | None => recover val Array[U8] end
          end
          let out = recover iso Array[U8](4 + encrypted.size() + gcm_tag.size()) end
          out.append(pkt_len_bytes)
          out.append(encrypted)
          out.append(gcm_tag)
          consume out
        else
          recover iso Array[U8] end
        end
      else
        let plaintext: Array[U8] val = consume result
        let encrypted = ctx.encrypt(plaintext)
        let out = recover iso Array[U8](encrypted.size()) end
        out.append(encrypted)
        consume out
      end
    | None =>
      consume result
    end

  fun ref _flatten_writer(w: Writer iso): Array[U8] val =>
    """Collect Writer chunks into a contiguous Array[U8] val."""
    var w' = consume ref w
    let total = w'.size()
    let chunks = w'.done()
    let out = recover iso Array[U8](total) end
    for chunk in (consume chunks).values() do
      match chunk
      | let a: Array[U8] val => out.append(a)
      | let s: String => out.append(s.array())
      end
    end
    consume out

  fun ref _increment_iv(iv: Array[U8] ref) =>
    """Increment the last 8 bytes of a 12-byte IV as a big-endian counter."""
    try
      var i: USize = iv.size() - 1
      while i >= 4 do
        let v = iv(i)? + 1
        iv(i)? = v
        if v != 0 then return end  // no carry
        i = i - 1
      end
    end

  fun sequence_number(): U32 => _sequence_number

class SshPacketReader
  let _buf: Reader = Reader
  var _sequence_number: U32 = 0
  var _is_aead: Bool = false
  // Per-packet GCM state
  var _gcm_key: (Array[U8] val | None) = None
  var _gcm_iv: (Array[U8] ref | None) = None
  var _mac_digest_len: USize = 0
  // Stream cipher (CTR/CBC)
  var _stream_ctx: (SshCipherContext | None) = None
  var _mac_key: (Array[U8] val | None) = None
  var _use_sha512: Bool = false
  var _block_size: USize = 16
  // Decrypted first block (waiting for rest of packet)
  var _decrypted_first_block: (Array[U8] val | None) = None
  var _first_block_packet_length: U32 = 0
  // Legacy single-shot context
  var _decrypt_ctx: (SshCipherContext | None) = None

  fun ref set_decrypt_ctx(
    ctx: SshCipherContext,
    mac_digest_len: USize = 16,
    is_aead: Bool = true)
  =>
    _decrypt_ctx = ctx
    _mac_digest_len = mac_digest_len
    _is_aead = is_aead

  fun ref set_gcm_params(key: Array[U8] val, iv: Array[U8] val) =>
    """
    Set up per-packet GCM decryption. A fresh cipher context is created per
    packet. iv must be 12 bytes. The last 8 bytes are incremented per packet.
    """
    _gcm_key = key
    let iv_copy = Array[U8].create(12)
    for b in iv.values() do iv_copy.push(b) end
    _gcm_iv = iv_copy
    _mac_digest_len = 16
    _is_aead = true

  fun ref set_stream_cipher(ctx: SshCipherContext, mac_key: Array[U8] val,
    mac_len: USize, block_size: USize = 16, use_sha512: Bool = false)
  =>
    """
    Set up streaming decryption (CTR/CBC) with HMAC verification.
    """
    _stream_ctx = ctx
    _mac_key = mac_key
    _mac_digest_len = mac_len
    _block_size = block_size
    _use_sha512 = use_sha512
    _is_aead = false

  fun ref clear_decrypt_ctx() =>
    _decrypt_ctx = None
    _mac_digest_len = 0
    _gcm_key = None
    _gcm_iv = None
    _stream_ctx = None
    _mac_key = None
    _decrypted_first_block = None

  fun ref append(data: Array[U8] val) =>
    """Append incoming TCP bytes to the internal buffer."""
    _buf.append(data)

  fun ref read(): (Array[U8] val | SshTransportError | None) =>
    """
    Try to read one complete packet from the buffer.
    Returns:
    - payload (Array[U8] val) on success
    - SshTransportError on protocol error
    - None if not enough data yet
    """
    // Per-packet GCM: create a fresh cipher context with the current IV,
    // then increment the IV's last 8 bytes for the next packet.
    match (_gcm_key, _gcm_iv)
    | (let key: Array[U8] val, let gcm_iv: Array[U8] ref) =>
      let iv_iso = recover iso Array[U8].create(12) end
      for b in gcm_iv.values() do iv_iso.push(b) end
      let iv: Array[U8] val = consume iv_iso
      try
        let ctx = if key.size() <= 16 then
          SshCipherContext.aes_128_gcm(key, iv, false)?
        else
          SshCipherContext.aes_256_gcm(key, iv, false)?
        end
        let result = _read_aead(ctx)
        match result
        | let _: Array[U8] val => _increment_iv(gcm_iv)
        end
        return result
      else
        return SshPacketCorrupt
      end
    end

    // Stream cipher (CTR/CBC) with HMAC
    match (_stream_ctx, _mac_key)
    | (let ctx: SshCipherContext, let mkey: Array[U8] val) =>
      return _read_stream(ctx, mkey)
    end

    // Legacy single-shot context (for tests)
    match _decrypt_ctx
    | let ctx: SshCipherContext =>
      if _is_aead then
        _read_aead(ctx)
      else
        _read_plaintext()
      end
    | None =>
      _read_plaintext()
    end

  fun ref _read_aead(ctx: SshCipherContext): (Array[U8] val | SshTransportError | None) =>
    """
    Read an AEAD-encrypted packet (GCM).
    Format: packet_length(4, cleartext) || encrypted_body(packet_length) || tag(mac_digest_len)
    """
    if _buf.size() < 4 then return None end

    let packet_length = try _buf.peek_u32_be()? else return SshPacketCorrupt end
    if packet_length.usize() > 35000 then return SshPacketTooLarge end

    let total_needed = 4 + packet_length.usize() + _mac_digest_len
    if _buf.size() < total_needed then return None end

    try
      let pkt_len_bytes: Array[U8] val = _buf.block(4)?
      let ciphertext: Array[U8] val = _buf.block(packet_length.usize())?
      let gcm_tag: Array[U8] val = _buf.block(_mac_digest_len)?

      ctx.set_aad(pkt_len_bytes)?
      ctx.set_tag(gcm_tag)?

      let decrypted = match ctx.decrypt(ciphertext)
      | let d: Array[U8] val => d
      | let _: SshCryptoError => return SshPacketCorrupt
      end

      let payload = _extract_payload(decrypted)?
      _sequence_number = _sequence_number + 1
      payload
    else
      SshPacketCorrupt
    end

  fun ref _read_stream(ctx: SshCipherContext, mkey: Array[U8] val):
    (Array[U8] val | SshTransportError | None)
  =>
    """
    Read a stream-cipher encrypted packet (CTR/CBC) with HMAC.
    Decrypt first block to get packet_length, then decrypt the rest,
    then verify HMAC.
    """
    // Step 1: If we haven't decrypted the first block yet, do it now
    match _decrypted_first_block
    | None =>
      if _buf.size() < _block_size then return None end
      let first_block_enc: Array[U8] val = try _buf.block(_block_size)?
      else return SshPacketCorrupt end
      let first_block = ctx.decrypt_stream(first_block_enc)
      // Extract packet_length via buffered.Reader
      let fb_reader = Reader
      fb_reader.append(first_block)
      let pkt_len = try fb_reader.u32_be()? else return SshPacketCorrupt end
      if pkt_len.usize() > 35000 then return SshPacketTooLarge end
      _decrypted_first_block = first_block
      _first_block_packet_length = pkt_len
    end

    // Step 2: Check if we have enough remaining data
    // First block already consumed from _buf
    let pkt_len = _first_block_packet_length
    let total_encrypted = 4 + pkt_len.usize()
    let remaining_encrypted = total_encrypted - _block_size
    if _buf.size() < (remaining_encrypted + _mac_digest_len) then return None end

    let first_block = match _decrypted_first_block
    | let fb: Array[U8] val => fb
    else return SshPacketCorrupt end
    _decrypted_first_block = None

    try
      // Step 3: Decrypt remaining encrypted bytes
      let remaining_dec = if remaining_encrypted > 0 then
        ctx.decrypt_stream(_buf.block(remaining_encrypted)?)
      else
        recover val Array[U8] end
      end

      // Step 4: Assemble full plaintext packet
      let plaintext = recover iso Array[U8](first_block.size() + remaining_dec.size()) end
      plaintext.append(first_block)
      plaintext.append(remaining_dec)
      let plaintext': Array[U8] val = consume plaintext

      // Step 5: Verify HMAC(key, seq_BE || plaintext_packet)
      let received_mac: Array[U8] val = _buf.block(_mac_digest_len)?

      let mac_w = Writer
      mac_w.u32_be(_sequence_number)
      mac_w.write(plaintext')
      let mac_input': Array[U8] val = _flatten_writer(consume mac_w)

      let expected_mac = if _use_sha512 then
        SshMac.compute_sha512(mkey, mac_input')
      else
        SshMac.compute_sha256(mkey, mac_input')
      end

      if not SshMac.verify(received_mac, expected_mac) then
        return SshPacketCorrupt
      end

      // Step 6: Extract payload from plaintext
      // plaintext is: packet_length(4) || padding_length(1) || payload || padding
      let payload = _extract_payload_with_header(plaintext')?
      _sequence_number = _sequence_number + 1
      payload
    else
      SshPacketCorrupt
    end

  fun ref _read_plaintext(): (Array[U8] val | SshTransportError | None) =>
    """Read an unencrypted packet."""
    if _buf.size() < 4 then return None end

    // Peek at packet_length (big-endian U32)
    let packet_length = try _buf.peek_u32_be()? else return SshPacketCorrupt end

    if packet_length.usize() > 35000 then
      return SshPacketTooLarge
    end

    let total_needed = 4 + packet_length.usize()
    if _buf.size() < total_needed then return None end

    // Now consume
    try
      _buf.skip(4)?  // packet_length field (already peeked)
      let padding_length = _buf.u8()?
      let payload_length = packet_length.usize() - 1 - padding_length.usize()
      if padding_length.usize() < 4 then return SshPacketCorrupt end
      let payload: Array[U8] val = _buf.block(payload_length)?
      _buf.skip(padding_length.usize())?  // discard padding
      _sequence_number = _sequence_number + 1
      payload
    else
      SshPacketCorrupt
    end

  fun _extract_payload(decrypted: Array[U8] val): Array[U8] val ? =>
    """
    Extract payload from decrypted AEAD body: padding_length(1) || payload || padding.
    """
    let r = Reader
    r.append(decrypted)
    let padding_length = r.u8()?.usize()
    if padding_length < 4 then error end
    let payload_length = decrypted.size() - 1 - padding_length
    if (1 + payload_length + padding_length) != decrypted.size() then error end
    r.block(payload_length)?

  fun _extract_payload_with_header(plaintext: Array[U8] val): Array[U8] val ? =>
    """
    Extract payload from full plaintext packet:
    packet_length(4) || padding_length(1) || payload || padding.
    """
    let r = Reader
    r.append(plaintext)
    let pkt_len = r.u32_be()?.usize()
    let padding_length = r.u8()?.usize()
    if padding_length < 4 then error end
    let payload_length = pkt_len - 1 - padding_length
    r.block(payload_length)?

  fun ref read_line(): (String val | None) =>
    """
    Scan the buffer for a line ending in \n. Returns the line content without
    the trailing \r\n (or \n), or None if no complete line yet.
    """
    try
      _buf.line()?
    else
      None
    end

  fun ref _flatten_writer(w: Writer iso): Array[U8] val =>
    """Collect Writer chunks into a contiguous Array[U8] val."""
    var w' = consume ref w
    let total = w'.size()
    let chunks = w'.done()
    let out = recover iso Array[U8](total) end
    for chunk in (consume chunks).values() do
      match chunk
      | let a: Array[U8] val => out.append(a)
      | let s: String => out.append(s.array())
      end
    end
    consume out

  fun ref _increment_iv(iv: Array[U8] ref) =>
    """Increment the last 8 bytes of a 12-byte IV as a big-endian counter."""
    try
      var i: USize = iv.size() - 1
      while i >= 4 do
        let v = iv(i)? + 1
        iv(i)? = v
        if v != 0 then return end
        i = i - 1
      end
    end

  fun sequence_number(): U32 => _sequence_number