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
153
154
155
156
157
158
159
160
161
162
163
164

// Copyright 2021 MaidSafe.net limited.
//
// This SAFE Network Software is licensed to you under the MIT license <LICENSE-MIT
// https://opensource.org/licenses/MIT> or the Modified BSD license <LICENSE-BSD
// https://opensource.org/licenses/BSD-3-Clause>, at your option. This file may not be copied,
// modified, or distributed except according to those terms. Please review the Licences for the
// specific language governing permissions and limitations relating to use of the SAFE Network
// Software.

pub mod client;
mod errors;
pub mod location;
mod msg_id;
#[cfg(not(feature = "client-only"))]
pub mod node;
pub mod sap;
pub mod section_info;
pub mod serialisation;

pub use self::{
    errors::{Error, Result},
    location::{Aggregation, DstLocation, EndUser, Itinerary, SrcLocation},
    msg_id::{MessageId, MESSAGE_ID_LEN},
    sap::SectionAuthorityProvider,
    serialisation::WireMsg,
};
use bytes::Bytes;
use serde::{Deserialize, Serialize};
use threshold_crypto::PublicKey;
use xor_name::XorName;

/// Type of message.
/// Note this is part of this crate's public API but this enum is
/// never serialised or even part of the message that is sent over the wire.
#[derive(PartialEq, Debug, Clone)]
#[allow(clippy::large_enum_variant)]
pub enum MessageType {
    SectionInfo {
        msg: section_info::SectionInfoMsg,
        dest_info: DestInfo,
    },
    Client {
        msg: client::ClientMsg,
        dest_info: DestInfo,
    },
    #[cfg(not(feature = "client-only"))]
    Routing {
        msg: node::RoutingMsg,
        dest_info: DestInfo,
    },
    #[cfg(not(feature = "client-only"))]
    Node {
        msg: node::NodeMsg,
        dest_info: DestInfo,
        src_section_pk: Option<PublicKey>,
    },
}

/// This is information kept by 'MessageType' so it can be properly
/// serialised with a valid 'WireMsgHeader'
#[derive(PartialEq, Debug, Clone, Serialize, Deserialize, Ord, PartialOrd, Eq)]
pub struct DestInfo {
    pub dest: XorName,
    pub dest_section_pk: PublicKey,
}

impl MessageType {
    /// serialize the message type into bytes ready to be sent over the wire.
    pub fn serialize(&self) -> Result<Bytes> {
        match self {
            Self::SectionInfo { msg, dest_info } => {
                WireMsg::serialize_section_info_msg(msg, dest_info.dest, dest_info.dest_section_pk)
            }
            Self::Client { msg, dest_info } => {
                WireMsg::serialize_client_msg(msg, dest_info.dest, dest_info.dest_section_pk)
            }
            #[cfg(not(feature = "client-only"))]
            Self::Routing { msg, dest_info } => {
                WireMsg::serialize_routing_msg(msg, dest_info.dest, dest_info.dest_section_pk)
            }
            #[cfg(not(feature = "client-only"))]
            Self::Node {
                msg,
                dest_info,
                src_section_pk,
            } => WireMsg::serialize_node_msg(
                msg,
                dest_info.dest,
                dest_info.dest_section_pk,
                *src_section_pk,
            ),
        }
    }

    pub fn to_wire_msg(&self) -> Result<WireMsg> {
        match self {
            Self::SectionInfo { msg, dest_info } => {
                WireMsg::new_section_info_msg(msg, dest_info.dest, dest_info.dest_section_pk)
            }
            Self::Client { msg, dest_info } => {
                WireMsg::new_client_msg(msg, dest_info.dest, dest_info.dest_section_pk)
            }
            #[cfg(not(feature = "client-only"))]
            Self::Routing { msg, dest_info } => {
                WireMsg::new_routing_msg(msg, dest_info.dest, dest_info.dest_section_pk)
            }
            #[cfg(not(feature = "client-only"))]
            Self::Node {
                msg,
                dest_info,
                src_section_pk,
            } => WireMsg::new_node_msg(
                msg,
                dest_info.dest,
                dest_info.dest_section_pk,
                *src_section_pk,
            ),
        }
    }

    pub fn update_dest_info(&mut self, dest_pk: Option<PublicKey>, dest: Option<XorName>) {
        #[cfg(not(feature = "client-only"))]
        match self {
            Self::Client { dest_info, .. } | Self::SectionInfo { dest_info, .. } => {
                if let Some(dest) = dest {
                    dest_info.dest = dest
                }
                if let Some(dest_pk) = dest_pk {
                    dest_info.dest_section_pk = dest_pk
                }
            }
            #[cfg(not(feature = "client-only"))]
            Self::Routing { dest_info, .. } => {
                if let Some(dest) = dest {
                    dest_info.dest = dest
                }
                if let Some(dest_pk) = dest_pk {
                    dest_info.dest_section_pk = dest_pk
                }
            }
            #[cfg(not(feature = "client-only"))]
            Self::Node { dest_info, .. } => {
                if let Some(dest) = dest {
                    dest_info.dest = dest
                }
                if let Some(dest_pk) = dest_pk {
                    dest_info.dest_section_pk = dest_pk
                }
            }
        }

        #[cfg(feature = "client-only")]
        match self {
            Self::Client { dest_info, .. } | Self::SectionInfo { dest_info, .. } => {
                if let Some(dest) = dest {
                    dest_info.dest = dest
                }
                if let Some(dest_pk) = dest_pk {
                    dest_info.dest_section_pk = dest_pk
                }
            }
        }
    }
}