https://github.com/GeekMasher/quibble

A container security tool written in Rust focusing on making security easy for compose based configurations
https://github.com/GeekMasher/quibble

containers docker docker-compose podman podman-compose security

Last synced: 3 months ago
JSON representation

A container security tool written in Rust focusing on making security easy for compose based configurations

• Host: GitHub
• URL: https://github.com/GeekMasher/quibble
• Owner: GeekMasher
• License: mit
• Created: 2022-11-30T20:13:33.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-20T19:10:52.000Z (6 months ago)
• Last Synced: 2024-05-20T22:21:53.544Z (6 months ago)
• Topics: containers, docker, docker-compose, podman, podman-compose, security
• Language: Rust
• Homepage: https://crates.io/crates/quibble/
• Size: 342 KB
• Stars: 11
• Watchers: 2
• Forks: 3
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


Quibble


[![GitHub](https://img.shields.io/badge/github-%23121011.svg?style=for-the-badge&logo=github&logoColor=white)](https://github.com/GeekMasher/quibble)

[![GitHub Actions](https://img.shields.io/github/actions/workflow/status/geekmasher/quibble/rust.yml?style=for-the-badge)](https://github.com/GeekMasher/quibble/actions/workflows/rust.yml?query=branch%3Amain)

[![GitHub Issues](https://img.shields.io/github/issues/geekmasher/quibble?style=for-the-badge)](https://github.com/GeekMasher/quibble/issues)

[![GitHub Stars](https://img.shields.io/github/stars/geekmasher/quibble?style=for-the-badge)](https://github.com/GeekMasher/quibble)

[![Crates.io](https://img.shields.io/crates/d/quibble?style=for-the-badge)](https://crates.io/crates/quibble/)

[![Licence](https://img.shields.io/github/license/Ileriayo/markdown-badges?style=for-the-badge)](./LICENSE)



A container security tool written in Rust focusing on making security easy for compose based configurations.

## Installing

### Crates.io

```bash

cargo install quibble

```

### Cargo CLI - From source

```bash

git clone https://github.com/GeekMasher/quibble

cd quibble

cargo install --path .

```

### Actions

```yml

- name: Quibble Scan

  uses: GeekMasher/[email protected]

```

## Usage

Quibble runs in many modes (more to come soon)

#### Compose

`compose` finds all compose files and runs a set of rules on the parsed compose files.

```bash

quibble compose --help

```

This is a very simple util to quickly scan and detect various security or information about the compose files found in a simple view.

```bash

quibble compose --path /srv

```

![screenshot of quibble on a directory containing many different compose files](./assets/quibble-output1.jpg)

## Contributing

Contributions are absolutely, positively welcome and encouraged!

Contributions come in many forms. You could:

1. Submit a feature request or bug report as an [issue].

2. Ask for improved documentation as an [issue].

3. Comment on [issues that require feedback].

4. Contribute code via [pull requests].

[issue]: https://github.com/GeekMasher/quibble/issues

[issues that require feedback]: https://github.com/GeekMasher/quibble/issues?q=is%3Aissue+is%3Aopen+label%3A%22feedback+wanted%22

[pull requests]: https://github.com/GeekMasher/quibble/pulls

We aim to keep Quibble's code quality at the highest level. This means that any

code you contribute must be:

- **Commented:** Complex and non-obvious functionality must be properly

  commented.

- **Documented:** Public items _must_ have doc comments with examples, if

  applicable.

- **Styled:** Your code's style should match the existing and surrounding code

  style.

- **Simple:** Your code should accomplish its task as simply and

  idiomatically as possible.

- **Tested:** You must write (and pass) convincing tests for any new

  functionality.

- **Focused:** Your code should do what it's supposed to and nothing more.

## License

All the code in this repository is under the [MIT License](./LICENSE).