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 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769
// Copyright 2023 The Matrix.org Foundation C.I.C.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
use anyhow::Context as _;
use async_graphql::{Context, Description, Enum, InputObject, Object, ID};
use mas_storage::{
job::{DeactivateUserJob, JobRepositoryExt, ProvisionUserJob},
user::UserRepository,
};
use tracing::{info, warn};
use zeroize::Zeroizing;
use crate::graphql::{
model::{NodeType, User},
state::ContextExt,
Requester, UserId,
};
#[derive(Default)]
pub struct UserMutations {
_private: (),
}
/// The input for the `addUser` mutation.
#[derive(InputObject)]
struct AddUserInput {
/// The username of the user to add.
username: String,
/// Skip checking with the homeserver whether the username is valid.
///
/// Use this with caution! The main reason to use this, is when a user used
/// by an application service needs to exist in MAS to craft special
/// tokens (like with admin access) for them
skip_homeserver_check: Option<bool>,
}
/// The status of the `addUser` mutation.
#[derive(Enum, Copy, Clone, Eq, PartialEq)]
enum AddUserStatus {
/// The user was added.
Added,
/// The user already exists.
Exists,
/// The username is reserved.
Reserved,
/// The username is invalid.
Invalid,
}
/// The payload for the `addUser` mutation.
#[derive(Description)]
enum AddUserPayload {
Added(mas_data_model::User),
Exists(mas_data_model::User),
Reserved,
Invalid,
}
#[Object(use_type_description)]
impl AddUserPayload {
/// Status of the operation
async fn status(&self) -> AddUserStatus {
match self {
Self::Added(_) => AddUserStatus::Added,
Self::Exists(_) => AddUserStatus::Exists,
Self::Reserved => AddUserStatus::Reserved,
Self::Invalid => AddUserStatus::Invalid,
}
}
/// The user that was added.
async fn user(&self) -> Option<User> {
match self {
Self::Added(user) | Self::Exists(user) => Some(User(user.clone())),
Self::Invalid | Self::Reserved => None,
}
}
}
/// The input for the `lockUser` mutation.
#[derive(InputObject)]
struct LockUserInput {
/// The ID of the user to lock.
user_id: ID,
/// Permanently lock the user.
deactivate: Option<bool>,
}
/// The status of the `lockUser` mutation.
#[derive(Enum, Copy, Clone, Eq, PartialEq)]
enum LockUserStatus {
/// The user was locked.
Locked,
/// The user was not found.
NotFound,
}
/// The payload for the `lockUser` mutation.
#[derive(Description)]
enum LockUserPayload {
/// The user was locked.
Locked(mas_data_model::User),
/// The user was not found.
NotFound,
}
#[Object(use_type_description)]
impl LockUserPayload {
/// Status of the operation
async fn status(&self) -> LockUserStatus {
match self {
Self::Locked(_) => LockUserStatus::Locked,
Self::NotFound => LockUserStatus::NotFound,
}
}
/// The user that was locked.
async fn user(&self) -> Option<User> {
match self {
Self::Locked(user) => Some(User(user.clone())),
Self::NotFound => None,
}
}
}
/// The input for the `unlockUser` mutation.
#[derive(InputObject)]
struct UnlockUserInput {
/// The ID of the user to unlock
user_id: ID,
}
/// The status of the `unlockUser` mutation.
#[derive(Enum, Copy, Clone, Eq, PartialEq)]
enum UnlockUserStatus {
/// The user was unlocked.
Unlocked,
/// The user was not found.
NotFound,
}
/// The payload for the `unlockUser` mutation.
#[derive(Description)]
enum UnlockUserPayload {
/// The user was unlocked.
Unlocked(mas_data_model::User),
/// The user was not found.
NotFound,
}
#[Object(use_type_description)]
impl UnlockUserPayload {
/// Status of the operation
async fn status(&self) -> UnlockUserStatus {
match self {
Self::Unlocked(_) => UnlockUserStatus::Unlocked,
Self::NotFound => UnlockUserStatus::NotFound,
}
}
/// The user that was unlocked.
async fn user(&self) -> Option<User> {
match self {
Self::Unlocked(user) => Some(User(user.clone())),
Self::NotFound => None,
}
}
}
/// The input for the `setCanRequestAdmin` mutation.
#[derive(InputObject)]
struct SetCanRequestAdminInput {
/// The ID of the user to update.
user_id: ID,
/// Whether the user can request admin.
can_request_admin: bool,
}
/// The payload for the `setCanRequestAdmin` mutation.
#[derive(Description)]
enum SetCanRequestAdminPayload {
/// The user was updated.
Updated(mas_data_model::User),
/// The user was not found.
NotFound,
}
#[Object(use_type_description)]
impl SetCanRequestAdminPayload {
/// The user that was updated.
async fn user(&self) -> Option<User> {
match self {
Self::Updated(user) => Some(User(user.clone())),
Self::NotFound => None,
}
}
}
/// The input for the `allowUserCrossSigningReset` mutation.
#[derive(InputObject)]
struct AllowUserCrossSigningResetInput {
/// The ID of the user to update.
user_id: ID,
}
/// The payload for the `allowUserCrossSigningReset` mutation.
#[derive(Description)]
enum AllowUserCrossSigningResetPayload {
/// The user was updated.
Allowed(mas_data_model::User),
/// The user was not found.
NotFound,
}
#[Object(use_type_description)]
impl AllowUserCrossSigningResetPayload {
/// The user that was updated.
async fn user(&self) -> Option<User> {
match self {
Self::Allowed(user) => Some(User(user.clone())),
Self::NotFound => None,
}
}
}
/// The input for the `setPassword` mutation.
#[derive(InputObject)]
struct SetPasswordInput {
/// The ID of the user to set the password for.
/// If you are not a server administrator then this must be your own user
/// ID.
user_id: ID,
/// The current password of the user.
/// Required if you are not a server administrator.
current_password: Option<String>,
/// The new password for the user.
new_password: String,
}
/// The input for the `setPasswordByRecovery` mutation.
#[derive(InputObject)]
struct SetPasswordByRecoveryInput {
/// The recovery ticket to use.
/// This identifies the user as well as proving authorisation to perform the
/// recovery operation.
ticket: String,
/// The new password for the user.
new_password: String,
}
/// The return type for the `setPassword` mutation.
#[derive(Description)]
struct SetPasswordPayload {
status: SetPasswordStatus,
}
/// The status of the `setPassword` mutation.
#[derive(Enum, Copy, Clone, Eq, PartialEq)]
enum SetPasswordStatus {
/// The password was updated.
Allowed,
/// The user was not found.
NotFound,
/// The user doesn't have a current password to attempt to match against.
NoCurrentPassword,
/// The supplied current password was wrong.
WrongPassword,
/// The new password is invalid. For example, it may not meet configured
/// security requirements.
InvalidNewPassword,
/// You aren't allowed to set the password for that user.
/// This happens if you aren't setting your own password and you aren't a
/// server administrator.
NotAllowed,
/// Password support has been disabled.
/// This usually means that login is handled by an upstream identity
/// provider.
PasswordChangesDisabled,
/// The specified recovery ticket does not exist.
NoSuchRecoveryTicket,
/// The specified recovery ticket has already been used and cannot be used
/// again.
RecoveryTicketAlreadyUsed,
/// The specified recovery ticket has expired.
ExpiredRecoveryTicket,
/// Your account is locked and you can't change its password.
AccountLocked,
}
#[Object(use_type_description)]
impl SetPasswordPayload {
/// Status of the operation
async fn status(&self) -> SetPasswordStatus {
self.status
}
}
fn valid_username_character(c: char) -> bool {
c.is_ascii_lowercase()
|| c.is_ascii_digit()
|| c == '='
|| c == '_'
|| c == '-'
|| c == '.'
|| c == '/'
|| c == '+'
}
// XXX: this should probably be moved somewhere else
fn username_valid(username: &str) -> bool {
if username.is_empty() || username.len() > 255 {
return false;
}
// Should not start with an underscore
if username.starts_with('_') {
return false;
}
// Should only contain valid characters
if !username.chars().all(valid_username_character) {
return false;
}
true
}
#[Object]
impl UserMutations {
/// Add a user. This is only available to administrators.
async fn add_user(
&self,
ctx: &Context<'_>,
input: AddUserInput,
) -> Result<AddUserPayload, async_graphql::Error> {
let state = ctx.state();
let requester = ctx.requester();
let clock = state.clock();
let mut rng = state.rng();
if !requester.is_admin() {
return Err(async_graphql::Error::new("Unauthorized"));
}
let mut repo = state.repository().await?;
if let Some(user) = repo.user().find_by_username(&input.username).await? {
return Ok(AddUserPayload::Exists(user));
}
// Do some basic check on the username
if !username_valid(&input.username) {
return Ok(AddUserPayload::Invalid);
}
// Ask the homeserver if the username is available
let homeserver_available = state
.homeserver_connection()
.is_localpart_available(&input.username)
.await?;
if !homeserver_available {
if !input.skip_homeserver_check.unwrap_or(false) {
return Ok(AddUserPayload::Reserved);
}
// If we skipped the check, we still want to shout about it
warn!("Skipped homeserver check for username {}", input.username);
}
let user = repo.user().add(&mut rng, &clock, input.username).await?;
repo.job()
.schedule_job(ProvisionUserJob::new(&user))
.await?;
repo.save().await?;
Ok(AddUserPayload::Added(user))
}
/// Lock a user. This is only available to administrators.
async fn lock_user(
&self,
ctx: &Context<'_>,
input: LockUserInput,
) -> Result<LockUserPayload, async_graphql::Error> {
let state = ctx.state();
let requester = ctx.requester();
if !requester.is_admin() {
return Err(async_graphql::Error::new("Unauthorized"));
}
let mut repo = state.repository().await?;
let user_id = NodeType::User.extract_ulid(&input.user_id)?;
let user = repo.user().lookup(user_id).await?;
let Some(user) = user else {
return Ok(LockUserPayload::NotFound);
};
let deactivate = input.deactivate.unwrap_or(false);
let user = repo.user().lock(&state.clock(), user).await?;
if deactivate {
info!("Scheduling deactivation of user {}", user.id);
repo.job()
.schedule_job(DeactivateUserJob::new(&user, deactivate))
.await?;
}
repo.save().await?;
Ok(LockUserPayload::Locked(user))
}
/// Unlock a user. This is only available to administrators.
async fn unlock_user(
&self,
ctx: &Context<'_>,
input: UnlockUserInput,
) -> Result<UnlockUserPayload, async_graphql::Error> {
let state = ctx.state();
let requester = ctx.requester();
let matrix = state.homeserver_connection();
if !requester.is_admin() {
return Err(async_graphql::Error::new("Unauthorized"));
}
let mut repo = state.repository().await?;
let user_id = NodeType::User.extract_ulid(&input.user_id)?;
let user = repo.user().lookup(user_id).await?;
let Some(user) = user else {
return Ok(UnlockUserPayload::NotFound);
};
// Call the homeserver synchronously to unlock the user
let mxid = matrix.mxid(&user.username);
matrix.reactivate_user(&mxid).await?;
// Now unlock the user in our database
let user = repo.user().unlock(user).await?;
repo.save().await?;
Ok(UnlockUserPayload::Unlocked(user))
}
/// Set whether a user can request admin. This is only available to
/// administrators.
async fn set_can_request_admin(
&self,
ctx: &Context<'_>,
input: SetCanRequestAdminInput,
) -> Result<SetCanRequestAdminPayload, async_graphql::Error> {
let state = ctx.state();
let requester = ctx.requester();
if !requester.is_admin() {
return Err(async_graphql::Error::new("Unauthorized"));
}
let mut repo = state.repository().await?;
let user_id = NodeType::User.extract_ulid(&input.user_id)?;
let user = repo.user().lookup(user_id).await?;
let Some(user) = user else {
return Ok(SetCanRequestAdminPayload::NotFound);
};
let user = repo
.user()
.set_can_request_admin(user, input.can_request_admin)
.await?;
repo.save().await?;
Ok(SetCanRequestAdminPayload::Updated(user))
}
/// Temporarily allow user to reset their cross-signing keys.
async fn allow_user_cross_signing_reset(
&self,
ctx: &Context<'_>,
input: AllowUserCrossSigningResetInput,
) -> Result<AllowUserCrossSigningResetPayload, async_graphql::Error> {
let state = ctx.state();
let user_id = NodeType::User.extract_ulid(&input.user_id)?;
let requester = ctx.requester();
if !requester.is_owner_or_admin(&UserId(user_id)) {
return Err(async_graphql::Error::new("Unauthorized"));
}
let mut repo = state.repository().await?;
let user = repo.user().lookup(user_id).await?;
repo.cancel().await?;
let Some(user) = user else {
return Ok(AllowUserCrossSigningResetPayload::NotFound);
};
let conn = state.homeserver_connection();
let mxid = conn.mxid(&user.username);
conn.allow_cross_signing_reset(&mxid)
.await
.context("Failed to allow cross-signing reset")?;
Ok(AllowUserCrossSigningResetPayload::Allowed(user))
}
/// Set the password for a user.
///
/// This can be used by server administrators to set any user's password,
/// or, provided the capability hasn't been disabled on this server,
/// by a user to change their own password as long as they know their
/// current password.
async fn set_password(
&self,
ctx: &Context<'_>,
input: SetPasswordInput,
) -> Result<SetPasswordPayload, async_graphql::Error> {
let state = ctx.state();
let user_id = NodeType::User.extract_ulid(&input.user_id)?;
let requester = ctx.requester();
if !requester.is_owner_or_admin(&UserId(user_id)) {
return Err(async_graphql::Error::new("Unauthorized"));
}
if input.new_password.is_empty() {
// TODO Expose the reason for the policy violation
// This involves redesigning the error handling
// Idea would be to expose an errors array in the response,
// with a list of union of different error kinds.
return Ok(SetPasswordPayload {
status: SetPasswordStatus::InvalidNewPassword,
});
}
let password_manager = state.password_manager();
if !password_manager.is_enabled() {
return Ok(SetPasswordPayload {
status: SetPasswordStatus::PasswordChangesDisabled,
});
}
if !password_manager.is_password_complex_enough(&input.new_password)? {
return Ok(SetPasswordPayload {
status: SetPasswordStatus::InvalidNewPassword,
});
}
let mut repo = state.repository().await?;
let Some(user) = repo.user().lookup(user_id).await? else {
return Ok(SetPasswordPayload {
status: SetPasswordStatus::NotFound,
});
};
if !requester.is_admin() {
// If the user isn't an admin, we:
// - check that password changes are enabled
// - check that they know their current password
if !state.site_config().password_change_allowed {
return Ok(SetPasswordPayload {
status: SetPasswordStatus::PasswordChangesDisabled,
});
}
let Some(active_password) = repo.user_password().active(&user).await? else {
// The user has no current password, so can't verify against one.
// In the future, it may be desirable to let the user set a password without any
// other verification instead.
return Ok(SetPasswordPayload {
status: SetPasswordStatus::NoCurrentPassword,
});
};
let Some(current_password_attempt) = input.current_password else {
return Err(async_graphql::Error::new(
"You must supply `currentPassword` to change your own password if you are not an administrator"
));
};
if let Err(_err) = password_manager
.verify(
active_password.version,
Zeroizing::new(current_password_attempt.into_bytes()),
active_password.hashed_password,
)
.await
{
return Ok(SetPasswordPayload {
status: SetPasswordStatus::WrongPassword,
});
}
}
let (new_password_version, new_password_hash) = password_manager
.hash(state.rng(), Zeroizing::new(input.new_password.into_bytes()))
.await?;
repo.user_password()
.add(
&mut state.rng(),
&state.clock(),
&user,
new_password_version,
new_password_hash,
None,
)
.await?;
repo.save().await?;
Ok(SetPasswordPayload {
status: SetPasswordStatus::Allowed,
})
}
/// Set the password for yourself, using a recovery ticket sent by e-mail.
async fn set_password_by_recovery(
&self,
ctx: &Context<'_>,
input: SetPasswordByRecoveryInput,
) -> Result<SetPasswordPayload, async_graphql::Error> {
let state = ctx.state();
let requester = ctx.requester();
let clock = state.clock();
if !matches!(requester, Requester::Anonymous) {
return Err(async_graphql::Error::new(
"Account recovery is only for anonymous users.",
));
}
let password_manager = state.password_manager();
if !password_manager.is_enabled() || !state.site_config().account_recovery_allowed {
return Ok(SetPasswordPayload {
status: SetPasswordStatus::PasswordChangesDisabled,
});
}
if !password_manager.is_password_complex_enough(&input.new_password)? {
return Ok(SetPasswordPayload {
status: SetPasswordStatus::InvalidNewPassword,
});
}
let mut repo = state.repository().await?;
let Some(ticket) = repo.user_recovery().find_ticket(&input.ticket).await? else {
return Ok(SetPasswordPayload {
status: SetPasswordStatus::NoSuchRecoveryTicket,
});
};
let session = repo
.user_recovery()
.lookup_session(ticket.user_recovery_session_id)
.await?
.context("Unknown session")?;
if session.consumed_at.is_some() {
return Ok(SetPasswordPayload {
status: SetPasswordStatus::RecoveryTicketAlreadyUsed,
});
}
if !ticket.active(clock.now()) {
return Ok(SetPasswordPayload {
status: SetPasswordStatus::ExpiredRecoveryTicket,
});
}
let user_email = repo
.user_email()
.lookup(ticket.user_email_id)
.await?
// Only allow confirmed email addresses
.filter(|email| email.confirmed_at.is_some())
.context("Unknown email address")?;
let user = repo
.user()
.lookup(user_email.user_id)
.await?
.context("Invalid user")?;
if !user.is_valid() {
return Ok(SetPasswordPayload {
status: SetPasswordStatus::AccountLocked,
});
}
let (new_password_version, new_password_hash) = password_manager
.hash(state.rng(), Zeroizing::new(input.new_password.into_bytes()))
.await?;
repo.user_password()
.add(
&mut state.rng(),
&state.clock(),
&user,
new_password_version,
new_password_hash,
None,
)
.await?;
// Mark the session as consumed
repo.user_recovery()
.consume_ticket(&clock, ticket, session)
.await?;
repo.save().await?;
Ok(SetPasswordPayload {
status: SetPasswordStatus::Allowed,
})
}
}