Skip to content

Instantly share code, notes, and snippets.

@tzkmx
Created September 1, 2025 16:23
Show Gist options
  • Save tzkmx/62147ae5e39363c86bebb8a8ff73cf2f to your computer and use it in GitHub Desktop.
Save tzkmx/62147ae5e39363c86bebb8a8ff73cf2f to your computer and use it in GitHub Desktop.
VBA Macro Password Recovery Procedure

VBA Macro Password Recovery Procedure

Released under terms of Artistic License 2.0

This document outlines the procedure used to regain access to password-protected VBA macro projects in Microsoft Office files (e.g., .xlsm, .dotm).

The Method

Microsoft Office files are fundamentally ZIP archives. The VBA project, including its password protection, is stored in a binary file named vbaProject.bin within this archive. The protection mechanism relies on a data structure identified by the byte sequence "DPB". By programmatically altering this identifier to "DPx", we can corrupt the password check, causing the Office application to bypass it and open the VBA project in an unprotected state.

The Script

The following PowerShell script, unprotect-macros.ps1, automates this entire process. It works on a copy of the original file, ensuring the procedure is non-destructive.

param (
    [string]$InputFile,
    [string]$OutputFile
)

$scriptPath = $PSScriptRoot
$tempDir = Join-Path $scriptPath "temp_unprotect"

# 1. Setup temporary directory
if (Test-Path $tempDir) {
    Remove-Item $tempDir -Recurse -Force
}
New-Item -ItemType Directory -Path $tempDir

# 2. Treat as a ZIP archive and extract
$zipFile = Join-Path $tempDir "archive.zip"
Copy-Item (Join-Path $scriptPath $InputFile) $zipFile
Expand-Archive -Path $zipFile -DestinationPath $tempDir

# 3. Locate the VBA file and modify the protection flag
$vbaProjectBin = Get-ChildItem -Path $tempDir -Filter "vbaProject.bin" -Recurse
if ($vbaProjectBin) {
    $vbaPath = $vbaProjectBin.FullName
    Write-Host "Found vbaProject.bin at $($vbaPath)"

    $encoding = [System.Text.Encoding]::GetEncoding('iso-8859-1')
    $contentBytes = Get-Content -Path $vbaPath -Encoding Byte -Raw
    $contentAsString = $encoding.GetString($contentBytes)

    if ($contentAsString.Contains("DPB")) {
        Write-Host "Found 'DPB' protection flag. Patching file..."
        $modifiedContentAsString = $contentAsString.Replace("DPB", "DPx")
        $modifiedContentBytes = $encoding.GetBytes($modifiedContentAsString)
        Set-Content -Path $vbaPath -Value $modifiedContentBytes -Encoding Byte
        Write-Host "File patched successfully."
    } else {
        Write-Warning "'DPB' protection flag not found. The macros may not be password protected, or use a different method. The file will be re-packaged without modification."
    }
} else {
    Write-Error "vbaProject.bin not found in the archive."
    Exit 1
}

# 4. Re-package the file
Remove-Item $zipFile -Force
$tempZipFile = Join-Path $scriptPath "temp_archive.zip"
$outputFileFullPath = Join-Path $scriptPath $OutputFile

if (Test-Path $outputFileFullPath) {
    Remove-Item $outputFileFullPath -Force
}
if (Test-Path $tempZipFile) {
    Remove-Item $tempZipFile -Force
}

Push-Location $tempDir
Compress-Archive -Path * -DestinationPath $tempZipFile -Force
Pop-Location

Move-Item -Path $tempZipFile -Destination $outputFileFullPath -Force

# 5. Cleanup
Remove-Item $tempDir -Recurse -Force

Write-Host "Successfully created unprotected file: $OutputFile"

How to Use the Script

  1. Save the code above into a file named unprotect-macros.ps1.
  2. Place the script in the same directory as the Office file you wish to unprotect.
  3. Open a PowerShell terminal in that directory.
  4. Execute the script, providing the name of the file to unprotect (-InputFile) and the desired name for the new, unprotected file (-OutputFile).

