kion-cli

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

[!TIP] If you are on OSX and use Homebrew you can install with brew install kionsoftware/tap/kion-cli.

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

   brew install kionsoftware/tap/kion-cli
   
   # or
   
   go build -ldflags "-X main.kionCliVersion=$(cat VERSION.md)" -o kion
   ln -s $(pwd)/kion /usr/local/bin/
   
   # or
   
   make install
   

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:

   ################################################################################
   ##                                                                            ##
   ##  Default Profile                                                           ##
   ##                                                                            ##
   ################################################################################
   
   kion:
     url: https://mykion.example
     api_key: [api key]
     default_region: us-east-1
   favorites:
     - name: sandbox
       account: "111122223333"
       cloud_access_role: Admin
       access_type: web               # optional (defaults to cli)
       region: us-gov-west-1          # optional
     - name: prod
       account: "111122224444"
       cloud_access_role: ReadOnly
   
   ################################################################################
   ##                                                                            ##
   ##  Alternate Profiles                                                        ##
   ##                                                                            ##
   ################################################################################
   
   profiles:
     dev:
       kion:
         url: https://dev.mykion.example
         api_key: [api key]
         disable_cache: true              # defaults false
       favorites:
         - name: sandbox
           account: 212121212121
           cloud_access_role: Dev
     test:
       kion:
         url: http://test.mykion.example
         api_key: [api key]
   

   You can also point Kion CLI to another configuration file by setting the KION_CONFIG environment variable to the desired path. See the "Configuration File" section below for all options.

4. Usage examples:

   Command Line:

   # open the sandbox AWS console favorited in the config above
   kion fav sandbox
   
   # generate and print keys for an AWS account
   kion stak --print --account 121212121212 --car Admin
   
   # start a sub-shell authenticated into an account
   kion stak --account 121212121212 --car Admin
   
   # start a sub-shell authenticated into an account via an account alias
   # NOTE: that account alias only supports Kion versions 3.9.9 and 3.10.2 and up
   kion stak --alias Prod --car Admin
   
   # start a sub-shell using a wizard to select a target account and Cloud Rule
   kion stak
   
   # federate into a web console using a wizard to select a target account and Cloud Rule
   # NOTE: that Firefox users will have to approve pop-ups on the first run
   kion console
   
   # federate into a web console using an alias
   # NOTE: that Firefox users will have to approve pop-ups on the first run
   # NOTE: that account alias only supports Kion versions 3.9.9 and 3.10.2 and up
   kion console --alias Prod --car Admin
   
   # federate into a web console using an account number
   kion console --account 111122223333 --car Admin
   

   AWS Profiles:

   [profile one]
   credential_process = /path/to/kion stak --credential-process --account 121212121212 --car DevOps
   
   [profile two]
   credential_process = /path/to/kion favorite --credential-process MyFavorite
   

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

util               Tools for managing Kion CLI.

help, h            Print usage text.


The following are maintained for compatibility with older Kion utilities:

setenv             Generate short-team access keys and print to standard out.
                   This is effectively 'stak --print'.

savecreds          Store short-term access keys to an AWS credentials profile.
                   This is effectively 'stak --save'.

Files:

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

Global Options:

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

--user USER, -u USER, --username USER  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

--saml-print-url                       Print the authentication URL instead of opening
                                       it automatically with the default browser.

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

--disable-cache                        Disable the use of cache for Kion CLI.

--debug                                Enables debug output for certain functions.

--quiet                                Reduces output for certain functions.

--profile PROFILE                      Use the specified PROFILE from the Kion CLI
                                       configuration file. If no profile is specified
                                       the default will be used.

--help, -h                             Print usage text.

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

STAK Command:

OPTIONS

  --print, -p                          Print STAK only. (default: false)

  --account val, --acc val, -a val     Target account number, used to bypass
                                       prompts, must be passed with --car.

  --alias val, --aka val, -l val       Target account alias, used to bypass
                                       prompts, must be passed with --car.
                                       Note account alias only supports
                                       Kion versions 3.9.9 and 3.10.2 and up.

  --car val, --cloud-access-role val,  Target cloud access role, used to bypass
    -c val                             prompts, must be passed with --account
                                       or --alias.
                                       Note account alias only supports
                                       Kion versions 3.9.9 and 3.10.2 and up.

  --region val, -r val                 Specify which region to target.

  --save, -s                           Save short-term keys to an aws credentials
                                       profile. The print flag will supercede this
                                       option.

  --credential-process                 For use with AWS credentials profiles to
                                       setup Kion CLI as a credentials process
                                       subsystem. Returns a json object in the
                                       format needed for the `credential_process`
                                       profile setting.

  --help, -h                           Print usage text.

Favorite Command:

SUB COMMANDS

  list                                 List all configured favorites. List
                                       accepts a --verbose / -v option to print
                                       additional details.

