kcatcher

Découvrez ce qui se cache dans vos clusters Kafka.

Introduction

Kcatcher est un utilitaire en ligne de commande permettant d'énumérer et d'évaluer les configurations de clusters Kafka. Il se connecte aux clusters Apache Kafka et récupère des informations détaillées sur les brokers, les topics, les ACL et même des exemples de messages. Parfait pour les audits de sécurité, les évaluations d'infrastructure ou simplement pour comprendre ce qui s'exécute dans votre environnement Kafka.

Démo

Installation

Go

Si vous disposez d'un environnement Go fonctionnel, vous pouvez installer avec :

go install github.com/RoseSecurity/kcatcher@latest

Apt

Pour installer les paquets, vous pouvez configurer rapidement le dépôt automatiquement :

curl -1sLf \
  'https://dl.cloudsmith.io/public/rosesecurity/kcatcher/setup.deb.sh' \
  | sudo -E bash

Une fois le dépôt configuré, vous pouvez installer avec :

apt install kcatcher

Source

git clone [email protected]:RoseSecurity/kcatcher.git
cd kcatcher
make build

Utilisation

Énumération de base

Connectez-vous à un cluster Kafka et récupérez les métadonnées des brokers et des topics :

kcatcher -b kafka-broker-1,kafka-broker-2

Port personnalisé

Spécifiez un port Kafka non par défaut :

kcatcher -b kafka-broker-1 -p 9093

Énumération des ACL

Récupérez les listes de contrôle d'accès (ACL) configurées sur le cluster :

kcatcher -b kafka-broker-1 --acls

Échantillonnage de messages

Échantillonnez des messages récents d'un topic spécifique :

kcatcher -b kafka-broker-1 --sample-topic my-topic --sample-count 5

Sortie JSON

Affichez les résultats au format JSON pour un traitement ultérieur :

kcatcher -b kafka-broker-1 --acls -o json

Énumération de la configuration

Récupérez les configurations des brokers et des topics :

kcatcher -b kafka-broker-1 --configs

Analyse de sécurité

Exécutez une analyse de sécurité complète sur votre cluster Kafka :

kcatcher -b kafka-broker-1 --analyze

Combinez avec l'énumération des ACL et de la configuration pour une évaluation complète :

kcatcher -b kafka-broker-1 --acls --configs --analyze

L'analyse de sécurité évalue votre cluster par rapport à 20 règles de sécurité intégrées réparties en cinq catégories : authentification, autorisation, chiffrement, contrôle d'accès et configuration. Les résultats incluent un score de sécurité (0-100), une note alphabétique et des constatations détaillées avec des recommandations de remédiation.

Options

Référence des règles de sécurité

Le moteur d'analyse de sécurité évalue votre cluster Kafka par rapport aux règles suivantes :

Authentification

Autorisation

Chiffrement

Contrôle d'accès (ACL)

Configuration

Score de sécurité

L'analyse produit un score de sécurité de 0 à 100 et une note alphabétique :

Contribution

Pour les rapports de bogues et les demandes de fonctionnalités, veuillez utiliser le suivi des problèmes.

Les PR sont les bienvenues ! Nous suivons le flux de travail Git classique « fork-and-pull ».

1. Fork le dépôt sur GitHub
2. Clone le projet sur votre propre machine
3. Commit les modifications sur votre propre branche
4. Push votre travail vers votre fork
5. Soumettez une Pull Request afin que nous puissions examiner vos modifications

[!TIP] Assurez-vous de fusionner les derniers changements depuis « upstream » avant de faire une pull request !

Un grand merci à nos contributeurs