Repository navigation
docs: bypass keys and the Allow access rule policy - #91
Merged
Merged
Conversation
Adds a Bypass Keys page: what a key is, how to create one in the portal, set it as a cookie in a browser or in Playwright/Cypress tests, verify the resulting token (the `ip` field is required) and revoke it. The Access Control Rules page only described Block and Restrict; it now covers Allow, including allow-listing an office IP range and the limits that apply (frictionless only, IP needed at verify, blocks still win). The API page lists `allow` and `bypassKeyHash`, and the verification failure reasons gain the two authenticated-token IP errors. Refs prosopo/captcha-private#2021
✅ Deploy Preview for peaceful-pothos-9e62ce ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for peaceful-pothos-9e62ce ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What changed
advanced/bypass-keys). Covers what a key is, creating one in the portal, setting the cookie (browser console, Playwright, Cypress), verifying the token (theipfield is required), and revoking it. Also covers the limits and a security warning.ipneeded at verify, Block/Restrict still win).typecan beallow, andbypassKeyHashis a condition field (send the hash, never the key).API.AUTHENTICATED_IP_REQUIREDandAPI.AUTHENTICATED_IP_MISMATCH.Effect
Customers can find out how to skip the captcha for trusted networks and for their own developers and tests.
Tests
Docs only. I checked link targets and anchors by hand. I did not run a local build; CI runs the build and link check.
Goes with the bypass keys feature in prosopo/captcha and prosopo/captcha-private. Refs prosopo/captcha-private#2021
Feature PRs: prosopo/captcha-private#4580 · prosopo/captcha#3256