github-personal/sysadm
1
0
Fork 0
mirror of https://github.com/outbackdingo/sysadm.git synced 2026-01-27 10:20:26 +00:00
Code Issues Packages Projects Releases Wiki Activity

Doc the pkg_audit action.

Browse Source
This commit is contained in:
dlavigne
2016-03-28 11:40:20 -04:00
parent 31593708bf
commit 7aa65f4d22
1 changed files with 54 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

58
api/classes/pkg.rst
View File

@@ -20,7 +20,7 @@ Every pkg class request contains the following parameters:
| namespace | sysadm | |
| | | |
+---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+
| action | | supported actions include "pkg_info", "pkg_search", "list_categories", "list_repos" |
| action | | supported actions include "pkg_info", "pkg_search", "list_categories", "list_repos", "pkg_audit" |
| | | |
+---------------------------------+---------------+----------------------------------------------------------------------------------------------------------------------+
@@ -233,7 +233,7 @@ The "pkg_search" action searches the package database for pkgs which match the g
.. code-block:: json
PUT /sysadm/pkg
PUT /sysadm/pkg
{
"repo" : "pcbsd-major",
"category" : "www",
@@ -401,8 +401,7 @@ PUT /sysadm/pkg
List Categories
===============
The "list_categories" action lists all the known categories within the specified repository or, if no repository is specified, the local repository. Note that just because a category is
listed, it does not mean that any packages exist within that category.
The "list_categories" action lists all the known, non-empty categories within the specified repository or, if no repository is specified, the local repository.
**REST Request**
@@ -539,4 +538,55 @@ action are valid as the optional "repo" argument for the other pkg API actions.
"id": "fooid",
"name": "response",
"namespace": "sysadm"
}
.. index:: pkg_audit, pkg
.. _Audit Packages:
Audit Packages
==============
The "pkg_audit" action performs an audit of all installed packages and reports any packages with known vulnerabilities as well as other packages which are impacted by those vulnerabilities.
.. note:: the vulnerability information will be returned as a dispatcher event as this action just queues up the results of the :command:`pkg` operation. This is due to a limitation of
:command:`pkg`, as it only supports one process call at a time. Refer to the :ref:`Dispatcher Subsystem` for instructions on how to subscribe to and query dispatcher events.
**REST Request**
.. code-block:: json
PUT /sysadm/pkg
{
"action" : "pkg_audit"
}
**WebSocket Request**
.. code-block:: json
{
"args" : {
"action" : "pkg_audit"
},
"name" : "pkg",
"id" : "fooid",
"namespace" : "sysadm"
}
**Response**
.. code-block:: json
{
"args": {
"pkg_audit": {
"proc_cmd": "pkg audit -qr",
"proc_id": "sysadm_pkg_audit-{257cc46b-9178-4990-810a-12416ddfad79}",
"status": "pending"
}
},
"id": "fooid",
"name": "response",
"namespace": "sysadm"
}