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 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276
// Copyright 2016 MaidSafe.net limited. // // This SAFE Network Software is licensed to you under (1) the MaidSafe.net Commercial License, // version 1.0 or later, or (2) The General Public License (GPL), version 3, depending on which // licence you accepted on initial access to the Software (the "Licences"). // // By contributing code to the SAFE Network Software, or to this project generally, you agree to be // bound by the terms of the MaidSafe Contributor Agreement, version 1.1. This, along with the // Licenses can be found in the root directory of this project at LICENSE, COPYING and CONTRIBUTOR. // // Unless required by applicable law or agreed to in writing, the SAFE Network Software distributed // under the GPL Licence is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY // KIND, either express or implied. // // Please review the Licences for the specific language governing permissions and limitations // relating to use of the SAFE Network Software. use data::{EntryAction, ImmutableData, MutableData, PermissionSet, User}; use rust_sodium::crypto::sign; use std::collections::{BTreeMap, BTreeSet}; use types::MessageId as MsgId; use xor_name::XorName; /// Request message types #[derive(Clone, Debug, Eq, Hash, Ord, PartialEq, PartialOrd, Serialize, Deserialize)] pub enum Request { /// Represents a refresh message sent between vaults. Vec<u8> is the message content. Refresh(Vec<u8>, MsgId), /// Gets MAID account information. GetAccountInfo(MsgId), // --- ImmutableData --- // ========================== /// Puts ImmutableData to the network. PutIData { /// ImmutableData to be stored data: ImmutableData, /// Unique message identifier msg_id: MsgId, }, /// Fetches ImmutableData from the network by the given name. GetIData { /// Network identifier of ImmutableData name: XorName, /// Unique message identifier msg_id: MsgId, }, // --- MutableData --- /// Fetches whole MutableData from the network. /// Note: responses to this request are unlikely to accumulate during churn. GetMData { /// Network identifier of MutableData name: XorName, /// Type tag tag: u64, /// Unique message identifier msg_id: MsgId, }, // ========================== /// Creates a new MutableData in the network. PutMData { /// MutableData to be stored data: MutableData, /// Unique message identifier msg_id: MsgId, /// Requester public key requester: sign::PublicKey, }, /// Fetches a latest version number. GetMDataVersion { /// Network identifier of MutableData name: XorName, /// Type tag tag: u64, /// Unique message identifier msg_id: MsgId, }, /// Fetches the shell (everthing except the entries). GetMDataShell { /// Network identifier of MutableData name: XorName, /// Type tag tag: u64, /// Unique message identifier msg_id: MsgId, }, // Data Actions /// Fetches a list of entries (keys + values). /// Note: responses to this request are unlikely to accumulate during churn. ListMDataEntries { /// Network identifier of MutableData name: XorName, /// Type tag tag: u64, /// Unique message identifier msg_id: MsgId, }, /// Fetches a list of keys in MutableData. /// Note: responses to this request are unlikely to accumulate during churn. ListMDataKeys { /// Network identifier of MutableData name: XorName, /// Type tag tag: u64, /// Unique message identifier msg_id: MsgId, }, /// Fetches a list of values in MutableData. /// Note: responses to this request are unlikely to accumulate during churn. ListMDataValues { /// Network identifier of MutableData name: XorName, /// Type tag tag: u64, /// Unique message identifier msg_id: MsgId, }, /// Fetches a single value from MutableData GetMDataValue { /// Network identifier of MutableData name: XorName, /// Type tag tag: u64, /// Key of an entry to be fetched key: Vec<u8>, /// Unique message identifier msg_id: MsgId, }, /// Updates MutableData entries in bulk. MutateMDataEntries { /// Network identifier of MutableData name: XorName, /// Type tag tag: u64, /// A list of mutations (inserts, updates, or deletes) to be performed /// on MutableData in bulk. actions: BTreeMap<Vec<u8>, EntryAction>, /// Unique message identifier msg_id: MsgId, /// Requester public key requester: sign::PublicKey, }, // Permission Actions /// Fetches a complete list of permissions. ListMDataPermissions { /// Network identifier of MutableData name: XorName, /// Type tag tag: u64, /// Unique message identifier msg_id: MsgId, }, /// Fetches a list of permissions for a particular User. ListMDataUserPermissions { /// Network identifier of MutableData name: XorName, /// Type tag tag: u64, /// A user identifier used to fetch permissions user: User, /// Unique message identifier msg_id: MsgId, }, /// Updates or inserts a list of permissions for a particular User in the given MutableData. SetMDataUserPermissions { /// Network identifier of MutableData name: XorName, /// Type tag tag: u64, /// A user identifier used to set permissions user: User, /// Permissions to be set for a user permissions: PermissionSet, /// Incremented version of MutableData version: u64, /// Unique message identifier msg_id: MsgId, /// Requester public key requester: sign::PublicKey, }, /// Deletes a list of permissions for a particular User in the given MutableData. DelMDataUserPermissions { /// Network identifier of MutableData name: XorName, /// Type tag tag: u64, /// A user identifier used to delete permissions user: User, /// Incremented version of MutableData version: u64, /// Unique message identifier msg_id: MsgId, /// Requester public key requester: sign::PublicKey, }, // Ownership Actions /// Changes an owner of the given MutableData. Only the current owner can perform this action. ChangeMDataOwner { /// Network identifier of MutableData name: XorName, /// Type tag tag: u64, /// A list of new owners new_owners: BTreeSet<sign::PublicKey>, /// Incremented version of MutableData version: u64, /// Unique message identifier msg_id: MsgId, }, // --- Client (Owner) to MM --- // ========================== /// Lists authorised keys and version stored in MaidManager. ListAuthKeysAndVersion(MsgId), /// Inserts an autorised key (for an app, user, etc.) to MaidManager. InsAuthKey { /// Authorised key to be inserted key: sign::PublicKey, /// Incremented version version: u64, /// Unique message identifier msg_id: MsgId, }, /// Deletes an authorised key from MaidManager. DelAuthKey { /// Authorised key to be deleted key: sign::PublicKey, /// Incremented version version: u64, /// Unique message identifier msg_id: MsgId, }, } impl Request { /// Message ID getter. pub fn message_id(&self) -> &MsgId { use Request::*; match *self { Refresh(_, ref msg_id) | GetAccountInfo(ref msg_id) | PutIData { ref msg_id, .. } | GetIData { ref msg_id, .. } | GetMData { ref msg_id, .. } | PutMData { ref msg_id, .. } | GetMDataVersion { ref msg_id, .. } | GetMDataShell { ref msg_id, .. } | ListMDataEntries { ref msg_id, .. } | ListMDataKeys { ref msg_id, .. } | ListMDataValues { ref msg_id, .. } | GetMDataValue { ref msg_id, .. } | MutateMDataEntries { ref msg_id, .. } | ListMDataPermissions { ref msg_id, .. } | ListMDataUserPermissions { ref msg_id, .. } | SetMDataUserPermissions { ref msg_id, .. } | DelMDataUserPermissions { ref msg_id, .. } | ChangeMDataOwner { ref msg_id, .. } | ListAuthKeysAndVersion(ref msg_id) | InsAuthKey { ref msg_id, .. } | DelAuthKey { ref msg_id, .. } => msg_id, } } /// Is the response corresponding to this request cacheable? pub fn is_cacheable(&self) -> bool { if let Request::GetIData { .. } = *self { true } else { false } } }