Skip to content

Security policy

The full policy lives in SECURITY.md in the vaultkeepr-public repository. This page summarizes it.

Do not open a public GitHub issue for a security vulnerability. Report it privately:

  • GitHub Security Advisories (preferred): use the “Report a vulnerability” button on the Security tab of the repository.
  • Email: [email protected]

Include a description of the issue and its impact, steps to reproduce (a proof of concept if possible), and the affected packages and versions. The project acknowledges reports within 48 hours and aims to provide a fix or mitigation within 30 days, depending on severity. Coordinated disclosure is appreciated.

There is no standing bounty for reports sent by email. Security rewards are distributed through the public Vault Challenge. The first edition has ended; the next one is in preparation, with a pool that grows as the challenge runs. Follow the project’s public channels for the launch announcement. Confirmed reports are credited in the public changelog, by name or handle with the reporter’s consent.

The policy covers the open-source packages and Solidity contracts: packages/core, packages/sync, packages/ipfs, packages/recovery, packages/premium, packages/wallet-messages, packages/smart-account, packages/cloud, packages/alias, packages/logger, packages/i18n, packages/ui, packages/sentry, packages/legacy, packages/ocr-native, and contracts/.

The web app, browser extension, iOS/Android apps, and the enterprise/API server are in a private repository and are out of scope for this public policy.

Finding type Severity Target
Dependency (SCA) Critical / High Fix or mitigate within 7 days
Dependency (SCA) Medium Within 30 days
Dependency (SCA) Low Within 90 days, or accepted with written justification
SAST (CodeQL) New High/Critical Blocks merge; triage within 7 days

Open findings that cannot be fixed upstream are documented in the accepted risk register in SECURITY.md and re-evaluated monthly.

Automated scan reports for the shipped clients and web app are published in the repository’s audits/ directory. These are tool-generated reports, not manual third-party code audits. Past reports include extension, iOS, and Android audits, VirusTotal scans, an MDN HTTP Observatory report for vaultkeepr.xyz, MobSF static analysis of the Android APK, and Maestro end-to-end runs. They are refreshed with each client release.

Client artifacts (Android APK, iOS IPA, browser extensions) are signed with minisign (Ed25519). The public key is committed in the repository as minisign.pub:

Historical example: v1.8.5 includes this APK, its signature, checksums and their signature. This is not a recommendation to install an old version or a statement of the current store version. The v1.8.10 tag has no client assets in the inventory used for this example. For another version, first check the assets on its release page and use their exact filenames.

Prerequisites: GitHub CLI (gh), curl, minisign and shasum. Use an empty directory. The command downloads all release assets because checksums.txt also references the iOS and browser archives. Check that the public key matches the signing key published by the project before trusting it. Authenticate checksums.txt before using its checksums:

Terminal window
set -euo pipefail
gh release download v1.8.5 -R VaultKeepR/vaultkeepr-public
curl --fail --location --output minisign.pub https://raw.githubusercontent.com/VaultKeepR/vaultkeepr-public/main/minisign.pub
minisign -Vm checksums.txt -x checksums.txt.minisig -p minisign.pub
minisign -Vm VaultKeepR-v1.8.5-android.apk -x VaultKeepR-v1.8.5-android.apk.minisig -p minisign.pub
shasum -a 256 -c checksums.txt

Do not assume that every release tag contains binaries. If any signature or checksum check fails, stop: do not install the artifact and report the problem privately.

The @vaultkeepr/* npm packages are built by GitHub Actions from the repository and carry SLSA build provenance:

Terminal window
set -euo pipefail
tarball="$(npm pack @vaultkeepr/core --silent)"
gh attestation verify "$tarball" --repo VaultKeepR/vaultkeepr-public

This attestation covers the npm SDK tarballs only. Application artifacts are built on the maintainer’s machine and covered by the minisign signature and the signed checksums; no CI build provenance is claimed for them.