Skip to content

fix: Add Windows UAC execution level support to manifest template #4350

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

Draft
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

leaanthony
Copy link
Member

Summary

Fixes #4349: Windows admin permissions not persisting between machines

This PR adds configurable UAC (User Account Control) execution level support to the Windows manifest template, allowing developers to specify admin requirements that persist when executables are distributed to other machines.

Problem Solved

Users building Wails applications with admin privileges using custom manifest files reported that:

  • Admin requirements worked on the build machine
  • Admin requirements were lost when copying executables to other machines
  • Using rsrc tool directly resulted in "too many .rsrc sections" errors

Root Cause

The default Wails manifest template didn't include UAC configuration options, and users trying to add their own resource files conflicted with Wails' resource embedding process.

Solution

✅ Enhanced Windows Manifest Template

  • Added conditional UAC trustInfo section using {{.ExecutionLevel}} template variable
  • Backward compatible: no UAC section when execution level not specified
  • Proper XML structure following Microsoft UAC manifest specifications

✅ Project Configuration Support

  • Added WindowsInfo struct to project configuration (v2/internal/project/project.go)
  • Added executionLevel field for specifying UAC requirements
  • Integrated into existing template data processing pipeline

✅ Template Data Enhancement

  • Extended assetData struct to include execution level field
  • Updated template resolution to extract Windows-specific configuration
  • Maintained full backward compatibility with existing projects

✅ Comprehensive Documentation

  • Added Windows UAC guide with practical examples (website/docs/guides/windows.mdx)
  • Updated project configuration reference (website/docs/reference/project-config.mdx)
  • Included usage examples for all supported execution levels

Usage

Developers can now configure UAC execution level in wails.json:

{
  "info": {
    "companyName": "My Company", 
    "productName": "My App",
    "productVersion": "1.0.0",
    "windows": {
      "executionLevel": "requireAdministrator"
    }
  }
}

Supported Execution Levels

Level Description
requireAdministrator Requires admin privileges, shows UAC prompt
highestAvailable Runs with highest available user privileges
asInvoker Runs with same privileges as calling process

Testing

✅ Verification Completed

  • Built Windows executable with requireAdministrator setting
  • Extracted resources using go-winres extract tool
  • Confirmed UAC trustInfo section properly embedded in executable
  • Verified requestedExecutionLevel level="requireAdministrator" present in manifest
  • Tested backward compatibility with projects without execution level specified

Resource Extraction Results

<trustInfo xmlns="urn:schemas-microsoft-com:asm.v3">
  <security>
    <requestedPrivileges>
      <requestedExecutionLevel level="requireAdministrator" uiAccess="false"/>
    </requestedPrivileges>
  </security>
</trustInfo>

Files Changed

  • v2/internal/project/project.go - Added Windows configuration struct
  • v2/pkg/buildassets/build/windows/wails.exe.manifest - Enhanced template with UAC support
  • v2/pkg/buildassets/buildassets.go - Updated template data processing
  • website/docs/guides/windows.mdx - Added comprehensive UAC guide
  • website/docs/reference/project-config.mdx - Updated configuration reference

Backward Compatibility

Fully backward compatible - existing projects continue to work unchanged
No breaking changes - UAC section only added when explicitly configured
Default behavior preserved - applications run with invoker privileges when not specified

Impact

  • Resolves persistent admin permissions issue affecting Windows developers
  • Eliminates "too many .rsrc sections" errors from manual rsrc tool usage
  • Provides clean, documented approach for Windows privilege configuration
  • Maintains Wails' ease-of-use philosophy with simple JSON configuration

🤖 Generated with Claude Code

Co-Authored-By: Claude noreply@anthropic.com

Fixes #4349: Windows admin permissions not persisting between machines

This change adds configurable UAC (User Account Control) execution level
support to the Windows manifest template, allowing developers to specify
admin requirements that persist when executables are distributed.

## Changes Made

### Enhanced Windows Manifest Template
- Added conditional UAC `trustInfo` section to manifest template
- Uses template variable `{{.ExecutionLevel}}` for dynamic configuration
- Backward compatible: no UAC section when execution level not specified

### Project Configuration Support
- Added `WindowsInfo` struct to project configuration
- Added `executionLevel` field for specifying UAC requirements
- Integrated execution level into template data processing

### Template Data Enhancement
- Extended `assetData` struct to include execution level
- Updated template resolution to extract Windows-specific configuration
- Maintained backward compatibility with existing projects

### Documentation Updates
- Added comprehensive Windows UAC guide with examples
- Updated project configuration reference with Windows options
- Included usage examples and supported execution levels

## Usage

Developers can now specify execution level in wails.json:

```json
{
  "info": {
    "windows": {
      "executionLevel": "requireAdministrator"
    }
  }
}
```

Supported values:
- `requireAdministrator`: Requires admin privileges
- `asInvoker`: Runs with invoker's privileges
- `highestAvailable`: Runs with highest available privileges

## Testing

Verified that:
- UAC trustInfo section is properly embedded in Windows executables
- Admin privileges persist when executables are copied between machines
- Backward compatibility maintained for existing projects
- Template processing works correctly during build

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
Copy link
Contributor

coderabbitai bot commented Jun 12, 2025

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@github-actions github-actions bot added Documentation Improvements or additions to documentation v2-only labels Jun 12, 2025
Copy link

Copy link

Deploying wails with  Cloudflare Pages  Cloudflare Pages

Latest commit: e3dbe29
Status: ✅  Deploy successful!
Preview URL: https://cd9b54b8.wails.pages.dev
Branch Preview URL: https://fix-windows-manifest-admin-p.wails.pages.dev

View logs

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation Improvements or additions to documentation v2-only
Projects
None yet
Development

Successfully merging this pull request may close these issues.

require admin permissions not persisting between machines
1 participant