Skip to main content

A command line interface for scanning configuration files with CoGuard

Project description

Coguard Logo

CoGuard

Introduction to the CoGuard CLI

CoGuard is a comprehensive static analysis tool for IT infrastructure configurations (cloud and on-premise).

This project is the command line interface to CoGuard, with additional auto-discovery functionality.

In its current release, it scans Docker images and its contents. In particular, it searches for known configuration files of different software packages (like webservers, databases, etc.), and scans these configurations for security and best practice.

How to install it

CoGuard CLI can either be pulled from this repository and used directly, or installed via pip:

pip install coguard-cli

Keep in mind that it is a requirement to have Docker installed locally.

How to use it

After installing the CoGuard CLI, you can run a scan on your local images using

coguard docker-image [<YOUR-IMAGE-NAME-OR-ID>]

If you omit the image ID parameter, CoGuard will scan all the images currently stored on your device.

This step requires you to create a CoGuard account. After completion, this image check will return the findings of CoGuard on this particular image.

Current support and future plans

The currently supported auto-discovery of configuration files inside Docker containers is limited to the finders in this folder. This list will expand in the future. In addition, we are scanning the Dockerfile used to create the images, and will add some Linux configuration files in the near future.

Learn more

CoGuard Website CoGuard Blog

Project details


Release history Release notifications | RSS feed

This version

0.1

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

coguard-cli-0.1.tar.gz (17.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

coguard_cli-0.1-py3-none-any.whl (30.0 kB view details)

Uploaded Python 3

File details

Details for the file coguard-cli-0.1.tar.gz.

File metadata

  • Download URL: coguard-cli-0.1.tar.gz
  • Upload date:
  • Size: 17.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.5

File hashes

Hashes for coguard-cli-0.1.tar.gz
Algorithm Hash digest
SHA256 7299a636573655aee7e56bee414c30456813332d689fc0a493c9bd8da4e349d6
MD5 868d329b8372d6faeb8d77f6b2cc54a5
BLAKE2b-256 0f1e5b197c14a0c88bf3c52622e89f1bbf062b25a35b09067433ef7ccc3cbf1f

See more details on using hashes here.

File details

Details for the file coguard_cli-0.1-py3-none-any.whl.

File metadata

  • Download URL: coguard_cli-0.1-py3-none-any.whl
  • Upload date:
  • Size: 30.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.10.5

File hashes

Hashes for coguard_cli-0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 7e46283932554c1f0b8f2b687a5831babb8d2a1e71b34340691c45d561199883
MD5 5397ea729559bf8676c801eca5af8ab8
BLAKE2b-256 3f37cf6af4ee8f0dc568afcd009db2bfb7d6c841175641fd471589152f914b58

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page