| | | 1 | | using System; |
| | | 2 | | using System.Collections.Generic; |
| | | 3 | | using System.ComponentModel.DataAnnotations; |
| | | 4 | | using System.Linq; |
| | | 5 | | using System.Threading.Tasks; |
| | | 6 | | using Jellyfin.Api.Constants; |
| | | 7 | | using Jellyfin.Api.Extensions; |
| | | 8 | | using Jellyfin.Api.Helpers; |
| | | 9 | | using Jellyfin.Api.Models.UserDtos; |
| | | 10 | | using Jellyfin.Data; |
| | | 11 | | using Jellyfin.Database.Implementations.Enums; |
| | | 12 | | using Jellyfin.Extensions; |
| | | 13 | | using MediaBrowser.Common.Api; |
| | | 14 | | using MediaBrowser.Common.Extensions; |
| | | 15 | | using MediaBrowser.Common.Net; |
| | | 16 | | using MediaBrowser.Controller.Authentication; |
| | | 17 | | using MediaBrowser.Controller.Configuration; |
| | | 18 | | using MediaBrowser.Controller.Devices; |
| | | 19 | | using MediaBrowser.Controller.Library; |
| | | 20 | | using MediaBrowser.Controller.Net; |
| | | 21 | | using MediaBrowser.Controller.Playlists; |
| | | 22 | | using MediaBrowser.Controller.QuickConnect; |
| | | 23 | | using MediaBrowser.Controller.Session; |
| | | 24 | | using MediaBrowser.Model.Configuration; |
| | | 25 | | using MediaBrowser.Model.Dto; |
| | | 26 | | using MediaBrowser.Model.Users; |
| | | 27 | | using Microsoft.AspNetCore.Authorization; |
| | | 28 | | using Microsoft.AspNetCore.Http; |
| | | 29 | | using Microsoft.AspNetCore.Mvc; |
| | | 30 | | using Microsoft.Extensions.Logging; |
| | | 31 | | |
| | | 32 | | namespace Jellyfin.Api.Controllers; |
| | | 33 | | |
| | | 34 | | /// <summary> |
| | | 35 | | /// User controller. |
| | | 36 | | /// </summary> |
| | | 37 | | [Route("Users")] |
| | | 38 | | public class UserController : BaseJellyfinApiController |
| | | 39 | | { |
| | | 40 | | private readonly IUserManager _userManager; |
| | | 41 | | private readonly ISessionManager _sessionManager; |
| | | 42 | | private readonly INetworkManager _networkManager; |
| | | 43 | | private readonly IDeviceManager _deviceManager; |
| | | 44 | | private readonly IAuthorizationContext _authContext; |
| | | 45 | | private readonly IServerConfigurationManager _config; |
| | | 46 | | private readonly ILogger _logger; |
| | | 47 | | private readonly IQuickConnect _quickConnectManager; |
| | | 48 | | private readonly IPlaylistManager _playlistManager; |
| | | 49 | | |
| | | 50 | | /// <summary> |
| | | 51 | | /// Initializes a new instance of the <see cref="UserController"/> class. |
| | | 52 | | /// </summary> |
| | | 53 | | /// <param name="userManager">Instance of the <see cref="IUserManager"/> interface.</param> |
| | | 54 | | /// <param name="sessionManager">Instance of the <see cref="ISessionManager"/> interface.</param> |
| | | 55 | | /// <param name="networkManager">Instance of the <see cref="INetworkManager"/> interface.</param> |
| | | 56 | | /// <param name="deviceManager">Instance of the <see cref="IDeviceManager"/> interface.</param> |
| | | 57 | | /// <param name="authContext">Instance of the <see cref="IAuthorizationContext"/> interface.</param> |
| | | 58 | | /// <param name="config">Instance of the <see cref="IServerConfigurationManager"/> interface.</param> |
| | | 59 | | /// <param name="logger">Instance of the <see cref="ILogger"/> interface.</param> |
| | | 60 | | /// <param name="quickConnectManager">Instance of the <see cref="IQuickConnect"/> interface.</param> |
| | | 61 | | /// <param name="playlistManager">Instance of the <see cref="IPlaylistManager"/> interface.</param> |
| | 48 | 62 | | public UserController( |
| | 48 | 63 | | IUserManager userManager, |
| | 48 | 64 | | ISessionManager sessionManager, |
| | 48 | 65 | | INetworkManager networkManager, |
| | 48 | 66 | | IDeviceManager deviceManager, |
| | 48 | 67 | | IAuthorizationContext authContext, |
| | 48 | 68 | | IServerConfigurationManager config, |
| | 48 | 69 | | ILogger<UserController> logger, |
| | 48 | 70 | | IQuickConnect quickConnectManager, |
| | 48 | 71 | | IPlaylistManager playlistManager) |
| | | 72 | | { |
| | 48 | 73 | | _userManager = userManager; |
| | 48 | 74 | | _sessionManager = sessionManager; |
| | 48 | 75 | | _networkManager = networkManager; |
| | 48 | 76 | | _deviceManager = deviceManager; |
| | 48 | 77 | | _authContext = authContext; |
| | 48 | 78 | | _config = config; |
| | 48 | 79 | | _logger = logger; |
| | 48 | 80 | | _quickConnectManager = quickConnectManager; |
| | 48 | 81 | | _playlistManager = playlistManager; |
| | 48 | 82 | | } |
| | | 83 | | |
| | | 84 | | /// <summary> |
| | | 85 | | /// Gets a list of users. |
| | | 86 | | /// </summary> |
| | | 87 | | /// <param name="isHidden">Optional filter by IsHidden=true or false.</param> |
| | | 88 | | /// <param name="isDisabled">Optional filter by IsDisabled=true or false.</param> |
| | | 89 | | /// <response code="200">Users returned.</response> |
| | | 90 | | /// <returns>An <see cref="IEnumerable{UserDto}"/> containing the users.</returns> |
| | | 91 | | [HttpGet] |
| | | 92 | | [Authorize] |
| | | 93 | | [ProducesResponseType(StatusCodes.Status200OK)] |
| | | 94 | | public ActionResult<IEnumerable<UserDto>> GetUsers( |
| | | 95 | | [FromQuery] bool? isHidden, |
| | | 96 | | [FromQuery] bool? isDisabled) |
| | | 97 | | { |
| | 1 | 98 | | var users = Get(isHidden, isDisabled, false, false); |
| | 1 | 99 | | return Ok(users); |
| | | 100 | | } |
| | | 101 | | |
| | | 102 | | /// <summary> |
| | | 103 | | /// Gets a list of publicly visible users for display on a login screen. |
| | | 104 | | /// </summary> |
| | | 105 | | /// <response code="200">Public users returned.</response> |
| | | 106 | | /// <returns>An <see cref="IEnumerable{UserDto}"/> containing the public users.</returns> |
| | | 107 | | [HttpGet("Public")] |
| | | 108 | | [ProducesResponseType(StatusCodes.Status200OK)] |
| | | 109 | | public ActionResult<IEnumerable<UserDto>> GetPublicUsers() |
| | | 110 | | { |
| | | 111 | | // If the startup wizard hasn't been completed then just return all users |
| | 1 | 112 | | if (!_config.Configuration.IsStartupWizardCompleted) |
| | | 113 | | { |
| | 1 | 114 | | return Ok(Get(false, false, false, false)); |
| | | 115 | | } |
| | | 116 | | |
| | 0 | 117 | | return Ok(Get(false, false, true, true)); |
| | | 118 | | } |
| | | 119 | | |
| | | 120 | | /// <summary> |
| | | 121 | | /// Gets a user by Id. |
| | | 122 | | /// </summary> |
| | | 123 | | /// <param name="userId">The user id.</param> |
| | | 124 | | /// <response code="200">User returned.</response> |
| | | 125 | | /// <response code="404">User not found.</response> |
| | | 126 | | /// <returns>An <see cref="UserDto"/> with information about the user or a <see cref="NotFoundResult"/> if the user |
| | | 127 | | [HttpGet("{userId}")] |
| | | 128 | | [Authorize(Policy = Policies.IgnoreParentalControl)] |
| | | 129 | | [ProducesResponseType(StatusCodes.Status200OK)] |
| | | 130 | | [ProducesResponseType(StatusCodes.Status404NotFound)] |
| | | 131 | | public ActionResult<UserDto> GetUserById([FromRoute, Required] Guid userId) |
| | | 132 | | { |
| | 0 | 133 | | var user = _userManager.GetUserById(userId); |
| | | 134 | | |
| | 0 | 135 | | if (user is null) |
| | | 136 | | { |
| | 0 | 137 | | return NotFound("User not found"); |
| | | 138 | | } |
| | | 139 | | |
| | 0 | 140 | | var result = _userManager.GetUserDto(user, HttpContext.GetNormalizedRemoteIP().ToString()); |
| | 0 | 141 | | return result; |
| | | 142 | | } |
| | | 143 | | |
| | | 144 | | /// <summary> |
| | | 145 | | /// Deletes a user. |
| | | 146 | | /// </summary> |
| | | 147 | | /// <param name="userId">The user id.</param> |
| | | 148 | | /// <response code="204">User deleted.</response> |
| | | 149 | | /// <response code="404">User not found.</response> |
| | | 150 | | /// <returns>A <see cref="NoContentResult"/> indicating success or a <see cref="NotFoundResult"/> if the user was no |
| | | 151 | | [HttpDelete("{userId}")] |
| | | 152 | | [Authorize(Policy = Policies.RequiresElevation)] |
| | | 153 | | [ProducesResponseType(StatusCodes.Status204NoContent)] |
| | | 154 | | [ProducesResponseType(StatusCodes.Status404NotFound)] |
| | | 155 | | public async Task<ActionResult> DeleteUser([FromRoute, Required] Guid userId) |
| | | 156 | | { |
| | 0 | 157 | | var user = _userManager.GetUserById(userId); |
| | 0 | 158 | | if (user is null) |
| | | 159 | | { |
| | 0 | 160 | | return NotFound(); |
| | | 161 | | } |
| | | 162 | | |
| | 0 | 163 | | await _sessionManager.RevokeUserTokens(user.Id, null).ConfigureAwait(false); |
| | 0 | 164 | | await _playlistManager.RemovePlaylistsAsync(userId).ConfigureAwait(false); |
| | 0 | 165 | | await _userManager.DeleteUserAsync(userId).ConfigureAwait(false); |
| | 0 | 166 | | return NoContent(); |
| | 0 | 167 | | } |
| | | 168 | | |
| | | 169 | | /// <summary> |
| | | 170 | | /// Authenticates a user. |
| | | 171 | | /// </summary> |
| | | 172 | | /// <param name="userId">The user id.</param> |
| | | 173 | | /// <param name="pw">The password as plain text.</param> |
| | | 174 | | /// <response code="200">User authenticated.</response> |
| | | 175 | | /// <response code="403">Sha1-hashed password only is not allowed.</response> |
| | | 176 | | /// <response code="404">User not found.</response> |
| | | 177 | | /// <returns>A <see cref="Task"/> containing an <see cref="AuthenticationResult"/>.</returns> |
| | | 178 | | [HttpPost("{userId}/Authenticate")] |
| | | 179 | | [ProducesResponseType(StatusCodes.Status200OK)] |
| | | 180 | | [ProducesResponseType(StatusCodes.Status403Forbidden)] |
| | | 181 | | [ProducesResponseType(StatusCodes.Status404NotFound)] |
| | | 182 | | [ApiExplorerSettings(IgnoreApi = true)] |
| | | 183 | | [Obsolete("Authenticate with username instead")] |
| | | 184 | | public async Task<ActionResult<AuthenticationResult>> AuthenticateUser( |
| | | 185 | | [FromRoute, Required] Guid userId, |
| | | 186 | | [FromQuery, Required] string pw) |
| | | 187 | | { |
| | | 188 | | var user = _userManager.GetUserById(userId); |
| | | 189 | | |
| | | 190 | | if (user is null) |
| | | 191 | | { |
| | | 192 | | return NotFound("User not found"); |
| | | 193 | | } |
| | | 194 | | |
| | | 195 | | AuthenticateUserByName request = new AuthenticateUserByName |
| | | 196 | | { |
| | | 197 | | Username = user.Username, |
| | | 198 | | Pw = pw |
| | | 199 | | }; |
| | | 200 | | return await AuthenticateUserByName(request).ConfigureAwait(false); |
| | | 201 | | } |
| | | 202 | | |
| | | 203 | | /// <summary> |
| | | 204 | | /// Authenticates a user by name. |
| | | 205 | | /// </summary> |
| | | 206 | | /// <param name="request">The <see cref="AuthenticateUserByName"/> request.</param> |
| | | 207 | | /// <response code="200">User authenticated.</response> |
| | | 208 | | /// <returns>A <see cref="Task"/> containing an <see cref="AuthenticationRequest"/> with information about the new s |
| | | 209 | | [HttpPost("AuthenticateByName")] |
| | | 210 | | [ProducesResponseType(StatusCodes.Status200OK)] |
| | | 211 | | [Tags("Authentication")] |
| | | 212 | | public async Task<ActionResult<AuthenticationResult>> AuthenticateUserByName([FromBody, Required] AuthenticateUserBy |
| | | 213 | | { |
| | 15 | 214 | | var auth = await _authContext.GetAuthorizationInfo(Request).ConfigureAwait(false); |
| | | 215 | | |
| | | 216 | | try |
| | | 217 | | { |
| | 15 | 218 | | var result = await _sessionManager.AuthenticateNewSession(new AuthenticationRequest |
| | 15 | 219 | | { |
| | 15 | 220 | | App = auth.Client, |
| | 15 | 221 | | AppVersion = auth.Version, |
| | 15 | 222 | | DeviceId = auth.DeviceId, |
| | 15 | 223 | | DeviceName = auth.Device, |
| | 15 | 224 | | Password = request.Pw, |
| | 15 | 225 | | RemoteEndPoint = HttpContext.GetNormalizedRemoteIP().ToString(), |
| | 15 | 226 | | Username = request.Username |
| | 15 | 227 | | }).ConfigureAwait(false); |
| | | 228 | | |
| | 15 | 229 | | return result; |
| | | 230 | | } |
| | 0 | 231 | | catch (SecurityException e) |
| | | 232 | | { |
| | | 233 | | // rethrow adding IP address to message |
| | 0 | 234 | | throw new SecurityException($"[{HttpContext.GetNormalizedRemoteIP()}] {e.Message}", e); |
| | | 235 | | } |
| | 15 | 236 | | } |
| | | 237 | | |
| | | 238 | | /// <summary> |
| | | 239 | | /// Authenticates a user with quick connect. |
| | | 240 | | /// </summary> |
| | | 241 | | /// <param name="request">The <see cref="QuickConnectDto"/> request.</param> |
| | | 242 | | /// <response code="200">User authenticated.</response> |
| | | 243 | | /// <response code="400">Missing token.</response> |
| | | 244 | | /// <returns>A <see cref="Task"/> containing an <see cref="AuthenticationRequest"/> with information about the new s |
| | | 245 | | [HttpPost("AuthenticateWithQuickConnect")] |
| | | 246 | | [ProducesResponseType(StatusCodes.Status200OK)] |
| | | 247 | | [Tags("Authentication")] |
| | | 248 | | public ActionResult<AuthenticationResult> AuthenticateWithQuickConnect([FromBody, Required] QuickConnectDto request) |
| | | 249 | | { |
| | | 250 | | try |
| | | 251 | | { |
| | 0 | 252 | | return _quickConnectManager.GetAuthorizedRequest(request.Secret); |
| | | 253 | | } |
| | 0 | 254 | | catch (SecurityException e) |
| | | 255 | | { |
| | | 256 | | // rethrow adding IP address to message |
| | 0 | 257 | | throw new SecurityException($"[{HttpContext.GetNormalizedRemoteIP()}] {e.Message}", e); |
| | | 258 | | } |
| | 0 | 259 | | } |
| | | 260 | | |
| | | 261 | | /// <summary> |
| | | 262 | | /// Updates a user's password. |
| | | 263 | | /// </summary> |
| | | 264 | | /// <param name="userId">The user id.</param> |
| | | 265 | | /// <param name="request">The <see cref="UpdateUserPassword"/> request.</param> |
| | | 266 | | /// <response code="204">Password successfully reset.</response> |
| | | 267 | | /// <response code="403">User is not allowed to update the password.</response> |
| | | 268 | | /// <response code="404">User not found.</response> |
| | | 269 | | /// <returns>A <see cref="NoContentResult"/> indicating success or a <see cref="ForbidResult"/> or a <see cref="NotF |
| | | 270 | | [HttpPost("Password")] |
| | | 271 | | [Authorize] |
| | | 272 | | [ProducesResponseType(StatusCodes.Status204NoContent)] |
| | | 273 | | [ProducesResponseType(StatusCodes.Status403Forbidden)] |
| | | 274 | | [ProducesResponseType(StatusCodes.Status404NotFound)] |
| | | 275 | | public async Task<ActionResult> UpdateUserPassword( |
| | | 276 | | [FromQuery] Guid? userId, |
| | | 277 | | [FromBody, Required] UpdateUserPassword request) |
| | | 278 | | { |
| | 2 | 279 | | var requestUserId = userId ?? User.GetUserId(); |
| | 2 | 280 | | var user = _userManager.GetUserById(requestUserId); |
| | 2 | 281 | | if (user is null) |
| | | 282 | | { |
| | 0 | 283 | | return NotFound(); |
| | | 284 | | } |
| | | 285 | | |
| | 2 | 286 | | if (!RequestHelpers.AssertCanUpdateUser(User, user, true)) |
| | | 287 | | { |
| | 0 | 288 | | return StatusCode(StatusCodes.Status403Forbidden, "User is not allowed to update the password."); |
| | | 289 | | } |
| | | 290 | | |
| | 2 | 291 | | if (request.ResetPassword) |
| | | 292 | | { |
| | 0 | 293 | | await _userManager.ResetPassword(user.Id).ConfigureAwait(false); |
| | | 294 | | } |
| | | 295 | | else |
| | | 296 | | { |
| | 2 | 297 | | if (!User.IsInRole(UserRoles.Administrator) || (userId.HasValue && User.GetUserId().Equals(userId.Value))) |
| | | 298 | | { |
| | 0 | 299 | | var success = await _userManager.AuthenticateUser( |
| | 0 | 300 | | user.Username, |
| | 0 | 301 | | request.CurrentPw ?? string.Empty, |
| | 0 | 302 | | HttpContext.GetNormalizedRemoteIP().ToString(), |
| | 0 | 303 | | false).ConfigureAwait(false); |
| | | 304 | | |
| | 0 | 305 | | if (success is null) |
| | | 306 | | { |
| | 0 | 307 | | return StatusCode(StatusCodes.Status403Forbidden, "Invalid user or password entered."); |
| | | 308 | | } |
| | | 309 | | } |
| | | 310 | | |
| | 2 | 311 | | await _userManager.ChangePassword(user.Id, request.NewPw ?? string.Empty).ConfigureAwait(false); |
| | | 312 | | |
| | 2 | 313 | | var currentToken = User.GetToken(); |
| | | 314 | | |
| | 2 | 315 | | await _sessionManager.RevokeUserTokens(user.Id, currentToken).ConfigureAwait(false); |
| | | 316 | | } |
| | | 317 | | |
| | 2 | 318 | | return NoContent(); |
| | 2 | 319 | | } |
| | | 320 | | |
| | | 321 | | /// <summary> |
| | | 322 | | /// Updates a user's password. |
| | | 323 | | /// </summary> |
| | | 324 | | /// <param name="userId">The user id.</param> |
| | | 325 | | /// <param name="request">The <see cref="UpdateUserPassword"/> request.</param> |
| | | 326 | | /// <response code="204">Password successfully reset.</response> |
| | | 327 | | /// <response code="403">User is not allowed to update the password.</response> |
| | | 328 | | /// <response code="404">User not found.</response> |
| | | 329 | | /// <returns>A <see cref="NoContentResult"/> indicating success or a <see cref="ForbidResult"/> or a <see cref="NotF |
| | | 330 | | [HttpPost("{userId}/Password")] |
| | | 331 | | [Authorize] |
| | | 332 | | [ProducesResponseType(StatusCodes.Status204NoContent)] |
| | | 333 | | [ProducesResponseType(StatusCodes.Status403Forbidden)] |
| | | 334 | | [ProducesResponseType(StatusCodes.Status404NotFound)] |
| | | 335 | | [Obsolete("Kept for backwards compatibility")] |
| | | 336 | | [ApiExplorerSettings(IgnoreApi = true)] |
| | | 337 | | public Task<ActionResult> UpdateUserPasswordLegacy( |
| | | 338 | | [FromRoute, Required] Guid userId, |
| | | 339 | | [FromBody, Required] UpdateUserPassword request) |
| | | 340 | | => UpdateUserPassword(userId, request); |
| | | 341 | | |
| | | 342 | | /// <summary> |
| | | 343 | | /// Updates a user. |
| | | 344 | | /// </summary> |
| | | 345 | | /// <param name="userId">The user id.</param> |
| | | 346 | | /// <param name="updateUser">The updated user model.</param> |
| | | 347 | | /// <response code="204">User updated.</response> |
| | | 348 | | /// <response code="400">User information was not supplied.</response> |
| | | 349 | | /// <response code="403">User update forbidden.</response> |
| | | 350 | | /// <returns>A <see cref="NoContentResult"/> indicating success or a <see cref="BadRequestResult"/> or a <see cref=" |
| | | 351 | | [HttpPost] |
| | | 352 | | [Authorize] |
| | | 353 | | [ProducesResponseType(StatusCodes.Status204NoContent)] |
| | | 354 | | [ProducesResponseType(StatusCodes.Status400BadRequest)] |
| | | 355 | | [ProducesResponseType(StatusCodes.Status403Forbidden)] |
| | | 356 | | public async Task<ActionResult> UpdateUser( |
| | | 357 | | [FromQuery] Guid? userId, |
| | | 358 | | [FromBody, Required] UserDto updateUser) |
| | | 359 | | { |
| | 0 | 360 | | var requestUserId = userId ?? User.GetUserId(); |
| | 0 | 361 | | var user = _userManager.GetUserById(requestUserId); |
| | 0 | 362 | | if (user is null) |
| | | 363 | | { |
| | 0 | 364 | | return NotFound(); |
| | | 365 | | } |
| | | 366 | | |
| | 0 | 367 | | if (!RequestHelpers.AssertCanUpdateUser(User, user, true)) |
| | | 368 | | { |
| | 0 | 369 | | return StatusCode(StatusCodes.Status403Forbidden, "User update not allowed."); |
| | | 370 | | } |
| | | 371 | | |
| | 0 | 372 | | if (!string.Equals(user.Username, updateUser.Name, StringComparison.Ordinal)) |
| | | 373 | | { |
| | 0 | 374 | | await _userManager.RenameUser(user.Id, user.Username, updateUser.Name).ConfigureAwait(false); |
| | | 375 | | } |
| | | 376 | | |
| | 0 | 377 | | await _userManager.UpdateConfigurationAsync(requestUserId, updateUser.Configuration).ConfigureAwait(false); |
| | | 378 | | |
| | 0 | 379 | | return NoContent(); |
| | 0 | 380 | | } |
| | | 381 | | |
| | | 382 | | /// <summary> |
| | | 383 | | /// Updates a user. |
| | | 384 | | /// </summary> |
| | | 385 | | /// <param name="userId">The user id.</param> |
| | | 386 | | /// <param name="updateUser">The updated user model.</param> |
| | | 387 | | /// <response code="204">User updated.</response> |
| | | 388 | | /// <response code="400">User information was not supplied.</response> |
| | | 389 | | /// <response code="403">User update forbidden.</response> |
| | | 390 | | /// <returns>A <see cref="NoContentResult"/> indicating success or a <see cref="BadRequestResult"/> or a <see cref=" |
| | | 391 | | [HttpPost("{userId}")] |
| | | 392 | | [Authorize] |
| | | 393 | | [ProducesResponseType(StatusCodes.Status204NoContent)] |
| | | 394 | | [ProducesResponseType(StatusCodes.Status400BadRequest)] |
| | | 395 | | [ProducesResponseType(StatusCodes.Status403Forbidden)] |
| | | 396 | | [Obsolete("Kept for backwards compatibility")] |
| | | 397 | | [ApiExplorerSettings(IgnoreApi = true)] |
| | | 398 | | public Task<ActionResult> UpdateUserLegacy( |
| | | 399 | | [FromRoute, Required] Guid userId, |
| | | 400 | | [FromBody, Required] UserDto updateUser) |
| | | 401 | | => UpdateUser(userId, updateUser); |
| | | 402 | | |
| | | 403 | | /// <summary> |
| | | 404 | | /// Updates a user policy. |
| | | 405 | | /// </summary> |
| | | 406 | | /// <param name="userId">The user id.</param> |
| | | 407 | | /// <param name="newPolicy">The new user policy.</param> |
| | | 408 | | /// <response code="204">User policy updated.</response> |
| | | 409 | | /// <response code="400">User policy was not supplied.</response> |
| | | 410 | | /// <response code="403">User policy update forbidden.</response> |
| | | 411 | | /// <returns>A <see cref="NoContentResult"/> indicating success or a <see cref="BadRequestResult"/> or a <see cref=" |
| | | 412 | | [HttpPost("{userId}/Policy")] |
| | | 413 | | [Authorize(Policy = Policies.RequiresElevation)] |
| | | 414 | | [ProducesResponseType(StatusCodes.Status204NoContent)] |
| | | 415 | | [ProducesResponseType(StatusCodes.Status400BadRequest)] |
| | | 416 | | [ProducesResponseType(StatusCodes.Status403Forbidden)] |
| | | 417 | | public async Task<ActionResult> UpdateUserPolicy( |
| | | 418 | | [FromRoute, Required] Guid userId, |
| | | 419 | | [FromBody, Required] UserPolicy newPolicy) |
| | | 420 | | { |
| | 1 | 421 | | var user = _userManager.GetUserById(userId); |
| | 1 | 422 | | if (user is null) |
| | | 423 | | { |
| | 1 | 424 | | return NotFound(); |
| | | 425 | | } |
| | | 426 | | |
| | | 427 | | // If removing admin access |
| | 0 | 428 | | if (!newPolicy.IsAdministrator && user.HasPermission(PermissionKind.IsAdministrator)) |
| | | 429 | | { |
| | 0 | 430 | | if (_userManager.GetUsers().Count(i => i.HasPermission(PermissionKind.IsAdministrator)) == 1) |
| | | 431 | | { |
| | 0 | 432 | | return StatusCode(StatusCodes.Status403Forbidden, "There must be at least one user in the system with ad |
| | | 433 | | } |
| | | 434 | | } |
| | | 435 | | |
| | | 436 | | // If disabling |
| | 0 | 437 | | if (newPolicy.IsDisabled && user.HasPermission(PermissionKind.IsAdministrator)) |
| | | 438 | | { |
| | 0 | 439 | | return StatusCode(StatusCodes.Status403Forbidden, "Administrators cannot be disabled."); |
| | | 440 | | } |
| | | 441 | | |
| | | 442 | | // If disabling |
| | 0 | 443 | | if (newPolicy.IsDisabled && !user.HasPermission(PermissionKind.IsDisabled)) |
| | | 444 | | { |
| | 0 | 445 | | if (_userManager.GetUsers().Count(i => !i.HasPermission(PermissionKind.IsDisabled)) == 1) |
| | | 446 | | { |
| | 0 | 447 | | return StatusCode(StatusCodes.Status403Forbidden, "There must be at least one enabled user in the system |
| | | 448 | | } |
| | | 449 | | |
| | 0 | 450 | | var currentToken = User.GetToken(); |
| | 0 | 451 | | await _sessionManager.RevokeUserTokens(user.Id, currentToken).ConfigureAwait(false); |
| | | 452 | | } |
| | | 453 | | |
| | 0 | 454 | | await _userManager.UpdatePolicyAsync(userId, newPolicy).ConfigureAwait(false); |
| | | 455 | | |
| | 0 | 456 | | return NoContent(); |
| | 1 | 457 | | } |
| | | 458 | | |
| | | 459 | | /// <summary> |
| | | 460 | | /// Updates a user configuration. |
| | | 461 | | /// </summary> |
| | | 462 | | /// <param name="userId">The user id.</param> |
| | | 463 | | /// <param name="userConfig">The new user configuration.</param> |
| | | 464 | | /// <response code="204">User configuration updated.</response> |
| | | 465 | | /// <response code="403">User configuration update forbidden.</response> |
| | | 466 | | /// <returns>A <see cref="NoContentResult"/> indicating success.</returns> |
| | | 467 | | [HttpPost("Configuration")] |
| | | 468 | | [Authorize] |
| | | 469 | | [ProducesResponseType(StatusCodes.Status204NoContent)] |
| | | 470 | | [ProducesResponseType(StatusCodes.Status403Forbidden)] |
| | | 471 | | public async Task<ActionResult> UpdateUserConfiguration( |
| | | 472 | | [FromQuery] Guid? userId, |
| | | 473 | | [FromBody, Required] UserConfiguration userConfig) |
| | | 474 | | { |
| | 0 | 475 | | var requestUserId = userId ?? User.GetUserId(); |
| | 0 | 476 | | var user = _userManager.GetUserById(requestUserId); |
| | 0 | 477 | | if (user is null) |
| | | 478 | | { |
| | 0 | 479 | | return NotFound(); |
| | | 480 | | } |
| | | 481 | | |
| | 0 | 482 | | if (!RequestHelpers.AssertCanUpdateUser(User, user, true)) |
| | | 483 | | { |
| | 0 | 484 | | return StatusCode(StatusCodes.Status403Forbidden, "User configuration update not allowed"); |
| | | 485 | | } |
| | | 486 | | |
| | 0 | 487 | | await _userManager.UpdateConfigurationAsync(requestUserId, userConfig).ConfigureAwait(false); |
| | | 488 | | |
| | 0 | 489 | | return NoContent(); |
| | 0 | 490 | | } |
| | | 491 | | |
| | | 492 | | /// <summary> |
| | | 493 | | /// Updates a user configuration. |
| | | 494 | | /// </summary> |
| | | 495 | | /// <param name="userId">The user id.</param> |
| | | 496 | | /// <param name="userConfig">The new user configuration.</param> |
| | | 497 | | /// <response code="204">User configuration updated.</response> |
| | | 498 | | /// <response code="403">User configuration update forbidden.</response> |
| | | 499 | | /// <returns>A <see cref="NoContentResult"/> indicating success.</returns> |
| | | 500 | | [HttpPost("{userId}/Configuration")] |
| | | 501 | | [Authorize] |
| | | 502 | | [Obsolete("Kept for backwards compatibility")] |
| | | 503 | | [ApiExplorerSettings(IgnoreApi = true)] |
| | | 504 | | [ProducesResponseType(StatusCodes.Status204NoContent)] |
| | | 505 | | [ProducesResponseType(StatusCodes.Status403Forbidden)] |
| | | 506 | | public Task<ActionResult> UpdateUserConfigurationLegacy( |
| | | 507 | | [FromRoute, Required] Guid userId, |
| | | 508 | | [FromBody, Required] UserConfiguration userConfig) |
| | | 509 | | => UpdateUserConfiguration(userId, userConfig); |
| | | 510 | | |
| | | 511 | | /// <summary> |
| | | 512 | | /// Creates a user. |
| | | 513 | | /// </summary> |
| | | 514 | | /// <param name="request">The create user by name request body.</param> |
| | | 515 | | /// <response code="200">User created.</response> |
| | | 516 | | /// <returns>An <see cref="UserDto"/> of the new user.</returns> |
| | | 517 | | [HttpPost("New")] |
| | | 518 | | [Authorize(Policy = Policies.RequiresElevation)] |
| | | 519 | | [ProducesResponseType(StatusCodes.Status200OK)] |
| | | 520 | | public async Task<ActionResult<UserDto>> CreateUserByName([FromBody, Required] CreateUserByName request) |
| | | 521 | | { |
| | 2 | 522 | | var newUser = await _userManager.CreateUserAsync(request.Name).ConfigureAwait(false); |
| | | 523 | | |
| | | 524 | | // no need to authenticate password for new user |
| | 1 | 525 | | if (request.Password is not null) |
| | | 526 | | { |
| | 0 | 527 | | await _userManager.ChangePassword(newUser.Id, request.Password).ConfigureAwait(false); |
| | | 528 | | } |
| | | 529 | | |
| | 1 | 530 | | var result = _userManager.GetUserDto(newUser, HttpContext.GetNormalizedRemoteIP().ToString()); |
| | | 531 | | |
| | 1 | 532 | | return result; |
| | 1 | 533 | | } |
| | | 534 | | |
| | | 535 | | /// <summary> |
| | | 536 | | /// Initiates the forgot password process for a local user. |
| | | 537 | | /// </summary> |
| | | 538 | | /// <param name="forgotPasswordRequest">The forgot password request containing the entered username.</param> |
| | | 539 | | /// <response code="200">Password reset process started.</response> |
| | | 540 | | /// <returns>A <see cref="Task"/> containing a <see cref="ForgotPasswordResult"/>.</returns> |
| | | 541 | | [HttpPost("ForgotPassword")] |
| | | 542 | | [ProducesResponseType(StatusCodes.Status200OK)] |
| | | 543 | | [Tags("Authentication")] |
| | | 544 | | public async Task<ActionResult<ForgotPasswordResult>> ForgotPassword([FromBody, Required] ForgotPasswordDto forgotPa |
| | | 545 | | { |
| | 0 | 546 | | var ip = HttpContext.GetNormalizedRemoteIP(); |
| | 0 | 547 | | var isLocal = HttpContext.IsLocal() |
| | 0 | 548 | | || _networkManager.IsInLocalNetwork(ip); |
| | | 549 | | |
| | 0 | 550 | | if (!isLocal) |
| | | 551 | | { |
| | 0 | 552 | | _logger.LogWarning("Password reset process initiated from outside the local network with IP: {IP}", ip); |
| | | 553 | | } |
| | | 554 | | |
| | 0 | 555 | | var result = await _userManager.StartForgotPasswordProcess(forgotPasswordRequest.EnteredUsername, isLocal).Confi |
| | | 556 | | |
| | 0 | 557 | | return result; |
| | 0 | 558 | | } |
| | | 559 | | |
| | | 560 | | /// <summary> |
| | | 561 | | /// Redeems a forgot password pin. |
| | | 562 | | /// </summary> |
| | | 563 | | /// <param name="forgotPasswordPinRequest">The forgot password pin request containing the entered pin.</param> |
| | | 564 | | /// <response code="200">Pin reset process started.</response> |
| | | 565 | | /// <returns>A <see cref="Task"/> containing a <see cref="PinRedeemResult"/>.</returns> |
| | | 566 | | [HttpPost("ForgotPassword/Pin")] |
| | | 567 | | [ProducesResponseType(StatusCodes.Status200OK)] |
| | | 568 | | [Tags("Authentication")] |
| | | 569 | | public async Task<ActionResult<PinRedeemResult>> ForgotPasswordPin([FromBody, Required] ForgotPasswordPinDto forgotP |
| | | 570 | | { |
| | 0 | 571 | | var result = await _userManager.RedeemPasswordResetPin(forgotPasswordPinRequest.Pin).ConfigureAwait(false); |
| | 0 | 572 | | return result; |
| | 0 | 573 | | } |
| | | 574 | | |
| | | 575 | | /// <summary> |
| | | 576 | | /// Gets the user based on auth token. |
| | | 577 | | /// </summary> |
| | | 578 | | /// <response code="200">User returned.</response> |
| | | 579 | | /// <response code="400">Token is not owned by a user.</response> |
| | | 580 | | /// <returns>A <see cref="UserDto"/> for the authenticated user.</returns> |
| | | 581 | | [HttpGet("Me")] |
| | | 582 | | [Authorize] |
| | | 583 | | [ProducesResponseType(StatusCodes.Status200OK)] |
| | | 584 | | [ProducesResponseType(StatusCodes.Status400BadRequest)] |
| | | 585 | | public ActionResult<UserDto> GetCurrentUser() |
| | | 586 | | { |
| | 17 | 587 | | var userId = User.GetUserId(); |
| | 17 | 588 | | if (userId.IsEmpty()) |
| | | 589 | | { |
| | 0 | 590 | | return BadRequest(); |
| | | 591 | | } |
| | | 592 | | |
| | 17 | 593 | | var user = _userManager.GetUserById(userId); |
| | 17 | 594 | | if (user is null) |
| | | 595 | | { |
| | 0 | 596 | | return BadRequest(); |
| | | 597 | | } |
| | | 598 | | |
| | 17 | 599 | | return _userManager.GetUserDto(user); |
| | | 600 | | } |
| | | 601 | | |
| | | 602 | | private IEnumerable<UserDto> Get(bool? isHidden, bool? isDisabled, bool filterByDevice, bool filterByNetwork) |
| | | 603 | | { |
| | 2 | 604 | | var users = _userManager.GetUsers(); |
| | | 605 | | |
| | 2 | 606 | | if (isDisabled.HasValue) |
| | | 607 | | { |
| | 1 | 608 | | users = users.Where(i => i.HasPermission(PermissionKind.IsDisabled) == isDisabled.Value); |
| | | 609 | | } |
| | | 610 | | |
| | 2 | 611 | | if (isHidden.HasValue) |
| | | 612 | | { |
| | 1 | 613 | | users = users.Where(i => i.HasPermission(PermissionKind.IsHidden) == isHidden.Value); |
| | | 614 | | } |
| | | 615 | | |
| | 2 | 616 | | if (filterByDevice) |
| | | 617 | | { |
| | 0 | 618 | | var deviceId = User.GetDeviceId(); |
| | | 619 | | |
| | 0 | 620 | | if (!string.IsNullOrWhiteSpace(deviceId)) |
| | | 621 | | { |
| | 0 | 622 | | users = users.Where(i => _deviceManager.CanAccessDevice(i, deviceId)); |
| | | 623 | | } |
| | | 624 | | } |
| | | 625 | | |
| | 2 | 626 | | if (filterByNetwork) |
| | | 627 | | { |
| | 0 | 628 | | if (!_networkManager.IsInLocalNetwork(HttpContext.GetNormalizedRemoteIP())) |
| | | 629 | | { |
| | 0 | 630 | | users = users.Where(i => i.HasPermission(PermissionKind.EnableRemoteAccess)); |
| | | 631 | | } |
| | | 632 | | } |
| | | 633 | | |
| | 2 | 634 | | var result = users |
| | 2 | 635 | | .OrderBy(u => u.Username) |
| | 2 | 636 | | .Select(i => _userManager.GetUserDto(i, HttpContext.GetNormalizedRemoteIP().ToString())); |
| | | 637 | | |
| | 2 | 638 | | return result; |
| | | 639 | | } |
| | | 640 | | } |