Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
86 changes: 84 additions & 2 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,24 +7,106 @@ on:
permissions:
contents: write

# Code signing is free for open-source projects through the SignPath Foundation
# (see docs/code-signing.md). It switches on by itself once the repository has
# the variable SIGNPATH_ORGANIZATION_ID and the secret SIGNPATH_API_TOKEN; until
# then the release is built exactly as before, unsigned.
env:
SIGNPATH_PROJECT: ${{ vars.SIGNPATH_PROJECT_SLUG || 'TaskGlass' }}
SIGNPATH_POLICY: ${{ vars.SIGNPATH_SIGNING_POLICY_SLUG || 'release-signing' }}

jobs:
release:
runs-on: windows-latest
timeout-minutes: 120
steps:
- uses: actions/checkout@v7
- uses: actions/setup-go@v6
with:
go-version-file: go.mod
- run: go test ./...
- name: Build

- name: Build binaries
shell: pwsh
run: |
$v = "${{ github.ref_name }}".TrimStart("v")
$env:GOOS = "windows"; $env:GOARCH = "amd64"
go build -ldflags "-H=windowsgui -s -w -X main.version=$v" -o dist/taskglass.exe ./cmd/taskglass
./scripts/build-tap.ps1
Compress-Archive -Path dist/taskglass.exe, dist/taskglass_tap.dll, LICENSE, NOTICE, README.md -DestinationPath "dist/taskglass-$v-windows-amd64.zip"

# --- sign taskglass.exe and taskglass_tap.dll (only when SignPath is set up)
- name: Upload unsigned binaries
id: unsigned-binaries
if: ${{ vars.SIGNPATH_ORGANIZATION_ID != '' }}
uses: actions/upload-artifact@v7
with:
name: unsigned-binaries
path: |
dist/taskglass.exe
dist/taskglass_tap.dll
- name: Sign binaries
if: ${{ vars.SIGNPATH_ORGANIZATION_ID != '' }}
uses: signpath/github-action-submit-signing-request@v1
with:
api-token: ${{ secrets.SIGNPATH_API_TOKEN }}
organization-id: ${{ vars.SIGNPATH_ORGANIZATION_ID }}
project-slug: ${{ env.SIGNPATH_PROJECT }}
signing-policy-slug: ${{ env.SIGNPATH_POLICY }}
artifact-configuration-slug: binaries
github-artifact-id: ${{ steps.unsigned-binaries.outputs.artifact-id }}
wait-for-completion: true
wait-for-completion-timeout-in-seconds: 3600
output-artifact-directory: signed/binaries
- name: Use the signed binaries
if: ${{ vars.SIGNPATH_ORGANIZATION_ID != '' }}
shell: pwsh
run: |
Copy-Item signed/binaries/taskglass.exe, signed/binaries/taskglass_tap.dll dist/ -Force
foreach ($f in "dist/taskglass.exe", "dist/taskglass_tap.dll") {
$s = Get-AuthenticodeSignature $f
if ($s.Status -ne "Valid") { throw "$f is not validly signed: $($s.Status)" }
}

- name: Package (zip and installer)
shell: pwsh
run: |
$v = "${{ github.ref_name }}".TrimStart("v")
Compress-Archive -Path dist/taskglass.exe, dist/taskglass_tap.dll, LICENSE, LICENSE.es.txt, NOTICE, README.md -DestinationPath "dist/taskglass-$v-windows-amd64.zip"
./scripts/build-installer.ps1 -Version $v

