Alison Wizard is a web assistant that facilitates the deployment of Alison Desktop on the end users stations, determines if all the necessary components are correctly installed and to suggest installation or update if necessary.

It detects the minimum conditions under which it should be performed and suggests the necessary corrective steps.

Among the tasks performed we can mention:

• Execute the download of its components
• Facilitate the correct installation of the components
• Validate its correct installation by signing a test transaction (if the user has a certificate)

Alison Desktop is used to generate the key pair, certificate installation, and digital signature operations for the following browser: Internet Explorer, Microsoft Edge, Firefox, Chrome, Opera, Safari.

Alison Desktop can recognize certificates installed in various secure repositories like Microsoft CSP, Firefox NSS, PKCS # 11 devices, Smartcards, eTokens, and multiple platforms (Windows, Mac OS, Linux).

Advantages and benefits

• Alison Wizard simplifies the download of the required components to operate and enable them on the browser properly.
• Users will have the same user experience, no matter which browser is using.
• End-user can test the correct installation of the certificate, even check if the certificate is valid or revoked.

Step 1: Detect Alison-Desktop

This is Alison Wizard's first step. The target is to verify if Alison Desktop is installed on the end-user machine. If not detected, downloads the appropriate installer for the operating system in use. End-user has to install it and run Alison-Desktop to allow Alison Wizard to continue. A new icon will appear on the tray to access additional features.

Step 2: Integrate

Verify the correct communication between the browser and Alison Desktop. If necessary, the process will prompt the end-user to install additional components.

If communication between the browser in use and Alison Desktop is enabled, Alison Wizard will jump to the third step.

Integration is shared between different browsers, like Internet Explorer and Chrome, but it's recommended to run the wizard on each browser that the end-user has. Alison Wizard is a diagnostic tool that facilitates end-user error detection and suggests a solution.

Step 3: Test user certificate

