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
// SPDX-License-Identifier: Apache-2.0
// This file is part of Frontier.
//
// Copyright (c) 2020-2022 Parity Technologies (UK) Ltd.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// 	http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.

#![cfg_attr(not(feature = "std"), no_std)]
#![allow(clippy::comparison_chain)]
#![deny(unused_crate_dependencies)]

extern crate alloc;

use alloc::{vec, vec::Vec};
use core::cmp::max;

use num::{BigUint, FromPrimitive, Integer, One, ToPrimitive, Zero};

use fp_evm::{
    ExitError, ExitSucceed, Precompile, PrecompileFailure, PrecompileHandle, PrecompileOutput,
    PrecompileResult,
};

pub struct Modexp;

const MIN_GAS_COST: u64 = 200;

// Calculate gas cost according to EIP 2565:
// https://eips.ethereum.org/EIPS/eip-2565
fn calculate_gas_cost(
    base_length: u64,
    mod_length: u64,
    exponent: &BigUint,
    exponent_bytes: &[u8],
    mod_is_even: bool,
) -> u64 {
    fn calculate_multiplication_complexity(base_length: u64, mod_length: u64) -> u64 {
        let max_length = max(base_length, mod_length);
        let mut words = max_length / 8;
        if max_length % 8 > 0 {
            words += 1;
        }

        // Note: can't overflow because we take words to be some u64 value / 8, which is
        // necessarily less than sqrt(u64::MAX).
        // Additionally, both base_length and mod_length are bounded to 1024, so this has
        // an upper bound of roughly (1024 / 8) squared
        words * words
    }

    fn calculate_iteration_count(exponent: &BigUint, exponent_bytes: &[u8]) -> u64 {
        let mut iteration_count: u64 = 0;
        let exp_length = exponent_bytes.len() as u64;

        if exp_length <= 32 && exponent.is_zero() {
            iteration_count = 0;
        } else if exp_length <= 32 {
            iteration_count = exponent.bits() - 1;
        } else if exp_length > 32 {
            // from the EIP spec:
            // (8 * (exp_length - 32)) + ((exponent & (2**256 - 1)).bit_length() - 1)
            //
            // Notes:
            // * exp_length is bounded to 1024 and is > 32
            // * exponent can be zero, so we subtract 1 after adding the other terms (whose sum
            //   must be > 0)
            // * the addition can't overflow because the terms are both capped at roughly
            //   8 * max size of exp_length (1024)
            // * the EIP spec is written in python, in which (exponent & (2**256 - 1)) takes the
            //   FIRST 32 bytes. However this `BigUint` `&` operator takes the LAST 32 bytes.
            //   We thus instead take the bytes manually.
            let exponent_head = BigUint::from_bytes_be(&exponent_bytes[..32]);

            iteration_count = (8 * (exp_length - 32)) + exponent_head.bits() - 1;
        }

        max(iteration_count, 1)
    }

    let multiplication_complexity = calculate_multiplication_complexity(base_length, mod_length);
    let iteration_count = calculate_iteration_count(exponent, exponent_bytes);
    max(
        MIN_GAS_COST,
        multiplication_complexity * iteration_count / 3,
    )
    .saturating_mul(if mod_is_even { 20 } else { 1 })
}

/// Copy bytes from input to target.
fn read_input(source: &[u8], target: &mut [u8], source_offset: &mut usize) {
    // We move the offset by the len of the target, regardless of what we
    // actually copy.
    let offset = *source_offset;
    *source_offset += target.len();

    // Out of bounds, nothing to copy.
    if source.len() <= offset {
        return
    }

    // Find len to copy up to target len, but not out of bounds.
    let len = core::cmp::min(target.len(), source.len() - offset);
    target[..len].copy_from_slice(&source[offset..][..len]);
}

// ModExp expects the following as inputs:
// 1) 32 bytes expressing the length of base
// 2) 32 bytes expressing the length of exponent
// 3) 32 bytes expressing the length of modulus
// 4) base, size as described above
// 5) exponent, size as described above
// 6) modulus, size as described above
//
//
// NOTE: input sizes are bound to 1024 bytes, with the expectation
//       that gas limits would be applied before actual computation.
//
//       maximum stack size will also prevent abuse.
//
//       see: https://eips.ethereum.org/EIPS/eip-198

