Skip to content

docs: say that the clearance scope option limits nothing #91

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cport1 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: say that the clearance scope option limits nothing #91

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions webdecoy.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,7 +199,12 @@ private function load_options(): void
// is safe to expose in page markup. Enables silent wd_clearance
// cookie minting so tripwire/decoy hits bind to a device fingerprint.
'site_key' => '',
// Optional scope passed to the clearance client (advanced).
// Passed through to the clearance client as data-scope, and it
// limits nothing: a clearance token is bound to the organization,
// and no validator reads a token's scope (WebDecoy/app #1122).
// Kept so a site that set it years ago keeps working unchanged.
// To require more on a sensitive path, set that path's
// Verification required level in WebDecoy.
'clearance_scope' => '',

// Cloud connection metadata, populated by the one-click connect flow
Expand Down Expand Up @@ -1015,6 +1020,9 @@ public function add_defer_to_scanner(string $tag, string $handle, string $src):
// script-tag attributes on older versions). Also load it async.
if ($handle === 'webdecoy-clearance') {
$attrs = ' async data-site-key="' . esc_attr((string) $this->options['site_key']) . '"';
// data-scope is inert: the client sends it, the mint signs it, and
// no validator reads it. Emitted only so a site that set the
// option behaves exactly as it did before (WebDecoy/app #1122).
$scope = (string) ($this->options['clearance_scope'] ?? '');
if ($scope !== '') {
$attrs .= ' data-scope="' . esc_attr($scope) . '"';
Expand Down Expand Up @@ -2331,7 +2339,8 @@ public function sanitize_options(array $input): array
$sanitized['api_key'] = $api_key;
}

// Publishable site key + clearance scope (not secret; stored as-is).
// Publishable site key, and the inert clearance scope (neither is
// secret; stored as-is).
$sanitized['site_key'] = sanitize_text_field($input['site_key'] ?? '');
$sanitized['clearance_scope'] = sanitize_text_field($input['clearance_scope'] ?? '');

Expand Down
Loading