sui_verifier_latest/
private_generics.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
// Copyright (c) Mysten Labs, Inc.
// SPDX-License-Identifier: Apache-2.0

use move_binary_format::{
    file_format::{
        Bytecode, FunctionDefinition, FunctionHandle, FunctionInstantiation, ModuleHandle,
        SignatureToken,
    },
    CompiledModule,
};
use move_bytecode_utils::format_signature_token;
use move_core_types::{account_address::AccountAddress, ident_str, identifier::IdentStr};
use move_vm_config::verifier::VerifierConfig;
use sui_types::{error::ExecutionError, SUI_FRAMEWORK_ADDRESS};

use crate::{verification_failure, TEST_SCENARIO_MODULE_NAME};

pub const TRANSFER_MODULE: &IdentStr = ident_str!("transfer");
pub const EVENT_MODULE: &IdentStr = ident_str!("event");
pub const EVENT_FUNCTION: &IdentStr = ident_str!("emit");
pub const GET_EVENTS_TEST_FUNCTION: &IdentStr = ident_str!("events_by_type");
pub const PUBLIC_TRANSFER_FUNCTIONS: &[&IdentStr] = &[
    ident_str!("public_transfer"),
    ident_str!("public_freeze_object"),
    ident_str!("public_share_object"),
    ident_str!("public_receive"),
    ident_str!("receiving_object_id"),
];
pub const PRIVATE_TRANSFER_FUNCTIONS: &[&IdentStr] = &[
    ident_str!("transfer"),
    ident_str!("freeze_object"),
    ident_str!("share_object"),
    ident_str!("receive"),
];
pub const TRANSFER_IMPL_FUNCTIONS: &[&IdentStr] = &[
    ident_str!("transfer_impl"),
    ident_str!("freeze_object_impl"),
    ident_str!("share_object_impl"),
    ident_str!("receive_impl"),
];

/// All transfer functions (the functions in `sui::transfer`) are "private" in that they are
/// restricted to the module.
/// For example, with `transfer::transfer<T>(...)`, either:
/// - `T` must be a type declared in the current module or
/// - `T` must have `store`
///
/// Similarly, `event::emit` is also "private" to the module. Unlike the `transfer` functions, there
/// is no relaxation for `store`
/// Concretely, with `event::emit<T>(...)`:
/// - `T` must be a type declared in the current module
pub fn verify_module(
    module: &CompiledModule,
    verifier_config: &VerifierConfig,
) -> Result<(), ExecutionError> {
    if *module.address() == SUI_FRAMEWORK_ADDRESS
        && module.name() == IdentStr::new(TEST_SCENARIO_MODULE_NAME).unwrap()
    {
        // exclude test_module which is a test-only module in the Sui framework which "emulates"
        // transactional execution and needs to allow test code to bypass private generics
        return Ok(());
    }
    // do not need to check the sui::transfer module itself
    for func_def in &module.function_defs {
        verify_function(module, func_def, verifier_config.allow_receiving_object_id).map_err(
            |error| {
                verification_failure(format!(
                    "{}::{}. {}",
                    module.self_id(),
                    module.identifier_at(module.function_handle_at(func_def.function).name),
                    error
                ))
            },
        )?;
    }
    Ok(())
}

fn verify_function(
    view: &CompiledModule,
    fdef: &FunctionDefinition,
    allow_receiving_object_id: bool,
) -> Result<(), String> {
    let code = match &fdef.code {
        None => return Ok(()),
        Some(code) => code,
    };
    for instr in &code.code {
        if let Bytecode::CallGeneric(finst_idx) = instr {
            let FunctionInstantiation {
                handle,
                type_parameters,
            } = view.function_instantiation_at(*finst_idx);

            let fhandle = view.function_handle_at(*handle);
            let mhandle = view.module_handle_at(fhandle.module);

            let type_arguments = &view.signature_at(*type_parameters).0;
            let ident = addr_module(view, mhandle);
            if ident == (SUI_FRAMEWORK_ADDRESS, TRANSFER_MODULE) {
                verify_private_transfer(view, fhandle, type_arguments, allow_receiving_object_id)?
            } else if ident == (SUI_FRAMEWORK_ADDRESS, EVENT_MODULE) {
                verify_private_event_emit(view, fhandle, type_arguments)?
            }
        }
    }
    Ok(())
}