OPTIONS

  --print, -p                          Print STAK only. Has no effect on
                                       favorites with an "access_type" of
                                       "web". (default: false)

  --access-type val , -t val           Override the access type of the favorite.
                                       Defaults to "cli" if not explicitly set
                                       in the favorite, however this option
                                       allows it to be overridden on demand.
                                       Expects "web" or "cli".

  --web, -w                            Shortcut for `--access-type web`. Takes
                                       precedence over --access-type val, -t val
                                       flag options.

  --credential-process                 For use with AWS credentials profiles to
                                       setup Kion CLI as a credentials process
                                       subsystem. Returns a json object in the
                                       format needed for the `credential_process`
                                       profile setting.

  --help, -h                           Print usage text.

Run Command:

ARGS

  [service]                            Optional argument to specify a service
                                       page to open as opposed to the default
                                       dashboard. For `kion con rds` would
                                       federate directly to the RDS services
                                       page.

OPTIONS

  --favorite val, --fav val, -f val    Specify which favorite to run against.

  --account val, -acc val, -a val      Specify which account to target, must be
                                       passed with --car.

  --alias val, --aka val, -l val       Target account alias, used to bypass
                                       prompts, must be passed with --car.
                                       Note account alias only supports
                                       Kion versions 3.9.9 and 3.10.2 and up.

  --car val, -c val                    Specify which Cloud Access Role to use,
                                       must be passed with --account or --alias.
                                       Note account alias only supports
                                       Kion versions 3.9.9 and 3.10.2 and up.

  --region val, -r val                 Specify which region to target.

  --help, -h                           Print usage text.

Console Command:

OPTIONS

  --account val, --acc val, -a val     Target account number, used to bypass
                                       prompts, must be passed with --car.

  --alias val, --aka val, -l val       Target account alias, used to bypass
                                       prompts, must be passed with --car.
                                       Note account alias only supports
                                       Kion versions 3.9.9 and 3.10.2 and up.

  --car val, --cloud-access-role val,  Target cloud access role, used to bypass
    -c val                             prompts, must be passed with --account
                                       or --alias. Note account alias only supports
                                       Kion versions 3.9.9 and 3.10.2 and up.

  --help, -h                           Print usage text.

Util Commands:

SUB COMMANDS

  flush-cache                          Clear out all cache entries for the Kion CLI.

  push-favorites                       Push locally defined favorites up to Kion.
                                       This will overwrite any favorites in Kion
                                       that have the same alias. After pushing, you
                                       are prompted to delete local favorites.

  validate-saml                        Validate the current SAML configuration.

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_CONFIG              Path to the Kion CLI configuration file.
                         Defaults to `~/.kion.yml`

KION_URL                 URL of the Kion instance to interact with.

KION_USERNAME            Username used for authenticating with Kion.

KION_PASSWORD            Password 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

KION_SAML_PRINT_URL      "TRUE" to print the authentication url as opposed to
                         automatically opening it in the default browser.
                         Defaults to "FALSE".

KION_DEBUG               "TRUE" to enable verbose debugging of the Kion CLI.

KION_QUIET               "TRUE" to reduce messages for quieter operation.

The following are maintained for compatibility with older Kion utilities:

CTKEY_USERNAME           Maps to KION_USERNAME.

CTKEY_PASSWORD           Maps to KION_PASSWORD.

CTKEY_APPAPIKEY          Maps to KION_API_KEY

Configuration File:

KION
----
kion.url                             URL to the target Kion instance.
kion.api_key                         API key used to authenticate.
kion.username                        Username for authentication, to be paired with password.
kion.password                        Password for authentication, to be paired with username.
kion.idms_id                         IDMS ID, if using a custom IDMS in Kion.
kion.saml_metadata_file              SAML metadata file location, URL or path.
kion.saml_sp_issuer                  Entity ID for the Kion SAML IDMS.
kion.saml_print_url                  Set 'true' to print the authentication url as opposed to
                                     automatically opening it in the default browser.
                                     Defaults to 'false'.
kion.disable_cache                   Prevents Kion CLI from caching STAK if 'true', defaults
                                     to 'false'.
kion.default_region                  The CSP region to use if one is not provided by argument
                                     flag or environment variable.

FAVORITES
---------
favorites[N].name                    Favorite name, used when calling `kion fav [name]`
favorites[N].account                 Account number associated with the favorite.
favorites[N].region                  Region to use when accessing the favorite.
favorites[N].cloud_access_role       Cloud Access Role used to authenicate with the favorite.
favorites[N].access_type             Favorite access type, 'web' or 'cli', defaults 'cli'.
favorites[N].service                 Service to open by default, for example 'rds', 'ec2', etc.
                                     Applies only to 'web' access types, defaults to the
                                     main dashboard.
favorites[N].firefox_container_name  Firefox container name to use when opening the favorite.
                                     Applies only to 'web' access types, defaults to the
                                     favorite name.
                                     ** Only applies if the 'browser.firefox_container'
                                     option is set to 'true'.

PROFILES
--------
profiles[NAME].KION                  An instance of KION as defined above.
profiles[NAME].FAVORITES             An instance of FAVORITES as defined above.

BROWSER
-------
browser.firefox_container            Boolean to enable Firefox container support, defaults
                                     to 'false'.
                                     ** Depends on the "Open external links in a container"
                                     Firefox plugin.

