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 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555
// Copyright 2023 MaidSafe.net limited.
//
// This SAFE Network Software is licensed to you under The General Public License (GPL), version 3.
// 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 crate::{
ipc::{req::AuthReq, resp::AuthGranted},
Result, SafeAuthReq,
};
use sn_client::api::Client;
use sn_interface::types::{Keypair, RegisterAddress};
use hmac::Hmac;
use rand_07::{rngs::StdRng, SeedableRng};
use sha3::Sha3_256;
use std::{
collections::HashSet,
net::SocketAddr,
path::{Path, PathBuf},
sync::Arc,
};
use tiny_keccak::{Hasher, Sha3};
use xor_name::XorName;
const SHA3_512_HASH_LEN: usize = 64;
// Type tag value used for the Map which holds the Safe's content on the network.
#[allow(dead_code)]
const SAFE_TYPE_TAG: u64 = 1_300;
/// Derive Passphrase, Password and Salt (in order).
pub fn derive_secrets(acc_passphrase: &[u8], acc_password: &[u8]) -> (Vec<u8>, Vec<u8>, Vec<u8>) {
let mut passphrase_hasher = Sha3::v512();
let mut passphrase_hash = [0; SHA3_512_HASH_LEN];
passphrase_hasher.update(acc_passphrase);
passphrase_hasher.finalize(&mut passphrase_hash);
let passphrase = passphrase_hash.to_vec();
let mut salt_hasher = Sha3::v512();
let mut salt_hash = [0; SHA3_512_HASH_LEN];
let salt_bytes = &passphrase_hash[SHA3_512_HASH_LEN / 2..];
salt_hasher.update(salt_bytes);
salt_hasher.finalize(&mut salt_hash);
let salt = salt_hash.to_vec();
let mut password_hasher = Sha3::v512();
let mut password_hash = [0; SHA3_512_HASH_LEN];
password_hasher.update(acc_password);
password_hasher.finalize(&mut password_hash);
let password = password_hash.to_vec();
(passphrase, password, salt)
}
/// Create a new Ed25519 keypair from seed
fn create_ed25519_keypair_from_seed(seeder: &[u8]) -> Keypair {
let mut hasher = Sha3::v256();
let mut seed = [0; 32];
hasher.update(seeder);
hasher.finalize(&mut seed);
let mut rng = StdRng::from_seed(seed);
let keypair = ed25519_dalek::Keypair::generate(&mut rng);
Keypair::Ed25519(Arc::new(keypair))
}
/// Perform all derivations and seeding to deterministically obtain location and Keypair from input
pub fn derive_location_and_keypair(passphrase: &str, password: &str) -> Result<(XorName, Keypair)> {
let (passphrase, password, salt) = derive_secrets(passphrase.as_bytes(), password.as_bytes());
let map_data_location = generate_network_address(&passphrase, &salt)?;
let mut seed = password;
seed.extend(salt.iter());
let keypair = create_ed25519_keypair_from_seed(&seed);
Ok((map_data_location, keypair))
}
/// Generates User's Identity for the network using supplied credentials in
/// a deterministic way. This is similar to the username in various places.
pub fn generate_network_address(passphrase: &[u8], salt: &[u8]) -> Result<XorName> {
let mut id = XorName::default();
const ITERATIONS: u32 = 10_000u32;
pbkdf2::pbkdf2::<Hmac<Sha3_256>>(passphrase, salt, ITERATIONS, &mut id.0[..]);
Ok(id)
}
// Authenticator API
#[derive(Default)]
pub struct SafeAuthenticator {
// We keep the client instantiated with the derived keypair, along
// with the address of the Map which holds its Safe on the network.
#[allow(dead_code)]
safe: Option<(Client, RegisterAddress)>,
#[allow(dead_code)]
config_path: Option<PathBuf>,
#[allow(dead_code)]
bootstrap_contacts: Option<HashSet<SocketAddr>>,
}
impl SafeAuthenticator {
pub fn new(
_config_dir_path: Option<&Path>,
_bootstrap_contacts: Option<HashSet<SocketAddr>>,
) -> Self {
unimplemented!("Authenticator hasn't yet been updated to work with the new Safe Network");
// let config_path = config_dir_path.map(|p| p.to_path_buf());
// Self {
// safe: None,
// config_path,
// bootstrap_contacts,
// }
}
/// # Create Safe
/// Creates a new Safe on the Network.
/// Returns an error if a Safe exists or if there was some
/// problem during the creation process.
/// If the Safe is successfully created it keeps the logged in session (discarding a previous session)
///
/// Note: This does _not_ perform any strength checks on the
/// strings used to create the Safe.
///
/// ## Example
/// ```ignore
/// use sn_api::SafeAuthenticator;
/// let mut safe_auth = SafeAuthenticator::new(None);
/// # fn random_str() -> String { (0..4).map(|_| rand::random::<char>()).collect() }
/// let my_secret = "mysecretstring";
/// let my_password = "mypassword";
/// # let my_secret = &(random_str());
/// # let my_password = &(random_str());
/// # let sk = "83c055c5efdc483bd967adba5c1769daee0a17bc5fa2b6e129cd6b596c217617";
/// # async_std::task::block_on(async {
/// let acc_created = safe_auth.create(sk, my_secret, my_password).await;
/// match acc_created {
/// Ok(()) => assert!(true), // This should pass
/// Err(_) => assert!(false)
/// }
/// # });
///```
///
/// ## Error Example
/// If a Safe with same passphrase already exists,
/// the function will return an error:
/// ```ignore
/// use sn_api::{SafeAuthenticator, Error};
/// let mut safe_auth = SafeAuthenticator::new(None);
/// # fn random_str() -> String { (0..4).map(|_| rand::random::<char>()).collect() }
/// /// Using an already existing Safe's passphrase and password:
/// let my_secret = "mysecretstring";
/// let my_password = "mypassword";
/// # let my_secret = &(random_str());
/// # let my_password = &(random_str());
/// # let sk = "83c055c5efdc483bd967adba5c1769daee0a17bc5fa2b6e129cd6b596c217617";
/// # async_std::task::block_on(async {
/// # safe_auth.create(sk, my_secret, my_password).await.unwrap();
/// let acc_not_created = safe_auth.create(sk, my_secret, my_password).await;
/// match acc_not_created {
/// Ok(_) => assert!(false), // This should not pass
/// Err(Error::AuthError(message)) => {
/// assert!(message.contains("Failed to create a Safe"));
/// }
/// Err(_) => assert!(false), // This should not pass
/// }
/// # });
///```
#[allow(clippy::unused_async)]
pub async fn create(&mut self, _passphrase: &str, _password: &str) -> Result<()> {
unimplemented!("Authenticator hasn't yet been updated to work with the new Safe Network");
// debug!("Attempting to create a Safe from provided passphrase and password.");
// let (location, keypair) = derive_location_and_keypair(passphrase, password)?;
// let data_owner = keypair.public_key();
// debug!("Creating Safe to be owned by PublicKey: {:?}", data_owner);
// let client = Client::new(
// Some(keypair),
// self.config_path.as_deref(),
// self.bootstrap_contacts.clone(),
// DEFAULT_OPERATION_TIMEOUT,
// )
// .await?;
// trace!("Client instantiated properly!");
// // Create Map data to store the list of keypairs generated for
// // each of the user's applications.
// let permission_set = MapPermissionSet::new()
// .allow(MapAction::Read)
// .allow(MapAction::Insert)
// .allow(MapAction::Update)
// .allow(MapAction::Delete)
// .allow(MapAction::ManagePermissions);
// let mut permission_map = BTreeMap::new();
// permission_map.insert(data_owner, permission_set);
// // TODO: encrypt content
// let map_address = client
// .store_seq_map(
// location,
// SAFE_TYPE_TAG,
// data_owner,
// None,
// Some(permission_map),
// )
// .await
// .map_err(|err| {
// Error::AuthenticatorError(format!("Failed to store Safe on a Map: {}", err))
// })?;
// debug!("Map stored successfully for new Safe!");
// self.safe = Some((client, map_address));
// Ok(())
}
/// # Unlock
///
/// Unlock a Safe already created on the network using the `Authenticator` daemon.
///
/// ## Example
/// ```ignore
/// use sn_api::SafeAuthenticator;
/// let mut safe_auth = SafeAuthenticator::new(None);
/// # fn random_str() -> String { (0..4).map(|_| rand::random::<char>()).collect() }
/// /// Using an already existing Safe's passphrase and password:
/// let my_secret = "mysecretstring";
/// let my_password = "mypassword";
/// # let my_secret = &(random_str());
/// # let my_password = &(random_str());
/// # let sk = "83c055c5efdc483bd967adba5c1769daee0a17bc5fa2b6e129cd6b596c217617";
/// # async_std::task::block_on(async {
/// # safe_auth.create(sk, my_secret, my_password).await.unwrap();
/// let logged_in = safe_auth.unlock(my_secret, my_password).await;
/// match logged_in {
/// Ok(()) => assert!(true), // This should pass
/// Err(_) => assert!(false)
/// }
/// # });
///```
///
/// ## Error Example
/// If the Safe does not exist, the function will return an appropriate error:
///```ignore
/// use sn_api::{SafeAuthenticator, Error};
/// let mut safe_auth = SafeAuthenticator::new(None);
/// # async_std::task::block_on(async {
/// let not_logged_in = safe_auth.unlock("non", "existant").await;
/// match not_logged_in {
/// Ok(()) => assert!(false), // This should not pass
/// Err(Error::AuthError(message)) => {
/// assert!(message.contains("Failed to log in"));
/// }
/// Err(_) => assert!(false), // This should not pass
/// }
/// # });
///```
#[allow(clippy::unused_async)]
pub async fn unlock(&mut self, _passphrase: &str, _password: &str) -> Result<()> {
unimplemented!("Authenticator hasn't yet been updated to work with the new Safe Network");
// debug!("Attempting to unlock a Safe...");
// let (location, keypair) = derive_location_and_keypair(passphrase, password)?;
// debug!(
// "Unlocking Safe owned by PublicKey: {:?}",
// keypair.public_key()
// );
// let client = Client::new(
// Some(keypair),
// self.config_path.as_deref(),
// self.bootstrap_contacts.clone(),
// DEFAULT_OPERATION_TIMEOUT,
// )
// .await?;
// trace!("Client instantiated properly!");
// let map_address = MapAddress::Seq {
// name: location,
// tag: SAFE_TYPE_TAG,
// };
// // Attempt to retrieve Map to make sure it actually exists
// let _ = client.get_map(map_address).await?;
// debug!("Safe unlocked successfully!");
// self.safe = Some((client, map_address));
// Ok(())
}
pub fn lock(&mut self) -> Result<()> {
unimplemented!("Authenticator hasn't yet been updated to work with the new Safe Network");
// debug!("Locking Safe...");
// self.safe = None;
// Ok(())
}
pub fn is_a_safe_unlocked(&self) -> bool {
unimplemented!("Authenticator hasn't yet been updated to work with the new Safe Network");
// let is_a_safe_unlocked = self.safe.is_some();
// debug!(
// "Is there a Safe currently unlocked?: {}",
// is_a_safe_unlocked
// );
// is_a_safe_unlocked
}
#[allow(clippy::unused_async)]
pub async fn decode_req(&self, _req: &str) -> Result<SafeAuthReq> {
unimplemented!("Authenticator hasn't yet been updated to work with the new Safe Network");
// match IpcMsg::from_string(req) {
// Ok(IpcMsg::Req(IpcReq::Auth(app_auth_req))) => {
// debug!("Auth request string decoded: {:?}", app_auth_req);
// Ok(SafeAuthReq::Auth(app_auth_req))
// }
// Ok(other) => Err(Error::AuthError(format!(
// "Failed to decode string as an authorisation request, it's a: '{:?}'",
// other
// ))),
// Err(error) => Err(Error::AuthenticatorError(format!(
// "Failed to decode request: {:?}",
// error
// ))),
// }
}
// TODO: update terminology around apps auth here
#[allow(clippy::unused_async)]
pub async fn revoke_app(&self, _y: &str) -> Result<()> {
unimplemented!()
}
/// Decode requests and trigger application authorisation against the current client
#[allow(clippy::unused_async)]
pub async fn authorise_app(&self, _req: &str) -> Result<String> {
unimplemented!("Authenticator hasn't yet been updated to work with the new Safe Network");
// let ipc_req = IpcMsg::from_string(req).map_err(|err| {
// Error::AuthenticatorError(format!("Failed to decode authorisation request: {:?}", err))
// })?;
// debug!("Auth request string decoded: {:?}", ipc_req);
// match ipc_req {
// IpcMsg::Req(IpcReq::Auth(app_auth_req)) => {
// info!("Request was recognised as an application auth request");
// debug!("Decoded request: {:?}", app_auth_req);
// self.gen_auth_response(app_auth_req).await
// }
// IpcMsg::Req(IpcReq::Unregistered(user_data)) => {
// info!("Request was recognised as an unregistered auth request");
// debug!("Decoded request: {:?}", user_data);
// self.gen_unreg_auth_response()
// }
// IpcMsg::Resp { .. } | IpcMsg::Err(..) => Err(Error::AuthError(
// "The request was not recognised as a valid auth request".to_string(),
// )),
// }
}
/// Authenticate an app request.
///
/// First, this function searches for an app info in the Safe.
/// If the app is found, then the `AuthGranted` struct is returned based on that information.
/// If the app is not found in the Safe, then it will be authenticated.
#[allow(clippy::unused_async)]
pub async fn authenticate(&self, _auth_req: AuthReq) -> Result<AuthGranted> {
unimplemented!("Authenticator hasn't yet been updated to work with the new Safe Network");
// debug!(
// "Retrieving/generating keypair for an application: {:?}",
// auth_req
// );
// if let Some((client, map_address)) = &self.safe {
// let app_id = auth_req.app_id.as_bytes().to_vec();
// let keypair = match client.get_map_value(*map_address, app_id.clone()).await {
// Ok(value) => {
// // This app already has its own keypair
// trace!(
// "The app ('{}') already has a Keypair in the Safe",
// auth_req.app_id
// );
// // TODO: support for scenario when app was previously revoked,
// // in which case we should generate a new keypair
// let keypair_bytes = match value {
// MapValue::Seq(seq_value) => seq_value.data,
// MapValue::Unseq(data) => data,
// };
// let keypair_str = String::from_utf8(keypair_bytes).map_err(|_err| {
// Error::AuthError(
// "The Safe contains an invalid keypair associated to this app"
// .to_string(),
// )
// })?;
// let keypair: Keypair = serde_json::from_str(&keypair_str).map_err(|_err| {
// Error::AuthError(
// "The Safe contains an invalid keypair associated to this app"
// .to_string(),
// )
// })?;
// debug!(
// "Keypair for the app being authorised ('{}') retrieved from the Safe: {}",
// auth_req.app_id,
// keypair.public_key()
// );
// keypair
// }
// Err(ClientError::ErrorMsg {
// source: NoSuchEntry,
// ..
// }) => {
// // This is the first time this app is being authorised,
// // thus let's generate a keypair for it
// trace!(
// "The app ('{}') was not assigned a Keypair yet in the Safe. Generating one for it...",
// auth_req.app_id
// );
// let mut rng = OsRng;
// let keypair = Keypair::new_ed25519(&mut rng);
// let keypair_str = serde_json::to_string(&keypair).map_err(|err| {
// Error::AuthError(format!(
// "Failed to serialised keypair to store it in the Safe: {}",
// err
// ))
// })?;
// debug!(
// "New keypair generated for app ('{}') being authorised: {}",
// auth_req.app_id,
// keypair.public_key()
// );
// // Store the keypair in the Safe, mapped to the app id
// let map_actions =
// MapSeqEntryActions::new().ins(app_id, keypair_str.as_bytes().to_vec(), 0);
// client
// .edit_map_entries(*map_address, MapEntryActions::Seq(map_actions))
// .await?;
// keypair
// }
// Err(err) => {
// return Err(Error::AuthError(format!(
// "Failed to retrieve keypair from the Safe: {}",
// err
// )))
// }
// };
// Ok(AuthGranted {
// app_keypair: keypair,
// bootstrap_config: self.bootstrap_contacts.clone(),
// })
// } else {
// Err(Error::AuthenticatorError(
// "No Safe is currently unlocked".to_string(),
// ))
// }
}
// Helper function to generate an app authorisation response
// async fn gen_auth_response(&self, auth_req: AuthReq) -> Result<String> {
// let auth_granted = self.authenticate(auth_req).await.map_err(|err| {
// Error::AuthenticatorError(format!(
// "Failed to authorise application on the network: {}",
// err
// ))
// })?;
// debug!("Encoding response with auth credentials auth granted...");
// let resp = serde_json::to_string(&IpcMsg::Resp(IpcResp::Auth(Ok(auth_granted)))).map_err(
// |err| Error::AuthenticatorError(format!("Failed to encode response: {:?}", err)),
// )?;
// debug!("Returning auth response generated");
// Ok(resp)
// }
// Helper function to generate an unregistered authorisation response
// fn gen_unreg_auth_response(&self) -> Result<String> {
// let bootstrap_contacts = self.bootstrap_contacts.clone().ok_or_else(|| {
// Error::AuthenticatorError("Bootstrap contacts information not available".to_string())
// })?;
// debug!("Encoding response... {:?}", bootstrap_contacts);
// let resp =
// serde_json::to_string(&IpcMsg::Resp(IpcResp::Unregistered(Ok(bootstrap_contacts))))
// .map_err(|err| {
// Error::AuthenticatorError(format!("Failed to encode response: {:?}", err))
// })?;
// debug!("Returning unregistered auth response generated: {:?}", resp);
// Ok(resp)
// }
}
#[cfg(test)]
mod tests {
use super::*;
use sn_interface::types::PublicKey;
use anyhow::{Context, Result};
use proptest::prelude::*;
#[test]
fn get_deterministic_pk_from_known_seed() -> Result<()> {
let seed = b"bacon";
let pk = create_ed25519_keypair_from_seed(seed).public_key();
let public_key_bytes: [u8; ed25519_dalek::PUBLIC_KEY_LENGTH] = [
239, 124, 31, 157, 76, 101, 124, 119, 164, 143, 80, 234, 249, 84, 0, 22, 91, 128, 67,
92, 39, 182, 197, 184, 83, 44, 41, 127, 78, 175, 205, 198,
];
let ed_pk = ed25519_dalek::PublicKey::from_bytes(&public_key_bytes)
.with_context(|| "Cannot deserialise expected key".to_string())?;
let expected_pk = PublicKey::from(ed_pk);
assert_eq!(pk, expected_pk);
Ok(())
}
proptest! {
#[test]
fn proptest_always_get_same_info_from_from_phrase_and_pw(s in "\\PC*", p in "\\PC*") {
let (location, keypair) = derive_location_and_keypair(&s, &p).expect("could not derive location/keypair");
let (location_again, keypair_again) = derive_location_and_keypair(&s, &p).expect("could not derive location/keypair");
prop_assert_eq!(location, location_again);
prop_assert_eq!(keypair, keypair_again);
}
}
}