Fix CFRelease memory safety issues causing potential crashes in OpenKey - #3
Draft
sonthepham-dev with Copilot wants to merge 12 commits into
Draft
Fix CFRelease memory safety issues causing potential crashes in OpenKey#3sonthepham-dev with Copilot wants to merge 12 commits into
sonthepham-dev with Copilot wants to merge 12 commits into
Conversation
Co-authored-by: sonthepham-dev <46697168+sonthepham-dev@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] find bug and fix
Fix CFRelease memory safety issues causing potential crashes in OpenKey
Jul 31, 2025
sonthepham-dev
force-pushed
the
master
branch
from
December 19, 2025 03:41
8ae93bb to
8f46d77
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Problem
The OpenKey macOS application had several critical memory safety issues in
OpenKey.mmthat could cause crashes and memory corruption:CFReleaseonCGEventRefobjects without checking if they were NULL firstCFArrayGetValueAtIndex)TISInputSourceRefobjects not being released in all code pathsRoot Cause
According to Apple's Core Foundation documentation,
CGEventCreateKeyboardEventcan return NULL if it fails to create the event object. CallingCFReleaseon a NULL pointer causes immediate crashes. Additionally, objects returned byCFArrayGetValueAtIndexare not retained and should not be released.Solution
Added NULL checks before all CFRelease calls:
Fixed incorrect CFRelease usage:
Protected global event objects:
Added NULL checks for
eventBackSpaceDownandeventBackSpaceUpusage to prevent crashes if these fail to initialize.Impact
These fixes prevent potential crashes and memory corruption issues in the OpenKey Vietnamese input method, making it significantly more stable and reliable for users. The changes are minimal and surgical, only adding necessary safety checks without altering the application's functionality.
Testing
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.