iota_transaction_checks/

deny.rs

// Copyright (c) Mysten Labs, Inc.
// Modifications Copyright (c) 2024 IOTA Stiftung
// SPDX-License-Identifier: Apache-2.0

use iota_sdk_types::{Command, ObjectReference, Transaction, UserSignature};
use iota_types::{
    deny_rule_governance::DenyRuleConfig,
    error::{IotaError, IotaResult, UserInputError},
    storage::BackingPackageStore,
    transaction::{InputObjectKind, TransactionAPI, TransactionKindExt},
};
use tracing::instrument;
macro_rules! deny_if_true {
    ($cond:expr, $msg:expr) => {
        if ($cond) {
            return Err(IotaError::UserInput {
                error: UserInputError::TransactionDenied {
                    error: $msg.to_string(),
                },
            });
        }
    };
}

/// Check that the provided transaction is allowed to be signed according to the
/// deny config.
#[instrument(level = "trace", skip_all, fields(tx_digest = ?tx.digest()))]
pub fn check_transaction_for_validation(
    tx: &Transaction,
    tx_signatures: &[UserSignature],
    input_object_kinds: &[InputObjectKind],
    receiving_objects: &[ObjectReference],
    filter_config: &dyn DenyRuleConfig,
    package_store: &dyn BackingPackageStore,
) -> IotaResult {
    check_disabled_features(filter_config, tx, tx_signatures)?;

    check_signers(filter_config, tx)?;

    check_input_objects(filter_config, input_object_kinds)?;

    check_package_dependencies(filter_config, tx, package_store)?;

    check_receiving_objects(filter_config, receiving_objects)?;

    Ok(())
}

#[instrument(level = "trace", skip_all)]
fn check_receiving_objects(
    filter_config: &dyn DenyRuleConfig,
    receiving_objects: &[ObjectReference],
) -> IotaResult {
    deny_if_true!(
        filter_config.receiving_objects_disabled() && !receiving_objects.is_empty(),
        "Receiving objects is temporarily disabled".to_string()
    );
    if !filter_config.has_denied_objects() {
        return Ok(());
    }
    for receiving_object in receiving_objects {
        deny_if_true!(
            filter_config.is_object_denied(&receiving_object.object_id),
            format!(
                "Access to object {:?} is temporarily disabled",
                receiving_object.object_id
            )
        );
    }
    Ok(())
}

#[instrument(level = "trace", skip_all)]
fn check_disabled_features(
    filter_config: &dyn DenyRuleConfig,
    tx: &Transaction,
    tx_signatures: &[UserSignature],
) -> IotaResult {
    deny_if_true!(
        filter_config.user_transaction_disabled(),
        "Transaction signing is temporarily disabled"
    );

    tx_signatures.iter().try_for_each(|s| {
        if let UserSignature::MoveAuthenticator(_) = s {
            deny_if_true!(
                filter_config.move_authenticator_disabled(),
                "MoveAuthenticator is temporarily disabled"
            );
        }
        Ok(())
    })?;

    if !filter_config.package_publish_disabled() && !filter_config.package_upgrade_disabled() {
        return Ok(());
    }

    for command in tx.kind().iter_commands() {
        deny_if_true!(
            filter_config.package_publish_disabled() && matches!(command, Command::Publish(..)),
            "Package publish is temporarily disabled"
        );
        deny_if_true!(
            filter_config.package_upgrade_disabled() && matches!(command, Command::Upgrade(..)),
            "Package upgrade is temporarily disabled"
        );
    }
    Ok(())
}

#[instrument(level = "trace", skip_all)]
fn check_signers(filter_config: &dyn DenyRuleConfig, tx: &Transaction) -> IotaResult {
    if !filter_config.has_denied_addresses() {
        return Ok(());
    }
    for signer in tx.signers() {
        deny_if_true!(
            filter_config.is_address_denied(&signer),
            format!(
                "Access to account address {:?} is temporarily disabled",
                signer
            )
        );
    }
    Ok(())
}

#[instrument(level = "trace", skip_all)]
fn check_input_objects(
    filter_config: &dyn DenyRuleConfig,
    input_object_kinds: &[InputObjectKind],
) -> IotaResult {
    let shared_object_disabled = filter_config.shared_object_disabled();
    if !filter_config.has_denied_objects() && !shared_object_disabled {
        // No need to iterate through the input objects if no relevant policy is set.
        return Ok(());
    }
    for input_object_kind in input_object_kinds {
        let id = input_object_kind.object_id();
        deny_if_true!(
            filter_config.is_object_denied(&id),
            format!("Access to input object {id} is temporarily disabled")
        );
        deny_if_true!(
            shared_object_disabled && input_object_kind.is_shared_object(),
            "Usage of shared object in transactions is temporarily disabled"
        );
    }
    Ok(())
}

#[instrument(level = "trace", skip_all)]
fn check_package_dependencies(
    filter_config: &dyn DenyRuleConfig,
    tx: &Transaction,
    package_store: &dyn BackingPackageStore,
) -> IotaResult {
    if !filter_config.has_denied_packages() {
        return Ok(());
    }
    let mut dependencies = vec![];
    for command in tx.kind().iter_commands() {
        match command {
            Command::Publish(cmd) => {
                // It is possible that the deps list is inaccurate since it's provided
                // by the user. But that's OK because this publish transaction will fail
                // to execute in the end. Similar reasoning for Upgrade.
                dependencies.extend(cmd.dependencies.iter().copied());
            }
            Command::Upgrade(cmd) => {
                dependencies.extend(cmd.dependencies.iter().copied());
                // It's crucial that we don't allow upgrading a package in the deny list,
                // otherwise one can bypass the deny list by upgrading a package.
                dependencies.push(cmd.package);
            }
            Command::MoveCall(cmd) => {
                let package = package_store.get_package_object(&cmd.package)?.ok_or(
                    IotaError::UserInput {
                        error: UserInputError::ObjectNotFound {
                            object_id: cmd.package,
                            version: None,
                        },
                    },
                )?;
                // linkage_table maps from the original package ID to the upgraded ID for each
                // dependency. Here we only check the upgraded (i.e. the latest) ID against the
                // deny list. This means that we only make sure that the denied package is not
                // currently used as a dependency. This allows us to deny an older version of
                // package but permits the use of a newer version.
                dependencies.extend(
                    package
                        .move_package()
                        .linkage_table()
                        .values()
                        .map(|upgrade_info| upgrade_info.upgraded_id),
                );
                dependencies.push(package.move_package().id());
            }
            Command::TransferObjects(..)
            | Command::SplitCoins(..)
            | Command::MergeCoins(..)
            | Command::MakeMoveVector(..) => {}
            _ => unimplemented!("a new Command enum variant was added and needs to be handled"),
        }
    }
    for dep in dependencies {
        deny_if_true!(
            filter_config.is_package_denied(&dep),
            format!("Access to package {dep} is temporarily disabled")
        );
    }
    Ok(())
}