diff --git a/README.md b/README.md index 07b8f167ec..dc73cfffd0 100644 --- a/README.md +++ b/README.md @@ -324,8 +324,13 @@ You can use `--config` option to provide configuration file for the tool. You ca ## Using CVE Binary Tool in GitHub Actions -If you want to integrate cve-bin-tool as a part of your github action pipeline. -You can checkout our example [github action](https://github.com/intel/cve-bin-tool/blob/main/doc/how_to_guides/cve_scanner_gh_action.yml). +If you want to integrate cve-bin-tool as a part of your github action pipeline, you can use cve-bin-tool's official GitHub Action. Find more details [here](https://github.com/intel/cve-bin-tool-action/#cve-binary-tool-github-action). The GitHub Action provide reports on the security tab. + + +Note: The Security Tab is only available to public open source projects. So if the project is private you can use the example below. + + +Also if you want something simple and directly want to use it on CI, you can checkout our example [github action](https://github.com/intel/cve-bin-tool/blob/main/doc/how_to_guides/cve_scanner_gh_action.yml). ## Data Sources @@ -432,53 +437,55 @@ This data source provides the CVEs for the CURL product. The following checkers are available for finding components in binary files: -| | | | Available checkers | | | | -|--------------- |--------------- |------------------ |------------- |--------------- |------------ |----------------- | -| accountsservice |acpid |apache_http_server |apcupsd |apparmor |asn1c |assimp | -| asterisk |atftp |avahi |bash |bind |binutils |bird | -| bison |bluez |boinc |botan |bro |bubblewrap |busybox | -| bwm_ng |bzip2 |c_ares |capnproto |ceph |chess |chrony | -| clamav |collectd |commons_compress |connman |coreutils |cpio |cronie | -| cryptsetup |cups |curl |cvs |darkhttpd |dav1d |davfs2 | -| dbus |dhclient |dhcpcd |dhcpd |dmidecode |dnsmasq |domoticz | -| dovecot |doxygen |dpkg |dropbear |e2fsprogs |elfutils |emacs | -| enscript |exim |exiv2 |f2fs_tools |faad2 |fastd |ffmpeg | -| file |firefox |flac |fluidsynth |freeradius |freerdp |fribidi | -| frr |gcc |gdb |gdk_pixbuf |gimp |git |glib | -| glibc |gmp |gnomeshell |gnupg |gnutls |gpgme |gpsd | -| graphicsmagick |grub2 |gstreamer |gupnp |gvfs |gzip |haproxy | -| harfbuzz |haserl |hdf5 |hostapd |hunspell |i2pd |icecast | -| icu |iperf3 |ipmitool |ipsec_tools |iptables |irssi |iucode_tool | -| jack2 |jacksondatabind |janus |jhead |json_c |kbd |keepalived | -| kerberos |kexectools |kodi |kubernetes |ldns |lftp |libarchive | -| libass |libbpg |libcoap |libconfuse |libcurl |libdb |libebml | -| libexpat |libgcrypt |libgd |libgit2 |libical |libidn2 |libinput | -| libjpeg |libjpeg_turbo |libksba |liblas |libmatroska |libmemcached |libmicrohttpd | -| libmodbus |libnss |libpcap |libraw |librsvg |librsync |libsamplerate | -| libseccomp |libsndfile |libsolv |libsoup |libsrtp |libssh |libssh2 | -| libtasn1 |libtiff |libtomcrypt |libupnp |libvirt |libvncserver |libvorbis | -| libxslt |lighttpd |linux_kernel |lldpd |logrotate |lua |luajit | -| lxc |lynx |lz4 |mailx |mariadb |mdadm |memcached | -| mini_httpd |minicom |minidlna |miniupnpc |miniupnpd |modsecurity |mosquitto | -| motion |mpv |msmtp |mtr |mutt |mysql |nano | -| nasm |nbd |ncurses |neon |nessus |netatalk |netkit_ftp | -| netpbm |nettle |nghttp2 |nginx |ngircd |nmap |node | -| ntfs_3g |ntp |ntpsec |open_iscsi |open_vm_tools |openafs |opencv | -| openjpeg |openldap |opensc |openssh |openssl |openswan |openvpn | -| p7zip |pango |patch |pcre |pcre2 |pcsc_lite |perl | -| picocom |pigz |pixman |png |polarssl_fedora |poppler |postgresql | -| ppp |privoxy |procps_ng |proftpd |pspp |pure_ftpd |putty | -| python |qemu |qt |quagga |radare2 |radvd |raptor | -| rauc |rdesktop |readline |rsync |rsyslog |rtl_433 |rtmpdump | -| runc |rust |samba |sane_backends |sdl |seahorse |shadowsocks_libev | -| sngrep |snort |sofia_sip |speex |spice |sqlite |squashfs | -| squid |sslh |stellarium |strongswan |stunnel |subversion |sudo | -| suricata |sylpheed |syslogng |sysstat |systemd |tcpdump |tcpreplay | -| thrift |thttpd |thunderbird |timescaledb |tinyproxy |tor |tpm2_tss | -| transmission |trousers |u_boot |udisks |unbound |unixodbc |upx | -| util_linux |varnish |vim |vorbis_tools |vsftpd |webkitgtk |wget | -| wireshark |wolfssl |wpa_supplicant |xerces |xml2 |xscreensaver |yasm | -| zabbix |zeek |zlib |znc |zsh | | | + +| | | | Available checkers | | | | +| --------------- | --------------- | ------------------ | ------------------ | --------------- | ------------ | ----------------- | +| accountsservice | acpid | apache_http_server | apcupsd | apparmor | asn1c | assimp | +| asterisk | atftp | avahi | bash | bind | binutils | bird | +| bison | bluez | boinc | botan | bro | bubblewrap | busybox | +| bwm_ng | bzip2 | c_ares | capnproto | ceph | chess | chrony | +| clamav | collectd | commons_compress | connman | coreutils | cpio | cronie | +| cryptsetup | cups | curl | cvs | darkhttpd | dav1d | davfs2 | +| dbus | dhclient | dhcpcd | dhcpd | dmidecode | dnsmasq | domoticz | +| dovecot | doxygen | dpkg | dropbear | e2fsprogs | elfutils | emacs | +| enscript | exim | exiv2 | f2fs_tools | faad2 | fastd | ffmpeg | +| file | firefox | flac | fluidsynth | freeradius | freerdp | fribidi | +| frr | gcc | gdb | gdk_pixbuf | gimp | git | glib | +| glibc | gmp | gnomeshell | gnupg | gnutls | gpgme | gpsd | +| graphicsmagick | grub2 | gstreamer | gupnp | gvfs | gzip | haproxy | +| harfbuzz | haserl | hdf5 | hostapd | hunspell | i2pd | icecast | +| icu | iperf3 | ipmitool | ipsec_tools | iptables | irssi | iucode_tool | +| jack2 | jacksondatabind | janus | jhead | json_c | kbd | keepalived | +| kerberos | kexectools | kodi | kubernetes | ldns | lftp | libarchive | +| libass | libbpg | libcoap | libconfuse | libcurl | libdb | libebml | +| libexpat | libgcrypt | libgd | libgit2 | libical | libidn2 | libinput | +| libjpeg | libjpeg_turbo | libksba | liblas | libmatroska | libmemcached | libmicrohttpd | +| libmodbus | libnss | libpcap | libraw | librsvg | librsync | libsamplerate | +| libseccomp | libsndfile | libsolv | libsoup | libsrtp | libssh | libssh2 | +| libtasn1 | libtiff | libtomcrypt | libupnp | libvirt | libvncserver | libvorbis | +| libxslt | lighttpd | linux_kernel | lldpd | logrotate | lua | luajit | +| lxc | lynx | lz4 | mailx | mariadb | mdadm | memcached | +| mini_httpd | minicom | minidlna | miniupnpc | miniupnpd | modsecurity | mosquitto | +| motion | mpv | msmtp | mtr | mutt | mysql | nano | +| nasm | nbd | ncurses | neon | nessus | netatalk | netkit_ftp | +| netpbm | nettle | nghttp2 | nginx | ngircd | nmap | node | +| ntfs_3g | ntp | ntpsec | open_iscsi | open_vm_tools | openafs | opencv | +| openjpeg | openldap | opensc | openssh | openssl | openswan | openvpn | +| p7zip | pango | patch | pcre | pcre2 | pcsc_lite | perl | +| picocom | pigz | pixman | png | polarssl_fedora | poppler | postgresql | +| ppp | privoxy | procps_ng | proftpd | pspp | pure_ftpd | putty | +| python | qemu | qt | quagga | radare2 | radvd | raptor | +| rauc | rdesktop | readline | rsync | rsyslog | rtl_433 | rtmpdump | +| runc | rust | samba | sane_backends | sdl | seahorse | shadowsocks_libev | +| sngrep | snort | sofia_sip | speex | spice | sqlite | squashfs | +| squid | sslh | stellarium | strongswan | stunnel | subversion | sudo | +| suricata | sylpheed | syslogng | sysstat | systemd | tcpdump | tcpreplay | +| thrift | thttpd | thunderbird | timescaledb | tinyproxy | tor | tpm2_tss | +| transmission | trousers | u_boot | udisks | unbound | unixodbc | upx | +| util_linux | varnish | vim | vorbis_tools | vsftpd | webkitgtk | wget | +| wireshark | wolfssl | wpa_supplicant | xerces | xml2 | xscreensaver | yasm | +| zabbix | zeek | zlib | znc | zsh | | | + All the checkers can be found in the checkers directory, as can the