From 8bfc43aad6e4fda045035f1c3f5407d089e69bee Mon Sep 17 00:00:00 2001 From: Kawaii Girl UwU OwO <154224080+sillygoofygamergirluwu69@users.noreply.github.com> Date: Mon, 18 Dec 2023 13:01:14 +0100 Subject: [PATCH] improve README.md --- README.md | 33 ++++++++++++++------------------- 1 file changed, 14 insertions(+), 19 deletions(-) diff --git a/README.md b/README.md index 75015fc..794b768 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,20 @@ -# golang-rpm-oval-parser -A simple parser for rpm oval xml files written in go +# Golang RPM Oval Parser +This repository hosts a simple parser crafted for RPM Oval XML files, implemented in Go. -This is an example on how to parse OVAL files for getting vulnerabilities definitions -for an RPM based distribution. +The code serves as an illustration of how to extract vulnerability definitions specifically tailored for RPM-based distributions from OVAL files. - More info on OVAL: https://oval.cisecurity.org/ +## What is OVAL? +Find more information about the Open Vulnerability and Assessment Language (OVAL) [here](https://oval.cisecurity.org/). - OVAL files for SUSE - http://ftp.suse.com/pub/projects/security/oval/ +## OVAL Files Resources +- SUSE: [SUSE OVAL Files](http://ftp.suse.com/pub/projects/security/oval/) +- RedHat: [RedHat OVAL Files](https://www.redhat.com/security/data/oval/) +- Oracle: [Oracle OVAL Files](https://linux.oracle.com/oval/) - OVAL files for RedHat - https://www.redhat.com/security/data/oval/ +## Usage +- Build the parser: `go build` +- Run it using: `./golang-rpm-oval-parser FILE.xml` +- Explore the test directory for sample files to test the parser's functionality. - OVAL files for Oracle - https://linux.oracle.com/oval/ - -Usage: - -build it with: go build - -you can run with ./golang-rpm-oval-parser FILE.xml - -you can use files in test directory for testing the parser +Feel free to use this parser to efficiently extract vulnerability information from OVAL files for RPM-based distributions. Contributions and feedback are always appreciated!