tari_comms 5.2.1

A peer-to-peer messaging system
Documentation 
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

// Copyright 2020, The Tari Project
//
// Redistribution and use in source and binary forms, with or without modification, are permitted provided that the
// following conditions are met:
//
// 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following
// disclaimer.
//
// 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the
// following disclaimer in the documentation and/or other materials provided with the distribution.
//
// 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote
// products derived from this software without specific prior written permission.
//
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
// SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
// WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE
// USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

//! # Tor Hidden Services and Control Port Client
//!
//! These modules interact with the Tor Control Port to create hidden services on-the-fly.
//!
//! The [client](crate::tor::TorControlPortClient) module contains the client library for the Tor Control Port. You can
//! find the spec here: <https://gitweb.torproject.org/torspec.git/tree/control-spec.txt>.
//!
//! The [hidden_service](crate::tor::HiddenService) module contains code which sets up hidden services required for
//! `tari_comms` to function over Tor.

mod control_client;
pub use control_client::{
    Authentication,
    KeyBlob,
    KeyType,
    PortMapping,
    PrivateKey,
    TorClientError,
    TorControlEvent,
    TorControlPortClient,
};

mod hidden_service;
pub use hidden_service::{
    HiddenService,
    HiddenServiceBuilder,
    HiddenServiceBuilderError,
    HiddenServiceController,
    HiddenServiceControllerError,
    HsFlags,
    TorIdentity,
};