impl Precompile for Modexp {
    fn execute(handle: &mut impl PrecompileHandle) -> PrecompileResult {
        let input = handle.input();
        let mut input_offset = 0;

        // Yellowpaper: whenever the input is too short, the missing bytes are
        // considered to be zero.
        let mut base_len_buf = [0u8; 32];
        read_input(input, &mut base_len_buf, &mut input_offset);
        let mut exp_len_buf = [0u8; 32];
        read_input(input, &mut exp_len_buf, &mut input_offset);
        let mut mod_len_buf = [0u8; 32];
        read_input(input, &mut mod_len_buf, &mut input_offset);

        // reasonable assumption: this must fit within the Ethereum EVM's max stack size
        let max_size_big = BigUint::from_u32(1024).expect("can't create BigUint");

        let base_len_big = BigUint::from_bytes_be(&base_len_buf);
        if base_len_big > max_size_big {
            return Err(PrecompileFailure::Error {
                exit_status: ExitError::Other("unreasonably large base length".into()),
            })
        }

        let exp_len_big = BigUint::from_bytes_be(&exp_len_buf);
        if exp_len_big > max_size_big {
            return Err(PrecompileFailure::Error {
                exit_status: ExitError::Other("unreasonably large exponent length".into()),
            })
        }

        let mod_len_big = BigUint::from_bytes_be(&mod_len_buf);
        if mod_len_big > max_size_big {
            return Err(PrecompileFailure::Error {
                exit_status: ExitError::Other("unreasonably large modulus length".into()),
            })
        }

        // bounds check handled above
        let base_len = base_len_big.to_usize().expect("base_len out of bounds");
        let exp_len = exp_len_big.to_usize().expect("exp_len out of bounds");
        let mod_len = mod_len_big.to_usize().expect("mod_len out of bounds");

        // if mod_len is 0 output must be empty
        if mod_len == 0 {
            return Ok(PrecompileOutput {
                exit_status: ExitSucceed::Returned,
                output: vec![],
            })
        }

        // Gas formula allows arbitrary large exp_len when base and modulus are empty, so we need to handle empty base first.
        let r = if base_len == 0 && mod_len == 0 {
            handle.record_cost(MIN_GAS_COST)?;
            BigUint::zero()
        } else {
            // read the numbers themselves.
            let mut base_buf = vec![0u8; base_len];
            read_input(input, &mut base_buf, &mut input_offset);
            let base = BigUint::from_bytes_be(&base_buf);

            let mut exp_buf = vec![0u8; exp_len];
            read_input(input, &mut exp_buf, &mut input_offset);
            let exponent = BigUint::from_bytes_be(&exp_buf);

            let mut mod_buf = vec![0u8; mod_len];
            read_input(input, &mut mod_buf, &mut input_offset);
            let modulus = BigUint::from_bytes_be(&mod_buf);

            // do our gas accounting
            let gas_cost = calculate_gas_cost(
                base_len as u64,
                mod_len as u64,
                &exponent,
                &exp_buf,
                modulus.is_even(),
            );

            handle.record_cost(gas_cost)?;

            if modulus.is_zero() || modulus.is_one() {
                BigUint::zero()
            } else {
                base.modpow(&exponent, &modulus)
            }
        };

        // write output to given memory, left padded and same length as the modulus.
        let bytes = r.to_bytes_be();

        // always true except in the case of zero-length modulus, which leads to
        // output of length and value 1.
        if bytes.len() == mod_len {
            Ok(PrecompileOutput {
                exit_status: ExitSucceed::Returned,
                output: bytes.to_vec(),
            })
        } else if bytes.len() < mod_len {
            let mut ret = Vec::with_capacity(mod_len);
            ret.extend(core::iter::repeat(0).take(mod_len - bytes.len()));
            ret.extend_from_slice(&bytes[..]);
            Ok(PrecompileOutput {
                exit_status: ExitSucceed::Returned,
                output: ret.to_vec(),
            })
        } else {
            Err(PrecompileFailure::Error {
                exit_status: ExitError::Other("failed".into()),
            })
        }
    }
}

#[cfg(test)]
mod tests {
    use super::*;
    extern crate hex;
    use fp_evm::Context;
    use pallet_evm_test_vector_support::{test_precompile_test_vectors, MockHandle};

