doc: More cross-references; Expand overview slightly

Change-Id: Ic290627ec2512a2b59cb9d81704b9cec4d14ccf4
This commit is contained in:
Harald Welte 2020-03-04 15:31:58 +01:00
parent ddbe43a366
commit 5103ea0a43
5 changed files with 33 additions and 0 deletions

View File

@ -50,6 +50,8 @@ The tasks of `osmo-remsim-server` include:
`osmo-remsim-bankd` instances `osmo-remsim-bankd` instances
* providing a RESTful JSON interface for external application logic to * providing a RESTful JSON interface for external application logic to
For more information, please see <<remsim-server>>.
=== osmo-remsim-client === osmo-remsim-client
The `osmo-remsim-client` software is co-located next to the _user of the card_ 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 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. instances of `osmo-remsim-client` on the same system, one for each phone/modem.
For more information, please see <<remsim-client>>.
=== osmo-remsim-bankd === osmo-remsim-bankd
The `osmo-remsim-bankd` software is co-located next to a bank of SIM cards. 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` * running a TCP server where TCP connections from `osmo-remsim-client`
instances are accepted and handled. instances are accepted and handled.
For more information, please see <<remsim-bankd>>.
=== 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 <<rspro>>.
=== 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 <<rsres>>.
=== 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.

View File

@ -1,3 +1,4 @@
[[remsim-bankd]]
== osmo-remsim-bankd == osmo-remsim-bankd
The `osmo-remsim-bankd` (SIM Bank Daemon) manages one given SIM bank. The `osmo-remsim-bankd` (SIM Bank Daemon) manages one given SIM bank.

View File

@ -1,3 +1,4 @@
[[remism-client]]
== osmo-remsim-client-st2 == osmo-remsim-client-st2
The client interfaces with GSM phones / modems via dedicated "Card The client interfaces with GSM phones / modems via dedicated "Card

View File

@ -1,3 +1,4 @@
[[remsim-server]]
== osmo-remsim-server == osmo-remsim-server
=== Running === Running
@ -18,6 +19,7 @@ in future versions.
verbosity is not yet configurable. However, as the libosmocore logging verbosity is not yet configurable. However, as the libosmocore logging
framework is used, extending this is an easy modification. framework is used, extending this is an easy modification.
[[rsres]]
=== RESTful/JSON Web API === RESTful/JSON Web API
`osmo-remsim-server` provides a RESTful/JSON WEB API for application logic `osmo-remsim-server` provides a RESTful/JSON WEB API for application logic

View File

@ -1,3 +1,4 @@
[[rspro]]
== RSPRO == RSPRO
*RSPRO*, the *Remote SIM Protocol*, is an osmo-remsim specific, *RSPRO*, the *Remote SIM Protocol*, is an osmo-remsim specific,