Document device attestation and verification
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 68/100
- Issue type
- Documentation
- Clarity
- Clearly specified
- Activity status
- Active
- Tech stack
- android
- Domain
- documentation, security
Research direction
Start by locating the admin and user documentation sections covering the posture check wizard, edit form, Devices list, verification flow, and device-blocked screens. Trace the existing desktop tray, full-window, and mobile client guidance, then document the listed statuses, supported platforms, enforcement timing, and verification actions. Done means every acceptance criterion is covered with clear instructions for administrators and users.
Written by the indexing model from the issue text.
Description
Acceptance criteria
Admin documentation
- An overview explains the attestation statuses (Not attested, Attested, On quarantine, Attested manually), the verification statuses (Verified, Not verified) and the Blocked access state.
- Supported platforms are listed: desktop TPM, Apple Secure Enclave and Android Keystore, plus the minimum Defguard client versions.
- The EK CA database page in Settings is described, including CAs marked "Manually added".
- Configuring attestation and ownership verification is covered, both in the posture check wizard and in the edit form, including how to read the impact tables.
- The docs explain how enforcement works and that changes apply at the device's next connection.
- The Devices list, its filters and the Device details panel are described.
- The verification flow is covered: initiate, compare the code, verify or cancel, and share instructions with the user.
- "Mark as verified", blocking a device, and restarting verification to unblock it are described.
- Handling unrecognised devices and accepting an unknown TPM is covered.
User documentation
- The docs explain how to verify a device in the desktop client (tray view and full window) and in the mobile client.
- The messages shown when a connection is rejected are explained, with what to do for each.
- The "Device blocked" screen is explained, with how to start verification from it.
- Dominant language
- Rust
- Stars
- 2.9k
- Forks
- 119
- Avg merge
- 1d 2h
- Merged PRs (30d)
- 57
Getting set up
- Ships a Dockerfile or Docker Compose file
- Has a pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from DefGuard/defguard
-
Invalid log level when LDAP credentials are invalidPossibly taken @Va1ter claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 62/100
DefGuard/defguard#3851 · 1 comment · 1 assignee ·
Maintainers usually reply within 1 day
-
Incorrect "Edit workflow" label for MFA flow formPossibly taken @j-chmielewski claimed this today. Openbug
Difficulty 1/5 Under an hour Newbie friendliness 78/100
DefGuard/defguard#3844 · 1 assignee ·
Maintainers usually reply within 1 day
-
Invalid hover on the OS delete in posture check edit formPossibly taken @jakub-tldr claimed this today. Open
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
DefGuard/defguard#3842 · 1 assignee ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
Maintainers usually reply within 1 day
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
DefGuard/defguard#3751 · 1 assignee ·
Maintainers usually reply within 1 day
All issues in DefGuard/defguard
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 75/100
RustCrypto/SSH#596 ·
-
proxy: SQL-over-HTTP turns empty arrays into [""] or [false], or HTTP 500 for int and float arraysOpen
Difficulty 2/5 1-3 hours Newbie friendliness 83/100
neondatabase/neon#12965 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
goauthentik/authentik#26867 ·
Maintainers usually reply within 1 day
-
api bug macos maintainer-needed p2 triaged
Difficulty 2/5 1-3 hours Newbie friendliness 66/100
Maintainers usually reply within 1 day
-
area::tern difficulty::easy good first issue kind::cleanup triage::ready
Difficulty 1/5 1-3 hours Newbie friendliness 88/100