    #[test]
    fn process_consensus_tests() -> Result<(), String> {
        test_precompile_test_vectors::<Modexp>("../testdata/modexp_eip2565.json")?;
        Ok(())
    }

    #[test]
    fn test_empty_input() {
        let input = Vec::new();

        let cost: u64 = 1;

        let context: Context = Context {
            address: Default::default(),
            caller: Default::default(),
            apparent_value: From::from(0),
        };

        let mut handle = MockHandle::new(input, Some(cost), context);

        match Modexp::execute(&mut handle) {
            Ok(precompile_result) => {
                assert_eq!(precompile_result.output.len(), 0);
            },
            Err(_) => {
                panic!("Modexp::execute() returned error"); // TODO: how to pass error on?
            },
        }
    }

    #[test]
    fn test_insufficient_input() {
        let input = hex::decode(
            "0000000000000000000000000000000000000000000000000000000000000001\
			0000000000000000000000000000000000000000000000000000000000000001\
			0000000000000000000000000000000000000000000000000000000000000001",
        )
        .expect("Decode failed");

        let cost: u64 = 1;

        let context: Context = Context {
            address: Default::default(),
            caller: Default::default(),
            apparent_value: From::from(0),
        };

        let mut handle = MockHandle::new(input, Some(cost), context);

        match Modexp::execute(&mut handle) {
            Ok(precompile_result) => {
                assert_eq!(precompile_result.output.len(), 1);
                assert_eq!(precompile_result.output, vec![0x00]);
            },
            Err(_) => {
                panic!("Modexp::execute() returned error"); // TODO: how to pass error on?
            },
        }
    }

    #[test]
    fn test_excessive_input() -> Result<(), PrecompileFailure> {
        let input = hex::decode(
            "1000000000000000000000000000000000000000000000000000000000000001\
			0000000000000000000000000000000000000000000000000000000000000001\
			0000000000000000000000000000000000000000000000000000000000000001",
        )
        .expect("Decode failed");

        let cost: u64 = 1;

        let context: Context = Context {
            address: Default::default(),
            caller: Default::default(),
            apparent_value: From::from(0),
        };

        let mut handle = MockHandle::new(input, Some(cost), context);

        match Modexp::execute(&mut handle) {
            Ok(_) => {
                panic!("Test not expected to pass");
            },
            Err(e) => {
                assert_eq!(
                    e,
                    PrecompileFailure::Error {
                        exit_status: ExitError::Other("unreasonably large base length".into())
                    }
                );
                Ok(())
            },
        }
    }

    #[test]
    fn test_simple_inputs() {
        let input = hex::decode(
            "0000000000000000000000000000000000000000000000000000000000000001\
			0000000000000000000000000000000000000000000000000000000000000001\
			0000000000000000000000000000000000000000000000000000000000000001\
			03\
			05\
			07",
        )
        .expect("Decode failed");

        // 3 ^ 5 % 7 == 5

        let cost: u64 = 100000;

        let context: Context = Context {
            address: Default::default(),
            caller: Default::default(),
            apparent_value: From::from(0),
        };

        let mut handle = MockHandle::new(input, Some(cost), context);

        match Modexp::execute(&mut handle) {
            Ok(precompile_result) => {
                assert_eq!(precompile_result.output.len(), 1); // should be same length as mod
                let result = BigUint::from_bytes_be(&precompile_result.output[..]);
                let expected = BigUint::parse_bytes(b"5", 10).unwrap();
                assert_eq!(result, expected);
            },
            Err(_) => {
                panic!("Modexp::execute() returned error"); // TODO: how to pass error on?
            },
        }
    }