Example

To unprotect a file named MyWorkbook.xlsm, you would run the following command:

powershell.exe -ExecutionPolicy Bypass -File ".\unprotect-macros.ps1" -InputFile "MyWorkbook.xlsm" -OutputFile "MyWorkbook_unprotected.xlsm"

Verification

After the script runs, open the newly created _unprotected file. Microsoft Office will likely display a warning about "errors" or "unreadable content." This is expected; click Yes to proceed. Once the file is open, you should be able to access the VBA editor (Alt + F11) and view the macro source code.

The Artistic License 2.0
Copyright (c) 2000-2006, The Perl Foundation.
Everyone is permitted to copy and distribute verbatim copies of this license document, but changing it is not allowed.
Preamble
This license establishes the terms under which a given free software Package may be copied, modified, distributed, and/or redistributed. The intent is that the Copyright Holder maintains some artistic control over the development of that Package while still keeping the Package available as open source and free software.
You are always permitted to make arrangements wholly outside of this license directly with the Copyright Holder of a given Package. If the terms of this license do not permit the full use that you propose to make of the Package, you should contact the Copyright Holder and seek a different licensing arrangement.
Definitions
"Copyright Holder" means the individual(s) or organization(s) named in the copyright notice for the entire Package.
"Contributor" means any party that has contributed code or other material to the Package, in accordance with the Copyright Holder's procedures.
"You" and "your" means any person who would like to copy, distribute, or modify the Package.
"Package" means the collection of files distributed by the Copyright Holder, and derivatives of that collection and/or of those files. A given Package may consist of either the Standard Version, or a Modified Version.
"Distribute" means providing a copy of the Package or making it accessible to anyone else, or in the case of a company or organization, to others outside of your company or organization.
"Distributor Fee" means any fee that you charge for Distributing this Package or providing support for this Package to another party. It does not mean licensing fees.
"Standard Version" refers to the Package if it has not been modified, or has been modified only in ways explicitly requested by the Copyright Holder.
"Modified Version" means the Package, if it has been changed by you or by someone else.
"Source" form means the source code, documentation source, and configuration files for the Package.
"Compiled" form means the compiled bytecode, object code, binary, or any other form resulting from mechanical transformation or translation of the Source form.
Permission for Use and Modification Without Distribution
(1) You are permitted to use the Standard Version and create and use Modified Versions for any purpose without restriction, provided that you do not Distribute the Modified Version.
Permissions for Redistribution of the Standard Version
(2) You may Distribute verbatim copies of the Source form of the Standard Version of this Package in any medium without restriction, either gratis or for a Distributor Fee, provided that you duplicate all of the original copyright notices and associated disclaimers. At your discretion, such verbatim copies may or may not include a Compiled form of the Package.
(3) You may apply any bug fixes, portability changes, and other modifications made available from the Copyright Holder. The resulting Package will still be considered the Standard Version, and as such will be subject to the Original License.
Distribution of Modified Versions of the Package as Source
(4) You may Distribute your Modified Version as Source (either gratis or for a Distributor Fee, and with or without a Compiled form of the Modified Version) provided that you clearly document how it differs from the Standard Version, including, but not limited to, documenting any non-standard features, executables, or modules, and provided that you do at least ONE of the following:
(a) make the Modified Version available to the Copyright Holder of the Standard Version, under the Original License, so that the Copyright Holder may include your modifications in the Standard Version.
(b) ensure that installation of your Modified Version does not prevent the user installing or running the Standard Version. In addition, the Modified Version must bear a name that is different from the name of the Standard Version.
(c) allow anyone who receives a copy of the Modified Version to make the Source form of the Modified Version available to others under
(i) the Original License or
(ii) a license that permits the licensee to freely copy, modify and redistribute the Modified Version using the same licensing terms that apply to the copy that the licensee received, and requires that the Source form of the Modified Version, and of any works derived from it, be made freely available in that license fees are prohibited but Distributor Fees are allowed.
Distribution of Compiled Forms of the Standard Version or Modified Versions without the Source
(5) You may Distribute Compiled forms of the Standard Version without the Source, provided that you include access to the Source form of the Standard Version in your documentation.
(6) You may Distribute Compiled forms of your Modified Version without the Source, provided that you do at least ONE of the following:
(a) include access to the Source form of the Modified Version in your documentation.
(b) make the Source form of the Modified Version available to everyone who receives the Compiled form.
Aggregating or Linking the Package
(7) You may aggregate the Package (either the Standard Version or Modified Version) with other packages and Distribute the resulting aggregation provided that you do not charge a licensing fee for the Package. Distributor Fees are permitted, and licensing fees for other components in the aggregation are permitted. The terms of this license apply to the use and Distribution of the Package as included in the aggregation.
(8) You are permitted to link Modified and Standard Versions with other works, to embed the Package in a larger work of your own, or to build stand-alone binary or bytecode versions of applications that include the Package, and Distribute the result without restriction, provided the result does not expose a direct interface to the Package.
Items That are Not Considered Part of a Modified Version
(9) Works (including, but not limited to, modules and scripts) that merely extend or make use of the Package, do not, by themselves, cause the Package to be a Modified Version.
General Provisions
(10) Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you have indicated your acceptance of the terms of this license.
(11) This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.
(12) This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.
(13) Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
param (
[string]$InputFile,
[string]$OutputFile
)
$scriptPath = $PSScriptRoot
$tempDir = Join-Path $scriptPath "temp_unprotect"
# 1. Setup temporary directory
if (Test-Path $tempDir) {
Remove-Item $tempDir -Recurse -Force
}
New-Item -ItemType Directory -Path $tempDir
# 2. Treat as a ZIP archive and extract
$zipFile = Join-Path $tempDir "archive.zip"
Copy-Item (Join-Path $scriptPath $InputFile) $zipFile
Expand-Archive -Path $zipFile -DestinationPath $tempDir
# 3. Locate the VBA file and modify the protection flag
$vbaProjectBin = Get-ChildItem -Path $tempDir -Filter "vbaProject.bin" -Recurse
if ($vbaProjectBin) {
$vbaPath = $vbaProjectBin.FullName
Write-Host "Found vbaProject.bin at $($vbaPath)"
$encoding = [System.Text.Encoding]::GetEncoding('iso-8859-1')
$contentBytes = Get-Content -Path $vbaPath -Encoding Byte -Raw
$contentAsString = $encoding.GetString($contentBytes)
if ($contentAsString.Contains("DPB")) {
Write-Host "Found 'DPB' protection flag. Patching file..."
$modifiedContentAsString = $contentAsString.Replace("DPB", "DPx")
$modifiedContentBytes = $encoding.GetBytes($modifiedContentAsString)
Set-Content -Path $vbaPath -Value $modifiedContentBytes -Encoding Byte
Write-Host "File patched successfully."
} else {
Write-Warning "'DPB' protection flag not found. The macros may not be password protected, or use a different method. The file will be re-packaged without modification."
}
} else {
Write-Error "vbaProject.bin not found in the archive."
Exit 1
}
# 4. Re-package the file
Remove-Item $zipFile -Force
$tempZipFile = Join-Path $scriptPath "temp_archive.zip"
$outputFileFullPath = Join-Path $scriptPath $OutputFile
if (Test-Path $outputFileFullPath) {
Remove-Item $outputFileFullPath -Force
}
if (Test-Path $tempZipFile) {
Remove-Item $tempZipFile -Force
}
Push-Location $tempDir
Compress-Archive -Path * -DestinationPath $tempZipFile -Force
Pop-Location
Move-Item -Path $tempZipFile -Destination $outputFileFullPath -Force
# 5. Cleanup
Remove-Item $tempDir -Recurse -Force
Write-Host "Successfully created unprotected file: $OutputFile"
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment