<p>laforge <strong>submitted</strong> this change.</p><p><a href="https://gerrit.osmocom.org/c/osmo-remsim/+/17346">View Change</a></p><div style="white-space:pre-wrap">Approvals:
  laforge: Looks good to me, approved
  Jenkins Builder: Verified

</div><pre style="font-family: monospace,monospace; white-space: pre-wrap;">doc: More cross-references; Expand overview slightly<br><br>Change-Id: Ic290627ec2512a2b59cb9d81704b9cec4d14ccf4<br>---<br>M doc/manuals/chapters/overview.adoc<br>M doc/manuals/chapters/remsim-bankd.adoc<br>M doc/manuals/chapters/remsim-client.adoc<br>M doc/manuals/chapters/remsim-server.adoc<br>M doc/manuals/chapters/rspro.adoc<br>5 files changed, 33 insertions(+), 0 deletions(-)<br><br></pre><pre style="font-family: monospace,monospace; white-space: pre-wrap;"><span>diff --git a/doc/manuals/chapters/overview.adoc b/doc/manuals/chapters/overview.adoc</span><br><span>index 2798b2f..d39a4f6 100644</span><br><span>--- a/doc/manuals/chapters/overview.adoc</span><br><span>+++ b/doc/manuals/chapters/overview.adoc</span><br><span>@@ -50,6 +50,8 @@</span><br><span>   `osmo-remsim-bankd` instances</span><br><span> * providing a RESTful JSON interface for external application logic to</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+For more information, please see <<remsim-server>>.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> === osmo-remsim-client</span><br><span> </span><br><span> The `osmo-remsim-client` software is co-located next to the _user of the card_</span><br><span>@@ -77,6 +79,8 @@</span><br><span> multiple phones/modems at one location, you can simply run multiple</span><br><span> instances of `osmo-remsim-client` on the same system, one for each phone/modem.</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+For more information, please see <<remsim-client>>.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span> === osmo-remsim-bankd</span><br><span> </span><br><span> The `osmo-remsim-bankd` software is co-located next to a bank of SIM cards.</span><br><span>@@ -90,4 +94,28 @@</span><br><span> * running a TCP server where TCP connections from `osmo-remsim-client`</span><br><span>   instances are accepted and handled.</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+For more information, please see <<remsim-bankd>>.</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+=== RSPRO</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+RSPRO is the *R*emote *S*IM *PRO*tocol.  It is a binary protocol</span><br><span style="color: hsl(120, 100%, 40%);">+specified in ASN.1 which is spoken on any of the internal connections</span><br><span style="color: hsl(120, 100%, 40%);">+between `osmo-remsim-client`, `osmo-remsim-bankd` and</span><br><span style="color: hsl(120, 100%, 40%);">+`osmo-remsim-server`.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+You can find more information about RSPRO in <<rspro>>.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+=== RSRES</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+RSRES is the *R*emote *S*IM *RES*T protocol.  It is an interface offered</span><br><span style="color: hsl(120, 100%, 40%);">+by `osmo-remsim-server` towards external back-end application logic of</span><br><span style="color: hsl(120, 100%, 40%);">+the operator of an osmo-remsim network.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+You can find more information about RSRES in <<rsres>>.</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+=== Security</span><br><span style="color: hsl(120, 100%, 40%);">+</span><br><span style="color: hsl(120, 100%, 40%);">+WARNING: RSPRO, RSRES and their underlying transport layer both operate in plain-text,</span><br><span style="color: hsl(120, 100%, 40%);">+There is no authentication or encryption built into the protocol.  It is</span><br><span style="color: hsl(120, 100%, 40%);">+assumed that the protocols are only spoken over trusted, controlled IP</span><br><span style="color: hsl(120, 100%, 40%);">+networks, such as inside a VPN or a closed / private corporate network.</span><br><span>diff --git a/doc/manuals/chapters/remsim-bankd.adoc b/doc/manuals/chapters/remsim-bankd.adoc</span><br><span>index a3a1921..e76afd5 100644</span><br><span>--- a/doc/manuals/chapters/remsim-bankd.adoc</span><br><span>+++ b/doc/manuals/chapters/remsim-bankd.adoc</span><br><span>@@ -1,3 +1,4 @@</span><br><span style="color: hsl(120, 100%, 40%);">+[[remsim-bankd]]</span><br><span> == osmo-remsim-bankd</span><br><span> </span><br><span> The `osmo-remsim-bankd` (SIM Bank Daemon) manages one given SIM bank.</span><br><span>diff --git a/doc/manuals/chapters/remsim-client.adoc b/doc/manuals/chapters/remsim-client.adoc</span><br><span>index e2c43d7..5e17ec0 100644</span><br><span>--- a/doc/manuals/chapters/remsim-client.adoc</span><br><span>+++ b/doc/manuals/chapters/remsim-client.adoc</span><br><span>@@ -1,3 +1,4 @@</span><br><span style="color: hsl(120, 100%, 40%);">+[[remism-client]]</span><br><span> == osmo-remsim-client-st2</span><br><span> </span><br><span> The client interfaces with GSM phones / modems via dedicated "Card</span><br><span>diff --git a/doc/manuals/chapters/remsim-server.adoc b/doc/manuals/chapters/remsim-server.adoc</span><br><span>index 5215b54..304a7f3 100644</span><br><span>--- a/doc/manuals/chapters/remsim-server.adoc</span><br><span>+++ b/doc/manuals/chapters/remsim-server.adoc</span><br><span>@@ -1,3 +1,4 @@</span><br><span style="color: hsl(120, 100%, 40%);">+[[remsim-server]]</span><br><span> == osmo-remsim-server</span><br><span> </span><br><span> === Running</span><br><span>@@ -18,6 +19,7 @@</span><br><span> verbosity is not yet configurable.  However, as the libosmocore logging</span><br><span> framework is used, extending this is an easy modification.</span><br><span> </span><br><span style="color: hsl(120, 100%, 40%);">+[[rsres]]</span><br><span> === RESTful/JSON Web API</span><br><span> </span><br><span> `osmo-remsim-server` provides a RESTful/JSON WEB API for application logic</span><br><span>diff --git a/doc/manuals/chapters/rspro.adoc b/doc/manuals/chapters/rspro.adoc</span><br><span>index ce39b9d..059182b 100644</span><br><span>--- a/doc/manuals/chapters/rspro.adoc</span><br><span>+++ b/doc/manuals/chapters/rspro.adoc</span><br><span>@@ -1,3 +1,4 @@</span><br><span style="color: hsl(120, 100%, 40%);">+[[rspro]]</span><br><span> == RSPRO</span><br><span> </span><br><span> *RSPRO*, the *Remote SIM Protocol*, is an osmo-remsim specific,</span><br><span></span><br></pre><p>To view, visit <a href="https://gerrit.osmocom.org/c/osmo-remsim/+/17346">change 17346</a>. To unsubscribe, or for help writing mail filters, visit <a href="https://gerrit.osmocom.org/settings">settings</a>.</p><div itemscope itemtype="http://schema.org/EmailMessage"><div itemscope itemprop="action" itemtype="http://schema.org/ViewAction"><link itemprop="url" href="https://gerrit.osmocom.org/c/osmo-remsim/+/17346"/><meta itemprop="name" content="View Change"/></div></div>

<div style="display:none"> Gerrit-Project: osmo-remsim </div>
<div style="display:none"> Gerrit-Branch: master </div>
<div style="display:none"> Gerrit-Change-Id: Ic290627ec2512a2b59cb9d81704b9cec4d14ccf4 </div>
<div style="display:none"> Gerrit-Change-Number: 17346 </div>
<div style="display:none"> Gerrit-PatchSet: 2 </div>
<div style="display:none"> Gerrit-Owner: laforge <laforge@osmocom.org> </div>
<div style="display:none"> Gerrit-Reviewer: Jenkins Builder </div>
<div style="display:none"> Gerrit-Reviewer: laforge <laforge@osmocom.org> </div>
<div style="display:none"> Gerrit-MessageType: merged </div>