    #[test]
    fn test_large_inputs() {
        let input = hex::decode(
            "0000000000000000000000000000000000000000000000000000000000000020\
			0000000000000000000000000000000000000000000000000000000000000020\
			0000000000000000000000000000000000000000000000000000000000000020\
			000000000000000000000000000000000000000000000000000000000000EA5F\
			0000000000000000000000000000000000000000000000000000000000000015\
			0000000000000000000000000000000000000000000000000000000000003874",
        )
        .expect("Decode failed");

        // 59999 ^ 21 % 14452 = 10055

        let cost: u64 = 100000;

        let context: Context = Context {
            address: Default::default(),
            caller: Default::default(),
            apparent_value: From::from(0),
        };

        let mut handle = MockHandle::new(input, Some(cost), context);

        match Modexp::execute(&mut handle) {
            Ok(precompile_result) => {
                assert_eq!(precompile_result.output.len(), 32); // should be same length as mod
                let result = BigUint::from_bytes_be(&precompile_result.output[..]);
                let expected = BigUint::parse_bytes(b"10055", 10).unwrap();
                assert_eq!(result, expected);
            },
            Err(_) => {
                panic!("Modexp::execute() returned error"); // TODO: how to pass error on?
            },
        }
    }

    #[test]
    fn test_large_computation() {
        let input = hex::decode(
            "0000000000000000000000000000000000000000000000000000000000000001\
			0000000000000000000000000000000000000000000000000000000000000020\
			0000000000000000000000000000000000000000000000000000000000000020\
			03\
			fffffffffffffffffffffffffffffffffffffffffffffffffffffffefffffc2e\
			fffffffffffffffffffffffffffffffffffffffffffffffffffffffefffffc2f",
        )
        .expect("Decode failed");

        let cost: u64 = 100000;

        let context: Context = Context {
            address: Default::default(),
            caller: Default::default(),
            apparent_value: From::from(0),
        };

        let mut handle = MockHandle::new(input, Some(cost), context);

        match Modexp::execute(&mut handle) {
            Ok(precompile_result) => {
                assert_eq!(precompile_result.output.len(), 32); // should be same length as mod
                let result = BigUint::from_bytes_be(&precompile_result.output[..]);
                let expected = BigUint::parse_bytes(b"1", 10).unwrap();
                assert_eq!(result, expected);
            },
            Err(_) => {
                panic!("Modexp::execute() returned error"); // TODO: how to pass error on?
            },
        }
    }

    #[test]
    fn test_zero_exp_with_33_length() {
        // This is a regression test which ensures that the 'iteration_count' calculation
        // in 'calculate_iteration_count' cannot underflow.
        //
        // In debug mode, this underflow could cause a panic. Otherwise, it causes N**0 to
        // be calculated at more-than-normal expense.
        //
        // TODO: cite security advisory

        let input = vec![
            0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
            0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
            0, 0, 0, 0, 0, 33, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
            0, 0, 0, 0, 0, 0, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
            0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1,
        ];

        let cost: u64 = 100000;

        let context: Context = Context {
            address: Default::default(),
            caller: Default::default(),
            apparent_value: From::from(0),
        };

        let mut handle = MockHandle::new(input, Some(cost), context);

        let precompile_result =
            Modexp::execute(&mut handle).expect("Modexp::execute() returned error");

        assert_eq!(precompile_result.output.len(), 1); // should be same length as mod
        let result = BigUint::from_bytes_be(&precompile_result.output[..]);
        let expected = BigUint::parse_bytes(b"0", 10).unwrap();
        assert_eq!(result, expected);
    }

    #[test]
    fn test_long_exp_gas_cost_matches_specs() {
        let input = vec![
            0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
            0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
            0, 0, 0, 0, 0, 38, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
            0, 0, 0, 0, 0, 0, 0, 0, 96, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
            16, 0, 0, 0, 255, 255, 255, 2, 0, 0, 179, 0, 0, 2, 0, 0, 122, 0, 0, 0, 0, 0, 0, 0, 0,
            0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
            0, 0, 0, 0, 0, 0, 0, 0, 255, 251, 0, 0, 0, 0, 4, 38, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
            0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
            0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
            0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 96, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
            0, 0, 0, 0, 0, 0, 0, 16, 0, 0, 0, 255, 255, 255, 2, 0, 0, 179, 0, 0, 0, 0, 0, 0, 0, 0,
            0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
            0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 255,
            255, 255, 255, 249,
        ];

        let context: Context = Context {
            address: Default::default(),
            caller: Default::default(),
            apparent_value: From::from(0),
        };

        let mut handle = MockHandle::new(input, Some(100_000), context);

        let _ = Modexp::execute(&mut handle).expect("Modexp::execute() returned error");

        assert_eq!(handle.gas_used, 7104 * 20); // gas used when ran in geth (x20)
    }
}