CertiSur distribute distributes Alison Wizard from Docker Hub (https://hub.docker.com/).

Download Docker image

In order to download the images, the user must be registered in the aforesaid platform. Contact CertiSur to request access, and inform the Docker Hub profile to grant access to the docker image.

Step 1- Login using a Docker Hub account

# docker login -u <docker hub account>
Password:
WARNING! Your password will be stored unencrypted in /root/.docker/config.json.
Configure a credential helper to remove this warning. See https://docs.docker.com/engine/reference/commandline/login/#credentials-store
Login Succeeded

Step 2- Pulling an image from Docker

# docker pull certisursa/wizard:latest

latest: Pulling from certisursa/wizard
a02a4930cb5d: Pull complete
b5ffff9dbcda: Pull complete
...
7e5f58de12ac: Pull complete
Digest: sha256:332ee89371399b7c6235465beb00fbd2071868fecee33fc14d04b87ba99b265d
Status: Downloaded newer image for certisursa/wizard:latest
docker.io/certisursa/wizard:latest

Step 3- Run Alison Wizard docker image

# docker run -d \
-it \
-p 8080:8080 \
--name wizard \
--mount type=bind,source="$(pwd)"/config/tenants, \
      target=/opt/jboss/config/tenants \ 
      certisursa/wizard:latest

Step 4- Test Alison wizard

Open your browser pointing to localhost:8080 (or the port defined by you) to access the URL where you published your Alison Wizard installation. You'll see the following image.

If you can see this image means that you have Alison Wizard running into your docker container.

Image Modified

After you have Alison Wizard running on your own container, you can add a custom tenant following the next steps:

Step 5- Download a custom example (looney)

Download the files from the following link looney-demo.tgz. 

├── debbie
│   ├── config
│   │   ├── certstore
│   │   │   ├── CertiSur.root.ClassB.G1.pilot.509.cer
│   │   │   └── CertiSur.shared.ClassB.G1.pilot.509.cer
│   │   ├── debbie.json
│   │   ├── debbielog.properties
│   │   └── policies
│   │       └── looney.policy.json
│   ├── logs
│   └── repository
├── docker-compose.yml
└── wizard
    ├── alison-sdk
    ├── logs
    └── tenants
        ├── looney
        │   ├── config
        │   │   ├── alison-config.json
        │   │   ├── authtoken-desktop.json
        │   │   └── license-desktop.json
        │   ├── images
        │   │   ├── background_world_map.png
        │   │   └── clientLogo.jpg
        │   └── stylesheets
        │       └── custom.css
        └── versiones.yml

Step 6- Define environment variables and mount external volumes

Define following variables to your docker instance:

Configure your docker-compose file to mount the following volumes.

Note: ./wizard/tenants external directory is the directory included into the example tenant config file (looney-demo.tgz) that you downloaded and stored in your local computer.

Step 7- Configure docker_compose.yml and restart the container

Use the previous variables and volume mappings to define the new configuration, in this example as a docker_compose.yml file.

version: '3'

services:

  wizard:
    image: certisursa/wizard:latest
    environment:
      ENABLED_TENANTS: looney
      WIZARD_SECRET_KEY_BASE: 95820b3cea66376d006bf3ca3adf48287c1fc671e81c5956f8cd56aaffc4ac707673872d3d8561e14d851dea4c685a9874329a86f5c4b741e6e187cb70895820
      BASE_INSTALLERS_PATH: https://s3.amazonaws.com/downloads.certisur.net/installers
    volumes:
      - "./wizard/tenants:/opt/jboss/config/tenants"
      - "./wizard/logs:/opt/jboss/logs"
    ports:
      - 8082:8080

Launch the container from a shell

> docker-compose --verbose -f docker-compose.yml up -d

Open your browser pointing to localhost:8082 (or the port defined by you) to access the URL where you published your Alison Wizard installation. You'll see the following image.

After you have Alison Wizard running on your own container, you can add a custom validation for your customer's certificates following the next steps:

Step 7- Download Debbie module

Debbie is a validation module 

# docker pull certisursa/wizard:latest

latest: Pulling from certisursa/wizard
a02a4930cb5d: Pull complete
b5ffff9dbcda: Pull complete
...
7e5f58de12ac: Pull complete
Digest: sha256:332ee89371399b7c6235465beb00fbd2071868fecee33fc14d04b87ba99b265d
Status: Downloaded newer image for certisursa/wizard:latest
docker.io/certisursa/wizard:latest

Step - Download a custom example (looney)

Download the files from the following link looney-demo.tgz. 

├── debbie
│   ├── config
│   │   ├── certstore
│   │   │   ├── CertiSur.root.ClassB.G1.pilot.509.cer
│   │   │   └── CertiSur.shared.ClassB.G1.pilot.509.cer
│   │   ├── debbie.json
│   │   ├── debbielog.properties
│   │   └── policies
│   │       └── looney.policy.json
│   ├── logs
│   └── repository
├── docker-compose.yml
└── wizard
    ├── alison-sdk
    ├── logs
    └── tenants
        ├── looney
        │   ├── config
        │   │   └──├── clientLogoalison-config.jpgjson
        │   └── stylesheets│   ├── authtoken-desktop.json
        │   │   └── license-desktop.json
        │   ├── images
    └── custom.css
        └── versiones.yml

    │   │   ├── background_world_map.png
        │   │   └── clientLogo.jpg
        │   └── stylesheets
        │       └── custom.css
        └── versiones.yml

Step 6- Define environment variables and mount external volumes

Define following variables to your docker instance:

Configure your docker-compose file to mount the following volumes.

Note: ./wizard/tenants external directory is the directory included into the example tenant config file (looney-demo.tgz) that you downloaded and stored in your local computer.

Step 7- Restart the container

Use the previous variables and volume mappings to define the new configuration, in this example as a docker_compose.yml file.

version: '3'

services:

  wizard:
    image: certisursa/wizard:latest
    environment:
      ENABLED_TENANTS: looney
      WIZARD_SECRET_KEY_BASE: 95820b3cea66376d006bf3ca3adf48287c1fc671e81c5956f8cd56aaffc4ac707673872d3d8561e14d851dea4c685a9874329a86f5c4b741e6e187cb70895820
      BASE_INSTALLERS_PATH: https://s3.amazonaws.com/downloads.certisur.net/installers
    volumes:
      - "./wizard/tenants:/opt/jboss/config/tenants"
      - "./wizard/logs:/opt/jboss/logs"
    ports:
      - 8082:8080

  debbie:
    image: certisursa/debbie:v2.2.9a
    environment:
      checkMACAddress: disabled
    volumes:
      - "./debbie/config:/app/config"
      - "./debbie/repository:/app/repository"
      - "./debbie/logs:/app/log"
    ports:
      - 8081:8080

Launch the container from a shell

> docker-compose --verbose -f docker-compose.yml up -d

Open your browser pointing to localhost:8082 (or the port defined by you) to access the URL where you published your Alison Wizard installation. You'll see the following image.

Open your browser pointing to localhost:8081 (or the port defined by you) to access the URL where you published your Debbie installation. You'll see the following image.

Alison Wizard docker image includes an ACME tenant inside. You must overwrite that definition to include your own company or project tenants.

Environment Variables

Configure the following variables to customize your tenants and platforms.

Volumes

The following volumes must be mounted on the Docker image to overwrite the variables of each defined tenant.

Running Custom Tenant

After configuring your own tenant, launch a new docker image with the new configuration.

version: '3'

services:

  wizard:
    image: certisursa/wizard:latest
    environment:
      ENABLED_TENANTS: looney
      WIZARD_SECRET_KEY_BASE: 95820b3cea66376d006bf3ca3adf48287c1fc671e81c5956f8cd56aaffc4ac707673872d3d8561e14d851dea4c685a9874329a86f5c4b741e6e187cb70895820
      BASE_INSTALLERS_PATH: https://s3.amazonaws.com/downloads.certisur.net/installers   
      DEBBIE_BASE_URL: http://192.168.1.61:8081
      ENABLED_BROWSERS: chrome,firefox,edge,safari
      ENABLED_PLATFORMS: windows,mac,linux
    volumes:
      - "./wizard/tenants:/opt/jboss/config/tenants"
      - "./wizard/logs:/opt/jboss/logs"
    ports:
      - 8082:8080

  debbie:
    image: certisursa/debbie:v2.2.9a
    environment:
      checkMACAddress: disabled
    volumes:
      - "./debbie/config:/app/config"
      - "./debbie/repository:/app/repository"
      - "./debbie/logs:/app/log"
    ports:
      - 8081:8080

Working with the demo

1 - Deploy and run

To deploy this configuration you must execute the following in a shell window.

# docker-compose --verbose -f docker-compose.yml up -d

Image Removed

Image Removed

3- Stop the containers

To stop the demo you must execute the following in a shell window.

# docker run -d \
-it \
-p 8080:8080 \
--name wizard \
--mount type=bind,source="$(pwd)"/config/tenants, target=/opt/jboss/config/tenants \
-e ENABLED_TENANTS=acme \
-e BASE_INSTALLERS_PATH=https://<wizard_url>/installers \
-e DEBBIE_BASE_URL=https://<debbie_url:port>/ \
-e WIZARD_SECRET_KEY_BASE=a95820b3cea66376d06bf3...9a86f5c4b741e6e187cb7085aaee \
certisursa/wizard:latest

License

Alison Wizard comes preinstalled with a universal license valid for up to 1 year.

To obtain a full license, contact CertiSur team (support@certisur.com) and inform the domain list (from all environments: development, staging, production) where the container will be published.

CertiSur will return a definitive license covering all the domains informed with a 3 years validity.

The license file must be included in each tenant configuration folder.

Plugins

These optional components may be installed on some browsers (Firefox, Chrome, Internet Explorer) to allow a different communication between the browser and Alison Desktop.

Plugins must be enabled by domain, similar to license.

Each tenant has its own configuration, and every Alison Wizard docker instance can manage one or several tenants. 

The configuration file allows defining all the behavior of the Wizard for each tenant. It is easy to make changes in the operation of the application. It requires to reload the Alison Wizard container image to apply any change made on these files.

The following files define tenant configuration and must be customized or replaces.

Create a new Tenant

The best way to create a new tenant is to copy ACME tenant configuration distributed on the last version of Docker Image, modify its name and apply changes on each related file.

Principal variables that you can modify to custom your tenant: