mirror of
https://github.com/onionshare/onionshare.git
synced 2025-01-25 02:32:58 -03:00
Complete codesigning and packaging for Windows
This commit is contained in:
Micah Lee
parent
c23a7856eb
commit
a2b1f8b578
2 changed files with 195 additions and 155 deletions
23
RELEASE.md
23
RELEASE.md
|
|
@ -102,20 +102,35 @@ snapcraft upload --release=stable onionshare_${VERSION}_amd64.snap
|
||||||
|
|
||||||
Set up the development environment described in desktop `README.md`.
|
Set up the development environment described in desktop `README.md`.
|
||||||
|
|
||||||
- To get `signtool.exe`, install the [Windows 10 SDK](https://developer.microsoft.com/en-us/windows/downloads/windows-10-sdk) and add `C:\Program Files (x86)\Windows Kits\10\bin\10.0.22000.0\x86` to your path.
|
- To get `signtool.exe`, install the [Windows SDK](https://developer.microsoft.com/en-us/windows/downloads/windows-sdk/) and add `C:\Program Files (x86)\Windows Kits\10\bin\10.0.22000.0\x64` to your path.
|
||||||
- Go to https://dotnet.microsoft.com/download/dotnet-framework and download and install .NET Framework 3.5 SP1 Runtime. I downloaded `dotnetfx35.exe`.
|
- Go to https://dotnet.microsoft.com/download/dotnet-framework and download and install .NET Framework 3.5 SP1 Runtime. I downloaded `dotnetfx35.exe`.
|
||||||
- Go to https://wixtoolset.org/releases/ and download and install WiX toolset. I downloaded `wix311.exe`. Add `C:\Program Files (x86)\WiX Toolset v3.11\bin` to the path.
|
- Go to https://wixtoolset.org/releases/ and download and install WiX toolset. I downloaded `wix311.exe`. Add `C:\Program Files (x86)\WiX Toolset v3.11\bin` to the path.
|
||||||
|
|
||||||
Build the Windows binaries, delete extra files, codesign, and create an MSI package:
|
Build the Windows binaries, delete extra files, codesign, and create an MSI package:
|
||||||
|
|
||||||
|
CircleCI will build the binary and delete extra files, basically running these:
|
||||||
|
|
||||||
```
|
```
|
||||||
poetry run python .\setup-freeze.py build
|
poetry run python .\setup-freeze.py build
|
||||||
poetry run python .\scripts\build-windows.py cleanup-build
|
poetry run python .\scripts\build-windows.py cleanup-build
|
||||||
poetry run python .\scripts\build-windows.py codesign [build_dir]
|
|
||||||
poetry run python .\scripts\build-windows.py package [build_dir]
|
|
||||||
```
|
```
|
||||||
|
|
||||||
This will create `desktop/dist/OnionShare-$VERSION.msi`, signed.
|
Find the CircleCI jobs `build-win32` and `build-win64`, switch to the artifacts tab, and download:
|
||||||
|
|
||||||
|
- `onionshare-win32.zip`
|
||||||
|
- `onionshare-win64.zip`
|
||||||
|
|
||||||
|
Extract these files, then run:
|
||||||
|
|
||||||
|
```
|
||||||
|
poetry run python .\scripts\build-windows.py codesign [onionshare_win32_path] [onionshare_win64_path]
|
||||||
|
poetry run python .\scripts\build-windows.py package [onionshare_win32_path] [onionshare_win64_path]
|
||||||
|
```
|
||||||
|
|
||||||
|
This will create:
|
||||||
|
|
||||||
|
- `desktop/dist/OnionShare-win32-$VERSION.msi`
|
||||||
|
= `desktop/dist/OnionShare-win64-$VERSION.msi`
|
||||||
|
|
||||||
## macOS
|
## macOS
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -52,7 +52,7 @@ def sign(filename):
|
||||||
"/d",
|
"/d",
|
||||||
"OnionShare",
|
"OnionShare",
|
||||||
"/sha1",
|
"/sha1",
|
||||||
"bb1d265ab02272e8fc742f149dcf8751cac63f50",
|
"1a0345732140749bdaa03efe8591b2c2a036884c",
|
||||||
"/fd",
|
"/fd",
|
||||||
"SHA256",
|
"SHA256",
|
||||||
"/td",
|
"/td",
|
||||||
|
|
@ -169,6 +169,150 @@ def wix_build_components_xml(root, data):
|
||||||
return component_ids
|
return component_ids
|
||||||
|
|
||||||
|
|
||||||
|
def msi_package(build_path, msi_path, product_update_code):
|
||||||
|
print(f"> Build the WiX file")
|
||||||
|
version_filename = os.path.join(
|
||||||
|
build_path, "lib", "onionshare_cli", "resources", "version.txt"
|
||||||
|
)
|
||||||
|
with open(version_filename) as f:
|
||||||
|
version = f.read().strip()
|
||||||
|
|
||||||
|
data = {
|
||||||
|
"id": "TARGETDIR",
|
||||||
|
"name": "SourceDir",
|
||||||
|
"dirs": [
|
||||||
|
{
|
||||||
|
"id": "ProgramFilesFolder",
|
||||||
|
"dirs": [],
|
||||||
|
},
|
||||||
|
{
|
||||||
|
"id": "ProgramMenuFolder",
|
||||||
|
"dirs": [],
|
||||||
|
},
|
||||||
|
],
|
||||||
|
}
|
||||||
|
|
||||||
|
data["dirs"][0]["dirs"].append(
|
||||||
|
wix_build_data(
|
||||||
|
build_path,
|
||||||
|
".",
|
||||||
|
"INSTALLDIR",
|
||||||
|
"OnionShare",
|
||||||
|
)
|
||||||
|
)
|
||||||
|
|
||||||
|
root_el = ET.Element("Wix", xmlns="http://schemas.microsoft.com/wix/2006/wi")
|
||||||
|
product_el = ET.SubElement(
|
||||||
|
root_el,
|
||||||
|
"Product",
|
||||||
|
Name="OnionShare",
|
||||||
|
Manufacturer="Micah Lee, et al.",
|
||||||
|
Id="*",
|
||||||
|
UpgradeCode="$(var.ProductUpgradeCode)",
|
||||||
|
Language="1033",
|
||||||
|
Codepage="1252",
|
||||||
|
Version="$(var.ProductVersion)",
|
||||||
|
)
|
||||||
|
ET.SubElement(
|
||||||
|
product_el,
|
||||||
|
"Package",
|
||||||
|
Id="*",
|
||||||
|
Keywords="Installer",
|
||||||
|
Description="OnionShare $(var.ProductVersion) Installer",
|
||||||
|
Manufacturer="Micah Lee, et al.",
|
||||||
|
InstallerVersion="100",
|
||||||
|
Languages="1033",
|
||||||
|
Compressed="yes",
|
||||||
|
SummaryCodepage="1252",
|
||||||
|
)
|
||||||
|
ET.SubElement(product_el, "Media", Id="1", Cabinet="product.cab", EmbedCab="yes")
|
||||||
|
ET.SubElement(
|
||||||
|
product_el,
|
||||||
|
"Icon",
|
||||||
|
Id="ProductIcon",
|
||||||
|
SourceFile=os.path.join(
|
||||||
|
desktop_dir, "onionshare", "resources", "onionshare.ico"
|
||||||
|
),
|
||||||
|
)
|
||||||
|
ET.SubElement(product_el, "Property", Id="ARPPRODUCTICON", Value="ProductIcon")
|
||||||
|
ET.SubElement(
|
||||||
|
product_el,
|
||||||
|
"Property",
|
||||||
|
Id="ARPHELPLINK",
|
||||||
|
Value="https://docs.onionshare.org",
|
||||||
|
)
|
||||||
|
ET.SubElement(
|
||||||
|
product_el,
|
||||||
|
"Property",
|
||||||
|
Id="ARPURLINFOABOUT",
|
||||||
|
Value="https://onionshare.org",
|
||||||
|
)
|
||||||
|
ET.SubElement(product_el, "UIRef", Id="WixUI_Minimal")
|
||||||
|
ET.SubElement(product_el, "UIRef", Id="WixUI_ErrorProgressText")
|
||||||
|
ET.SubElement(
|
||||||
|
product_el,
|
||||||
|
"WixVariable",
|
||||||
|
Id="WixUILicenseRtf",
|
||||||
|
Value=os.path.join(desktop_dir, "package", "license.rtf"),
|
||||||
|
)
|
||||||
|
ET.SubElement(
|
||||||
|
product_el,
|
||||||
|
"WixVariable",
|
||||||
|
Id="WixUIDialogBmp",
|
||||||
|
Value=os.path.join(desktop_dir, "package", "dialog.bmp"),
|
||||||
|
)
|
||||||
|
ET.SubElement(
|
||||||
|
product_el,
|
||||||
|
"MajorUpgrade",
|
||||||
|
AllowSameVersionUpgrades="yes",
|
||||||
|
DowngradeErrorMessage="A newer version of [ProductName] is already installed. If you are sure you want to downgrade, remove the existing installation via Programs and Features.",
|
||||||
|
)
|
||||||
|
|
||||||
|
wix_build_dir_xml(product_el, data)
|
||||||
|
component_ids = wix_build_components_xml(product_el, data)
|
||||||
|
|
||||||
|
feature_el = ET.SubElement(product_el, "Feature", Id="DefaultFeature", Level="1")
|
||||||
|
for component_id in component_ids:
|
||||||
|
ET.SubElement(feature_el, "ComponentRef", Id=component_id)
|
||||||
|
ET.SubElement(feature_el, "ComponentRef", Id="ApplicationShortcuts")
|
||||||
|
|
||||||
|
with open(os.path.join(build_path, "OnionShare.wxs"), "w") as f:
|
||||||
|
f.write('<?xml version="1.0" encoding="windows-1252"?>\n')
|
||||||
|
f.write(f'<?define ProductVersion = "{version}"?>\n')
|
||||||
|
f.write(f'<?define ProductUpgradeCode = "{product_update_code}"?>\n')
|
||||||
|
|
||||||
|
ET.indent(root_el)
|
||||||
|
f.write(ET.tostring(root_el).decode())
|
||||||
|
|
||||||
|
print(f"> Build the MSI")
|
||||||
|
run(
|
||||||
|
[shutil.which("candle.exe"), "OnionShare.wxs"],
|
||||||
|
build_path,
|
||||||
|
)
|
||||||
|
run(
|
||||||
|
[shutil.which("light.exe"), "-ext", "WixUIExtension", "OnionShare.wixobj"],
|
||||||
|
build_path,
|
||||||
|
)
|
||||||
|
|
||||||
|
print(f"> Prepare OnionShare.msi for signing")
|
||||||
|
run(
|
||||||
|
[
|
||||||
|
shutil.which("insignia.exe"),
|
||||||
|
"-im",
|
||||||
|
os.path.join(build_path, "OnionShare.msi"),
|
||||||
|
],
|
||||||
|
error_ok=True,
|
||||||
|
)
|
||||||
|
sign(os.path.join(build_path, "OnionShare.msi"))
|
||||||
|
|
||||||
|
print(f"> Final MSI: {msi_path}")
|
||||||
|
os.makedirs(os.path.join(desktop_dir, "dist"), exist_ok=True)
|
||||||
|
os.rename(
|
||||||
|
os.path.join(build_path, "OnionShare.msi"),
|
||||||
|
msi_path,
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
@click.group()
|
@click.group()
|
||||||
def main():
|
def main():
|
||||||
"""
|
"""
|
||||||
|
|
@ -424,23 +568,28 @@ def cleanup_build():
|
||||||
|
|
||||||
|
|
||||||
@main.command()
|
@main.command()
|
||||||
@click.argument("build_path")
|
@click.argument("win32_path")
|
||||||
def codesign(build_path):
|
@click.argument("win64_path")
|
||||||
|
def codesign(win32_path, win64_path):
|
||||||
"""Sign Windows binaries before packaging"""
|
"""Sign Windows binaries before packaging"""
|
||||||
if not os.path.isdir(build_path):
|
paths = [win32_path, win64_path]
|
||||||
click.echo("Invalid build path")
|
|
||||||
return
|
|
||||||
|
|
||||||
click.echo("> Signing onionshare.exe")
|
for path in paths:
|
||||||
sign(os.path.join(build_path, "onionshare.exe"))
|
if not os.path.isdir(path):
|
||||||
|
click.echo("Invalid build path")
|
||||||
|
return
|
||||||
|
|
||||||
click.echo("> Signing onionshare-cli.exe")
|
for path in paths:
|
||||||
sign(os.path.join(build_path, "onionshare-cli.exe"))
|
bin_path = os.path.join(path, "onionshare.exe")
|
||||||
|
click.echo(f"> Signing {bin_path}")
|
||||||
|
sign(bin_path)
|
||||||
|
|
||||||
click.echo("> Signing meek-client.exe")
|
bin_path = os.path.join(path, "onionshare-cli.exe")
|
||||||
sign(
|
click.echo(f"> Signing {bin_path}")
|
||||||
os.path.join(
|
sign(bin_path)
|
||||||
build_path,
|
|
||||||
|
bin_path = os.path.join(
|
||||||
|
path,
|
||||||
"lib",
|
"lib",
|
||||||
"onionshare",
|
"onionshare",
|
||||||
"resources",
|
"resources",
|
||||||
|
|
@ -448,154 +597,30 @@ def codesign(build_path):
|
||||||
"Tor",
|
"Tor",
|
||||||
"meek-client.exe",
|
"meek-client.exe",
|
||||||
)
|
)
|
||||||
)
|
click.echo(f"> Signing {bin_path}")
|
||||||
|
sign(bin_path)
|
||||||
|
|
||||||
|
|
||||||
@main.command()
|
@main.command()
|
||||||
@click.argument("build_path")
|
@click.argument("win32_path")
|
||||||
def package(build_path):
|
@click.argument("win64_path")
|
||||||
|
def package(win32_path, win64_path):
|
||||||
"""Build the MSI package"""
|
"""Build the MSI package"""
|
||||||
|
|
||||||
print(f"> Build the WiX file")
|
|
||||||
version_filename = os.path.join(
|
version_filename = os.path.join(
|
||||||
root, "cli", "onionshare_cli", "resources", "version.txt"
|
root, "cli", "onionshare_cli", "resources", "version.txt"
|
||||||
)
|
)
|
||||||
with open(version_filename) as f:
|
with open(version_filename) as f:
|
||||||
version = f.read().strip()
|
version = f.read().strip()
|
||||||
|
|
||||||
data = {
|
msi_package(
|
||||||
"id": "TARGETDIR",
|
win32_path,
|
||||||
"name": "SourceDir",
|
os.path.join(desktop_dir, "dist", f"OnionShare-win32-{version}.msi"),
|
||||||
"dirs": [
|
"12b9695c-965b-4be0-bc33-21274e809576",
|
||||||
{
|
|
||||||
"id": "ProgramFilesFolder",
|
|
||||||
"dirs": [],
|
|
||||||
},
|
|
||||||
{
|
|
||||||
"id": "ProgramMenuFolder",
|
|
||||||
"dirs": [],
|
|
||||||
},
|
|
||||||
],
|
|
||||||
}
|
|
||||||
|
|
||||||
data["dirs"][0]["dirs"].append(
|
|
||||||
wix_build_data(
|
|
||||||
build_path,
|
|
||||||
"INSTALLDIR",
|
|
||||||
"OnionShare",
|
|
||||||
)
|
|
||||||
)
|
)
|
||||||
|
msi_package(
|
||||||
root_el = ET.Element("Wix", xmlns="http://schemas.microsoft.com/wix/2006/wi")
|
win64_path,
|
||||||
product_el = ET.SubElement(
|
os.path.join(desktop_dir, "dist", f"OnionShare-win64-{version}.msi"),
|
||||||
root_el,
|
"ed7f9243-3528-4b4a-b85c-9943982e75eb",
|
||||||
"Product",
|
|
||||||
Name="OnionShare",
|
|
||||||
Manufacturer="Micah Lee, et al.",
|
|
||||||
Id="*",
|
|
||||||
UpgradeCode="$(var.ProductUpgradeCode)",
|
|
||||||
Language="1033",
|
|
||||||
Codepage="1252",
|
|
||||||
Version="$(var.ProductVersion)",
|
|
||||||
)
|
|
||||||
ET.SubElement(
|
|
||||||
product_el,
|
|
||||||
"Package",
|
|
||||||
Id="*",
|
|
||||||
Keywords="Installer",
|
|
||||||
Description="OnionShare $(var.ProductVersion) Installer",
|
|
||||||
Manufacturer="Micah Lee, et al.",
|
|
||||||
InstallerVersion="100",
|
|
||||||
Languages="1033",
|
|
||||||
Compressed="yes",
|
|
||||||
SummaryCodepage="1252",
|
|
||||||
)
|
|
||||||
ET.SubElement(product_el, "Media", Id="1", Cabinet="product.cab", EmbedCab="yes")
|
|
||||||
ET.SubElement(
|
|
||||||
product_el,
|
|
||||||
"Icon",
|
|
||||||
Id="ProductIcon",
|
|
||||||
SourceFile="..\\onionshare\\resources\\onionshare.ico",
|
|
||||||
)
|
|
||||||
ET.SubElement(product_el, "Property", Id="ARPPRODUCTICON", Value="ProductIcon")
|
|
||||||
ET.SubElement(
|
|
||||||
product_el,
|
|
||||||
"Property",
|
|
||||||
Id="ARPHELPLINK",
|
|
||||||
Value="https://docs.onionshare.org",
|
|
||||||
)
|
|
||||||
ET.SubElement(
|
|
||||||
product_el,
|
|
||||||
"Property",
|
|
||||||
Id="ARPURLINFOABOUT",
|
|
||||||
Value="https://onionshare.org",
|
|
||||||
)
|
|
||||||
ET.SubElement(product_el, "UIRef", Id="WixUI_Minimal")
|
|
||||||
ET.SubElement(product_el, "UIRef", Id="WixUI_ErrorProgressText")
|
|
||||||
ET.SubElement(
|
|
||||||
product_el,
|
|
||||||
"WixVariable",
|
|
||||||
Id="WixUILicenseRtf",
|
|
||||||
Value="..\\package\\license.rtf",
|
|
||||||
)
|
|
||||||
ET.SubElement(
|
|
||||||
product_el,
|
|
||||||
"WixVariable",
|
|
||||||
Id="WixUIDialogBmp",
|
|
||||||
Value="..\\package\\dialog.bmp",
|
|
||||||
)
|
|
||||||
ET.SubElement(
|
|
||||||
product_el,
|
|
||||||
"MajorUpgrade",
|
|
||||||
AllowSameVersionUpgrades="yes",
|
|
||||||
DowngradeErrorMessage="A newer version of [ProductName] is already installed. If you are sure you want to downgrade, remove the existing installation via Programs and Features.",
|
|
||||||
)
|
|
||||||
|
|
||||||
wix_build_dir_xml(product_el, data)
|
|
||||||
component_ids = wix_build_components_xml(product_el, data)
|
|
||||||
|
|
||||||
feature_el = ET.SubElement(product_el, "Feature", Id="DefaultFeature", Level="1")
|
|
||||||
for component_id in component_ids:
|
|
||||||
ET.SubElement(feature_el, "ComponentRef", Id=component_id)
|
|
||||||
ET.SubElement(feature_el, "ComponentRef", Id="ApplicationShortcuts")
|
|
||||||
|
|
||||||
with open(os.path.join(root, "desktop", "build", "OnionShare.wxs"), "w") as f:
|
|
||||||
f.write('<?xml version="1.0" encoding="windows-1252"?>\n')
|
|
||||||
f.write(f'<?define ProductVersion = "{version}"?>\n')
|
|
||||||
f.write(
|
|
||||||
'<?define ProductUpgradeCode = "12b9695c-965b-4be0-bc33-21274e809576"?>\n'
|
|
||||||
)
|
|
||||||
|
|
||||||
ET.indent(root_el)
|
|
||||||
f.write(ET.tostring(root_el).decode())
|
|
||||||
|
|
||||||
print(f"> Build the MSI")
|
|
||||||
run(
|
|
||||||
[shutil.which("candle.exe"), "OnionShare.wxs"],
|
|
||||||
os.path.join(desktop_dir, "build"),
|
|
||||||
)
|
|
||||||
run(
|
|
||||||
[shutil.which("light.exe"), "-ext", "WixUIExtension", "OnionShare.wixobj"],
|
|
||||||
os.path.join(desktop_dir, "build"),
|
|
||||||
)
|
|
||||||
|
|
||||||
print(f"> Prepare OnionShare.msi for signing")
|
|
||||||
run(
|
|
||||||
[
|
|
||||||
shutil.which("insignia.exe"),
|
|
||||||
"-im",
|
|
||||||
os.path.join(desktop_dir, "build", "OnionShare.msi"),
|
|
||||||
],
|
|
||||||
error_ok=True,
|
|
||||||
)
|
|
||||||
sign(os.path.join(desktop_dir, "build", "OnionShare.msi"))
|
|
||||||
|
|
||||||
final_msi_filename = os.path.join(desktop_dir, "dist", f"OnionShare-{version}.msi")
|
|
||||||
print(f"> Final MSI: {final_msi_filename}")
|
|
||||||
os.makedirs(os.path.join(desktop_dir, "dist"), exist_ok=True)
|
|
||||||
os.rename(
|
|
||||||
os.path.join(desktop_dir, "build", "OnionShare.msi"),
|
|
||||||
final_msi_filename,
|
|
||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
|
|
||||||
Loading…
Add table
Reference in a new issue