Skip to content

fix(weaponset): Add sanity check for weapon slot index in WeaponSet::setWeaponLock() #3529

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.

Sign up for GitHub

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
xezon merged 1 commit into from
Oct 18, 2026
Merged

fix(weaponset): Add sanity check for weapon slot index in WeaponSet::setWeaponLock() #3529

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions Generals/Code/GameEngine/Source/GameLogic/Object/WeaponSet.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1065,6 +1065,11 @@ Bool WeaponSet::setWeaponLock( WeaponSlotType weaponSlot, WeaponLockType lockTyp
return false;
}

if (static_cast<UnsignedInt>(weaponSlot) >= ARRAY_SIZE(m_weapons))
{
return false;

@Skyaero42 Skyaero42 Oct 15, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is a DEBUG_CRASH maybe warranted here?

@Caball009 Caball009 Oct 15, 2026

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't mind adding it, but I don't see the value myself.

@Mauller Mauller Oct 16, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It can help warn of invalid data?

@Caball009 Caball009 Oct 16, 2026

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It can help warn of invalid data?

What is the value of the warning? Is there an action we could or should take if we know that this code was executed?

@Mauller Mauller Oct 16, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i was just considering if there was the possibility of invalid ini data getting this far, but it likely doesn't.

You could also simplify this to weaponSlot >= WEAPONSLOT_COUNT

@Caball009 Caball009 Oct 16, 2026 •
edited
Loading

Copy link
Copy Markdown
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i was just considering if there was the possibility of invalid ini data getting this far, but it likely doesn't.

Not that I'm aware of.

You could also simplify this to weaponSlot >= WEAPONSLOT_COUNT

This doesn't catch negative numbers (WeaponSlotType's underlying type is signed). It also requires you to look up that ARRAY_SIZE(m_weapons) == WEAPONSLOT_COUNT.

@Mauller Mauller Oct 16, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

most of the code already uses WEAPONSLOT_COUNT in this context, but it is also fair on the unsigned side of it.

}

// Verify the asked for weapon exists , choose it, and then lock it as chosen until unlocked
// the old code was just plain wrong. (look at it in perforce and you'll see...)
if (m_weapons[weaponSlot] != nullptr)
Expand Down
5 changes: 5 additions & 0 deletions GeneralsMD/Code/GameEngine/Source/GameLogic/Object/WeaponSet.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1109,6 +1109,11 @@ Bool WeaponSet::setWeaponLock( WeaponSlotType weaponSlot, WeaponLockType lockTyp
return false;
}

if (static_cast<UnsignedInt>(weaponSlot) >= ARRAY_SIZE(m_weapons))
{
return false;
}

// Verify the asked for weapon exists , choose it, and then lock it as chosen until unlocked
// the old code was just plain wrong. (look at it in perforce and you'll see...)
if (m_weapons[weaponSlot] != nullptr)
Expand Down
Loading