Files
moloch---sliver-script/docs/index.html
T
2021-07-04 10:42:12 -05:00

233 lines
24 KiB
HTML

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>sliver-script</title>
<meta name="description" content="Documentation for sliver-script">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="assets/css/main.css">
<script async src="assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="assets/js/search.json" data-base=".">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="index.html" class="title">sliver-script</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<h1>sliver-script</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<div class="tsd-panel tsd-typography">
<a href="#sliver-script" id="sliver-script" style="color: inherit; text-decoration: none;">
<h1>Sliver Script</h1>
</a>
<p>Sliver-script is a TypeScript/JavaScript client library for Sliver, it can be used to automate any operator interaction with Sliver. Sliver-script uses existing Sliver client configuration files and connects to servers using gRPC over Mutual-TLS. It also provides <a href="https://www.learnrxjs.io/">RxJS</a> abstractions for easy interactions with real-time components.</p>
<p><a href="https://www.gnu.org/licenses/gpl-3.0"><img src="https://img.shields.io/badge/License-GPLv3-blue.svg" alt="License: GPL v3"></a></p>
<a href="#install" id="install" style="color: inherit; text-decoration: none;">
<h3>Install</h3>
</a>
<p>Node v14 or later is required for this package, and it can be installed via npm:</p>
<p><code>npm install sliver-script</code></p>
<a href="#typescript-example" id="typescript-example" style="color: inherit; text-decoration: none;">
<h3>TypeScript Example</h3>
</a>
<a href="#basic" id="basic" style="color: inherit; text-decoration: none;">
<h4>Basic</h4>
</a>
<pre><code class="language-typescript"><span style="color: #AF00DB">import</span><span style="color: #000000"> { </span><span style="color: #001080">SliverClient</span><span style="color: #000000">, </span><span style="color: #001080">ParseConfigFile</span><span style="color: #000000"> } </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;sliver-script&#039;</span>
<span style="color: #000000">(</span><span style="color: #0000FF">async</span><span style="color: #000000"> </span><span style="color: #0000FF">function</span><span style="color: #000000">() {</span>
<span style="color: #000000"> </span>
<span style="color: #000000"> </span><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">config</span><span style="color: #000000"> = </span><span style="color: #AF00DB">await</span><span style="color: #000000"> </span><span style="color: #795E26">ParseConfigFile</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;./moloch_localhost.cfg&#039;</span><span style="color: #000000">)</span>
<span style="color: #000000"> </span><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">client</span><span style="color: #000000"> = </span><span style="color: #0000FF">new</span><span style="color: #000000"> </span><span style="color: #795E26">SliverClient</span><span style="color: #000000">(</span><span style="color: #001080">config</span><span style="color: #000000">)</span>
<span style="color: #000000"> </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">`Connecting to </span><span style="color: #0000FF">${</span><span style="color: #001080">client</span><span style="color: #000000FF">.</span><span style="color: #795E26">host</span><span style="color: #000000FF">()</span><span style="color: #0000FF">}</span><span style="color: #A31515"> ...`</span><span style="color: #000000">)</span>
<span style="color: #000000"> </span><span style="color: #AF00DB">await</span><span style="color: #000000"> </span><span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">connect</span><span style="color: #000000">()</span>
<span style="color: #000000"> </span><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">sessions</span><span style="color: #000000"> = </span><span style="color: #AF00DB">await</span><span style="color: #000000"> </span><span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">sessions</span><span style="color: #000000">()</span>
<span style="color: #000000"> </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #001080">sessions</span><span style="color: #000000">)</span>
<span style="color: #000000">})()</span>
</code></pre>
<a href="#monitor-events-in-real-time" id="monitor-events-in-real-time" style="color: inherit; text-decoration: none;">
<h4>Monitor Events in Real-time</h4>
</a>
<pre><code class="language-typescript"><span style="color: #AF00DB">import</span><span style="color: #000000"> { </span><span style="color: #001080">SliverClient</span><span style="color: #000000">, </span><span style="color: #001080">ParseConfigFile</span><span style="color: #000000"> } </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;sliver-script&#039;</span>
<span style="color: #000000">(</span><span style="color: #0000FF">async</span><span style="color: #000000"> </span><span style="color: #0000FF">function</span><span style="color: #000000">() {</span>
<span style="color: #000000"> </span><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">config</span><span style="color: #000000"> = </span><span style="color: #AF00DB">await</span><span style="color: #000000"> </span><span style="color: #795E26">ParseConfigFile</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;./moloch_localhost.cfg&#039;</span><span style="color: #000000">)</span>
<span style="color: #000000"> </span><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">client</span><span style="color: #000000"> = </span><span style="color: #0000FF">new</span><span style="color: #000000"> </span><span style="color: #795E26">SliverClient</span><span style="color: #000000">(</span><span style="color: #001080">config</span><span style="color: #000000">)</span>
<span style="color: #000000"> </span><span style="color: #AF00DB">await</span><span style="color: #000000"> </span><span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">connect</span><span style="color: #000000">()</span>
<span style="color: #000000"> </span><span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #001080">event$</span><span style="color: #000000">.</span><span style="color: #795E26">subscribe</span><span style="color: #000000">((</span><span style="color: #001080">event</span><span style="color: #000000">) </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
<span style="color: #000000"> </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #001080">event</span><span style="color: #000000">)</span>
<span style="color: #000000"> })</span>
<span style="color: #000000">})()</span>
</code></pre>
<a href="#automatically-interact-with-new-sessions" id="automatically-interact-with-new-sessions" style="color: inherit; text-decoration: none;">
<h4>Automatically Interact with New Sessions</h4>
</a>
<pre><code class="language-typescript"><span style="color: #AF00DB">import</span><span style="color: #000000"> { </span><span style="color: #001080">SliverClient</span><span style="color: #000000">, </span><span style="color: #001080">ParseConfigFile</span><span style="color: #000000"> } </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;sliver-script&#039;</span>
<span style="color: #000000">(</span><span style="color: #0000FF">async</span><span style="color: #000000"> </span><span style="color: #0000FF">function</span><span style="color: #000000">() {</span>
<span style="color: #000000"> </span><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">config</span><span style="color: #000000"> = </span><span style="color: #AF00DB">await</span><span style="color: #000000"> </span><span style="color: #795E26">ParseConfigFile</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;moloch_localhost.cfg&#039;</span><span style="color: #000000">)</span>
<span style="color: #000000"> </span><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">client</span><span style="color: #000000"> = </span><span style="color: #0000FF">new</span><span style="color: #000000"> </span><span style="color: #795E26">SliverClient</span><span style="color: #000000">(</span><span style="color: #001080">config</span><span style="color: #000000">);</span>
<span style="color: #000000"> </span><span style="color: #AF00DB">await</span><span style="color: #000000"> </span><span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">connect</span><span style="color: #000000">()</span>
<span style="color: #000000"> </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;Waiting for new sessions ...&#039;</span><span style="color: #000000">)</span>
<span style="color: #000000"> </span><span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #001080">session$</span><span style="color: #000000">.</span><span style="color: #795E26">subscribe</span><span style="color: #000000">(</span><span style="color: #0000FF">async</span><span style="color: #000000"> (</span><span style="color: #001080">event</span><span style="color: #000000">) </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
<span style="color: #000000"> </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">`New session #</span><span style="color: #0000FF">${</span><span style="color: #001080">event</span><span style="color: #000000FF">.</span><span style="color: #795E26">getSession</span><span style="color: #000000FF">().</span><span style="color: #795E26">getId</span><span style="color: #000000FF">()</span><span style="color: #0000FF">}</span><span style="color: #A31515">!`</span><span style="color: #000000">)</span>
<span style="color: #000000"> </span><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">session</span><span style="color: #000000"> = </span><span style="color: #AF00DB">await</span><span style="color: #000000"> </span><span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">interactWith</span><span style="color: #000000">(</span><span style="color: #001080">event</span><span style="color: #000000">.</span><span style="color: #795E26">getSession</span><span style="color: #000000">())</span>
<span style="color: #000000"> </span><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">ls</span><span style="color: #000000"> = </span><span style="color: #AF00DB">await</span><span style="color: #000000"> </span><span style="color: #001080">session</span><span style="color: #000000">.</span><span style="color: #795E26">ls</span><span style="color: #000000">()</span>
<span style="color: #000000"> </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">`Path: </span><span style="color: #0000FF">${</span><span style="color: #001080">ls</span><span style="color: #000000FF">.</span><span style="color: #795E26">getPath</span><span style="color: #000000FF">()</span><span style="color: #0000FF">}</span><span style="color: #A31515">`</span><span style="color: #000000">)</span>
<span style="color: #000000"> </span><span style="color: #001080">ls</span><span style="color: #000000">.</span><span style="color: #795E26">getFilesList</span><span style="color: #000000">().</span><span style="color: #795E26">forEach</span><span style="color: #000000">(</span><span style="color: #001080">file</span><span style="color: #000000"> </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
<span style="color: #000000"> </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">`Name: </span><span style="color: #0000FF">${</span><span style="color: #001080">file</span><span style="color: #000000FF">.</span><span style="color: #795E26">getName</span><span style="color: #000000FF">()</span><span style="color: #0000FF">}</span><span style="color: #A31515"> (Size: </span><span style="color: #0000FF">${</span><span style="color: #001080">file</span><span style="color: #000000FF">.</span><span style="color: #795E26">getSize</span><span style="color: #000000FF">()</span><span style="color: #0000FF">}</span><span style="color: #A31515">)`</span><span style="color: #000000">)</span>
<span style="color: #000000"> })</span>
<span style="color: #000000"> })</span>
<span style="color: #000000">})()</span>
</code></pre>
<a href="#javascript-example" id="javascript-example" style="color: inherit; text-decoration: none;">
<h3>JavaScript Example</h3>
</a>
<pre><code class="language-javascript"><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">sliver</span><span style="color: #000000"> = </span><span style="color: #795E26">require</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;sliver-script&#039;</span><span style="color: #000000">)</span>
<span style="color: #000000">(</span><span style="color: #0000FF">async</span><span style="color: #000000"> </span><span style="color: #0000FF">function</span><span style="color: #000000">() { </span>
<span style="color: #000000"> </span><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">config</span><span style="color: #000000"> = </span><span style="color: #AF00DB">await</span><span style="color: #000000"> </span><span style="color: #001080">sliver</span><span style="color: #000000">.</span><span style="color: #795E26">ParseConfigFile</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;./moloch_localhost.cfg&#039;</span><span style="color: #000000">)</span>
<span style="color: #000000"> </span><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">client</span><span style="color: #000000"> = </span><span style="color: #0000FF">new</span><span style="color: #000000"> </span><span style="color: #001080">sliver</span><span style="color: #000000">.</span><span style="color: #795E26">SliverClient</span><span style="color: #000000">(</span><span style="color: #001080">config</span><span style="color: #000000">)</span>
<span style="color: #000000"> </span><span style="color: #AF00DB">await</span><span style="color: #000000"> </span><span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">connect</span><span style="color: #000000">()</span>
<span style="color: #000000"> </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;Waiting for new sessions ...&#039;</span><span style="color: #000000">)</span>
<span style="color: #000000"> </span><span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #001080">session$</span><span style="color: #000000">.</span><span style="color: #795E26">subscribe</span><span style="color: #000000">(</span><span style="color: #0000FF">async</span><span style="color: #000000"> (</span><span style="color: #001080">event</span><span style="color: #000000">) </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
<span style="color: #000000"> </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">`New session #</span><span style="color: #0000FF">${</span><span style="color: #001080">event</span><span style="color: #000000FF">.</span><span style="color: #795E26">getSession</span><span style="color: #000000FF">().</span><span style="color: #795E26">getId</span><span style="color: #000000FF">()</span><span style="color: #0000FF">}</span><span style="color: #A31515">!`</span><span style="color: #000000">)</span>
<span style="color: #000000"> </span><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">session</span><span style="color: #000000"> = </span><span style="color: #AF00DB">await</span><span style="color: #000000"> </span><span style="color: #001080">client</span><span style="color: #000000">.</span><span style="color: #795E26">interactWith</span><span style="color: #000000">(</span><span style="color: #001080">event</span><span style="color: #000000">.</span><span style="color: #795E26">getSession</span><span style="color: #000000">())</span>
<span style="color: #000000"> </span><span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">ls</span><span style="color: #000000"> = </span><span style="color: #AF00DB">await</span><span style="color: #000000"> </span><span style="color: #001080">session</span><span style="color: #000000">.</span><span style="color: #795E26">ls</span><span style="color: #000000">()</span>
<span style="color: #000000"> </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">`Path: </span><span style="color: #0000FF">${</span><span style="color: #001080">ls</span><span style="color: #000000FF">.</span><span style="color: #795E26">getPath</span><span style="color: #000000FF">()</span><span style="color: #0000FF">}</span><span style="color: #A31515">`</span><span style="color: #000000">)</span>
<span style="color: #000000"> </span><span style="color: #001080">ls</span><span style="color: #000000">.</span><span style="color: #795E26">getFilesList</span><span style="color: #000000">().</span><span style="color: #795E26">forEach</span><span style="color: #000000">(</span><span style="color: #001080">file</span><span style="color: #000000"> </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
<span style="color: #000000"> </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">`Name: </span><span style="color: #0000FF">${</span><span style="color: #001080">file</span><span style="color: #000000FF">.</span><span style="color: #795E26">getName</span><span style="color: #000000FF">()</span><span style="color: #0000FF">}</span><span style="color: #A31515"> (Size: </span><span style="color: #0000FF">${</span><span style="color: #001080">file</span><span style="color: #000000FF">.</span><span style="color: #795E26">getSize</span><span style="color: #000000FF">()</span><span style="color: #0000FF">}</span><span style="color: #A31515">)`</span><span style="color: #000000">)</span>
<span style="color: #000000"> })</span>
<span style="color: #000000"> </span>
<span style="color: #000000"> })</span>
<span style="color: #000000">})()</span>
</code></pre>
</div>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="modules.html">Exports</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/client.html">client</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/config.html">config</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/events.html">events</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/index.html">index</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/pb_clientpb_client_pb.html">pb/clientpb/client_<wbr>pb</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/pb_commonpb_common_pb.html">pb/commonpb/common_<wbr>pb</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/pb_rpcpb_services_grpc_pb.html">pb/rpcpb/services_<wbr>grpc_<wbr>pb</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/pb_rpcpb_services_pb.html">pb/rpcpb/services_<wbr>pb</a>
</li>
<li class=" tsd-kind-module">
<a href="modules/pb_sliverpb_sliver_pb.html">pb/sliverpb/sliver_<wbr>pb</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-namespace"><span class="tsd-kind-icon">Namespace</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="assets/js/main.js"></script>
</body>
</html>