Documentation
Last updated: [DATE]
What Qunoq does, how to read its results, and where it can be wrong.
Getting started
- Sign in with GitHub. Qunoq asks for read-only access.
- Import a repository from the Repositories page. A scan starts straight away.
- Open Findings to see each cryptographic use, where it is, and whether a quantum computer breaks it. Each finding has a recommended replacement.
- Triage: mark findings, create tickets or GitHub Issues, or request a risk exception.
- Want a quick look without an account? The public scanner checks any public domain's TLS.
What we detect
Qunoq finds cryptography in four places.
- Source code patterns: use of algorithms and APIs in C/C++, C#, Go, Java/Kotlin, JavaScript/TypeScript, PHP, Python, Ruby, Rust, shell and Swift.
- Dependencies: cryptographic libraries declared in package manifests.
- Key and certificate files committed to a repository (only a fingerprint is kept, never key material).
- TLS configuration and live endpoints: protocol versions, key exchange, certificate and HSTS, graded A to F.
Typical categories: RSA, ECDSA/ECDH, DSA and Diffie-Hellman (broken by a large quantum computer); weak classical choices such as MD5, SHA-1, DES/3DES, RC4 and ECB mode; symmetric ciphers and hashes; and post-quantum algorithms such as ML-KEM and ML-DSA. The rule list evolves; see the rule files in the repository (crates/qunoq-rules).
Quantum status meanings
| Status | Meaning |
|---|---|
| Vulnerable | Relies on maths a large quantum computer is expected to break (for example RSA, ECDSA, ECDH, finite-field DH). Plan a migration. |
| Investigate | Not clearly safe or unsafe from what we can see: weak or legacy classical crypto, or a use whose context we cannot determine. Needs a human look. |
| Safe | Considered safe against known quantum attacks at the parameters seen (for example AES-256, SHA-256 and larger). |
| PQC | A post-quantum algorithm (for example ML-KEM, ML-DSA) or a hybrid that includes one. |
Scoring
Each finding gets a 0 to 100 priority score from these factors:
| Factor | Weight |
|---|---|
| Production | 20 |
| Internet-facing | 20 |
| Harvest-now-decrypt-later or long-lived signatures | 20 |
| Sensitive data | 15 |
| Critical service | 15 |
| PQC fix available | 10 |
| Classically weak | 15 |
Tiers: Critical at 85 and above, High at 65, Medium at 45, otherwise Low. Open a finding to see which factors applied and why.
Workspace readiness combines inventory coverage (25%), risk triage (20%), ownership (15%), migration planning (20%) and high-risk remediation (20%). It measures how far along your migration is. It is readiness, not certification.
CBOM export
A cryptographic bill of materials lists every algorithm, key size, library and certificate found. From Reports, export a CycloneDX 1.6 CBOM (qunoq-cbom.cdx.json), a findings CSV, or an executive brief. Exports come from your own workspace data and contain paths and redacted evidence only, never source code.
Publish a repository summary, badge and attestation
Publishing is opt-in per repository, admin-only, and limited to public repositories. Once published:
- A public page at
/r/<owner>/<name>shows a grade plus severity counts and algorithm families. It never shows paths, lines or snippets. - A badge is available as SVG for your README; the page gives the Markdown to copy.
- A signed attestation (
attestation.json) is signed with both Ed25519 and ML-DSA-65. Anyone can check it at /verify; both signatures must pass. Public keys are at/.well-known/qunoq-keys.json.
Unpublish at any time and the page, badge and attestation return a not-found.
Domain verification
To scan a domain from your workspace, or publish its attestation, prove you control it. Add the token Qunoq shows you either as a DNS TXT record qunoq-verify=<token> on the host, or as a line in https://<host>/.well-known/qunoq.txt, then press Verify. Verification lasts 90 days and can be renewed. See also the acceptable use policy.
FAQ
- Is my code stored?
- No. A temporary checkout is read during the scan and then deleted. We keep paths, line ranges, rule ids and evidence snippets of at most 240 characters with secrets redacted. See the data map.
- Do you run my code?
- No. Repositories are treated as untrusted data: we never build, install or execute anything from them.
- What access does Qunoq need?
- Read-only access to the repositories you choose.
- How do I delete my data?
- Delete your account from settings; your data is removed within 30 days.
- Does a good score mean I am quantum-safe?
- No. It means we found little quantum-vulnerable cryptography in what we could see.
Limitations and false positives
Qunoq is a static pattern scanner plus a live TLS probe. Please read these limits.
- False positives happen. A pattern match can sit in a test, a comment, a fixture, vendored code or a disabled branch. Findings carry a confidence value; low-confidence ones are marked Investigate.
- False negatives happen. Cryptography called through wrappers, generated at runtime, loaded from configuration we do not read, or written in languages we do not cover will be missed. Binary files and compiled artefacts are not analysed.
- Context is guessed. Qunoq cannot know whether code runs in production or protects sensitive data unless you tell it. Scores use the context you provide.
- TLS checks are a snapshot from one vantage point; a CDN or load balancer may answer differently elsewhere, and a handshake does not see what happens behind it.
- Not a certification. Grades and readiness are guidance, not an audit or compliance opinion.
If something looks wrong, use Report false positive in the finding panel. Reports feed our rule tests. You can mark a finding as a false positive in your own workspace right away.