ggstd 0.1.0

Partial implementation of Go standard library
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
// Copyright 2023 The rust-ggstd authors. All rights reserved.
// Copyright 2009 The Go Authors. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.

use super::consts::{POWX, SBOX0, SBOX1, TD0, TD1, TD2, TD3, TE0, TE1, TE2, TE3};
use crate::encoding::binary::{self, ByteOrder};

// This Go implementation is derived in part from the reference
// ANSI C implementation, which carries the following notice:
//
//	rijndael-alg-fst.c
//
//	@version 3.0 (December 2000)
//
//	Optimised ANSI C code for the Rijndael cipher (now AES)
//
//	@author Vincent Rijmen <vincent.rijmen@esat.kuleuven.ac.be>
//	@author Antoon Bosselaers <antoon.bosselaers@esat.kuleuven.ac.be>
//	@author Paulo Barreto <paulo.barreto@terra.com.br>
//
//	This code is hereby placed in the public domain.
//
//	THIS SOFTWARE IS PROVIDED BY THE AUTHORS ''AS IS'' AND ANY EXPRESS
//	OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
//	WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
//	ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHORS OR CONTRIBUTORS BE
//	LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
//	CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
//	SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR
//	BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
//	WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
//	OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
//	EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//
// See FIPS 197 for specification, and see Daemen and Rijmen's Rijndael submission
// for implementation details.
//	https://csrc.nist.gov/csrc/media/publications/fips/197/final/documents/fips-197.pdf
//	https://csrc.nist.gov/archive/aes/rijndael/Rijndael-ammended.pdf

/// encrypt one block from src into dst, using the expanded key xk.
pub fn encrypt_block_go(xk: &[u32], dst: &mut [u8], src: &[u8]) {
    assert!(src.len() >= 16); // bounds check

    let mut s0 = binary::BIG_ENDIAN.uint32(&src[0..4]);
    let mut s1 = binary::BIG_ENDIAN.uint32(&src[4..8]);
    let mut s2 = binary::BIG_ENDIAN.uint32(&src[8..12]);
    let mut s3 = binary::BIG_ENDIAN.uint32(&src[12..16]);

    // First round just XORs input with key.
    s0 ^= xk[0];
    s1 ^= xk[1];
    s2 ^= xk[2];
    s3 ^= xk[3];

    // Middle rounds shuffle using tables.
    // Number of rounds is set by length of expanded key.
    let nr = xk.len() / 4 - 2; // - 2: one above, one more below
    let mut k = 4;
    let mut t0: u32;
    let mut t1: u32;
    let mut t2: u32;
    let mut t3: u32;
    let mut r = 0;
    loop {
        t0 = xk[k]
            ^ TE0[((s0 >> 24) as u8) as usize]
            ^ TE1[((s1 >> 16) as u8) as usize]
            ^ TE2[((s2 >> 8) as u8) as usize]
            ^ TE3[((s3) as u8) as usize];
        t1 = xk[k + 1]
            ^ TE0[((s1 >> 24) as u8) as usize]
            ^ TE1[((s2 >> 16) as u8) as usize]
            ^ TE2[((s3 >> 8) as u8) as usize]
            ^ TE3[((s0) as u8) as usize];
        t2 = xk[k + 2]
            ^ TE0[((s2 >> 24) as u8) as usize]
            ^ TE1[((s3 >> 16) as u8) as usize]
            ^ TE2[((s0 >> 8) as u8) as usize]
            ^ TE3[((s1) as u8) as usize];
        t3 = xk[k + 3]
            ^ TE0[((s3 >> 24) as u8) as usize]
            ^ TE1[((s0 >> 16) as u8) as usize]
            ^ TE2[((s1 >> 8) as u8) as usize]
            ^ TE3[((s2) as u8) as usize];
        k += 4;
        (s0, s1, s2, s3) = (t0, t1, t2, t3);
        r += 1;
        if r == nr {
            break;
        }
    }

    // Last round uses s-box directly and XORs to produce output.
    s0 = (((SBOX0[(t0 >> 24) as usize]) as u32) << 24)
        | ((SBOX0[((t1 >> 16) & 0xff) as usize] as u32) << 16)
        | ((SBOX0[((t2 >> 8) & 0xff) as usize] as u32) << 8)
        | (SBOX0[(t3 & 0xff) as usize] as u32);
    s1 = (((SBOX0[(t1 >> 24) as usize]) as u32) << 24)
        | ((SBOX0[((t2 >> 16) & 0xff) as usize] as u32) << 16)
        | ((SBOX0[((t3 >> 8) & 0xff) as usize] as u32) << 8)
        | (SBOX0[(t0 & 0xff) as usize] as u32);
    s2 = (((SBOX0[(t2 >> 24) as usize]) as u32) << 24)
        | ((SBOX0[((t3 >> 16) & 0xff) as usize] as u32) << 16)
        | ((SBOX0[((t0 >> 8) & 0xff) as usize] as u32) << 8)
        | (SBOX0[(t1 & 0xff) as usize] as u32);
    s3 = (((SBOX0[(t3 >> 24) as usize]) as u32) << 24)
        | ((SBOX0[((t0 >> 16) & 0xff) as usize] as u32) << 16)
        | ((SBOX0[((t1 >> 8) & 0xff) as usize] as u32) << 8)
        | (SBOX0[(t2 & 0xff) as usize] as u32);

    s0 ^= xk[k];
    s1 ^= xk[k + 1];
    s2 ^= xk[k + 2];
    s3 ^= xk[k + 3];

    assert!(dst.len() >= 16); // bounds check
    binary::BIG_ENDIAN.put_uint32(&mut dst[0..4], s0);
    binary::BIG_ENDIAN.put_uint32(&mut dst[4..8], s1);
    binary::BIG_ENDIAN.put_uint32(&mut dst[8..12], s2);
    binary::BIG_ENDIAN.put_uint32(&mut dst[12..16], s3);
}

