Console

The server serves a web console on its own TLS listener. The console is a page that calls the HTTP API with the key you sign in with, so it can do exactly what that key can do over the API, and every request it makes is checked and recorded in the audit log as any client's would be.

Open it

Open /console/ on the server's address in a browser, for example:

https://vcon.example.com:8443/console/

/console without the slash is sent on to /console/. The page and its two files need no key; they hold no data.

Sign in

1. Paste an API key into API key. Any key works: a tenant key with any of its scopes, or an operator key. See tenants and keys to make one.
2. Choose Sign in. The console asks the server about the key with GET /key. If the server accepts it, the console shows the key's id, tenant and scopes. If not, it shows "The key was not accepted." and nothing else.
3. Choose Sign out when you are done.

What you see

After you sign in, the console shows a button for each view your key's scopes allow. A view, or a control inside one, that the key may not use is not shown; the API would refuse its request anyway.

Work with vCons

Choose vCons.

• List them (read): the tenant's live vCons, newest stored first, 25 at a time, with each one's uuid, current version, and when it was first stored and last changed. Choose More for the next 25. The list uses GET /vcons.
• Read one (read): choose Open beside it in the list, or type its uuid under vCon uuid and choose Open. The console shows its version (ETag) and the vCon as text (GET /vcons/{uuid}). A vCon stored gzipped is inflated first.
• Store one (write): under Store a vCon from a file, pick the file and choose Store. The console sends the file's bytes unchanged (POST /vcons) and shows the stored uuid and version, or why the server refused it, such as The body is not one JSON object (422).
• Delete one (delete): choose Delete under the vCon you opened, or type its uuid and choose Delete, then confirm. The console calls DELETE /vcons/{uuid}.

Look up a vCon as a legal key

Choose Legal, type the vCon's uuid and choose Find. The console shows whether the vCon is live or deleted, its current version (or, once deleted, the last kept one) as text, and every kept version with when it was stored and hidden. Choose Open beside a version to read it. These use GET /legal/vcons/{uuid}, GET /legal/vcons/{uuid}/versions and GET /legal/vcons/{uuid}/versions/{version}.

Under the vCon found:

• Hold puts a legal hold on it (PUT /legal/vcons/{uuid}/hold).
• Release hold takes the hold off (DELETE /legal/vcons/{uuid}/hold).
• Restore makes a deleted vCon live again with its last kept version (POST /legal/vcons/{uuid}/restore). A live vCon is refused with not-deleted (409).

Read the audit log

Choose Audit log. A tenant key with the audit scope sees its tenant's log (GET /audit); an operator key sees the admin log (GET /admin/audit). Records are listed oldest first, 50 at a time, with their seq, time, actor, action, target, version, status and count; choose More for the next 50. Each page read is itself recorded, as audit_read. See audit logs for the fields.

Manage tenants and keys

Sign in with an operator key and choose Tenants.

• Create a tenant: type its Name and, if it should not use the server default, a Retention period such as 7y, 18m or 90d, then choose Create tenant (POST /admin/tenants).
• Change its retention: choose Retention in its row and type the new period, or leave it empty for the server default (PATCH /admin/tenants/{id}).
• Remove it: choose Remove and confirm (DELETE /admin/tenants/{id}). If it still holds vCons, the console asks again before it removes them too (?force=true). A tenant with any vCon under a legal hold is never removed over the API.
• Its keys: choose Keys to list them. To issue one, tick its scopes, type a Label and choose Issue key (POST /admin/tenants/{id}/keys). The token is shown once, under the form: copy it then. It is gone once you leave the view, and the server cannot show it again. Revoke a key and confirm to end it (DELETE /admin/keys/{id}).

Each of these leaves the same audit record as the same request made with curl or any other client.

What the console keeps

• The key is held in the page's memory only. It is never written to the browser's storage, a cookie or the address bar. Reloading the page, closing the tab or signing out forgets it, and you sign in again.
• The console asks the browser not to cache any answer, and writes nothing the server sends to browser storage.
• Everything the server sends is shown as text. Markup inside a stored vCon, a tenant name or a key label is shown as the characters it is made of and never runs.

What protects it

Every console answer carries these headers, so the page runs only its own script, loads nothing from another site, cannot be shown inside another site's frame and is not cached:

Content-Security-Policy: default-src 'none'; script-src 'self'; style-src 'self'; img-src 'self'; connect-src 'self'; base-uri 'none'; form-action 'none'; frame-ancestors 'none'; require-trusted-types-for 'script'; trusted-types 'none'
X-Frame-Options: DENY
X-Content-Type-Options: nosniff
Referrer-Policy: no-referrer
Cache-Control: no-store
Cross-Origin-Opener-Policy: same-origin
Cross-Origin-Resource-Policy: same-origin

The server sets no cookie and sends no cross-origin (CORS) headers, so a page on another site cannot send your key or read an answer. The console cannot protect a key from code that already runs inside your browser, such as a hostile extension.

The console is always served; it adds no power that a key does not already have.

Source of this page: website/content/docs/console.md