Giter Site home page Giter Site logo

iifybot's Introduction

IIFYBOT

Overview

IIFYBOT (aka "Is It Fix Yet?" Bot) is a Slack Bot designed to aid in triaging and mitigating potential vulnerabilities within the Red Hat-based container images you are using for your application. IIFYBOT uses the Red Hat Security Data API to provide CVRF, CVE, and OVAL data, allowing users to quickly understand whether Red Hat has provided a fix for security issues regarding their Packages (RPMs). Additionally, IIFYBOT also uses the Red Hat Catalog API to allow users to quickly get a listing of RPMs within the newest release of a selected Red Hat container image. With both previously mentioned data points, users can quickly understand if a fix has been released for a RPM and whether that fix is within the newest release of the Red Hat container image they are using, answering the question... Is it Fixed Yet?


Getting Started

At this time, IIFYBOT is not a distributed Slack application. However, if you want to deploy your own instance of IIFYBOT, all the code is here to get you quickly set up! IIFYBOT uses the Slack Bolt Framework for Python, and Slack has done a fantastic job outlining how to set up your own Slack app. Follow Slack's Guide for creating and setting up a Slack app, get your Bot Token and Signing Secret, link IIFYBOT's slash commands to your own endpoint, and build and run the provided Dockerfile, and then you are off to the races.

Building & Running IIFYBOT Locally

Use the provided Dockerfile to build the IIFYBOT container image.

docker build --no-cache -t iifybot:local .

Next run the IIFYBOT container image with the following command.

docker run \
	--env SLACK_BOT_TOKEN=<%YOUR-SLACK-BOT-TOKEN%> \
	--env SIGNING_SECRET=<%YOUR-SIGNING-SECRET%> \
	-p 5000:5000 \
	--name iifybot iifybot:local

The Commands

  • /iify - This command gives back Red Hat security information on one or more CVEs
    • EXAMPLE: /iffy cve-xxxx-xxxxx or /iffy cve-xxxx-xxxxx cve-xxxx-xxxxx cve-xxxx-xxxxx
  • /sbom - Provide a Container Image name from the Red Hat Catalog and get a listing of the image's included RPMs and their version.
    • NOTE: This will only provide the RPMs of newest version of the Container Image provided.
    • EXAMPLE: /iffy_sbom ubi8/ubi or /iffy_sbom rhel8/python-38
  • /iifyhelp - Provides a list of IIFYBOT command and their functions
  • /iifyart - Provides a random piece of ASCII art created by the man, the myth, the legend Kent Aycoth

iifybot's People

Contributors

xxlhacker avatar

Watchers

Ben Thomasson avatar Gerd Oberlechner avatar James Cloos avatar John Mitchell avatar Jan-Hendrik Boll avatar Keith Walsh avatar Jon Mosco avatar Bennyturns avatar Matt Pusateri avatar Barnaby Court avatar Tomas Lestach avatar Olivia Huang avatar Esron Silva avatar Guillaume PONT avatar Suzana Nesic avatar  avatar Kevan Holdaway avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.