-
Notifications
You must be signed in to change notification settings - Fork 329
/
compatibility.rs
1112 lines (1035 loc) · 43.5 KB
/
compatibility.rs
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
use std::collections::BTreeSet;
use std::collections::HashSet;
use wasmer::wasmparser::Import;
use wasmer::wasmparser::TypeRef;
use crate::capabilities::required_capabilities_from_module;
use crate::config::WasmLimits;
use crate::errors::{VmError, VmResult};
use crate::limited::LimitedDisplay;
use crate::parsed_wasm::ParsedWasm;
use crate::static_analysis::ExportInfo;
/// Lists all imports we provide upon instantiating the instance in Instance::from_module()
/// This should be updated when new imports are added
const SUPPORTED_IMPORTS: &[&str] = &[
"env.abort",
"env.db_read",
"env.db_write",
"env.db_remove",
"env.addr_validate",
"env.addr_canonicalize",
"env.addr_humanize",
"env.bls12_381_aggregate_g1",
"env.bls12_381_aggregate_g2",
"env.bls12_381_pairing_equality",
"env.bls12_381_hash_to_g1",
"env.bls12_381_hash_to_g2",
"env.secp256k1_verify",
"env.secp256k1_recover_pubkey",
"env.secp256r1_verify",
"env.secp256r1_recover_pubkey",
"env.ed25519_verify",
"env.ed25519_batch_verify",
"env.debug",
"env.query_chain",
#[cfg(feature = "iterator")]
"env.db_scan",
#[cfg(feature = "iterator")]
"env.db_next",
#[cfg(feature = "iterator")]
"env.db_next_key",
#[cfg(feature = "iterator")]
"env.db_next_value",
];
/// Lists all entry points we expect to be present when calling a contract.
/// Other optional exports exist, e.g. "execute", "migrate" and "query".
/// The marker export interface_version_* is checked separately.
/// This is unlikely to change much, must be frozen at 1.0 to avoid breaking existing contracts
const REQUIRED_EXPORTS: &[&str] = &[
// IO
"allocate",
"deallocate",
];
const INTERFACE_VERSION_PREFIX: &str = "interface_version_";
const SUPPORTED_INTERFACE_VERSIONS: &[&str] = &["interface_version_8"];
#[derive(Clone, Copy)]
pub enum LogOutput {
StdOut,
StdErr,
}
#[derive(Clone, Copy, Default)]
pub enum Logger<'a> {
On {
prefix: &'a str,
output: LogOutput,
},
#[default]
Off,
}
impl<'a> Logger<'a> {
pub fn with_config(output: LogOutput, prefix: &'a str) -> Self {
On { output, prefix }
}
/// Adds a message to the logs, if they are enabled.
/// This is a convenience method for adding a single message.
///
/// Takes a closure that returns the message to add to avoid unnecessary allocations.
pub fn add(&self, msg_fn: impl FnOnce() -> String) {
if let On { prefix, output } = &self {
let msg = msg_fn();
match output {
LogOutput::StdOut => println!("{prefix}{msg}"),
LogOutput::StdErr => eprintln!("{prefix}{msg}"),
}
}
}
}
use Logger::*;
/// Checks if the data is valid wasm and compatibility with the CosmWasm API (imports and exports)
pub fn check_wasm(
wasm_code: &[u8],
available_capabilities: &HashSet<String>,
limits: &WasmLimits,
logs: Logger<'_>,
) -> VmResult<()> {
logs.add(|| format!("Size of Wasm blob: {}", wasm_code.len()));
let mut module = ParsedWasm::parse(wasm_code)?;
check_wasm_tables(&module, limits)?;
check_wasm_memories(&module, limits)?;
check_interface_version(&module)?;
check_wasm_exports(&module, logs)?;
check_wasm_imports(&module, SUPPORTED_IMPORTS, limits, logs)?;
check_wasm_capabilities(&module, available_capabilities, logs)?;
check_wasm_functions(&module, limits, logs)?;
module.validate_funcs()
}
fn check_wasm_tables(module: &ParsedWasm, wasm_limits: &WasmLimits) -> VmResult<()> {
match module.tables.len() {
0 => Ok(()),
1 => {
let limits = &module.tables[0];
if let Some(maximum) = limits.maximum {
if maximum > wasm_limits.table_size_limit() {
return Err(VmError::static_validation_err(
"Wasm contract's first table section has a too large max limit",
));
}
Ok(())
} else {
Err(VmError::static_validation_err(
"Wasm contract must not have unbound table section",
))
}
}
_ => Err(VmError::static_validation_err(
"Wasm contract must not have more than 1 table section",
)),
}
}
fn check_wasm_memories(module: &ParsedWasm, limits: &WasmLimits) -> VmResult<()> {
if module.memories.len() != 1 {
return Err(VmError::static_validation_err(
"Wasm contract must contain exactly one memory",
));
}
let memory = &module.memories[0];
if memory.initial > limits.initial_memory_limit() as u64 {
return Err(VmError::static_validation_err(format!(
"Wasm contract memory's minimum must not exceed {} pages.",
limits.initial_memory_limit()
)));
}
if memory.maximum.is_some() {
return Err(VmError::static_validation_err(
"Wasm contract memory's maximum must be unset. The host will set it for you.",
));
}
Ok(())
}
fn check_interface_version(module: &ParsedWasm) -> VmResult<()> {
let mut interface_version_exports = module
.exported_function_names(Some(INTERFACE_VERSION_PREFIX))
.into_iter();
if let Some(first_interface_version_export) = interface_version_exports.next() {
if interface_version_exports.next().is_some() {
Err(VmError::static_validation_err(
"Wasm contract contains more than one marker export: interface_version_*",
))
} else {
// Exactly one interface version found
let version_str = first_interface_version_export.as_str();
if SUPPORTED_INTERFACE_VERSIONS
.iter()
.any(|&v| v == version_str)
{
Ok(())
} else {
Err(VmError::static_validation_err(
"Wasm contract has unknown interface_version_* marker export (see https://github.com/CosmWasm/cosmwasm/blob/main/packages/vm/README.md)",
))
}
}
} else {
Err(VmError::static_validation_err(
"Wasm contract missing a required marker export: interface_version_*",
))
}
}
fn check_wasm_exports(module: &ParsedWasm, logs: Logger) -> VmResult<()> {
let available_exports: HashSet<String> = module.exported_function_names(None);
logs.add(|| format!("Exports: {}", available_exports.to_string_limited(20_000)));
for required_export in REQUIRED_EXPORTS {
if !available_exports.contains(*required_export) {
return Err(VmError::static_validation_err(format!(
"Wasm contract doesn't have required export: \"{required_export}\". Exports required by VM: {REQUIRED_EXPORTS:?}."
)));
}
}
Ok(())
}
/// Checks if the import requirements of the contract are satisfied.
/// When this is not the case, we either have an incompatibility between contract and VM
/// or a error in the contract.
fn check_wasm_imports(
module: &ParsedWasm,
supported_imports: &[&str],
limits: &WasmLimits,
logs: Logger,
) -> VmResult<()> {
logs.add(|| {
format!(
"Imports ({}): {}",
module.imports.len(),
module
.imports
.iter()
.map(|import| full_import_name(import))
.collect::<Vec<_>>()
.join(", ")
)
});
if module.imports.len() > limits.max_imports() {
return Err(VmError::static_validation_err(format!(
"Import count exceeds limit. Imports: {}. Limit: {}.",
module.imports.len(),
limits.max_imports()
)));
}
for required_import in &module.imports {
let full_name = full_import_name(required_import);
if !supported_imports.contains(&full_name.as_str()) {
let required_import_names: BTreeSet<_> =
module.imports.iter().map(full_import_name).collect();
return Err(VmError::static_validation_err(format!(
"Wasm contract requires unsupported import: \"{}\". Required imports: {}. Available imports: {:?}.",
full_name, required_import_names.to_string_limited(200), supported_imports
)));
}
match required_import.ty {
TypeRef::Func(_) => {} // ok
_ => return Err(VmError::static_validation_err(format!(
"Wasm contract requires non-function import: \"{full_name}\". Right now, all supported imports are functions."
)))
}
}
Ok(())
}
fn full_import_name(ie: &Import) -> String {
format!("{}.{}", ie.module, ie.name)
}
fn check_wasm_capabilities(
module: &ParsedWasm,
available_capabilities: &HashSet<String>,
logs: Logger,
) -> VmResult<()> {
let required_capabilities = required_capabilities_from_module(module);
logs.add(|| {
format!(
"Required capabilities: {}",
required_capabilities.to_string_limited(20_000)
)
});
if !required_capabilities.is_subset(available_capabilities) {
// We switch to BTreeSet to get a sorted error message
let unavailable: BTreeSet<_> = required_capabilities
.difference(available_capabilities)
.collect();
return Err(VmError::static_validation_err(format!(
"Wasm contract requires unavailable capabilities: {}",
unavailable.to_string_limited(200)
)));
}
Ok(())
}
fn check_wasm_functions(module: &ParsedWasm, limits: &WasmLimits, logs: Logger) -> VmResult<()> {
logs.add(|| format!("Function count: {}", module.function_count));
logs.add(|| format!("Max function parameters: {}", module.max_func_params));
logs.add(|| format!("Max function results: {}", module.max_func_results));
logs.add(|| {
format!(
"Total function parameter count: {}",
module.total_func_params
)
});
if module.function_count > limits.max_functions() {
return Err(VmError::static_validation_err(format!(
"Wasm contract contains more than {} functions",
limits.max_functions()
)));
}
if module.max_func_params > limits.max_function_params() {
return Err(VmError::static_validation_err(format!(
"Wasm contract contains function with more than {} parameters",
limits.max_function_params()
)));
}
if module.max_func_results > limits.max_function_results() {
return Err(VmError::static_validation_err(format!(
"Wasm contract contains function with more than {} results",
limits.max_function_results()
)));
}
if module.total_func_params > limits.max_total_function_params() {
return Err(VmError::static_validation_err(format!(
"Wasm contract contains more than {} function parameters in total",
limits.max_total_function_params()
)));
}
Ok(())
}
#[cfg(test)]
mod tests {
use super::*;
use crate::capabilities_from_csv;
static CONTRACT_0_7: &[u8] = include_bytes!("../testdata/hackatom_0.7.wasm");
static CONTRACT_0_12: &[u8] = include_bytes!("../testdata/hackatom_0.12.wasm");
static CONTRACT_0_14: &[u8] = include_bytes!("../testdata/hackatom_0.14.wasm");
static CONTRACT_0_15: &[u8] = include_bytes!("../testdata/hackatom_0.15.wasm");
static CONTRACT: &[u8] = include_bytes!("../testdata/hackatom.wasm");
static CYBERPUNK: &[u8] = include_bytes!("../testdata/cyberpunk.wasm");
static CONTRACT_RUST_170: &[u8] = include_bytes!("../testdata/cyberpunk_rust170.wasm");
fn default_capabilities() -> HashSet<String> {
capabilities_from_csv("cosmwasm_1_1,cosmwasm_1_2,cosmwasm_1_3,iterator,staking,stargate")
}
#[test]
fn check_wasm_passes_for_latest_contract() {
// this is our reference check, must pass
check_wasm(
CONTRACT,
&default_capabilities(),
&WasmLimits::default(),
Off,
)
.unwrap();
check_wasm(
CYBERPUNK,
&default_capabilities(),
&WasmLimits::default(),
Off,
)
.unwrap();
}
#[test]
fn check_wasm_allows_sign_ext() {
// See https://github.com/CosmWasm/cosmwasm/issues/1727
check_wasm(
CONTRACT_RUST_170,
&default_capabilities(),
&WasmLimits::default(),
Off,
)
.unwrap();
}
#[test]
fn check_wasm_old_contract() {
match check_wasm(CONTRACT_0_15, &default_capabilities(),&WasmLimits::default(),
Off) {
Err(VmError::StaticValidationErr { msg, .. }) => assert_eq!(
msg,
"Wasm contract has unknown interface_version_* marker export (see https://github.com/CosmWasm/cosmwasm/blob/main/packages/vm/README.md)"
),
Err(e) => panic!("Unexpected error {e:?}"),
Ok(_) => panic!("This must not succeed"),
};
match check_wasm(CONTRACT_0_14, &default_capabilities(),&WasmLimits::default(),
Off,) {
Err(VmError::StaticValidationErr { msg, .. }) => assert_eq!(
msg,
"Wasm contract has unknown interface_version_* marker export (see https://github.com/CosmWasm/cosmwasm/blob/main/packages/vm/README.md)"
),
Err(e) => panic!("Unexpected error {e:?}"),
Ok(_) => panic!("This must not succeed"),
};
match check_wasm(
CONTRACT_0_12,
&default_capabilities(),
&WasmLimits::default(),
Off,
) {
Err(VmError::StaticValidationErr { msg, .. }) => {
assert!(msg.contains(
"Wasm contract missing a required marker export: interface_version_*"
))
}
Err(e) => panic!("Unexpected error {e:?}"),
Ok(_) => panic!("This must not succeed"),
};
match check_wasm(
CONTRACT_0_7,
&default_capabilities(),
&WasmLimits::default(),
Off,
) {
Err(VmError::StaticValidationErr { msg, .. }) => {
assert!(msg.contains(
"Wasm contract missing a required marker export: interface_version_*"
))
}
Err(e) => panic!("Unexpected error {e:?}"),
Ok(_) => panic!("This must not succeed"),
};
}
#[test]
fn check_wasm_tables_works() {
let limits = WasmLimits::default();
// No tables is fine
let wasm = wat::parse_str("(module)").unwrap();
assert!(ParsedWasm::parse(&wasm).unwrap().tables.is_empty());
// One table (bound)
let wasm = wat::parse_str("(module (table $name 123 123 funcref))").unwrap();
check_wasm_tables(&ParsedWasm::parse(&wasm).unwrap(), &limits).unwrap();
// One table (bound, initial > max)
let wasm = wat::parse_str("(module (table $name 124 123 funcref))").unwrap();
// this should be caught by the validator
let err = &ParsedWasm::parse(&wasm).unwrap_err();
assert!(err
.to_string()
.contains("size minimum must not be greater than maximum"));
// One table (bound, max too large)
let wasm = wat::parse_str("(module (table $name 100 9999 funcref))").unwrap();
let err = check_wasm_tables(&ParsedWasm::parse(&wasm).unwrap(), &limits).unwrap_err();
assert!(err
.to_string()
.contains("Wasm contract's first table section has a too large max limit"));
// One table (unbound)
let wasm = wat::parse_str("(module (table $name 100 funcref))").unwrap();
let err = check_wasm_tables(&ParsedWasm::parse(&wasm).unwrap(), &limits).unwrap_err();
assert!(err
.to_string()
.contains("Wasm contract must not have unbound table section"));
}
#[test]
fn check_wasm_memories_ok() {
let wasm = wat::parse_str("(module (memory 1))").unwrap();
check_wasm_memories(&ParsedWasm::parse(&wasm).unwrap(), &WasmLimits::default()).unwrap()
}
#[test]
fn check_wasm_memories_no_memory() {
let limits = WasmLimits::default();
let wasm = wat::parse_str("(module)").unwrap();
match check_wasm_memories(&ParsedWasm::parse(&wasm).unwrap(), &limits) {
Err(VmError::StaticValidationErr { msg, .. }) => {
assert!(msg.starts_with("Wasm contract must contain exactly one memory"));
}
Err(e) => panic!("Unexpected error {e:?}"),
Ok(_) => panic!("Didn't reject wasm with invalid api"),
}
}
#[test]
fn check_wasm_memories_two_memories() {
// Generated manually because wat2wasm protects us from creating such Wasm:
// "error: only one memory block allowed"
let wasm = hex::decode(concat!(
"0061736d", // magic bytes
"01000000", // binary version (uint32)
"05", // section type (memory)
"05", // section length
"02", // number of memories
"0009", // element of type "resizable_limits", min=9, max=unset
"0009", // element of type "resizable_limits", min=9, max=unset
))
.unwrap();
// wrong number of memories should be caught by the validator
match ParsedWasm::parse(&wasm) {
Err(VmError::StaticValidationErr { msg, .. }) => {
assert!(msg.contains("multiple memories"));
}
Err(e) => panic!("Unexpected error {e:?}"),
Ok(_) => panic!("Didn't reject wasm with invalid api"),
}
}
#[test]
fn check_wasm_memories_zero_memories() {
// Generated manually because wat2wasm would not create an empty memory section
let wasm = hex::decode(concat!(
"0061736d", // magic bytes
"01000000", // binary version (uint32)
"05", // section type (memory)
"01", // section length
"00", // number of memories
))
.unwrap();
match check_wasm_memories(&ParsedWasm::parse(&wasm).unwrap(), &WasmLimits::default()) {
Err(VmError::StaticValidationErr { msg, .. }) => {
assert!(msg.starts_with("Wasm contract must contain exactly one memory"));
}
Err(e) => panic!("Unexpected error {e:?}"),
Ok(_) => panic!("Didn't reject wasm with invalid api"),
}
}
#[test]
fn check_wasm_memories_initial_size() {
let limits = WasmLimits::default();
let wasm_ok = wat::parse_str("(module (memory 512))").unwrap();
check_wasm_memories(&ParsedWasm::parse(&wasm_ok).unwrap(), &limits).unwrap();
let wasm_too_big = wat::parse_str("(module (memory 513))").unwrap();
match check_wasm_memories(&ParsedWasm::parse(&wasm_too_big).unwrap(), &limits) {
Err(VmError::StaticValidationErr { msg, .. }) => {
assert!(msg.starts_with("Wasm contract memory's minimum must not exceed 512 pages"));
}
Err(e) => panic!("Unexpected error {e:?}"),
Ok(_) => panic!("Didn't reject wasm with invalid api"),
}
}
#[test]
fn check_wasm_memories_maximum_size() {
let wasm_max = wat::parse_str("(module (memory 1 5))").unwrap();
match check_wasm_memories(
&ParsedWasm::parse(&wasm_max).unwrap(),
&WasmLimits::default(),
) {
Err(VmError::StaticValidationErr { msg, .. }) => {
assert!(msg.starts_with("Wasm contract memory's maximum must be unset"));
}
Err(e) => panic!("Unexpected error {e:?}"),
Ok(_) => panic!("Didn't reject wasm with invalid api"),
}
}
#[test]
fn check_interface_version_works() {
// valid
let wasm = wat::parse_str(
r#"(module
(type (func))
(func (type 0) nop)
(export "add_one" (func 0))
(export "allocate" (func 0))
(export "interface_version_8" (func 0))
(export "deallocate" (func 0))
(export "instantiate" (func 0))
)"#,
)
.unwrap();
let module = ParsedWasm::parse(&wasm).unwrap();
check_interface_version(&module).unwrap();
// missing
let wasm = wat::parse_str(
r#"(module
(type (func))
(func (type 0) nop)
(export "add_one" (func 0))
(export "allocate" (func 0))
(export "deallocate" (func 0))
(export "instantiate" (func 0))
)"#,
)
.unwrap();
let module = ParsedWasm::parse(&wasm).unwrap();
match check_interface_version(&module).unwrap_err() {
VmError::StaticValidationErr { msg, .. } => {
assert_eq!(
msg,
"Wasm contract missing a required marker export: interface_version_*"
);
}
err => panic!("Unexpected error {err:?}"),
}
// multiple
let wasm = wat::parse_str(
r#"(module
(type (func))
(func (type 0) nop)
(export "add_one" (func 0))
(export "allocate" (func 0))
(export "interface_version_8" (func 0))
(export "interface_version_9" (func 0))
(export "deallocate" (func 0))
(export "instantiate" (func 0))
)"#,
)
.unwrap();
let module = ParsedWasm::parse(&wasm).unwrap();
match check_interface_version(&module).unwrap_err() {
VmError::StaticValidationErr { msg, .. } => {
assert_eq!(
msg,
"Wasm contract contains more than one marker export: interface_version_*"
);
}
err => panic!("Unexpected error {err:?}"),
}
// CosmWasm 0.15
let wasm = wat::parse_str(
r#"(module
(type (func))
(func (type 0) nop)
(export "add_one" (func 0))
(export "allocate" (func 0))
(export "interface_version_6" (func 0))
(export "deallocate" (func 0))
(export "instantiate" (func 0))
)"#,
)
.unwrap();
let module = ParsedWasm::parse(&wasm).unwrap();
match check_interface_version(&module).unwrap_err() {
VmError::StaticValidationErr { msg, .. } => {
assert_eq!(msg, "Wasm contract has unknown interface_version_* marker export (see https://github.com/CosmWasm/cosmwasm/blob/main/packages/vm/README.md)");
}
err => panic!("Unexpected error {err:?}"),
}
// Unknown value
let wasm = wat::parse_str(
r#"(module
(type (func))
(func (type 0) nop)
(export "add_one" (func 0))
(export "allocate" (func 0))
(export "interface_version_broken" (func 0))
(export "deallocate" (func 0))
(export "instantiate" (func 0))
)"#,
)
.unwrap();
let module = ParsedWasm::parse(&wasm).unwrap();
match check_interface_version(&module).unwrap_err() {
VmError::StaticValidationErr { msg, .. } => {
assert_eq!(msg, "Wasm contract has unknown interface_version_* marker export (see https://github.com/CosmWasm/cosmwasm/blob/main/packages/vm/README.md)");
}
err => panic!("Unexpected error {err:?}"),
}
}
#[test]
fn check_wasm_exports_works() {
// valid
let wasm = wat::parse_str(
r#"(module
(type (func))
(func (type 0) nop)
(export "add_one" (func 0))
(export "allocate" (func 0))
(export "deallocate" (func 0))
)"#,
)
.unwrap();
let module = ParsedWasm::parse(&wasm).unwrap();
check_wasm_exports(&module, Off).unwrap();
// this is invalid, as it doesn't any required export
let wasm = wat::parse_str(
r#"(module
(type (func))
(func (type 0) nop)
(export "add_one" (func 0))
)"#,
)
.unwrap();
let module = ParsedWasm::parse(&wasm).unwrap();
match check_wasm_exports(&module, Off) {
Err(VmError::StaticValidationErr { msg, .. }) => {
assert!(msg.starts_with("Wasm contract doesn't have required export: \"allocate\""));
}
Err(e) => panic!("Unexpected error {e:?}"),
Ok(_) => panic!("Didn't reject wasm with invalid api"),
}
// this is invalid, as it doesn't contain all required exports
let wasm = wat::parse_str(
r#"(module
(type (func))
(func (type 0) nop)
(export "add_one" (func 0))
(export "allocate" (func 0))
)"#,
)
.unwrap();
let module = ParsedWasm::parse(&wasm).unwrap();
match check_wasm_exports(&module, Off) {
Err(VmError::StaticValidationErr { msg, .. }) => {
assert!(
msg.starts_with("Wasm contract doesn't have required export: \"deallocate\"")
);
}
Err(e) => panic!("Unexpected error {e:?}"),
Ok(_) => panic!("Didn't reject wasm with invalid api"),
}
}
#[test]
fn check_wasm_imports_ok() {
let wasm = wat::parse_str(
r#"(module
(import "env" "db_read" (func (param i32 i32) (result i32)))
(import "env" "db_write" (func (param i32 i32) (result i32)))
(import "env" "db_remove" (func (param i32) (result i32)))
(import "env" "addr_validate" (func (param i32) (result i32)))
(import "env" "addr_canonicalize" (func (param i32 i32) (result i32)))
(import "env" "addr_humanize" (func (param i32 i32) (result i32)))
(import "env" "secp256k1_verify" (func (param i32 i32 i32) (result i32)))
(import "env" "secp256k1_recover_pubkey" (func (param i32 i32 i32) (result i64)))
(import "env" "secp256r1_verify" (func (param i32 i32 i32) (result i32)))
(import "env" "secp256r1_recover_pubkey" (func (param i32 i32 i32) (result i64)))
(import "env" "ed25519_verify" (func (param i32 i32 i32) (result i32)))
(import "env" "ed25519_batch_verify" (func (param i32 i32 i32) (result i32)))
)"#,
)
.unwrap();
check_wasm_imports(
&ParsedWasm::parse(&wasm).unwrap(),
SUPPORTED_IMPORTS,
&WasmLimits::default(),
Off,
)
.unwrap();
}
#[test]
fn check_wasm_imports_exceeds_limit() {
let wasm = wat::parse_str(
r#"(module
(import "env" "db_write" (func (param i32 i32) (result i32)))
(import "env" "db_remove" (func (param i32) (result i32)))
(import "env" "addr_validate" (func (param i32) (result i32)))
(import "env" "addr_canonicalize" (func (param i32 i32) (result i32)))
(import "env" "addr_humanize" (func (param i32 i32) (result i32)))
(import "env" "secp256k1_verify" (func (param i32 i32 i32) (result i32)))
(import "env" "secp256k1_recover_pubkey" (func (param i32 i32 i32) (result i64)))
(import "env" "secp256r1_verify" (func (param i32 i32 i32) (result i32)))
(import "env" "secp256r1_recover_pubkey" (func (param i32 i32 i32) (result i64)))
(import "env" "ed25519_verify" (func (param i32 i32 i32) (result i32)))
(import "env" "ed25519_batch_verify" (func (param i32 i32 i32) (result i32)))
(import "env" "spam01" (func (param i32 i32) (result i32)))
(import "env" "spam02" (func (param i32 i32) (result i32)))
(import "env" "spam03" (func (param i32 i32) (result i32)))
(import "env" "spam04" (func (param i32 i32) (result i32)))
(import "env" "spam05" (func (param i32 i32) (result i32)))
(import "env" "spam06" (func (param i32 i32) (result i32)))
(import "env" "spam07" (func (param i32 i32) (result i32)))
(import "env" "spam08" (func (param i32 i32) (result i32)))
(import "env" "spam09" (func (param i32 i32) (result i32)))
(import "env" "spam10" (func (param i32 i32) (result i32)))
(import "env" "spam11" (func (param i32 i32) (result i32)))
(import "env" "spam12" (func (param i32 i32) (result i32)))
(import "env" "spam13" (func (param i32 i32) (result i32)))
(import "env" "spam14" (func (param i32 i32) (result i32)))
(import "env" "spam15" (func (param i32 i32) (result i32)))
(import "env" "spam16" (func (param i32 i32) (result i32)))
(import "env" "spam17" (func (param i32 i32) (result i32)))
(import "env" "spam18" (func (param i32 i32) (result i32)))
(import "env" "spam19" (func (param i32 i32) (result i32)))
(import "env" "spam20" (func (param i32 i32) (result i32)))
(import "env" "spam21" (func (param i32 i32) (result i32)))
(import "env" "spam22" (func (param i32 i32) (result i32)))
(import "env" "spam23" (func (param i32 i32) (result i32)))
(import "env" "spam24" (func (param i32 i32) (result i32)))
(import "env" "spam25" (func (param i32 i32) (result i32)))
(import "env" "spam26" (func (param i32 i32) (result i32)))
(import "env" "spam27" (func (param i32 i32) (result i32)))
(import "env" "spam28" (func (param i32 i32) (result i32)))
(import "env" "spam29" (func (param i32 i32) (result i32)))
(import "env" "spam30" (func (param i32 i32) (result i32)))
(import "env" "spam31" (func (param i32 i32) (result i32)))
(import "env" "spam32" (func (param i32 i32) (result i32)))
(import "env" "spam33" (func (param i32 i32) (result i32)))
(import "env" "spam34" (func (param i32 i32) (result i32)))
(import "env" "spam35" (func (param i32 i32) (result i32)))
(import "env" "spam36" (func (param i32 i32) (result i32)))
(import "env" "spam37" (func (param i32 i32) (result i32)))
(import "env" "spam38" (func (param i32 i32) (result i32)))
(import "env" "spam39" (func (param i32 i32) (result i32)))
(import "env" "spam40" (func (param i32 i32) (result i32)))
(import "env" "spam41" (func (param i32 i32) (result i32)))
(import "env" "spam42" (func (param i32 i32) (result i32)))
(import "env" "spam43" (func (param i32 i32) (result i32)))
(import "env" "spam44" (func (param i32 i32) (result i32)))
(import "env" "spam45" (func (param i32 i32) (result i32)))
(import "env" "spam46" (func (param i32 i32) (result i32)))
(import "env" "spam47" (func (param i32 i32) (result i32)))
(import "env" "spam48" (func (param i32 i32) (result i32)))
(import "env" "spam49" (func (param i32 i32) (result i32)))
(import "env" "spam50" (func (param i32 i32) (result i32)))
(import "env" "spam51" (func (param i32 i32) (result i32)))
(import "env" "spam52" (func (param i32 i32) (result i32)))
(import "env" "spam53" (func (param i32 i32) (result i32)))
(import "env" "spam54" (func (param i32 i32) (result i32)))
(import "env" "spam55" (func (param i32 i32) (result i32)))
(import "env" "spam56" (func (param i32 i32) (result i32)))
(import "env" "spam57" (func (param i32 i32) (result i32)))
(import "env" "spam58" (func (param i32 i32) (result i32)))
(import "env" "spam59" (func (param i32 i32) (result i32)))
(import "env" "spam60" (func (param i32 i32) (result i32)))
(import "env" "spam61" (func (param i32 i32) (result i32)))
(import "env" "spam62" (func (param i32 i32) (result i32)))
(import "env" "spam63" (func (param i32 i32) (result i32)))
(import "env" "spam64" (func (param i32 i32) (result i32)))
(import "env" "spam65" (func (param i32 i32) (result i32)))
(import "env" "spam66" (func (param i32 i32) (result i32)))
(import "env" "spam67" (func (param i32 i32) (result i32)))
(import "env" "spam68" (func (param i32 i32) (result i32)))
(import "env" "spam69" (func (param i32 i32) (result i32)))
(import "env" "spam70" (func (param i32 i32) (result i32)))
(import "env" "spam71" (func (param i32 i32) (result i32)))
(import "env" "spam72" (func (param i32 i32) (result i32)))
(import "env" "spam73" (func (param i32 i32) (result i32)))
(import "env" "spam74" (func (param i32 i32) (result i32)))
(import "env" "spam75" (func (param i32 i32) (result i32)))
(import "env" "spam76" (func (param i32 i32) (result i32)))
(import "env" "spam77" (func (param i32 i32) (result i32)))
(import "env" "spam78" (func (param i32 i32) (result i32)))
(import "env" "spam79" (func (param i32 i32) (result i32)))
(import "env" "spam80" (func (param i32 i32) (result i32)))
(import "env" "spam81" (func (param i32 i32) (result i32)))
(import "env" "spam82" (func (param i32 i32) (result i32)))
(import "env" "spam83" (func (param i32 i32) (result i32)))
(import "env" "spam84" (func (param i32 i32) (result i32)))
(import "env" "spam85" (func (param i32 i32) (result i32)))
(import "env" "spam86" (func (param i32 i32) (result i32)))
(import "env" "spam87" (func (param i32 i32) (result i32)))
(import "env" "spam88" (func (param i32 i32) (result i32)))
(import "env" "spam89" (func (param i32 i32) (result i32)))
(import "env" "spam90" (func (param i32 i32) (result i32)))
)"#,
)
.unwrap();
let err = check_wasm_imports(
&ParsedWasm::parse(&wasm).unwrap(),
SUPPORTED_IMPORTS,
&WasmLimits::default(),
Off,
)
.unwrap_err();
match err {
VmError::StaticValidationErr { msg, .. } => {
assert_eq!(msg, "Import count exceeds limit. Imports: 101. Limit: 100.");
}
err => panic!("Unexpected error: {err:?}"),
}
}
#[test]
fn check_wasm_imports_missing() {
let wasm = wat::parse_str(
r#"(module
(import "env" "foo" (func (param i32 i32) (result i32)))
(import "env" "bar" (func (param i32 i32) (result i32)))
(import "env" "spammyspam01" (func (param i32 i32) (result i32)))
(import "env" "spammyspam02" (func (param i32 i32) (result i32)))
(import "env" "spammyspam03" (func (param i32 i32) (result i32)))
(import "env" "spammyspam04" (func (param i32 i32) (result i32)))
(import "env" "spammyspam05" (func (param i32 i32) (result i32)))
(import "env" "spammyspam06" (func (param i32 i32) (result i32)))
(import "env" "spammyspam07" (func (param i32 i32) (result i32)))
(import "env" "spammyspam08" (func (param i32 i32) (result i32)))
(import "env" "spammyspam09" (func (param i32 i32) (result i32)))
(import "env" "spammyspam10" (func (param i32 i32) (result i32)))
)"#,
)
.unwrap();
let supported_imports: &[&str] = &[
"env.db_read",
"env.db_write",
"env.db_remove",
"env.addr_canonicalize",
"env.addr_humanize",
"env.debug",
"env.query_chain",
];
let result = check_wasm_imports(
&ParsedWasm::parse(&wasm).unwrap(),
supported_imports,
&WasmLimits::default(),
Off,
);
match result.unwrap_err() {
VmError::StaticValidationErr { msg, .. } => {
println!("{msg}");
assert_eq!(
msg,
r#"Wasm contract requires unsupported import: "env.foo". Required imports: {"env.bar", "env.foo", "env.spammyspam01", "env.spammyspam02", "env.spammyspam03", "env.spammyspam04", "env.spammyspam05", "env.spammyspam06", "env.spammyspam07", "env.spammyspam08", ... 2 more}. Available imports: ["env.db_read", "env.db_write", "env.db_remove", "env.addr_canonicalize", "env.addr_humanize", "env.debug", "env.query_chain"]."#
);
}
err => panic!("Unexpected error: {err:?}"),
}
}
#[test]
fn check_wasm_imports_of_old_contract() {
let module = &ParsedWasm::parse(CONTRACT_0_7).unwrap();
let result = check_wasm_imports(module, SUPPORTED_IMPORTS, &WasmLimits::default(), Off);
match result.unwrap_err() {
VmError::StaticValidationErr { msg, .. } => {
assert!(
msg.starts_with("Wasm contract requires unsupported import: \"env.read_db\"")
);
}
err => panic!("Unexpected error: {err:?}"),
}
}
#[test]
fn check_wasm_imports_wrong_type() {
let wasm = wat::parse_str(r#"(module (import "env" "db_read" (memory 1 1)))"#).unwrap();
let result = check_wasm_imports(
&ParsedWasm::parse(&wasm).unwrap(),
SUPPORTED_IMPORTS,
&WasmLimits::default(),
Off,
);
match result.unwrap_err() {
VmError::StaticValidationErr { msg, .. } => {
assert!(
msg.starts_with("Wasm contract requires non-function import: \"env.db_read\"")
);
}
err => panic!("Unexpected error: {err:?}"),
}
}
#[test]
fn check_wasm_capabilities_ok() {
let wasm = wat::parse_str(
r#"(module
(type (func))
(func (type 0) nop)
(export "requires_water" (func 0))
(export "requires_" (func 0))
(export "requires_nutrients" (func 0))
(export "require_milk" (func 0))
(export "REQUIRES_air" (func 0))
(export "requires_sun" (func 0))
)"#,
)
.unwrap();
let module = ParsedWasm::parse(&wasm).unwrap();
let available = [
"water".to_string(),
"nutrients".to_string(),
"sun".to_string(),
"freedom".to_string(),
]
.into_iter()
.collect();
check_wasm_capabilities(&module, &available, Off).unwrap();
}
#[test]
fn check_wasm_capabilities_fails_for_missing() {
let wasm = wat::parse_str(
r#"(module
(type (func))
(func (type 0) nop)
(export "requires_water" (func 0))
(export "requires_" (func 0))
(export "requires_nutrients" (func 0))
(export "require_milk" (func 0))
(export "REQUIRES_air" (func 0))
(export "requires_sun" (func 0))
)"#,
)
.unwrap();
let module = ParsedWasm::parse(&wasm).unwrap();