mirror of
https://github.com/openziti/zrok.git
synced 2024-12-26 00:29:15 +01:00
67 lines
5.1 KiB
Markdown
67 lines
5.1 KiB
Markdown
---
|
|
title: Interstitial Pages
|
|
sidebar_label: Interstitial Pages
|
|
sidebar_position: 18
|
|
---
|
|
|
|
On large zrok installations that support open registration and shared public frontends, abuse can become an issue. In order to mitigate phishing and other similar forms of abuse, zrok offers an interstitial page that announces to the visiting user that the share is hosted through zrok, and probably isn't their financial institution.
|
|
|
|
Interstitial pages can be enabled on a per-frontend basis. This allows the interstitial to be enabled on open public frontends but not closed public frontends (closed public frontends require a grant to use).
|
|
|
|
The interstitial page requirement can also be overridden on a per-account basis, allowing shares created by specific accounts to bypass the interstitial requirement on frontends that enable it. This facilitates building infrastructure that grants trusted users additional privileges.
|
|
|
|
By default, if you do not specifically enable interstitial pages on a public frontend, then your self-hosted service instance will not offer them.
|
|
|
|
Let's take a look at how the interstitial pages mechanism works. The following diagram shows the share configuration rendezvous made between the zrok controller and a zrok frontend:
|
|
|
|
|
|
|
|
Every zrok share has a _config_ recorded in the underlying OpenZiti network. The config is of type `zrok.proxy.v1`. The frontend uses the information in this config to understand the disposition of the share. The config can contain an `interstitial: true` setting. If the config has this setting, and the frontend is configured to enable interstitial pages, then end users accessing the share will receive the interstitial page on first visit.
|
|
|
|
By default the zrok controller will record `interstitial: true` in the share config _unless_ a row is present in the `skip_interstitial_grants` table in the underlying database for the account creating the share. The `skip_interstitial_grants` table is a basic SQL structure that allows inserting a row per account.
|
|
|
|
```
|
|
create table skip_interstitial_grants (
|
|
id serial primary key,
|
|
|
|
account_id integer references accounts (id) not null,
|
|
|
|
created_at timestamptz not null default(current_timestamp),
|
|
updated_at timestamptz not null default(current_timestamp),
|
|
deleted boolean not null default(false)
|
|
);
|
|
```
|
|
|
|
If an account has a row present in this table when creating a share, then the controller will write `interstitial: false` into the config for the share, which will bypass the interstitial regardless of frontend configuration. The `skip_interstitial_grants` controls what the zrok controller will store in the share config when creating the share.
|
|
|
|
The frontend configuration controls what the frontend will do with the share config it finds in OpenZiti. The new stanza looks like this:
|
|
|
|
```
|
|
# Configure interstitial pages for this frontend. The interstitial page presents a warning to internet users, alerting
|
|
# them to the fact that they're visiting a zrok share.
|
|
#
|
|
#interstitial:
|
|
# # Enable or disable interstitial pages on this frontend.
|
|
# #
|
|
# enabled: true
|
|
#
|
|
# # Specify a list of User-Agent prefixes that should receive the interstitial page. If interstitial pages are enabled
|
|
# # and this list is not set, all user agents will receive an interstitial page.
|
|
# #
|
|
# user_agent_prefixes:
|
|
# - "Mozilla/5.0"
|
|
```
|
|
|
|
Setting `enabled: true` in the `interstitial` stanza of the frontend config will allow the configured frontend to offer an interstitial page if the share config enables the interstitial page for that share. The `user_agent_prefixes` array can be used to specify which specific `User-Agent` types receive the interstitial. User agents that match a prefix in the list will receive the interstitial, while others will not. If the `user_agent_prefixes` list is omitted, _all_ user agents will receive the interstitial page.
|
|
|
|
## Bypassing the Interstitial
|
|
|
|
The interstitial page will be presented unless the client shows up with a `zrok_interstitial` cookie (depending on `user_agent_prefixes` configuration). When the user is presented with the interstitial page, there is a button they can click which sets the necessary cookie and allows them to visit the site. The cookie is set to expire in one week.
|
|
|
|
Typically the `user_agent_prefixes` list contains `Mozilla/5.0`, which matches all typical interactive mobile and desktop browsers. Setting a non-standard `User-Agent` in an interactive browser will bypass the interstitial pages for frontends configured with the usual `Mozilla/5.0` prefix.
|
|
|
|
End users can offer an HTTP header of `skip_zrok_interstitial`, set to any value to bypass the interstitial page. Setting this header means that the user most likely understands what a zrok share is and will hopefully not fall for a phishing attack.
|
|
|
|
The `skip_zrok_interstitial` header is especially useful for API clients (like `curl`) and other types of non-interactive clients.
|
|
|
|
The `drive` backend mode does not currently support `GET` requests and cannot be accessed with a conventional web browser, so it bypasses the interstitial page requirement. |