Verisco
Documentation

VERISCO Shield Get started

Quickstart

From an invitation to an application protected by VERISCO sign-in. Nothing here blocks your users until the last step, and the last step can be undone in seconds.

This is the path for gateway and connector mode, where VERISCO sits in front of your application. In SDK mode steps 4 to 7 are different: read SDK mode instead.

  1. Get an invitation

    There is no self-serve sign-up. Request access, tell us what you run, and we send you an invitation link to the onboarding form.

  2. Onboard your application

    The form has seven steps: your details, your plan, your application, your identity source, how VERISCO connects to it, the protection you want, and a review. Before you can submit you test the connection to your user directory from the form itself.

    See Onboarding for every field.

  3. Wait for approval

    A VERISCO administrator reviews the submission and publishes your tenant. That creates your sign-in realm, your signing key and your route. A free 30-day Pilot with every feature starts at approval.

    Your hostname now goes through VERISCO in pass-through: nobody is blocked, and your own login keeps working. You can change your code in any order.

  4. Install the CLI and fetch your public key

    Shell
    curl -fsSL https://your-verisco-host/api/v1/cli/install | sh
    verisco-analyzer download-key --api-key <your analyzer key>

    The key is saved to verisco_public.pem under ./config/. Your analyzer key is on your integration page in the console.

  5. Mount the middleware

    Shell
    npm install https://your-verisco-host/api/v1/sdk/node
    server.js
    const { verisco, protect } = require('@verisco/verisco-middleware');
    
    // Mount before your routes. Populates req.user from the
    // verisco_session cookie, verified with your RS256 public key.
    app.use(verisco({ publicKeyFile: './config/verisco_public.pem' }));
    
    // Require a signed-in user on a route:
    app.get('/dashboard', protect(), (req, res) => res.json(req.user));

    Not on Node? Your application reads one header, X-Verisco-Claims, and verifies it with any JWT library. See Read the signed-in user.

  6. Verify

    Shell
    verisco-analyzer verify --api-key <your analyzer key>

    It checks the middleware and the key on your machine and reports the result to your console, which runs its own checks from outside.

  7. Go live

    Shell
    verisco-analyzer go-live --api-key <your analyzer key>

    Within about five seconds every request goes through VERISCO sign-in. go-back returns to pass-through just as fast, with no DNS change. See Going live.

What to do next#

Something missing or wrong on this page? Tell us and we will fix it.

↑↓ to move Enter to open Esc to close