sign.toml is the configuration file for cargo-codesign. It maps platform signing settings to environment variable names.
cargo-codesign looks for config in this order:
--config <PATH> flag (explicit)./sign.toml (project root)./.cargo/sign.toml (fallback)
If both ./sign.toml and ./.cargo/sign.toml exist, ./sign.toml wins and a warning is emitted.
# sign.toml — cargo-codesign configuration
# Generate with: cargo codesign init (coming soon)
[macos]
identity = "Developer ID Application"
entitlements = "entitlements.plist"
auth = "api-key" # "api-key" (CI) or "apple-id" (local/indie)
[macos.dmg]
background = "assets/dmg-background.png"
window-size = [660, 400]
icon-size = 128
app-position = [160, 200]
app-drop-link = [500, 200]
[macos.env]
# api-key mode
certificate = "MACOS_CERTIFICATE"
certificate-password = "MACOS_CERTIFICATE_PASSWORD"
notarization-key = "APPLE_NOTARIZATION_KEY"
notarization-key-id = "APPLE_NOTARIZATION_KEY_ID"
notarization-issuer = "APPLE_NOTARIZATION_ISSUER_ID"
# apple-id mode
apple-id = "APPLE_ID"
team-id = "APPLE_TEAM_ID"
app-password = "APPLE_APP_PASSWORD"
[windows]
timestamp-server = "http://timestamp.acs.microsoft.com"
[windows.env]
tenant-id = "AZURE_TENANT_ID"
client-id = "AZURE_CLIENT_ID"
client-secret = "AZURE_CLIENT_SECRET"
endpoint = "AZURE_SIGNING_ENDPOINT"
account-name = "AZURE_SIGNING_ACCOUNT_NAME"
cert-profile = "AZURE_SIGNING_CERT_PROFILE"
[linux]
method = "cosign" # cosign | minisign | gpg
[linux.env]
key = "COSIGN_PRIVATE_KEY"
[update]
public-key = "update-signing.pub"
[update.env]
signing-key = "UPDATE_SIGNING_KEY"
[status]
cert-warn-days = 60
cert-error-days = 7
| Field | Type | Default | Description |
|---|
identity | string | "Developer ID Application" | Signing identity substring |
entitlements | path | none | Path to entitlements plist |
auth | "api-key" or "apple-id" | required | Notarization auth mode |
Optional. When present, the DMG gets a styled installer window with a background image and positioned icons. When absent, a plain DMG is created.
| Field | Type | Description |
|---|
background | path | Background image (PNG recommended). Relative to the directory where cargo codesign runs. |
window-size | [width, height] | Finder window size in pixels, e.g. [660, 400]. |
icon-size | integer | Icon size in the Finder window (px), e.g. 128. |
app-position | [x, y] | Position of the .app icon in the window. |
app-drop-link | [x, y] | Position of the Applications symlink icon. |
All fields are required when the section is present. See DMG Styling for a complete walkthrough.
Maps credential fields to environment variable names. Which fields are required depends on the auth mode:
apple-id mode:
| Field | Required | Description |
|---|
apple-id | yes | Env var for Apple ID email |
team-id | yes | Env var for team ID |
app-password | yes | Env var for app-specific password |
api-key mode:
| Field | Required | Description |
|---|
certificate | yes | Env var for base64 .p12 certificate |
certificate-password | yes | Env var for .p12 password |
notarization-key | yes | Env var for base64 .p8 API key |
notarization-key-id | yes | Env var for API key ID |
notarization-issuer | yes | Env var for issuer ID |
| Field | Type | Default | Description |
|---|
timestamp-server | string | none | Timestamp server URL |
| Field | Description |
|---|
tenant-id | Azure tenant ID |
client-id | Azure client ID |
client-secret | Azure client secret |
endpoint | Azure signing endpoint |
account-name | Azure signing account name |
cert-profile | Azure certificate profile |
| Field | Type | Description |
|---|
method | "cosign", "minisign", or "gpg" | Signing method |
| Field | Description |
|---|
key | Signing key env var |
| Field | Type | Description |
|---|
public-key | path | Path to public key file |
| Field | Description |
|---|
signing-key | Env var for base64 Ed25519 private key |
| Field | Type | Description |
|---|
cert-warn-days | integer | Warn when cert expires within N days |
cert-error-days | integer | Error when cert expires within N days |
All sections use deny_unknown_fields — typos in field names cause a clear parse error rather than being silently ignored.