aos-keys
Aos CLI Tool aos-keys is designed to manage users' certificates and private keys.
The tool can:
- generate user's private keys and store them locally
- request a certificate and install it into web browsers
- install current Aos root certificates to system storages/vaults and into web browsers.
-V, --version
Shows installed version.
- Windows
- macOS/Linux
~/.aos/venv/Scripts/python -m aos_keys -V
~/.aos/venv/bin/python3 -m aos_keys -V
-h, --help
Shows general help or help for a selected command.
- Windows
- macOS/Linux
~/.aos/venv/Scripts/python -m aos_keys -h
~/.aos/venv/Scripts/python -m aos_keys install-cert -h
~/.aos/venv/bin/python3 -m aos_keys -h
~/.aos/venv/bin/python3 -m aos_keys install-cert -h
install-cert
Installs user's certificate and private key pair into browser
install-cert [-h] [-o CERT_FILE_NAME] [--oem | --sp | --fleet ]
| Options | Required | Description | Default |
|---|---|---|---|
| -o | TBD | TBD | |
| --oem, --sp, --fleet | TBD | User's role |
install-root
Installs Aos root certificate.
- Windows
- macOS
- Linux
~/.aos/venv/Scripts/python -m aos_keys install-root
~/.aos/venv/bin/python3 -m aos_keys install-root
~/.aos/venv/bin/python3 -m aos_keys install-root
After this command, it's necessary to install the Aos Root certificate system-wide.
To do this, run the following command, as suggested by the aos-keys install-root script :
sudo ~/.aos/scripts/install_aos_root_ca.sh
new-user
Generates AosCloud user private key, Certificate Sign Request and issues user's certificate using AosCloud CA.
new-user [-h] [-o OUTPUT_DIR] [-d REGISTER_DOMAIN] [-t TOKEN] [-oem] [-s] [-f] [-a] [-e] [--skip-browser-install]
| Options | Required | Description | Default |
|---|---|---|---|
| -d, --domain | + | Base URL of target AosCloud instance that issues user certificate | |
| -t, --token | + | Token tied to the user issued by AosCloud | |
| --oem, --sp, --fleet | + | User's role | |
| -e, --ec | Generate private key with Elliptic Curves | true | |
| --skip-browser-install | Skips installing certificate into browsers | false | |
| -o, --output-dir | Configures output directory for private keys and certificate | ~/.aos/security |
Example:
- Windows
- macOS/Linux
~/.aos/venv/Scripts/python -m aos_keys new-user -d api.aoscloud.io -t [USER_TOKEN_HERE] --oem
~/.aos/venv/bin/python3 -m aos_keys new-user -d api.aoscloud.io -t [USER_TOKEN_HERE] --oem