Command-line interface (CLI) for managing user authentication when using IQM quantum computers.
Installing Cortex CLI#
Requirements for installing:
$ pip install iqm-cortex-cli
Using Cortex CLI#
For general usage instructions, run
$ cortex --help
First, Cortex CLI needs initialization, which produces a configuration file:
$ cortex init
Cortex CLI will ask a few questions. You can also pass the values via command line to avoid having an interactive
cortex init --help for details.
To log in, use
$ cortex auth login
This will ask you to enter your username and password. If you have a temporary password you will be asked to go to the authentication server and enter a new password. URL of the authentication server will be provided.
After a successful authentication, tokens will be saved into a tokens file (path specified in the configuration file), and a token manager daemon will start in the background. Token manager will periodically refresh the session and re-write the tokens file.
To use the token manager in a foreground mode (not as daemon), run
cortex auth login --no-daemon. This requires
keeping the shell session alive. However, you can start the process in the background by adding
& after the
cortex auth login --no-daemon &. This applies to Bash, zsh and similar shells, but may not be available
on all shells.
To login and get tokens once, without starting a token manager at all, run
cortex auth login --no-refresh.
If the tokens file already exists, then running
cortex auth login will first attempt to refresh the session without
asking you for a username and password. If that fails (because existing tokens may already have expired), you’ll be
asked to re-enter your credentials.
cortex auth login --help for more details.
Use with Cirq on IQM, Qiskit on IQM, etc.#
Adapters based on IQM Client, such as Cirq on IQM and Qiskit on IQM, can take advantage of the tokens file maintained by
Cortex CLI. This way you won’t need to provide the authentication server URL, username, or password to the adapter
library itself. To achieve this, follow the instructions printed on the screen after running
cortex auth login.
Namely, set the
IQM_TOKENS_FILE environment variable to point to your tokens file.
$ export IQM_TOKENS_FILE=/home/<username>/tokens.json
Once set, this environment variable is read by the instance of IQM Client associated with the adapter. As a result, from the point of view of the adapter it looks like authentication is simply not required (i.e. no authentication-related information has to be provided to the adapter).
To see the current status of the token manager, use:
$ cortex auth status
If the tokens file exists,
cortex auth status will report whether the corresponding token
manager is running. It will also print the time of the last successful refresh request, and
how much time is left until current tokens expire.
cortex auth status --help for more details.
To log out, run
$ cortex auth logout
This will send a logout request to the authentication server, kill the token manager daemon (if any), and delete the tokens file.
You may want to stop the token manager, but maintain the session on the server and keep the tokens file intact. To do so, run:
$ cortex auth logout --keep-tokens
cortex auth logout --help for more details.
Multiple configuration files#
By default, all Cortex CLI commands read the configuration file from the default location
~/.config/iqm-cortex-cli/config.json. You can specify a different filepath by providing the
$ cortex auth status --config-file /home/joe/config.json
$ cortex auth login --config-file /home/joe/config.json
$ cortex auth logout --config-file /home/joe/config.json