/// encrypt one block in the buffer
pub fn encrypt_block_inplace_go(xk: &[u32], buffer: &mut [u8]) {
    assert!(buffer.len() >= 16); // bounds check

    let mut s0 = binary::BIG_ENDIAN.uint32(&buffer[0..4]);
    let mut s1 = binary::BIG_ENDIAN.uint32(&buffer[4..8]);
    let mut s2 = binary::BIG_ENDIAN.uint32(&buffer[8..12]);
    let mut s3 = binary::BIG_ENDIAN.uint32(&buffer[12..16]);

    // First round just XORs input with key.
    s0 ^= xk[0];
    s1 ^= xk[1];
    s2 ^= xk[2];
    s3 ^= xk[3];

    // Middle rounds shuffle using tables.
    // Number of rounds is set by length of expanded key.
    let nr = xk.len() / 4 - 2; // - 2: one above, one more below
    let mut k = 4;
    let mut t0: u32;
    let mut t1: u32;
    let mut t2: u32;
    let mut t3: u32;
    let mut r = 0;
    loop {
        t0 = xk[k]
            ^ TE0[((s0 >> 24) as u8) as usize]
            ^ TE1[((s1 >> 16) as u8) as usize]
            ^ TE2[((s2 >> 8) as u8) as usize]
            ^ TE3[((s3) as u8) as usize];
        t1 = xk[k + 1]
            ^ TE0[((s1 >> 24) as u8) as usize]
            ^ TE1[((s2 >> 16) as u8) as usize]
            ^ TE2[((s3 >> 8) as u8) as usize]
            ^ TE3[((s0) as u8) as usize];
        t2 = xk[k + 2]
            ^ TE0[((s2 >> 24) as u8) as usize]
            ^ TE1[((s3 >> 16) as u8) as usize]
            ^ TE2[((s0 >> 8) as u8) as usize]
            ^ TE3[((s1) as u8) as usize];
        t3 = xk[k + 3]
            ^ TE0[((s3 >> 24) as u8) as usize]
            ^ TE1[((s0 >> 16) as u8) as usize]
            ^ TE2[((s1 >> 8) as u8) as usize]
            ^ TE3[((s2) as u8) as usize];
        k += 4;
        (s0, s1, s2, s3) = (t0, t1, t2, t3);
        r += 1;
        if r == nr {
            break;
        }
    }

    // Last round uses s-box directly and XORs to produce output.
    s0 = (((SBOX0[(t0 >> 24) as usize]) as u32) << 24)
        | ((SBOX0[((t1 >> 16) & 0xff) as usize] as u32) << 16)
        | ((SBOX0[((t2 >> 8) & 0xff) as usize] as u32) << 8)
        | (SBOX0[(t3 & 0xff) as usize] as u32);
    s1 = (((SBOX0[(t1 >> 24) as usize]) as u32) << 24)
        | ((SBOX0[((t2 >> 16) & 0xff) as usize] as u32) << 16)
        | ((SBOX0[((t3 >> 8) & 0xff) as usize] as u32) << 8)
        | (SBOX0[(t0 & 0xff) as usize] as u32);
    s2 = (((SBOX0[(t2 >> 24) as usize]) as u32) << 24)
        | ((SBOX0[((t3 >> 16) & 0xff) as usize] as u32) << 16)
        | ((SBOX0[((t0 >> 8) & 0xff) as usize] as u32) << 8)
        | (SBOX0[(t1 & 0xff) as usize] as u32);
    s3 = (((SBOX0[(t3 >> 24) as usize]) as u32) << 24)
        | ((SBOX0[((t0 >> 16) & 0xff) as usize] as u32) << 16)
        | ((SBOX0[((t1 >> 8) & 0xff) as usize] as u32) << 8)
        | (SBOX0[(t2 & 0xff) as usize] as u32);

    s0 ^= xk[k];
    s1 ^= xk[k + 1];
    s2 ^= xk[k + 2];
    s3 ^= xk[k + 3];

    assert!(buffer.len() >= 16); // bounds check
    binary::BIG_ENDIAN.put_uint32(&mut buffer[0..4], s0);
    binary::BIG_ENDIAN.put_uint32(&mut buffer[4..8], s1);
    binary::BIG_ENDIAN.put_uint32(&mut buffer[8..12], s2);
    binary::BIG_ENDIAN.put_uint32(&mut buffer[12..16], s3);
}