Note: if the authentication password is not provided as a Flag / Environment Variable / Configuration file entry, kion will prompt for the password on the command line. Kion will cache this password in the system keychain's encrypted storage. This may be preferable in environments where plaintext storage of credentials is frowned upon.

Caching:

The Kion CLI has caching enabled by default. The cache is stored in the system keychain and can be disabled by either passing the --disable-cache global flag or by setting kion.disable_cache: true in the ~/.kion.yml configuration file. The Kion CLI attempts to receive temporary credential expirations from Kion however if nothing is returned a default credential duration of 15 minutes is set. Cached credentials will be used by default unless:

• Caching is disabled via the --disable-cache global flag
• Caching is disabled in the ~/.kion.yml configuration file by setting disable_cache: true
• The credential has less than 5 seconds left and Kion CLI is being used as an AWS credential provider
• The credential has less than 5 minutes left and Kion CLI is being used to print keys
• The credential has less than 10 minutes left and Kion CLI is being used to create an AWS configuration profile
• The credential has less than 5 minutes left and Kion CLI is being used to create an authenticated subshell
• The credential has less than 5 seconds left and Kion CLI is being used to run an ad hoc command

Compatibility

Kion-CLI is setup to be a drop in replacement for the older cloudtamer.io utility ctkey where possible. The one exception is the --iam-role options flag is no longer supported and must be replaced with --cloud-access-role, --car, or -c flag followed by a valid Cloud Access Role name.

# old ctkey usage to print short-term access keys
ctkey setenv --url=https://YOUR-KION-URL --account=121212121212 --cloud-access-role=admin
# new Kion-CLI example (drop in replacement)
kion setenv --url=https://YOUR-KION-URL --account=121212121212 --cloud-access-role=admin
# new Kion-CLI example (new usage, assumes use of ~/.kion.yml config)
kion stak --print --account 121212121212 --car admin
# new Kion-CLI example (short usage, assumes use of ~/.kion.yml config)
kion s -p -a 121212121212 -c admin

# old ctkey usage to store short-term access keys in an aws configuration profile
ctkey savecreds --url=https://YOUR-KION-URL --account=121212121212 --cloud-access-role=admin
# new Kion-CLI example (drop in replacement)
kion savecreds --url=https://YOUR-KION-URL --account=121212121212 --cloud-access-role=admin
# new Kion-CLI example (new usage, assumes use of ~/.kion.yml config)
kion stak --save --account 121212121212 --car admin
# new Kion-CLI example (short usage, assumes use of ~/.kion.yml config)
kion s -s -a 121212121212 -c admin

While you can drop in Kion-CLI directly with old usage it is recommended that you familiarize yourself with the new methods of access as it is does not require modification of AWS CLI configuration files.

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 util validate-saml

 SAML Configuration Validation
──────────────────────────────────────────────────────────────────

Kion URL configured                                              ✓
  URL: https://mykion.example

SAML Metadata configured                                         ✓
  Source: https://idp.example.com/metadata.xml

SAML SP Issuer configured                                        ✓
  Issuer: https://mykion.example/api/v1/saml/auth/2

Port 8400 is available for callback                              ✓
  Port is available for SAML callback

Kion server is accessible                                        ✓
  Status: HTTP 200

SAML Metadata is accessible                                      ✓

SAML Metadata structure is valid                                 ✓

IDP certificates are valid                                       ✓
  All 1 certificate(s) are valid and not expiring soon

IDP SSO URL is reachable                                         ✓
  Status: HTTP 200 (IDP is responding)

Kion CSRF endpoint is accessible                                 ✓
  Status: HTTP 200

──────────────────────────────────────────────────────────────────

╔══════════════════════════════════════════════════════════════╗
║ ✓ All validation checks passed!                              ║
║                                                              ║
║ Your SAML configuration appears to be correct.               ║
║ Try running SAML authentication to complete the flow.        ║
╚══════════════════════════════════════════════════════════════╝

Firefox Containers

Kion CLI supports the use of Firefox Containers to isolate federated sessions and allow multiple accounts to be accessed simultaneously in the same browser. To use containers with the Kion CLI, you must have the Open external links in a container Firefox extension installed. This extension adds a custom protocol handler that allows the Kion CLI to create new container tabs when opening console sessions.

To configure Kion CLI to use Firefox Containers, add the following to your ~/.kion.yml file:

browser:
  firefox_containers: true

Custom Builds

The Kion CLI can be customized for distribution within your organization by compiling with custom defaults. For example you can have a custom build with the URL of your Kion instance and SAML configurations pre-defined allowing new users to start using the CLI without any additional required setup. To create a custom build add your desired values to the lib/defaults/defaults.yml file then build with make build. Note that you should not store any sensitive information in the lib/defaults/defaults.yml file as they will be stored in plain text within the binary.

Contributing

1. Ensure you have golang installed and configured.
2. Clone the repository and initialize with make init. This will setup the necessary git hooks and other needed tools.
3. Create and populate your ~/.kion.yml configuration file. See the example at the top of this document.
4. When submitting a PR be sure to note your changes in the CHANGELOG.md.