Keys & Signing
DayZ servers that verify signatures accept a mod only if each of its PBOs carries a signature made by a key the server trusts. This page creates your key pair, signs PBOs and checks a mod folder the way a server does. It replaces Bohemia's DSCreateKey, DSSignFile and DSCheckSignatures and produces the same files. You need packed PBOs to sign (PBO Packer or Build mod on Steam Workshop).
It is the second step of the build-and-ship path: pack, sign, test in the Launcher, publish from Steam Workshop. You create a key once; after that, Build mod signs for you with it.
The screen
- Create key pair (top left): Authority name (the name of your key), Key size,
Output folder, Generate. It writes
<name>.biprivatekeyand<name>.bikeyinto the folder. The first key you create becomes the default key. - Sign PBOs (top right): Private key (prefilled with the default key), the target (a mod
folder such as
@MyModor itsaddonsfolder, or one PBO through PBO file…), the option Remove other keys' signatures and copy the .bikey into the mod's keys/ (on by default), Sign, Set as default key, and a log of every file written or removed. - Check signatures (bottom): Mod folder, Trusted keys (a
.bikeyfile or a folder of them; empty uses the mod's ownkeys/folder), Check, then a table with one row per PBO: valid, unsigned, unknown key, INVALID or error, with the detail.
First steps
- In Create key pair, type an authority name: your mod tag, without spaces (e.g.
MyModTag). - Choose an output folder outside your mod folder (for example a
keysfolder in your documents, orci/keysof your project if that folder is not published). - Press Generate. Two files are written, and the key becomes your default key.
- In Sign PBOs, choose your built mod folder (
…/target/@MyMod) and press Sign. Each PBO gets a.bisign, and your.bikeyis copied to@MyMod/keys/. - In Check signatures, choose the same mod folder and press Check: every row must be valid.
Take the tour (in the app)
Common tasks
Create your key pair (once)
- Authority name, output folder, Generate.
- Back up the
.biprivatekeysomewhere safe. If you lose it you cannot sign updates with the same key, and server owners must install a new.bikey.
Sign a whole mod
- Private key: your
.biprivatekey. - Target: the
@Modfolder (everyaddons/*.pbois signed). - Keep the tidy option ticked, press Sign, read the log.
Sign one PBO
- Press PBO file… and pick the
.pbo. - Sign. The
.bisignis written next to it. If the PBO is not in an@Mod/addonsfolder, the log says there is nokeys/folder to copy the.bikeyinto.
Check a mod before giving it to a server
- Mod folder: the
@Modfolder. - Leave Trusted keys empty to check against
@Mod/keys, or point it at a server'skeysfolder to know what that server would say. - Check. Fix anything that is not valid: unsigned (sign it), unknown key (the
.bikeyof that signature is not among the trusted keys), INVALID (the PBO changed after it was signed: sign again).
Make a key the default
- Put its path in Private key, press Set as default key.
- The PBO page ("Sign after packing") and Build mod use it when the project has no key of its own.
Examples
This page has no example to open: it works on your own keys and mods. To see real signatures,
look at a Workshop mod folder on your disk: its addons folder has a .bisign next to each
.pbo and its keys folder has the author's .bikey. Checking such a folder is safe: Check
only reads.
Concepts
.biprivatekey: your private key. It makes signatures. Whoever has it can sign PBOs in your name. It stays on your computer and is never published, committed to a public repository, sent to a server owner or shown to an assistant..bikey: the matching public key. It can only verify signatures. It is meant to be given away: it ships in thekeys/folder of your mod..bisign: the signature of one PBO made with one private key, named<pbo name>.<authority>.bisign, stored next to the PBO inaddons/. This page writes version 3 signatures, the version DayZ uses.- Authority: the name inside a key and its signatures; it is how a signature finds its key.
- Where each file goes:
@MyMod/addons/x.pboand@MyMod/addons/x.pbo.<authority>.bisign: shipped with the mod.@MyMod/keys/<authority>.bikey: shipped with the mod, for server owners.<DayZ Server>/keys/<authority>.bikey: the server owner copies it there. A server trusts exactly the keys in itskeys/folder. The Launcher does this copy for you when it starts a local server.<authority>.biprivatekey: nowhere but your own machine and your backup.verifySignatures: the setting of the server config (serverDZ.cfg) that makes the server check signatures.verifySignatures = 2;is the value to use; the Launcher's diagnostics flag any other value. With it on, a client loading a PBO whose signature the server does not trust is kicked. Reference: the "DayZ:Server Configuration" page of the Bohemia Interactive community wiki, https://community.bistudio.com/wiki/DayZ:Server_Configuration.- One key set per mod: a PBO signed by two keys, or a leftover
.bisignof an old key, confuses checks and uploads. The tidy option removes signatures of the same PBO made with other keys and lists each removed file.
Pitfalls
- Publishing the private key: never generate the key inside the folder you upload
(
@MyMod). The Workshop pre-flight checks refuse an upload that contains a private key. - Repacking after signing: a PBO changed after signing is INVALID. Always sign last. Build mod removes outdated signatures and signs again.
- Forgetting the
.bikey: withoutkeys/<authority>.bikeyin the mod, server owners cannot trust it. The tidy option and Build mod put it there. - Losing the key: a new key means a new
.bikeyfor every server that runs your mod. - "unknown key" on a mod you just signed: the trusted keys you checked against do not
include your
.bikey; leave the field empty to use the mod's ownkeys/. - Buttons greyed out: hover them, the tooltip says what is missing (authority name, output folder, key, target, mod folder).
For agents
- Tools of
dztthat do the same work without the window: sign_create_key: create a.biprivatekey+.bikeypair (like DSCreateKey).sign_pbo: sign one PBO or every PBO of a mod folder (v3); like the page, removes signatures of the same PBO by other keys and copies the.bikeyinto the mod'skeys/.sign_check: verify a mod folder against trusted.bikeyfiles (default: the mod'skeys/).pbo_packwith a key signs right after packing;mod_buildsigns the whole mod.- Files read: the
.biprivatekey, the PBOs, the.bikeyfiles of the trusted keys or of@Mod/keys(alsoKeys). Files written: the key pair in the chosen folder;.bisignnext to each PBO;@Mod/keys/<authority>.bikey;.bisignof other keys are deleted when the tidy option is on. The default key path is stored in the settings (private_key). - Page state given to the assistant: the authority being created, the PBO or folder to sign, the mod folder checked, the keys checked against, and as problems every check row that is not valid plus the warning / error lines of the signing log. Key files are named, never read or sent. Never ask the user to paste a private key.
- Anchors:
signing-create,signing-generate,signing-sign,signing-tidy,signing-sign-button,signing-set-default,signing-check,signing-check-button.
See also
- PBO Packer: pack (and optionally sign) one addon.
- Steam Workshop: Build mod packs and signs the whole mod, then publishes.
- Launcher: its Diagnostics tab checks
verifySignaturesand unsigned mods. - Beans Workbench overview.