RosvVulns

<p>An R6 class to provide a lower-level interface to the vulnerability
endpoint of the OSV API.</p>

Connect, query, and operate on information available from the
'Open Source Vulnerability' database <https://osv.dev/>. Although 'CRAN'
has vulnerabilities listed, these are few compared to projects such as
'PyPI'. With tighter integration between 'R' and 'Python', having an
'R' specific package to access details about vulnerabilities from
various sources is a worthwhile enterprise.

Allen OBrien

rosv

Client to Access and Operate on the 'Open Source Vulnerability'
API

RosvVulns function

<p><code>rosv::RosvQuery1</code> -&gt; <code>RosvVulns</code></p>

Super class


<div class="section" id="public-methods">
<h3>Public methods</h3><p></p><p><ul>
<li><p><a href="/link/RosvVulns%24new()?package=rosv&version=0.5.1" data-mini-rdoc="rosv::RosvVulns$new()"><code>RosvVulns$new()</code></a></p></li>
<li><p><a href="/link/RosvVulns%24run()?package=rosv&version=0.5.1" data-mini-rdoc="rosv::RosvVulns$run()"><code>RosvVulns$run()</code></a></p></li>
<li><p><a href="/link/RosvVulns%24print()?package=rosv&version=0.5.1" data-mini-rdoc="rosv::RosvVulns$print()"><code>RosvVulns$print()</code></a></p></li>
<li><p><a href="/link/RosvVulns%24clone()?package=rosv&version=0.5.1" data-mini-rdoc="rosv::RosvVulns$clone()"><code>RosvVulns$clone()</code></a></p></li>
</ul></p><p></p></div><p><details open><summary>Inherited methods</summary>
<ul>
<li><span class="pkg-link" data-pkg="rosv" data-topic="RosvQuery1" data-id="parse"><a href="/link/rosv%3A%3ARosvQuery1%24parse()?package=rosv&version=0.5.1" data-mini-rdoc="rosv::rosv::RosvQuery1$parse()"><code>rosv::RosvQuery1$parse()</code></a></span></li>
</ul>
</details></p><p><hr>
<a id="method-RosvVulns-new"></a></p><div class="section" id="method-new-">
<h3>Method <code>new()</code></h3>
<p>Set the core request details for subsequent use when called in <code>run()</code> method.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>RosvVulns$new(vuln_ids)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>vuln_ids</code></dt>
<dd><p>Character vector of vulnerability IDs.</p></dd></dl></div></p><p>
</p><p></p>
<p></p><p></p><p><hr>
<a id="method-RosvVulns-run"></a></p><div class="section" id="method-run-">
<h3>Method <code>run()</code></h3>
<p>Perform the request and return response for OSV API call.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>RosvVulns$run()</code></pre><p></p></div><p></p>
</div><p></p><p>
</p><p><hr>
<a id="method-RosvVulns-print"></a></p><div class="section" id="method-print-">
<h3>Method <code><a href="/link/print()?package=rosv&version=0.5.1" data-mini-rdoc="rosv::print()">print()</a></code></h3>
<p>Print basic details of query object to screen.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>RosvVulns$print(...)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>...</code></dt>
<dd><p>Reserved for possible future use.</p></dd></dl></div></p><p>
</p><p></p>
<p></p><p></p><p><hr>
<a id="method-RosvVulns-clone"></a></p><div class="section" id="method-clone-">
<h3>Method <code>clone()</code></h3>
<p>The objects of this class are cloneable with this method.</p><div class="section" id="usage">
<h4>Usage</h4>
<p><div class="r"></div></p><pre><code>RosvVulns$clone(deep = FALSE)</code></pre><p></p></div><p></p>
</div><p></p><p><div class="section" id="arguments">
<h4>Arguments</h4>
<p><div class="arguments"></div></p><dl>
<dt><code>deep</code></dt>
<dd><p>Whether to make a deep clone.</p></dd></dl></div></p><p>
</p><p></p>
<p></p><p>
</p>

Methods

R6 Class for OSV Vulns Endpoint — RosvVulns


<div class='section' id='public-methods'>
<h3>Public methods</h3>

<ul>
<li><p><a href='#method-RosvVulns-new'><code>RosvVulns$new()</code></a></p></li>
<li><p><a href='#method-RosvVulns-run'><code>RosvVulns$run()</code></a></p></li>
<li><p><a href='#method-RosvVulns-print'><code>RosvVulns$print()</code></a></p></li>
<li><p><a href='#method-RosvVulns-clone'><code>RosvVulns$clone()</code></a></p></li>
</ul>

</div><p><details open><summary>Inherited methods</summary>
<ul>
<li><span class="pkg-link" data-pkg="rosv" data-topic="RosvQuery1" data-id="parse"><a href='../../rosv/html/RosvQuery1.html#method-RosvQuery1-parse'><code>rosv::RosvQuery1$parse()</code></a></span></li>
</ul>
</details>

<hr>
<a id="method-RosvVulns-new"></a></p><div class='section' id='method-new-'>
<h3>Method <code>new()</code></h3>
<p>Set the core request details for subsequent use when called in <code>run()</code> method.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>RosvVulns$new(vuln_ids)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>vuln_ids</code></dt>
<dd><p>Character vector of vulnerability IDs.</p></dd>


</dl><p></div></p>
</div>

</div><p><hr>
<a id="method-RosvVulns-run"></a></p><div class='section' id='method-run-'>
<h3>Method <code>run()</code></h3>
<p>Perform the request and return response for OSV API call.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>RosvVulns$run()</code></pre><p></div></p>
</div>


</div><p><hr>
<a id="method-RosvVulns-print"></a></p><div class='section' id='method-print-'>
<h3>Method <code><a href='https://rdrr.io/r/base/print.html'>print()</a></code></h3>
<p>Print basic details of query object to screen.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>RosvVulns$print(...)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>...</code></dt>
<dd><p>Reserved for possible future use.</p></dd>


</dl><p></div></p>
</div>

</div><p><hr>
<a id="method-RosvVulns-clone"></a></p><div class='section' id='method-clone-'>
<h3>Method <code>clone()</code></h3>
<p>The objects of this class are cloneable with this method.</p><div class='section' id='usage'>
<h4>Usage</h4>
<p><div class="r"></p><pre><code>RosvVulns$clone(deep = FALSE)</code></pre><p></div></p>
</div>

<div class='section' id='arguments'>
<h4>Arguments</h4>
<p><div class="arguments"></p><dl>
<dt><code>deep</code></dt>
<dd><p>Whether to make a deep clone.</p></dd>


</dl><p></div></p>
</div>

</div>


RosvVulns: R6 Class for OSV Vulns Endpoint

Description

Arguments

Value

Super class

Methods

Public methods

Method `new()`

Usage

Arguments

Method `run()`

Usage

Method `print()`

Usage

Arguments

Method `clone()`

Usage

Arguments

See Also

Examples

Description

Arguments

Value

Super class

Methods

Public methods

Method new()

Usage

Arguments

Method run()

Usage

Method print()

Usage

Arguments

Method clone()

Usage

Arguments

See Also

Examples

Method `new()`

Method `run()`

Method `print()`

Method `clone()`