/// decrypt one block from src into dst, using the expanded key xk.
pub fn decrypt_block_go(xk: &[u32], dst: &mut [u8], src: &[u8]) {
    assert!(src.len() >= 16); // bounds check
    let mut s0 = binary::BIG_ENDIAN.uint32(&src[0..4]);
    let mut s1 = binary::BIG_ENDIAN.uint32(&src[4..8]);
    let mut s2 = binary::BIG_ENDIAN.uint32(&src[8..12]);
    let mut s3 = binary::BIG_ENDIAN.uint32(&src[12..16]);

    // First round just XORs input with key.
    s0 ^= xk[0];
    s1 ^= xk[1];
    s2 ^= xk[2];
    s3 ^= xk[3];

    // Middle rounds shuffle using tables.
    // Number of rounds is set by length of expanded key.
    let nr = xk.len() / 4 - 2; // - 2: one above, one more below
    let mut k = 4;
    let mut t0: u32;
    let mut t1: u32;
    let mut t2: u32;
    let mut t3: u32;
    let mut r = 0;
    loop {
        t0 = xk[k]
            ^ TD0[((s0 >> 24) as u8) as usize]
            ^ TD1[((s3 >> 16) as u8) as usize]
            ^ TD2[((s2 >> 8) as u8) as usize]
            ^ TD3[((s1) as u8) as usize];
        t1 = xk[k + 1]
            ^ TD0[((s1 >> 24) as u8) as usize]
            ^ TD1[((s0 >> 16) as u8) as usize]
            ^ TD2[((s3 >> 8) as u8) as usize]
            ^ TD3[((s2) as u8) as usize];
        t2 = xk[k + 2]
            ^ TD0[((s2 >> 24) as u8) as usize]
            ^ TD1[((s1 >> 16) as u8) as usize]
            ^ TD2[((s0 >> 8) as u8) as usize]
            ^ TD3[((s3) as u8) as usize];
        t3 = xk[k + 3]
            ^ TD0[((s3 >> 24) as u8) as usize]
            ^ TD1[((s2 >> 16) as u8) as usize]
            ^ TD2[((s1 >> 8) as u8) as usize]
            ^ TD3[((s0) as u8) as usize];
        k += 4;
        (s0, s1, s2, s3) = (t0, t1, t2, t3);
        r += 1;
        if r == nr {
            break;
        }
    }

    // Last round uses s-box directly and XORs to produce output.
    s0 = (((SBOX1[(t0 >> 24) as usize]) as u32) << 24)
        | ((SBOX1[((t3 >> 16) & 0xff) as usize] as u32) << 16)
        | ((SBOX1[((t2 >> 8) & 0xff) as usize] as u32) << 8)
        | (SBOX1[(t1 & 0xff) as usize] as u32);
    s1 = (((SBOX1[(t1 >> 24) as usize]) as u32) << 24)
        | ((SBOX1[((t0 >> 16) & 0xff) as usize] as u32) << 16)
        | ((SBOX1[((t3 >> 8) & 0xff) as usize] as u32) << 8)
        | (SBOX1[(t2 & 0xff) as usize] as u32);
    s2 = (((SBOX1[(t2 >> 24) as usize]) as u32) << 24)
        | ((SBOX1[((t1 >> 16) & 0xff) as usize] as u32) << 16)
        | ((SBOX1[((t0 >> 8) & 0xff) as usize] as u32) << 8)
        | (SBOX1[(t3 & 0xff) as usize] as u32);
    s3 = (((SBOX1[(t3 >> 24) as usize]) as u32) << 24)
        | ((SBOX1[((t2 >> 16) & 0xff) as usize] as u32) << 16)
        | ((SBOX1[((t1 >> 8) & 0xff) as usize] as u32) << 8)
        | (SBOX1[(t0 & 0xff) as usize] as u32);

    s0 ^= xk[k];
    s1 ^= xk[k + 1];
    s2 ^= xk[k + 2];
    s3 ^= xk[k + 3];

    assert!(dst.len() >= 16); // bounds check
    binary::BIG_ENDIAN.put_uint32(&mut dst[0..4], s0);
    binary::BIG_ENDIAN.put_uint32(&mut dst[4..8], s1);
    binary::BIG_ENDIAN.put_uint32(&mut dst[8..12], s2);
    binary::BIG_ENDIAN.put_uint32(&mut dst[12..16], s3);
}

