Skip to navigation

Set up app hashes

A real release example

Say you ship Northstar Editor 2.3.0. You want the copy you built and tested to sign in, but you do not want an old or changed executable to pass the same check.

SHA-256 makes a fingerprint from the exact bytes in one file. If one byte changes, the fingerprint changes too. AuthlyX compares the hash sent by the SDK with the hashes you approved for that app.

Yes No Build Northstar Editor 2.3.0 Calculate SHA-256 of Northstar.exe Add hash to this app in AuthlyX Enable hash checking Customer starts Northstar.exe SDK sends configured build hashat sign-in Hash is on the app allowlist? Continue normal access checks Reject sign-in

Hash checking is one extra check. It does not prove that a desktop app cannot be changed, and it does not replace license, user or device checks.

Get the hash for the file you ship

Build the file you want to approve, then run this in PowerShell:

Get-FileHash -LiteralPath '.\MyApp.exe' -Algorithm SHA256

For example, if the SDK reports the hash of Northstar.exe, calculate the hash of Northstar.exe. Do not calculate the ZIP hash unless your app actually reports the ZIP hash. Copy the 64-character Hash value from PowerShell.

Add it to AuthlyX

  1. Open Northstar Editor in the dashboard and go to Settings.
  2. Open Hash management.
  3. Add the SHA-256 hash of the approved build.
  4. Enable Hash checking in this tab and save.
  5. Configure the SDK’s build-hash option with the same 64-character value. This is the buildHash sent during sign-in. It must describe the same file you hashed above.
  6. Test the approved build, then test a changed file. A request that omits the hash must be rejected while checking is enabled.

Release another build

Before sending version 2.3.1 to customers, calculate the new executable’s hash and add it too. Keep the 2.3.0 hash while customers still need that build. Remove it only when you are ready for 2.3.0 to fail this check. The version text (2.3.0) and the SHA-256 fingerprint are separate values.