|
| 1 | +// Copyright 2024 The Matrix.org Foundation C.I.C. |
| 2 | +// |
| 3 | +// Licensed under the Apache License, Version 2.0 (the "License"); |
| 4 | +// you may not use this file except in compliance with the License. |
| 5 | +// You may obtain a copy of the License at |
| 6 | +// |
| 7 | +// http://www.apache.org/licenses/LICENSE-2.0 |
| 8 | +// |
| 9 | +// Unless required by applicable law or agreed to in writing, software |
| 10 | +// distributed under the License is distributed on an "AS IS" BASIS, |
| 11 | +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 12 | +// See the License for the specific language governing permissions and |
| 13 | +// limitations under the License. |
| 14 | + |
| 15 | +use aide::{transform::TransformOperation, OperationIo}; |
| 16 | +use axum::{extract::State, response::IntoResponse, Json}; |
| 17 | +use hyper::StatusCode; |
| 18 | +use mas_matrix::BoxHomeserverConnection; |
| 19 | +use ulid::Ulid; |
| 20 | + |
| 21 | +use crate::{ |
| 22 | + admin::{ |
| 23 | + call_context::CallContext, |
| 24 | + model::{Resource, User}, |
| 25 | + params::UlidPathParam, |
| 26 | + response::{ErrorResponse, SingleResponse}, |
| 27 | + }, |
| 28 | + impl_from_error_for_route, |
| 29 | +}; |
| 30 | + |
| 31 | +#[derive(Debug, thiserror::Error, OperationIo)] |
| 32 | +#[aide(output_with = "Json<ErrorResponse>")] |
| 33 | +pub enum RouteError { |
| 34 | + #[error(transparent)] |
| 35 | + Internal(Box<dyn std::error::Error + Send + Sync + 'static>), |
| 36 | + |
| 37 | + #[error(transparent)] |
| 38 | + Homeserver(anyhow::Error), |
| 39 | + |
| 40 | + #[error("User ID {0} not found")] |
| 41 | + NotFound(Ulid), |
| 42 | +} |
| 43 | + |
| 44 | +impl_from_error_for_route!(mas_storage::RepositoryError); |
| 45 | + |
| 46 | +impl IntoResponse for RouteError { |
| 47 | + fn into_response(self) -> axum::response::Response { |
| 48 | + let error = ErrorResponse::from_error(&self); |
| 49 | + let status = match self { |
| 50 | + Self::Internal(_) | Self::Homeserver(_) => StatusCode::INTERNAL_SERVER_ERROR, |
| 51 | + Self::NotFound(_) => StatusCode::NOT_FOUND, |
| 52 | + }; |
| 53 | + (status, Json(error)).into_response() |
| 54 | + } |
| 55 | +} |
| 56 | + |
| 57 | +pub fn doc(operation: TransformOperation) -> TransformOperation { |
| 58 | + operation |
| 59 | + .summary("Unlock a user") |
| 60 | + .tag("user") |
| 61 | + .response_with::<200, Json<SingleResponse<User>>, _>(|t| { |
| 62 | + // In the samples, the third user is the one locked |
| 63 | + let [sample, ..] = User::samples(); |
| 64 | + let id = sample.id(); |
| 65 | + let response = SingleResponse::new(sample, format!("/api/admin/v1/users/{id}/unlock")); |
| 66 | + t.description("User was unlocked").example(response) |
| 67 | + }) |
| 68 | + .response_with::<404, RouteError, _>(|t| { |
| 69 | + let response = ErrorResponse::from_error(&RouteError::NotFound(Ulid::nil())); |
| 70 | + t.description("User ID not found").example(response) |
| 71 | + }) |
| 72 | +} |
| 73 | + |
| 74 | +#[tracing::instrument(name = "handler.admin.v1.users.unlock", skip_all, err)] |
| 75 | +pub async fn handler( |
| 76 | + CallContext { mut repo, .. }: CallContext, |
| 77 | + State(homeserver): State<BoxHomeserverConnection>, |
| 78 | + id: UlidPathParam, |
| 79 | +) -> Result<Json<SingleResponse<User>>, RouteError> { |
| 80 | + let id = *id; |
| 81 | + let user = repo |
| 82 | + .user() |
| 83 | + .lookup(id) |
| 84 | + .await? |
| 85 | + .ok_or(RouteError::NotFound(id))?; |
| 86 | + |
| 87 | + // Call the homeserver synchronously to unlock the user |
| 88 | + let mxid = homeserver.mxid(&user.username); |
| 89 | + homeserver |
| 90 | + .reactivate_user(&mxid) |
| 91 | + .await |
| 92 | + .map_err(RouteError::Homeserver)?; |
| 93 | + |
| 94 | + // Now unlock the user in our database |
| 95 | + let user = repo.user().unlock(user).await?; |
| 96 | + |
| 97 | + repo.save().await?; |
| 98 | + |
| 99 | + Ok(Json(SingleResponse::new( |
| 100 | + User::from(user), |
| 101 | + format!("/api/admin/v1/users/{id}/unlock"), |
| 102 | + ))) |
| 103 | +} |
| 104 | + |
| 105 | +#[cfg(test)] |
| 106 | +mod tests { |
| 107 | + use hyper::{Request, StatusCode}; |
| 108 | + use mas_matrix::{HomeserverConnection, ProvisionRequest}; |
| 109 | + use mas_storage::{user::UserRepository, RepositoryAccess}; |
| 110 | + use sqlx::PgPool; |
| 111 | + |
| 112 | + use crate::test_utils::{setup, RequestBuilderExt, ResponseExt, TestState}; |
| 113 | + |
| 114 | + #[sqlx::test(migrator = "mas_storage_pg::MIGRATOR")] |
| 115 | + async fn test_unlock_user(pool: PgPool) { |
| 116 | + setup(); |
| 117 | + let mut state = TestState::from_pool(pool).await.unwrap(); |
| 118 | + let token = state.token_with_scope("urn:mas:admin").await; |
| 119 | + |
| 120 | + let mut repo = state.repository().await.unwrap(); |
| 121 | + let user = repo |
| 122 | + .user() |
| 123 | + .add(&mut state.rng(), &state.clock, "alice".to_owned()) |
| 124 | + .await |
| 125 | + .unwrap(); |
| 126 | + let user = repo.user().lock(&state.clock, user).await.unwrap(); |
| 127 | + repo.save().await.unwrap(); |
| 128 | + |
| 129 | + // Also provision the user on the homeserver, because this endpoint will try to |
| 130 | + // reactivate it |
| 131 | + let mxid = state.homeserver_connection.mxid(&user.username); |
| 132 | + state |
| 133 | + .homeserver_connection |
| 134 | + .provision_user(&ProvisionRequest::new(&mxid, &user.sub)) |
| 135 | + .await |
| 136 | + .unwrap(); |
| 137 | + |
| 138 | + let request = Request::post(format!("/api/admin/v1/users/{}/unlock", user.id)) |
| 139 | + .bearer(&token) |
| 140 | + .empty(); |
| 141 | + let response = state.request(request).await; |
| 142 | + response.assert_status(StatusCode::OK); |
| 143 | + let body: serde_json::Value = response.json(); |
| 144 | + |
| 145 | + assert_eq!( |
| 146 | + body["data"]["attributes"]["locked_at"], |
| 147 | + serde_json::json!(null) |
| 148 | + ); |
| 149 | + } |
| 150 | + |
| 151 | + #[sqlx::test(migrator = "mas_storage_pg::MIGRATOR")] |
| 152 | + async fn test_unlock_deactivated_user(pool: PgPool) { |
| 153 | + setup(); |
| 154 | + let mut state = TestState::from_pool(pool).await.unwrap(); |
| 155 | + let token = state.token_with_scope("urn:mas:admin").await; |
| 156 | + |
| 157 | + let mut repo = state.repository().await.unwrap(); |
| 158 | + let user = repo |
| 159 | + .user() |
| 160 | + .add(&mut state.rng(), &state.clock, "alice".to_owned()) |
| 161 | + .await |
| 162 | + .unwrap(); |
| 163 | + let user = repo.user().lock(&state.clock, user).await.unwrap(); |
| 164 | + repo.save().await.unwrap(); |
| 165 | + |
| 166 | + // Provision the user on the homeserver |
| 167 | + let mxid = state.homeserver_connection.mxid(&user.username); |
| 168 | + state |
| 169 | + .homeserver_connection |
| 170 | + .provision_user(&ProvisionRequest::new(&mxid, &user.sub)) |
| 171 | + .await |
| 172 | + .unwrap(); |
| 173 | + // but then deactivate it |
| 174 | + state |
| 175 | + .homeserver_connection |
| 176 | + .delete_user(&mxid, true) |
| 177 | + .await |
| 178 | + .unwrap(); |
| 179 | + |
| 180 | + // The user should be deactivated on the homeserver |
| 181 | + let mx_user = state.homeserver_connection.query_user(&mxid).await.unwrap(); |
| 182 | + assert!(mx_user.deactivated); |
| 183 | + |
| 184 | + let request = Request::post(format!("/api/admin/v1/users/{}/unlock", user.id)) |
| 185 | + .bearer(&token) |
| 186 | + .empty(); |
| 187 | + let response = state.request(request).await; |
| 188 | + response.assert_status(StatusCode::OK); |
| 189 | + let body: serde_json::Value = response.json(); |
| 190 | + |
| 191 | + assert_eq!( |
| 192 | + body["data"]["attributes"]["locked_at"], |
| 193 | + serde_json::json!(null) |
| 194 | + ); |
| 195 | + // The user should be reactivated on the homeserver |
| 196 | + let mx_user = state.homeserver_connection.query_user(&mxid).await.unwrap(); |
| 197 | + assert!(!mx_user.deactivated); |
| 198 | + } |
| 199 | + |
| 200 | + #[sqlx::test(migrator = "mas_storage_pg::MIGRATOR")] |
| 201 | + async fn test_lock_unknown_user(pool: PgPool) { |
| 202 | + setup(); |
| 203 | + let mut state = TestState::from_pool(pool).await.unwrap(); |
| 204 | + let token = state.token_with_scope("urn:mas:admin").await; |
| 205 | + |
| 206 | + let request = Request::post("/api/admin/v1/users/01040G2081040G2081040G2081/unlock") |
| 207 | + .bearer(&token) |
| 208 | + .empty(); |
| 209 | + let response = state.request(request).await; |
| 210 | + response.assert_status(StatusCode::NOT_FOUND); |
| 211 | + let body: serde_json::Value = response.json(); |
| 212 | + assert_eq!( |
| 213 | + body["errors"][0]["title"], |
| 214 | + "User ID 01040G2081040G2081040G2081 not found" |
| 215 | + ); |
| 216 | + } |
| 217 | +} |
0 commit comments