/// decrypt one block in the buffer, using the expanded key xk.
pub fn decrypt_block_inplace_go(xk: &[u32], buffer: &mut [u8]) {
    assert!(buffer.len() >= 16); // bounds check
    let mut s0 = binary::BIG_ENDIAN.uint32(&buffer[0..4]);
    let mut s1 = binary::BIG_ENDIAN.uint32(&buffer[4..8]);
    let mut s2 = binary::BIG_ENDIAN.uint32(&buffer[8..12]);
    let mut s3 = binary::BIG_ENDIAN.uint32(&buffer[12..16]);

    // First round just XORs input with key.
    s0 ^= xk[0];
    s1 ^= xk[1];
    s2 ^= xk[2];
    s3 ^= xk[3];

    // Middle rounds shuffle using tables.
    // Number of rounds is set by length of expanded key.
    let nr = xk.len() / 4 - 2; // - 2: one above, one more below
    let mut k = 4;
    let mut t0: u32;
    let mut t1: u32;
    let mut t2: u32;
    let mut t3: u32;
    let mut r = 0;
    loop {
        t0 = xk[k]
            ^ TD0[((s0 >> 24) as u8) as usize]
            ^ TD1[((s3 >> 16) as u8) as usize]
            ^ TD2[((s2 >> 8) as u8) as usize]
            ^ TD3[((s1) as u8) as usize];
        t1 = xk[k + 1]
            ^ TD0[((s1 >> 24) as u8) as usize]
            ^ TD1[((s0 >> 16) as u8) as usize]
            ^ TD2[((s3 >> 8) as u8) as usize]
            ^ TD3[((s2) as u8) as usize];
        t2 = xk[k + 2]
            ^ TD0[((s2 >> 24) as u8) as usize]
            ^ TD1[((s1 >> 16) as u8) as usize]
            ^ TD2[((s0 >> 8) as u8) as usize]
            ^ TD3[((s3) as u8) as usize];
        t3 = xk[k + 3]
            ^ TD0[((s3 >> 24) as u8) as usize]
            ^ TD1[((s2 >> 16) as u8) as usize]
            ^ TD2[((s1 >> 8) as u8) as usize]
            ^ TD3[((s0) as u8) as usize];
        k += 4;
        (s0, s1, s2, s3) = (t0, t1, t2, t3);
        r += 1;
        if r == nr {
            break;
        }
    }

    // Last round uses s-box directly and XORs to produce output.
    s0 = (((SBOX1[(t0 >> 24) as usize]) as u32) << 24)
        | ((SBOX1[((t3 >> 16) & 0xff) as usize] as u32) << 16)
        | ((SBOX1[((t2 >> 8) & 0xff) as usize] as u32) << 8)
        | (SBOX1[(t1 & 0xff) as usize] as u32);
    s1 = (((SBOX1[(t1 >> 24) as usize]) as u32) << 24)
        | ((SBOX1[((t0 >> 16) & 0xff) as usize] as u32) << 16)
        | ((SBOX1[((t3 >> 8) & 0xff) as usize] as u32) << 8)
        | (SBOX1[(t2 & 0xff) as usize] as u32);
    s2 = (((SBOX1[(t2 >> 24) as usize]) as u32) << 24)
        | ((SBOX1[((t1 >> 16) & 0xff) as usize] as u32) << 16)
        | ((SBOX1[((t0 >> 8) & 0xff) as usize] as u32) << 8)
        | (SBOX1[(t3 & 0xff) as usize] as u32);
    s3 = (((SBOX1[(t3 >> 24) as usize]) as u32) << 24)
        | ((SBOX1[((t2 >> 16) & 0xff) as usize] as u32) << 16)
        | ((SBOX1[((t1 >> 8) & 0xff) as usize] as u32) << 8)
        | (SBOX1[(t0 & 0xff) as usize] as u32);

    s0 ^= xk[k];
    s1 ^= xk[k + 1];
    s2 ^= xk[k + 2];
    s3 ^= xk[k + 3];

    assert!(buffer.len() >= 16); // bounds check
    binary::BIG_ENDIAN.put_uint32(&mut buffer[0..4], s0);
    binary::BIG_ENDIAN.put_uint32(&mut buffer[4..8], s1);
    binary::BIG_ENDIAN.put_uint32(&mut buffer[8..12], s2);
    binary::BIG_ENDIAN.put_uint32(&mut buffer[12..16], s3);
}

