1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152

//! rings-node
//! ===============

//! [![rings-node](https://github.com/RingsNetwork/rings-node/actions/workflows/rings-node.yml/badge.svg)](https://github.com/RingsNetwork/rings-node/actions/workflows/rings-node.yml)
//! [![cargo](https://img.shields.io/crates/v/rings-node.svg)](https://crates.io/crates/rings-node)
//! [![docs](https://docs.rs/rings-node/badge.svg)](https://docs.rs/rings-node/0.1.0/rings_node/)

//! ### ICE Scheme:

//! 1. Peer A:
//! {
//!     create offer,
//!     set it as local description
//! } -> Send Offer to Peer B

//! 2. Peer B: {
//!   set receiveed offer as remote description
//!   create answer
//!   set it as local description
//!   Send Answer to Peer A
//! }

//! 3. Peer A: {
//!    Set receiveed answer as remote description
//! }

//! ### Keywords

//! * Candidate

//!     - A CANDIDATE is a transport address -- a combination of IP address and port for a particular transport protocol (with only UDP specified here).

//!     - If an agent is multihomed, it obtains a candidate from each IP address.

//!     - The agent uses STUN or TURN to obtain additional candidates. These come in two flavors: translated addresses on the public side of a NAT (SERVER REFLEXIVE CANDIDATES) and addresses on TURN servers (RELAYED CANDIDATES).

//! ```text
//!                  To Internet

//!                      |
//!                      |
//!                      |  /------------  Relayed
//!                  Y:y | /               Address
//!                  +--------+
//!                  |        |
//!                  |  TURN  |
//!                  | Server |
//!                  |        |
//!                  +--------+
//!                      |
//!                      |
//!                      | /------------  Server
//!               X1':x1'|/               Reflexive
//!                +------------+         Address
//!                |    NAT     |
//!                +------------+
//!                      |
//!                      | /------------  Local
//!                  X:x |/               Address
//!                  +--------+
//!                  |        |
//!                  | Agent  |
//!                  |        |
//!                  +--------+

//!                      Figure 2: Candidate Relationships

//! ```

//! * Channel

//! In the WebRTC framework, communication between the parties consists of media (for example, audio and video) and non-media data.

//! Non-media data is handled by using the Stream Control Transmission Protocol (SCTP) encapsulated in DTLS.

//! ```text
//!                                +----------+
//!                                |   SCTP   |
//!                                +----------+
//!                                |   DTLS   |
//!                                +----------+
//!                                | ICE/UDP  |
//!                                +----------+

//! ```

//! The encapsulation of SCTP over DTLS (see RFC8261) over ICE/UDP (see RFC8445) provides a NAT traversal solution together with confidentiality, source authentication, and integrity-protected transfers.

//!  The layering of protocols for WebRTC is shown as:

//! ```text
//!                                  +------+------+------+
//!                                  | DCEP | UTF-8|Binary|
//!                                  |      | Data | Data |
//!                                  +------+------+------+
//!                                  |        SCTP        |
//!                    +----------------------------------+
//!                    | STUN | SRTP |        DTLS        |
//!                    +----------------------------------+
//!                    |                ICE               |
//!                    +----------------------------------+
//!                    | UDP1 | UDP2 | UDP3 | ...         |
//!                    +----------------------------------+
//! ```

//! ### Architecture

//! ```text
//! +-----------------------------------------------------------------------------------------+
//! |                                         RINGS                                           |
//! +-----------------------------------------------------------------------------------------+
//! |   Encrypted IM / Secret Sharing Storage / Distributed Content / Secret Data Exchange    |
//! +-----------------------------------------------------------------------------------------+
//! |                  SSSS                  |  Perdson Commitment/zkPod/ Secret Sharing      |
//! +-----------------------------------------------------------------------------------------+
//! |                     |       dDNS       |                 Sigma Protocol                 |
//! +      K-V Storage    +------------------+------------------------------------------------+
//! |                     |  Peer LOOKUP     |          MSRP        |  End-to-End Encryption  |
//! +----------------------------------------+------------------------------------------------+
//! |            Peer-to-Peer Network        |                                                |
//! |----------------------------------------+               DID / Resource ID                |
//! |                 Chord DHT              |                                                |
//! +----------------------------------------+------------------------------------------------+
//! |                Trickle SDP             |        ElGamal        | Persistence Storage    |
//! +----------------------------------------+-----------------------+------------------------+
//! |            STUN  | SDP  | ICE          |  Crosschain Binding   | Smart Contract Binding |
//! +----------------------------------------+------------------------------------------------+
//! |             SCTP | UDP | TCP           |             Finate Pubkey Group                |
//! +----------------------------------------+------------------------------------------------+
//! |   WASM Runtime    |                    |                                                |
//! +-------------------|  Operation System  |                   ECDSA                        |
//! |     Browser       |                    |                                                |
//! +-----------------------------------------------------------------------------------------+
//! ```

#![feature(async_closure)]
pub mod backend;
#[cfg(feature = "browser")]
pub mod browser;
#[cfg(feature = "node")]
pub mod cli;
pub mod consts;
pub mod error;
pub mod jsonrpc;
pub mod jsonrpc_client;
pub mod logging;
pub mod prelude;
pub mod processor;
pub mod seed;
#[cfg(feature = "node")]
pub mod service;
pub mod util;