-
Notifications
You must be signed in to change notification settings - Fork 0
New lint missing_mut_constraint #11
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 2 commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
81630b8
feat: new lint missing_mut_constraint
meumar-osec cac791e
chore: cargo fmt
meumar-osec be3c8ef
tests: Use workspace deps for anchor in test programs
meumar-osec 764ef86
Update lints/missing_mut_constraint/Cargo.toml
meumar-osec 45d23a8
refactor: move account_name_from_place_or_rvalue into MirAnalyzer
meumar-osec 3a45cc9
chore: Use `cargo-install` action to install package (#14)
jamie-osec 38f7b1a
chore: cargo fmt
meumar-osec File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| [package] | ||
| name = "missing_mut_constraint" | ||
| version.workspace = true | ||
| edition.workspace = true | ||
| publish = false | ||
| authors = ["authors go here"] | ||
| description = "Detects accounts that are mutated in the instruction but not declared with #[account(mut)]" | ||
|
|
||
| [lib] | ||
| crate-type = ["cdylib"] | ||
|
|
||
| [dependencies] | ||
| anchor-lints-utils.workspace = true | ||
| clippy_utils.workspace = true | ||
| dylint_linting.workspace = true | ||
|
|
||
| [dev-dependencies] | ||
| dylint_testing.workspace = true | ||
|
|
||
| [package.metadata.rust-analyzer] | ||
| rustc_private = true | ||
|
|
||
| [lints] | ||
| workspace = true | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| # `missing_mut_constraint` | ||
|
|
||
| ### What it does | ||
| Detects when an account is mutated in the instruction body but not declared with `#[account(mut)]` in the Anchor accounts struct. | ||
|
|
||
| ### Why is this bad? | ||
| Mutating an account without the `mut` constraint can cause the runtime to reject the transaction or behave unexpectedly, because the account was not marked as writable. | ||
|
|
||
| ### Example | ||
|
|
||
| **Bad:** account mutated without `#[account(mut)]` | ||
| ```rust | ||
| #[derive(Accounts)] | ||
| pub struct Update<'info> { | ||
| pub vault: Account<'info, Vault>, // missing #[account(mut)] | ||
| } | ||
|
|
||
| pub fn update(ctx: Context<Update>) -> Result<()> { | ||
| ctx.accounts.vault.amount += 1; // mutation | ||
| Ok(()) | ||
| } | ||
| ``` | ||
|
|
||
| **Good:** account has `#[account(mut)]` when mutated | ||
| ```rust | ||
| #[derive(Accounts)] | ||
| pub struct Update<'info> { | ||
| #[account(mut)] | ||
| pub vault: Account<'info, Vault>, | ||
| } | ||
|
|
||
| pub fn update(ctx: Context<Update>) -> Result<()> { | ||
| ctx.accounts.vault.amount += 1; | ||
| Ok(()) | ||
| } | ||
| ``` |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,203 @@ | ||
| #![feature(rustc_private)] | ||
| #![warn(unused_extern_crates)] | ||
| #![feature(box_patterns)] | ||
|
|
||
| extern crate rustc_hir; | ||
| extern crate rustc_middle; | ||
| extern crate rustc_span; | ||
|
|
||
| use anchor_lints_utils::{ | ||
| mir_analyzer::{AnchorContextInfo, MirAnalyzer}, | ||
| utils::{extract_account_constraints, should_skip_function}, | ||
| }; | ||
| use clippy_utils::diagnostics::span_lint; | ||
|
|
||
| use rustc_hir::{Body as HirBody, FnDecl, def_id::LocalDefId, intravisit::FnKind}; | ||
| use rustc_lint::{LateContext, LateLintPass}; | ||
| use rustc_middle::{ | ||
| mir::{Mutability, Place, Rvalue, StatementKind}, | ||
| ty::TyKind, | ||
| }; | ||
| use rustc_span::Span; | ||
|
|
||
| use std::collections::{HashMap, HashSet}; | ||
|
|
||
| dylint_linting::impl_late_lint! { | ||
| /// ### What it does | ||
| /// Detects when an account is mutated in the instruction body but not declared | ||
| /// with `#[account(mut)]` in the Anchor accounts struct. | ||
| /// | ||
| /// ### Why is this bad? | ||
| /// Mutating an account without the `mut` constraint can cause the runtime to | ||
| /// reject the transaction or behave unexpectedly, as the account was not | ||
| /// marked as writable. | ||
| /// | ||
| /// ### Example | ||
| /// ```rust | ||
| /// #[derive(Accounts)] | ||
| /// pub struct Update<'info> { | ||
| /// pub vault: Account<'info, Vault>, // missing #[account(mut)] | ||
| /// } | ||
| /// pub fn update(ctx: Context<Update>) -> Result<()> { | ||
| /// ctx.accounts.vault.amount += 1; // mutation | ||
| /// Ok(()) | ||
| /// } | ||
| /// ``` | ||
| /// | ||
| /// ### Good | ||
| /// ```rust | ||
| /// #[derive(Accounts)] | ||
| /// pub struct Update<'info> { | ||
| /// #[account(mut)] | ||
| /// pub vault: Account<'info, Vault>, | ||
| /// } | ||
| /// ``` | ||
| pub MISSING_MUT_CONSTRAINT, | ||
| Warn, | ||
| "account is mutated but missing #[account(mut)]", | ||
| MissingMutConstraint | ||
| } | ||
|
|
||
| #[derive(Default)] | ||
| pub struct MissingMutConstraint; | ||
|
|
||
| struct AccountMutability { | ||
| span: Span, | ||
| mutable: bool, | ||
| } | ||
|
|
||
| impl<'tcx> LateLintPass<'tcx> for MissingMutConstraint { | ||
| fn check_fn( | ||
| &mut self, | ||
| cx: &LateContext<'tcx>, | ||
| _kind: FnKind<'tcx>, | ||
| _: &FnDecl<'tcx>, | ||
| body: &HirBody<'tcx>, | ||
| main_fn_span: Span, | ||
| def_id: LocalDefId, | ||
| ) { | ||
| if should_skip_function(cx, main_fn_span, def_id) { | ||
| return; | ||
| } | ||
|
|
||
| let mut mir_analyzer = MirAnalyzer::new(cx, body, def_id); | ||
| anchor_lints_utils::utils::ensure_anchor_context_initialized(&mut mir_analyzer, body); | ||
|
|
||
| // Analyze functions that take Anchor context | ||
| let Some(anchor_context_info) = mir_analyzer.anchor_context_info.as_ref() else { | ||
| return; | ||
| }; | ||
|
|
||
| analyze_missing_mut_constraint(cx, &mir_analyzer, anchor_context_info); | ||
| } | ||
| } | ||
|
|
||
| fn analyze_missing_mut_constraint<'cx, 'tcx>( | ||
| cx: &'cx LateContext<'tcx>, | ||
| mir_analyzer: &MirAnalyzer<'cx, 'tcx>, | ||
| anchor_context_info: &AnchorContextInfo<'tcx>, | ||
| ) { | ||
| let accounts_struct_ty = &anchor_context_info.anchor_context_account_type; | ||
| let TyKind::Adt(adt_def, _generics) = accounts_struct_ty.kind() else { | ||
| return; | ||
| }; | ||
|
|
||
| if !adt_def.is_struct() && !adt_def.is_union() { | ||
| return; | ||
| } | ||
|
|
||
| let variant = adt_def.non_enum_variant(); | ||
| let mut account_mutability: HashMap<String, AccountMutability> = HashMap::new(); | ||
|
|
||
| for field in &variant.fields { | ||
| let account_name = field.ident(cx.tcx).to_string(); | ||
| let account_span = cx.tcx.def_span(field.did); | ||
| let constraints = extract_account_constraints(cx, field); | ||
| account_mutability.insert( | ||
| account_name, | ||
| AccountMutability { | ||
| span: account_span, | ||
| mutable: constraints.mutable, | ||
| }, | ||
| ); | ||
| } | ||
|
|
||
| let mutated_accounts = collect_mutated_accounts(mir_analyzer); | ||
| let mut visited = HashSet::new(); | ||
|
|
||
| for account_name in mutated_accounts { | ||
| if visited.contains(&account_name) { | ||
| continue; | ||
| } | ||
| visited.insert(account_name.clone()); | ||
|
|
||
| if let Some(info) = account_mutability.get(&account_name) | ||
| && !info.mutable | ||
| { | ||
| span_lint( | ||
| cx, | ||
| MISSING_MUT_CONSTRAINT, | ||
| info.span, | ||
| format!( | ||
| "account `{}` is mutated in the instruction but is not declared with `#[account(mut)]`", | ||
| account_name | ||
| ), | ||
| ); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /// Collects the accounts that are mutated in the instruction body | ||
| fn collect_mutated_accounts<'cx, 'tcx>(mir_analyzer: &MirAnalyzer<'cx, 'tcx>) -> HashSet<String> { | ||
| let mut mutated = HashSet::new(); | ||
|
|
||
| for (_bb, bbdata) in mir_analyzer.mir.basic_blocks.iter_enumerated() { | ||
| for stmt in &bbdata.statements { | ||
| if let StatementKind::Assign(box (place, rvalue)) = &stmt.kind | ||
| && let Some(account_name) = | ||
| account_name_from_place_or_rvalue(mir_analyzer, place, rvalue) | ||
| { | ||
| mutated.insert(account_name); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| mutated | ||
| } | ||
|
|
||
| /// Extracts the account name from a place or rvalue | ||
| fn account_name_from_place_or_rvalue<'cx, 'tcx>( | ||
|
meumar-osec marked this conversation as resolved.
Outdated
|
||
| mir_analyzer: &MirAnalyzer<'cx, 'tcx>, | ||
| place: &Place<'_>, | ||
| rvalue: &Rvalue<'_>, | ||
| ) -> Option<String> { | ||
| let base_local = place.local; | ||
| let resolved = mir_analyzer.resolve_to_original_local(base_local, &mut HashSet::new()); | ||
| if let Some(acc) = mir_analyzer.extract_account_name_from_local(&resolved, true) { | ||
| let name = acc | ||
| .account_name | ||
| .split('.') | ||
| .next() | ||
| .unwrap_or(&acc.account_name) | ||
| .to_string(); | ||
| return Some(name); | ||
| } | ||
|
|
||
| if let Rvalue::Ref(_, borrow_kind, ref_place) = rvalue | ||
| && borrow_kind.mutability() == Mutability::Mut | ||
| { | ||
| let base = ref_place.local; | ||
| let resolved = mir_analyzer.resolve_to_original_local(base, &mut HashSet::new()); | ||
| if let Some(acc) = mir_analyzer.extract_account_name_from_local(&resolved, true) { | ||
| let name = acc | ||
| .account_name | ||
| .split('.') | ||
| .next() | ||
| .unwrap_or(&acc.account_name) | ||
| .to_string(); | ||
| return Some(name); | ||
| } | ||
| } | ||
|
|
||
| None | ||
| } | ||
13 changes: 13 additions & 0 deletions
13
lints/missing_mut_constraint/tests/test_program/Cargo.toml
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| [package] | ||
| name = "missing_mut_constraint_test_program" | ||
| version = "0.1.0" | ||
| edition = "2021" | ||
| workspace = "../../../../tests" | ||
|
|
||
|
|
||
| [lib] | ||
| crate-type = ["cdylib"] | ||
|
|
||
| [dependencies] | ||
| anchor-lang = { git = "https://github.com/jamie-osec/anchor.git", branch = "anchor-lint" } | ||
| anchor-spl = { git = "https://github.com/jamie-osec/anchor.git", branch = "anchor-lint" } | ||
|
meumar-osec marked this conversation as resolved.
Outdated
|
||
76 changes: 76 additions & 0 deletions
76
lints/missing_mut_constraint/tests/test_program/src/lib.rs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| use anchor_lang::prelude::*; | ||
|
|
||
| declare_id!("11111111111111111111111111111111"); | ||
|
|
||
| #[program] | ||
| pub mod missing_mut_constraint { | ||
| use super::*; | ||
|
|
||
| // Bad: Account (vault) is mutated but not declared with #[account(mut)] | ||
| pub fn update_bad(ctx: Context<UpdateBad>) -> Result<()> { | ||
| ctx.accounts.vault.amount += 1; | ||
| Ok(()) | ||
| } | ||
|
|
||
| // Good: Account (vault) has #[account(mut)] | ||
| pub fn update_good(ctx: Context<UpdateGood>) -> Result<()> { | ||
| ctx.accounts.vault.amount += 1; | ||
| Ok(()) | ||
| } | ||
|
|
||
| // Good: Account (vault) is only read, no mut needed | ||
| pub fn read_only(ctx: Context<ReadOnly>) -> Result<()> { | ||
| let _ = ctx.accounts.vault.amount; | ||
| Ok(()) | ||
| } | ||
|
|
||
| // Bad: Account (treasury) is mutated but not declared with #[account(mut)] (Account (vault) has mut) | ||
| pub fn transfer_bad(ctx: Context<TransferBad>) -> Result<()> { | ||
| ctx.accounts.vault.amount -= 10; | ||
| ctx.accounts.treasury.amount += 10; | ||
| Ok(()) | ||
| } | ||
|
|
||
| // Good: lamport mutation with #[account(mut)] on payer | ||
| pub fn pay_lamports(ctx: Context<PayLamports>, amount: u64) -> Result<()> { | ||
| **ctx.accounts.payer.lamports.borrow_mut() -= amount; | ||
| **ctx.accounts.recipient.lamports.borrow_mut() += amount; | ||
| Ok(()) | ||
| } | ||
| } | ||
|
|
||
| #[account] | ||
| pub struct Vault { | ||
| pub amount: u64, | ||
| } | ||
|
|
||
| #[derive(Accounts)] | ||
| pub struct UpdateBad<'info> { | ||
| pub vault: Account<'info, Vault>, // [missing_mut_constraint] | ||
| } | ||
|
|
||
| #[derive(Accounts)] | ||
| pub struct UpdateGood<'info> { | ||
| #[account(mut)] | ||
| pub vault: Account<'info, Vault>, | ||
| } | ||
|
|
||
| #[derive(Accounts)] | ||
| pub struct ReadOnly<'info> { | ||
| pub vault: Account<'info, Vault>, | ||
| } | ||
|
|
||
| #[derive(Accounts)] | ||
| pub struct TransferBad<'info> { | ||
| #[account(mut)] | ||
| pub vault: Account<'info, Vault>, | ||
| pub treasury: Account<'info, Vault>, // [missing_mut_constraint] | ||
| } | ||
|
|
||
| #[derive(Accounts)] | ||
| pub struct PayLamports<'info> { | ||
| #[account(mut)] | ||
| pub payer: AccountInfo<'info>, | ||
| #[account(mut)] | ||
| pub recipient: AccountInfo<'info>, | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.