fn verify_private_transfer(
    view: &CompiledModule,
    fhandle: &FunctionHandle,
    type_arguments: &[SignatureToken],
    allow_receiving_object_id: bool,
) -> Result<(), String> {
    let public_transfer_functions = if allow_receiving_object_id {
        PUBLIC_TRANSFER_FUNCTIONS
    } else {
        // Before protocol version 33, the `receiving_object_id` function was not public
        &PUBLIC_TRANSFER_FUNCTIONS[..PUBLIC_TRANSFER_FUNCTIONS.len() - 1]
    };
    let self_handle = view.module_handle_at(view.self_handle_idx());
    if addr_module(view, self_handle) == (SUI_FRAMEWORK_ADDRESS, TRANSFER_MODULE) {
        return Ok(());
    }
    let fident = view.identifier_at(fhandle.name);
    // public transfer functions require `store` and have no additional rules
    if public_transfer_functions.contains(&fident) {
        return Ok(());
    }
    if !PRIVATE_TRANSFER_FUNCTIONS.contains(&fident) {
        // unknown function, so a bug in the implementation here
        debug_assert!(false, "unknown transfer function {}", fident);
        return Err(format!("Calling unknown transfer function, {}", fident));
    };

    if type_arguments.len() != 1 {
        debug_assert!(false, "Expected 1 type argument for {}", fident);
        return Err(format!("Expected 1 type argument for {}", fident));
    }

    let type_arg = &type_arguments[0];
    if !is_defined_in_current_module(view, type_arg) {
        return Err(format!(
            "Invalid call to '{sui}::transfer::{f}' on an object of type '{t}'. \
            The transferred object's type must be defined in the current module. \
            If the object has the 'store' type ability, you can use the non-internal variant \
            instead, i.e. '{sui}::transfer::public_{f}'",
            sui = SUI_FRAMEWORK_ADDRESS,
            f = fident,
            t = format_signature_token(view, type_arg),
        ));
    }

    Ok(())
}

fn verify_private_event_emit(
    view: &CompiledModule,
    fhandle: &FunctionHandle,
    type_arguments: &[SignatureToken],
) -> Result<(), String> {
    let fident = view.identifier_at(fhandle.name);
    if fident == GET_EVENTS_TEST_FUNCTION {
        // test-only function witn no params--no need to verify
        return Ok(());
    }
    if fident != EVENT_FUNCTION {
        debug_assert!(false, "unknown event function {}", fident);
        return Err(format!("Calling unknown event function, {}", fident));
    };

    if type_arguments.len() != 1 {
        debug_assert!(false, "Expected 1 type argument for {}", fident);
        return Err(format!("Expected 1 type argument for {}", fident));
    }

    let type_arg = &type_arguments[0];
    if !is_defined_in_current_module(view, type_arg) {
        return Err(format!(
            "Invalid call to '{}::event::{}' with an event type '{}'. \
                The event's type must be defined in the current module",
            SUI_FRAMEWORK_ADDRESS,
            fident,
            format_signature_token(view, type_arg),
        ));
    }

    Ok(())
}

fn is_defined_in_current_module(view: &CompiledModule, type_arg: &SignatureToken) -> bool {
    match type_arg {
        SignatureToken::Datatype(_) | SignatureToken::DatatypeInstantiation(_) => {
            let idx = match type_arg {
                SignatureToken::Datatype(idx) => *idx,
                SignatureToken::DatatypeInstantiation(s) => s.0,
                _ => unreachable!(),
            };
            let shandle = view.datatype_handle_at(idx);
            view.self_handle_idx() == shandle.module
        }
        SignatureToken::TypeParameter(_)
        | SignatureToken::Bool
        | SignatureToken::U8
        | SignatureToken::U16
        | SignatureToken::U32
        | SignatureToken::U64
        | SignatureToken::U128
        | SignatureToken::U256
        | SignatureToken::Address
        | SignatureToken::Vector(_)
        | SignatureToken::Signer
        | SignatureToken::Reference(_)
        | SignatureToken::MutableReference(_) => false,
    }
}

fn addr_module<'a>(
    view: &'a CompiledModule,
    mhandle: &ModuleHandle,
) -> (AccountAddress, &'a IdentStr) {
    let maddr = view.address_identifier_at(mhandle.address);
    let mident = view.identifier_at(mhandle.name);
    (*maddr, mident)
}