xAppSec

A command tool to perform the security check to xApp and set up EFK stack for monitoring xApp's behavior.

Environment.

✅ Working well in Near-RT RIC Cluster [E Release]
✅ Ubuntu 18.04 LTS

Funcitonality

xAppSec Usage:

./xAppSec.sh [OPTIONS]

[OPTIONS]:image
 -i: initialize the envrionment.
 -n: normal mode, do xApp image scanning,onboarding and installing the xApp.
 -k: Setup Kibana Index Pattern.
 -h: Help.

Setup Environment for xApp image scanning, onboarding and deploying.
Deploy EFK Stack for monitoring xApp's behavior.
Automatically Setup Kibana Index Pattern.

Initialization

The initialization includes the following steps:

Install VeinMind SDK and related dependencies.
Clone O-RAN xapp_onboarder repo.
Build custom fluentd daemonset dockerfile.
Deploy EFK K8S objects.
Run helm server locally.

Image Scan

Run the following script for scanning xApp's image.

ImageRegistryCheck.py
backdoor_scan.py
image_history.py

EFK Monitoring

Capture xApp's Pod log and present its behavior.

Create Index Pattern automatically.

Architecture

Process

xApp Onboarding and Deploying

程式運作- Run EFK to process xApp log data

Execution

./xAppSec.sh -i

After initializing, a helm server is running. and waiting for xApp to onboard.

./xAppSec/sh -n

normal mode, to scan xApp image, Onboard xApp via descriptor

leozzmc/xAppSec