Kion CLI

Kion CLI is a tool allowing Kion customers to generate short term access keys and federate into the cloud service provider console via the command line.

Setup

1. Build the application and place it in your path:

   go build -o kion
   ln -s $(pwd)/kion /usr/local/bin/

2. (optional) For ZSH completion place this file as _kion in your ZSH autocomplete path:

   #compdef kion
   
   _cli_zsh_autocomplete() {
     local -a opts
     local cur
     cur=${words[-1]}
     if [[ "$cur" == "-"* ]]; then
       opts=("${(@f)$(${words[@]:0:#words[@]-1} ${cur} --generate-bash-completion)}")
     else
       opts=("${(@f)$(${words[@]:0:#words[@]-1} --generate-bash-completion)}")
     fi
   
     if [[ "${opts[1]}" != "" ]]; then
       _describe 'values' opts
     else
       _files
     fi
   }
   
   compdef _cli_zsh_autocomplete kion

3. (optional) Create a configuration file in your home directory named .kion.yml:

   kion:
     url: https://mykion.example
     api_key: [api key]
     username:
     password:
     idms_id:
     saml_metadata_file:
     saml_sp_issuer:
   favorites:
     - name: sandbox
       account: "111122223333"
       cloud_access_role: Admin
       access_type: web
     - name: prod
       account: "111122224444"
       cloud_access_role: ReadOnly
       access_type: cli

User Manual

Description:

The Kion CLI allows users to perform common Kion workflows via the command line. Users can quickly generate short term access keys (stak) or federate into the cloud service provider web console via configured favorites or by walking through an account and role selection wizard.

Commands:

stak, s            Generate short-term access keys.

favorite, fav, f   Access pre-configured favorites to quickly generate staks or federate
                   into the cloud service provider console depending on the access_type
                   defined in the favorite.

console, con, c    Federate into the cloud service provider console.

run                Run a command with short-term access keys

help, h            Print usage text.

Files:

~/.kion.yml       The user configuration file. Defines credentials, target Kion
                  instance, and a list of favorites.

Global Options:

--endpoint URL, -e URL             URL of the Kion instance to interface with.

--user USERNAME, -u USERNAME       Username used for authenticating with Kion.

--password PASSWORD, -p PASSWORD   Password used for authenticating with Kion.

--idms IDMS_ID, -i IDMS_ID         IDMS ID with which to authenticate if using
                                   username and password. If only one IDMS is
                                   configured that uses username and password
                                   it is not required to specify its ID.

--saml_metadata_file FILENAME|URL  FILENAME or URL of the identity provider's
                                   XML metadata document.  If a URL, this file
                                   will be downloaded every time the CLI app
                                   is run.  If a local file, this should be an
                                   absolute path to a file on your computer.

--saml_sp_issuer ISSUER            SAML Service Provider issuer value from Kion
                                   for example:
                                   https://mykioninstance.example/api/v1/saml/auth/1

--token TOKEN, -t TOKEN            Token (API or Bearer) used to authenticate.

--help, -h                         Print usage text.

--version, -v                      Print the Kion CLI version.

Environment:

Environment variables can be set to enable other modalities of Kion CLI usage. Kion CLI follows standard precedence for defining configurations:

Flag > Environment Variable > Configuration File > Default Value

KION_URL        URL of the Kion instance to interact with.

KION_USERNAME   Username used for authenticating with Kion.

KION_PASSWORD   Passwrod used for authenticating with Kion.

KION_IDMS_ID    IDMS ID with which to authenticate if using username and
                password. If only one IDMS is configured that uses username and
                password it is not required to specify its ID.

KION_API_KEY    API key used to authenticate. Corresponds to the `--token` flag.

KION_SAML_METADATA_FILE  FILENAME or URL of the identity provider's XML metadata
                         document.  If a URL, this file will be downloaded
                         every time the CLI app is run.  If a local file, this
                         should be an absolute path to a file on your computer.

KION_SAML_SP_ISSUER     The Kion IDMS issuer value, for example
                        https://mykioninstance.example/api/v1/saml/auth/1

SAML Setup

Kion CLI can use the same SAML identity provider as the Kion user interface to authenticate access to Kion. This allows for CLI access with no Kion credentials or API tokens stored to disk.

When SAML is used for authentication, Kion CLI will prompt users to authenticate via their IDP in a web browser. Once authenticated through the IDP, the web page is closed and Kion CLI will use this authenticated session to interact with the Kion API and generate cloud tokens.

Some extra setup is required to use SAML:

Kion Setup

You must configure Kion to allow proxying a SAML Assertion via the Kion CLI tool as a supported SAML destination. This is a supported SAML configuration but it is not enabled by default.

1. In the Kion app, identify the ID of the SAML IDMS used to log in. Navigate to Users -> Identitiy Management Systems -> click on the SAML IDMS you use to login to Kion. Locate the ID in the URL of this page.

   For example: https://mykion.example/portal/idms/##

2. Using the Kion API, add the Kion CLI tool as an additional SAML destination by adding http://localhost:8400/callback as a supported destination URL. Use the POST /v3/idms/{id}/destination-url API.

   For example, if the IDMS ID from the previous step is 2:

   curl -H "Authorization: Bearer $APIKEY" \
        -X POST \
        -H 'Content-Type: application-json' \
        https://mykion.example/api/v3/idms/2/destination-url \
        -d '{"destination_url": "http://localhost:8400/callback"}'
   

Kion CLI Configuration

You must add SAML configuration options to your ~/.kion.yml file under the kion section:

• saml_metadata_file - This is the SAML Metadata XML file provided by your IDP. This should be a path to a file on your computer, or a URL from your identity provider.

  Example 1: /Users/jdoe/.kion/saml-metadata.xml

  Example 2: https://dev-XXXXXX.oktapreview.com/app/exkXXXXXXXXXXXXXXXXXXX/sso/saml/metadata

  To obtain this file:

  • In the Okta Admin UI, this can be found on the SAML application's Sign On tab.
  • In the Entra ID UI, this can be found in the SAML application's Endpoints section. Look for the Federation metadata document.

• saml_sp_issuer - This is the Entity ID for the Kion SAML IDMS. This can be found by navigating to the SAML IDMS in Kion (Users -> Identitiy Management Systems). Edit the SAML IDMS and copy the Service Provider Issuer (Entity ID) URL.

  For example: https://mykion.example/api/v1/saml/auth/2

Okta Configuration

Add the Kion CLI URL, http://localhost:8400/callback as an additional requestable SSO URL:

1. Login to the Okta administrator UI
2. Browse to the SSO Apps and select the Kion Application you’d like to configure.
3. On the General tab, scroll down to the SAML Settings section and click Edit
4. Hit Next on Step 1, and get to the Configure SAML section in Step 2 of the wizard.
5. Click Show Advanced Settings
   1. Under Other Requestable SSO URLs, leave the first one as your primary FQDN with an Index of 1. This will be the normal Kion application callback URL such as https://mykion.example/api/v1/saml/callback.
   2. Click + Add Another and enter the Kion CLI URL:
      1. URL: http://localhost:8400/callback
      2. Index: 2
6. Click Next and then Finish.

Entra ID / Azure AD

Add the Kion CLI URL, http://localhost:8400/callback as an additional redirect URI:

1. Login to your Entra ID / Azure AD UI
2. Browse to the Entra ID App registrations
3. Find and click on the SAML App Registration for your Kion application
4. Navigate to the Manage -> Authentication section
5. Under the Redirect URIs section, click the Add URI link to add the Kion CLI URL: http://localhost:8400/callback
6. Save your changes