/// Apply sbox0 to each byte in w.
fn subw(w: u32) -> u32 {
    ((SBOX0[(w >> 24) as usize]) as u32) << 24
        | (SBOX0[((w >> 16) & 0xff) as usize] as u32) << 16
        | (SBOX0[((w >> 8) & 0xff) as usize] as u32) << 8
        | ((SBOX0[(w & 0xff) as usize]) as u32)
}

/// Rotate
fn rotw(w: u32) -> u32 {
    (w << 8) | (w >> 24)
}

/// Key expansion algorithm. See FIPS-197, Figure 11.
/// Their rcon[i] is our powx[i-1] << 24.
pub fn expand_key_go(key: &[u8], enc: &mut [u32], dec: &mut [u32]) {
    // Encryption key setup.
    // 	var i int
    let nk = key.len() / 4;
    for i in 0..nk {
        enc[i] = binary::BIG_ENDIAN.uint32(&key[4 * i..]);
    }
    for i in nk..enc.len() {
        let mut t = enc[i - 1];
        if i % nk == 0 {
            t = subw(rotw(t)) ^ ((POWX[i / nk - 1] as u32) << 24);
        } else if nk > 6 && i % nk == 4 {
            t = subw(t);
        }
        enc[i] = enc[i - nk] ^ t;
    }

    // Derive decryption key from encryption key.
    // Reverse the 4-word round key sets from enc to produce dec.
    // All sets but the first and last get the MixColumn transform applied.
    // 	if dec == nil {
    // 		return
    // 	}
    let n = enc.len();
    for i in (0..n).step_by(4) {
        let ei = n - i - 4;
        for j in 0..4 {
            let mut x = enc[ei + j];
            if i > 0 && i + 4 < n {
                x = TD0[SBOX0[(x >> 24) as usize] as usize]
                    ^ TD1[SBOX0[((x >> 16) & 0xff) as usize] as usize]
                    ^ TD2[SBOX0[((x >> 8) & 0xff) as usize] as usize]
                    ^ TD3[SBOX0[(x & 0xff) as usize] as usize];
            }
            dec[i + j] = x;
        }
    }
}