# --- sign the installer too
- name: Upload unsigned installer
id: unsigned-installer
if: ${{ vars.SIGNPATH_ORGANIZATION_ID != '' }}
uses: actions/upload-artifact@v7
with:
name: unsigned-installer
path: dist/*-Setup.exe
- name: Sign installer
if: ${{ vars.SIGNPATH_ORGANIZATION_ID != '' }}
uses: signpath/github-action-submit-signing-request@v1
with:
api-token: ${{ secrets.SIGNPATH_API_TOKEN }}
organization-id: ${{ vars.SIGNPATH_ORGANIZATION_ID }}
project-slug: ${{ env.SIGNPATH_PROJECT }}
signing-policy-slug: ${{ env.SIGNPATH_POLICY }}
artifact-configuration-slug: installer
github-artifact-id: ${{ steps.unsigned-installer.outputs.artifact-id }}
wait-for-completion: true
wait-for-completion-timeout-in-seconds: 3600
output-artifact-directory: signed/installer
- name: Use the signed installer
if: ${{ vars.SIGNPATH_ORGANIZATION_ID != '' }}
shell: pwsh
run: |
Copy-Item (Get-ChildItem signed/installer/*-Setup.exe).FullName dist/ -Force
$f = Get-ChildItem dist/*-Setup.exe
$s = Get-AuthenticodeSignature $f.FullName
if ($s.Status -ne "Valid") { throw "$($f.Name) is not validly signed: $($s.Status)" }

- name: Checksums
shell: pwsh
run: |
Get-ChildItem dist/*.zip, dist/*-Setup.exe | ForEach-Object {
"$((Get-FileHash $_.FullName -Algorithm SHA256).Hash.ToLower()) $($_.Name)"
} | Out-File dist/SHA256SUMS.txt -Encoding ascii
Expand Down
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,12 @@

Format based on [Keep a Changelog](https://keepachangelog.com/); versioning follows [SemVer](https://semver.org/).

## [Unreleased]

### Added
- **Code signing in the release workflow.** The release now signs `taskglass.exe`, `taskglass_tap.dll` and the installer through the free SignPath Foundation programme for open-source projects, verifies every signature and fails the release if one is invalid. It stays off (releases remain unsigned) until the repository has the `SIGNPATH_ORGANIZATION_ID` variable and the `SIGNPATH_API_TOKEN` secret; setup is in `docs/code-signing.md`.
- The release zip now also includes the Spanish license text (`LICENSE.es.txt`).

## [1.3.1] - 2026-11-20

### Changed
Expand Down
139 changes: 139 additions & 0 deletions docs/code-signing.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,139 @@
# Code signing

Unsigned programs that hook into other processes are often flagged by antivirus
heuristics and by Windows SmartScreen. Signing `taskglass.exe`,
`taskglass_tap.dll` and the installer with a trusted certificate removes most
of those false positives.

Signing is free for open-source projects through the
[SignPath Foundation](https://signpath.org/) (certificate issued to the
foundation, signing done by [SignPath.io](https://signpath.io/)). The release
workflow is already prepared: it **stays unsigned until you complete the setup
below**, then signs by itself. Nothing else has to change.

[Versión en español más abajo.](#firma-de-código)

## One-time setup

1. **Apply** for the open-source programme on the SignPath Foundation site
(project: TaskGlass, repository `AnderCMD/TaskGlass`, Apache-2.0). They review
the project by hand; approval is not instant.
2. In SignPath create the **project** (slug `TaskGlass`), the **signing policy**
`release-signing`, and two **artifact configurations** (below). Connect the
project to the GitHub repository (trusted build system: GitHub Actions).
3. Create an **API token** for a CI user that may submit to that policy.
4. In the GitHub repository (**Settings → Secrets and variables → Actions**) add:

| Kind | Name | Value |
|------|------|-------|
| Variable | `SIGNPATH_ORGANIZATION_ID` | your SignPath organization id (turns signing on) |
| Secret | `SIGNPATH_API_TOKEN` | the CI user's API token |
| Variable (optional) | `SIGNPATH_PROJECT_SLUG` | default `TaskGlass` |
| Variable (optional) | `SIGNPATH_SIGNING_POLICY_SLUG` | default `release-signing` |

5. Add the code signing policy statement SignPath asks for to the README, for
example:

> Free code signing provided by [SignPath.io](https://signpath.io), certificate
> by [SignPath Foundation](https://signpath.org). TaskGlass makes no network connections; see
> `SECURITY.md`.

6. Push a tag (`vX.Y.Z`). The workflow signs the binaries, builds the zip and the
installer from the signed binaries, signs the installer, checks every
signature with `Get-AuthenticodeSignature` (the release fails if one is
invalid) and publishes.

If the signing policy requires manual approval, the workflow waits (up to an
hour) for you to approve the request in SignPath.

## Artifact configurations

`binaries` (the zip with `taskglass.exe` and `taskglass_tap.dll`):

```xml
<artifact-configuration xmlns="http://signpath.io/artifact-configuration/v1">
<zip-file>
<pe-file-set>
<include path="*.exe" />
<include path="*.dll" />
<authenticode-sign />
</pe-file-set>
</zip-file>
</artifact-configuration>
```

`installer` (the zip with `TaskGlass-<version>-Setup.exe`):

```xml
<artifact-configuration xmlns="http://signpath.io/artifact-configuration/v1">
<zip-file>
<pe-file-set>
<include path="*-Setup.exe" />
<authenticode-sign />
</pe-file-set>
</zip-file>
</artifact-configuration>
```

SignPath validates a configuration when you save it; if its editor suggests a
different element name for your plan, follow the editor.

## Good to know

- Signing does not make an antivirus trust a program instantly: SmartScreen and
some engines also look at download reputation, which builds up over time.
A signed file with a stable publisher identity is, however, far less likely to
be quarantined.
- Never commit certificates or tokens. The workflow only reads the secret above.
- Until signing is enabled, report a false positive to the antivirus vendor and
verify downloads with `SHA256SUMS.txt`.

---

# Firma de código

Los programas sin firmar que se enganchan a otros procesos suelen ser marcados
por la heurística de los antivirus y por Windows SmartScreen. Firmar
`taskglass.exe`, `taskglass_tap.dll` y el instalador con un certificado de
confianza elimina la mayoría de esos falsos positivos.

La firma es gratuita para proyectos de código abierto mediante la
[SignPath Foundation](https://signpath.org/) (el certificado pertenece a la
fundación y la firma la hace [SignPath.io](https://signpath.io/)). El workflow de
publicación ya está preparado: **se mantiene sin firmar hasta que completes la
configuración**, y entonces firma solo. No hay que cambiar nada más.

## Configuración (una sola vez)

1. **Solicita** el programa de código abierto en el sitio de SignPath Foundation
(proyecto TaskGlass, repositorio `AnderCMD/TaskGlass`, Apache-2.0). Revisan el
proyecto a mano; la aprobación no es inmediata.
2. En SignPath crea el **proyecto** (slug `TaskGlass`), la **política de firma**
`release-signing` y las dos **configuraciones de artefacto** (arriba), y
conecta el proyecto con el repositorio de GitHub (sistema de compilación de
confianza: GitHub Actions).
3. Crea un **token de API** para un usuario de CI que pueda enviar a esa política.
4. En el repositorio de GitHub (**Settings → Secrets and variables → Actions**)
añade la variable `SIGNPATH_ORGANIZATION_ID` (activa la firma) y el secreto
`SIGNPATH_API_TOKEN`. Opcionales: las variables `SIGNPATH_PROJECT_SLUG` y
`SIGNPATH_SIGNING_POLICY_SLUG` si usas otros nombres.
5. Añade al README la declaración de política de firma que pide SignPath (el
ejemplo de arriba, traducida si quieres).
6. Sube un tag (`vX.Y.Z`). El workflow firma los binarios, construye el zip y el
instalador con los binarios firmados, firma el instalador, comprueba cada
firma con `Get-AuthenticodeSignature` (la release falla si alguna no es
válida) y publica.

Si la política exige aprobación manual, el workflow espera (hasta una hora) a que
apruebes la solicitud en SignPath.

## Conviene saber

- Firmar no hace que un antivirus confíe al instante: SmartScreen y algunos
motores también valoran la reputación de la descarga, que se gana con el
tiempo. Aun así, un archivo firmado con un editor estable tiene muchas menos
probabilidades de ir a cuarentena.
- Nunca subas certificados ni tokens al repositorio. El workflow solo lee el
secreto indicado.
- Mientras la firma no esté activa, notifica el falso positivo al fabricante del
antivirus y verifica las descargas con `SHA256SUMS.txt`.