From 5103ea0a43c36aae00b89a337c3eb0979a0c5200 Mon Sep 17 00:00:00 2001 From: Harald Welte Date: Wed, 4 Mar 2020 15:31:58 +0100 Subject: [PATCH] doc: More cross-references; Expand overview slightly Change-Id: Ic290627ec2512a2b59cb9d81704b9cec4d14ccf4 --- doc/manuals/chapters/overview.adoc | 28 +++++++++++++++++++++++++ doc/manuals/chapters/remsim-bankd.adoc | 1 + doc/manuals/chapters/remsim-client.adoc | 1 + doc/manuals/chapters/remsim-server.adoc | 2 ++ doc/manuals/chapters/rspro.adoc | 1 + 5 files changed, 33 insertions(+) diff --git a/doc/manuals/chapters/overview.adoc b/doc/manuals/chapters/overview.adoc index 2798b2f..d39a4f6 100644 --- a/doc/manuals/chapters/overview.adoc +++ b/doc/manuals/chapters/overview.adoc @@ -50,6 +50,8 @@ The tasks of `osmo-remsim-server` include: `osmo-remsim-bankd` instances * providing a RESTful JSON interface for external application logic to +For more information, please see <>. + === osmo-remsim-client The `osmo-remsim-client` software is co-located next to the _user of the card_ @@ -77,6 +79,8 @@ The tasks of `osmo-remsim-client` include: multiple phones/modems at one location, you can simply run multiple instances of `osmo-remsim-client` on the same system, one for each phone/modem. +For more information, please see <>. + === osmo-remsim-bankd The `osmo-remsim-bankd` software is co-located next to a bank of SIM cards. @@ -90,4 +94,28 @@ The tasks of `osmo-remsim-bankd` include: * running a TCP server where TCP connections from `osmo-remsim-client` instances are accepted and handled. +For more information, please see <>. +=== RSPRO + +RSPRO is the *R*emote *S*IM *PRO*tocol. It is a binary protocol +specified in ASN.1 which is spoken on any of the internal connections +between `osmo-remsim-client`, `osmo-remsim-bankd` and +`osmo-remsim-server`. + +You can find more information about RSPRO in <>. + +=== RSRES + +RSRES is the *R*emote *S*IM *RES*T protocol. It is an interface offered +by `osmo-remsim-server` towards external back-end application logic of +the operator of an osmo-remsim network. + +You can find more information about RSRES in <>. + +=== Security + +WARNING: RSPRO, RSRES and their underlying transport layer both operate in plain-text, +There is no authentication or encryption built into the protocol. It is +assumed that the protocols are only spoken over trusted, controlled IP +networks, such as inside a VPN or a closed / private corporate network. diff --git a/doc/manuals/chapters/remsim-bankd.adoc b/doc/manuals/chapters/remsim-bankd.adoc index a3a1921..e76afd5 100644 --- a/doc/manuals/chapters/remsim-bankd.adoc +++ b/doc/manuals/chapters/remsim-bankd.adoc @@ -1,3 +1,4 @@ +[[remsim-bankd]] == osmo-remsim-bankd The `osmo-remsim-bankd` (SIM Bank Daemon) manages one given SIM bank. diff --git a/doc/manuals/chapters/remsim-client.adoc b/doc/manuals/chapters/remsim-client.adoc index e2c43d7..5e17ec0 100644 --- a/doc/manuals/chapters/remsim-client.adoc +++ b/doc/manuals/chapters/remsim-client.adoc @@ -1,3 +1,4 @@ +[[remism-client]] == osmo-remsim-client-st2 The client interfaces with GSM phones / modems via dedicated "Card diff --git a/doc/manuals/chapters/remsim-server.adoc b/doc/manuals/chapters/remsim-server.adoc index 5215b54..304a7f3 100644 --- a/doc/manuals/chapters/remsim-server.adoc +++ b/doc/manuals/chapters/remsim-server.adoc @@ -1,3 +1,4 @@ +[[remsim-server]] == osmo-remsim-server === Running @@ -18,6 +19,7 @@ in future versions. verbosity is not yet configurable. However, as the libosmocore logging framework is used, extending this is an easy modification. +[[rsres]] === RESTful/JSON Web API `osmo-remsim-server` provides a RESTful/JSON WEB API for application logic diff --git a/doc/manuals/chapters/rspro.adoc b/doc/manuals/chapters/rspro.adoc index ce39b9d..059182b 100644 --- a/doc/manuals/chapters/rspro.adoc +++ b/doc/manuals/chapters/rspro.adoc @@ -1,3 +1,4 @@ +[[rspro]] == RSPRO *RSPRO*, the *Remote SIM Protocol*, is an osmo-remsim specific,