UserManager.cs 35 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023
  1. using MediaBrowser.Common.Events;
  2. using MediaBrowser.Common.Extensions;
  3. using MediaBrowser.Common.IO;
  4. using MediaBrowser.Common.Net;
  5. using MediaBrowser.Controller;
  6. using MediaBrowser.Controller.Configuration;
  7. using MediaBrowser.Controller.Connect;
  8. using MediaBrowser.Controller.Drawing;
  9. using MediaBrowser.Controller.Dto;
  10. using MediaBrowser.Controller.Entities;
  11. using MediaBrowser.Controller.Library;
  12. using MediaBrowser.Controller.Net;
  13. using MediaBrowser.Controller.Persistence;
  14. using MediaBrowser.Controller.Providers;
  15. using MediaBrowser.Model.Configuration;
  16. using MediaBrowser.Model.Connect;
  17. using MediaBrowser.Model.Dto;
  18. using MediaBrowser.Model.Entities;
  19. using MediaBrowser.Model.Events;
  20. using MediaBrowser.Model.Logging;
  21. using MediaBrowser.Model.Querying;
  22. using MediaBrowser.Model.Serialization;
  23. using MediaBrowser.Model.Users;
  24. using System;
  25. using System.Collections.Generic;
  26. using System.Globalization;
  27. using System.IO;
  28. using System.Linq;
  29. using System.Security.Cryptography;
  30. using System.Text;
  31. using System.Threading;
  32. using System.Threading.Tasks;
  33. namespace MediaBrowser.Server.Implementations.Library
  34. {
  35. /// <summary>
  36. /// Class UserManager
  37. /// </summary>
  38. public class UserManager : IUserManager
  39. {
  40. /// <summary>
  41. /// Gets the users.
  42. /// </summary>
  43. /// <value>The users.</value>
  44. public IEnumerable<User> Users { get; private set; }
  45. /// <summary>
  46. /// The _logger
  47. /// </summary>
  48. private readonly ILogger _logger;
  49. /// <summary>
  50. /// Gets or sets the configuration manager.
  51. /// </summary>
  52. /// <value>The configuration manager.</value>
  53. private IServerConfigurationManager ConfigurationManager { get; set; }
  54. /// <summary>
  55. /// Gets the active user repository
  56. /// </summary>
  57. /// <value>The user repository.</value>
  58. private IUserRepository UserRepository { get; set; }
  59. public event EventHandler<GenericEventArgs<User>> UserPasswordChanged;
  60. private readonly IXmlSerializer _xmlSerializer;
  61. private readonly IJsonSerializer _jsonSerializer;
  62. private readonly INetworkManager _networkManager;
  63. private readonly Func<IImageProcessor> _imageProcessorFactory;
  64. private readonly Func<IDtoService> _dtoServiceFactory;
  65. private readonly Func<IConnectManager> _connectFactory;
  66. private readonly IServerApplicationHost _appHost;
  67. private readonly IFileSystem _fileSystem;
  68. public UserManager(ILogger logger, IServerConfigurationManager configurationManager, IUserRepository userRepository, IXmlSerializer xmlSerializer, INetworkManager networkManager, Func<IImageProcessor> imageProcessorFactory, Func<IDtoService> dtoServiceFactory, Func<IConnectManager> connectFactory, IServerApplicationHost appHost, IJsonSerializer jsonSerializer, IFileSystem fileSystem)
  69. {
  70. _logger = logger;
  71. UserRepository = userRepository;
  72. _xmlSerializer = xmlSerializer;
  73. _networkManager = networkManager;
  74. _imageProcessorFactory = imageProcessorFactory;
  75. _dtoServiceFactory = dtoServiceFactory;
  76. _connectFactory = connectFactory;
  77. _appHost = appHost;
  78. _jsonSerializer = jsonSerializer;
  79. _fileSystem = fileSystem;
  80. ConfigurationManager = configurationManager;
  81. Users = new List<User>();
  82. DeletePinFile();
  83. }
  84. #region UserUpdated Event
  85. /// <summary>
  86. /// Occurs when [user updated].
  87. /// </summary>
  88. public event EventHandler<GenericEventArgs<User>> UserUpdated;
  89. public event EventHandler<GenericEventArgs<User>> UserConfigurationUpdated;
  90. public event EventHandler<GenericEventArgs<User>> UserLockedOut;
  91. /// <summary>
  92. /// Called when [user updated].
  93. /// </summary>
  94. /// <param name="user">The user.</param>
  95. private void OnUserUpdated(User user)
  96. {
  97. EventHelper.FireEventIfNotNull(UserUpdated, this, new GenericEventArgs<User> { Argument = user }, _logger);
  98. }
  99. #endregion
  100. #region UserDeleted Event
  101. /// <summary>
  102. /// Occurs when [user deleted].
  103. /// </summary>
  104. public event EventHandler<GenericEventArgs<User>> UserDeleted;
  105. /// <summary>
  106. /// Called when [user deleted].
  107. /// </summary>
  108. /// <param name="user">The user.</param>
  109. private void OnUserDeleted(User user)
  110. {
  111. EventHelper.QueueEventIfNotNull(UserDeleted, this, new GenericEventArgs<User> { Argument = user }, _logger);
  112. }
  113. #endregion
  114. /// <summary>
  115. /// Gets a User by Id
  116. /// </summary>
  117. /// <param name="id">The id.</param>
  118. /// <returns>User.</returns>
  119. /// <exception cref="System.ArgumentNullException"></exception>
  120. public User GetUserById(Guid id)
  121. {
  122. if (id == Guid.Empty)
  123. {
  124. throw new ArgumentNullException("id");
  125. }
  126. return Users.FirstOrDefault(u => u.Id == id);
  127. }
  128. /// <summary>
  129. /// Gets the user by identifier.
  130. /// </summary>
  131. /// <param name="id">The identifier.</param>
  132. /// <returns>User.</returns>
  133. public User GetUserById(string id)
  134. {
  135. return GetUserById(new Guid(id));
  136. }
  137. public User GetUserByName(string name)
  138. {
  139. if (string.IsNullOrWhiteSpace(name))
  140. {
  141. throw new ArgumentNullException("name");
  142. }
  143. return Users.FirstOrDefault(u => string.Equals(u.Name, name, StringComparison.OrdinalIgnoreCase));
  144. }
  145. public async Task Initialize()
  146. {
  147. Users = await LoadUsers().ConfigureAwait(false);
  148. var users = Users.ToList();
  149. // If there are no local users with admin rights, make them all admins
  150. if (!users.Any(i => i.Policy.IsAdministrator))
  151. {
  152. foreach (var user in users)
  153. {
  154. if (!user.ConnectLinkType.HasValue || user.ConnectLinkType.Value == UserLinkType.LinkedUser)
  155. {
  156. user.Policy.IsAdministrator = true;
  157. await UpdateUserPolicy(user, user.Policy, false).ConfigureAwait(false);
  158. }
  159. }
  160. }
  161. }
  162. public Task<bool> AuthenticateUser(string username, string passwordSha1, string remoteEndPoint)
  163. {
  164. return AuthenticateUser(username, passwordSha1, null, remoteEndPoint);
  165. }
  166. public bool IsValidUsername(string username)
  167. {
  168. // Usernames can contain letters (a-z), numbers (0-9), dashes (-), underscores (_), apostrophes ('), and periods (.)
  169. return username.All(IsValidUsernameCharacter);
  170. }
  171. private bool IsValidUsernameCharacter(char i)
  172. {
  173. return char.IsLetterOrDigit(i) || char.Equals(i, '-') || char.Equals(i, '_') || char.Equals(i, '\'') ||
  174. char.Equals(i, '.');
  175. }
  176. public string MakeValidUsername(string username)
  177. {
  178. if (IsValidUsername(username))
  179. {
  180. return username;
  181. }
  182. // Usernames can contain letters (a-z), numbers (0-9), dashes (-), underscores (_), apostrophes ('), and periods (.)
  183. var builder = new StringBuilder();
  184. foreach (var c in username)
  185. {
  186. if (IsValidUsernameCharacter(c))
  187. {
  188. builder.Append(c);
  189. }
  190. }
  191. return builder.ToString();
  192. }
  193. public async Task<bool> AuthenticateUser(string username, string passwordSha1, string passwordMd5, string remoteEndPoint)
  194. {
  195. if (string.IsNullOrWhiteSpace(username))
  196. {
  197. throw new ArgumentNullException("username");
  198. }
  199. var user = Users
  200. .FirstOrDefault(i => string.Equals(username, i.Name, StringComparison.OrdinalIgnoreCase));
  201. if (user == null)
  202. {
  203. throw new SecurityException("Invalid username or password entered.");
  204. }
  205. if (user.Policy.IsDisabled)
  206. {
  207. throw new SecurityException(string.Format("The {0} account is currently disabled. Please consult with your administrator.", user.Name));
  208. }
  209. var success = false;
  210. // Authenticate using local credentials if not a guest
  211. if (!user.ConnectLinkType.HasValue || user.ConnectLinkType.Value != UserLinkType.Guest)
  212. {
  213. success = string.Equals(GetPasswordHash(user), passwordSha1.Replace("-", string.Empty), StringComparison.OrdinalIgnoreCase);
  214. if (!success && _networkManager.IsInLocalNetwork(remoteEndPoint) && user.Configuration.EnableLocalPassword)
  215. {
  216. success = string.Equals(GetLocalPasswordHash(user), passwordSha1.Replace("-", string.Empty), StringComparison.OrdinalIgnoreCase);
  217. }
  218. }
  219. // Update LastActivityDate and LastLoginDate, then save
  220. if (success)
  221. {
  222. user.LastActivityDate = user.LastLoginDate = DateTime.UtcNow;
  223. await UpdateUser(user).ConfigureAwait(false);
  224. await UpdateInvalidLoginAttemptCount(user, 0).ConfigureAwait(false);
  225. }
  226. else
  227. {
  228. await UpdateInvalidLoginAttemptCount(user, user.Policy.InvalidLoginAttemptCount + 1).ConfigureAwait(false);
  229. }
  230. _logger.Info("Authentication request for {0} {1}.", user.Name, (success ? "has succeeded" : "has been denied"));
  231. return success;
  232. }
  233. private async Task UpdateInvalidLoginAttemptCount(User user, int newValue)
  234. {
  235. if (user.Policy.InvalidLoginAttemptCount != newValue || newValue > 0)
  236. {
  237. user.Policy.InvalidLoginAttemptCount = newValue;
  238. var maxCount = user.Policy.IsAdministrator ?
  239. 3 :
  240. 5;
  241. var fireLockout = false;
  242. if (newValue >= maxCount)
  243. {
  244. _logger.Debug("Disabling user {0} due to {1} unsuccessful login attempts.", user.Name, newValue.ToString(CultureInfo.InvariantCulture));
  245. user.Policy.IsDisabled = true;
  246. fireLockout = true;
  247. }
  248. await UpdateUserPolicy(user, user.Policy, false).ConfigureAwait(false);
  249. if (fireLockout)
  250. {
  251. if (UserLockedOut != null)
  252. {
  253. EventHelper.FireEventIfNotNull(UserLockedOut, this, new GenericEventArgs<User>(user), _logger);
  254. }
  255. }
  256. }
  257. }
  258. private string GetPasswordHash(User user)
  259. {
  260. return string.IsNullOrEmpty(user.Password)
  261. ? GetSha1String(string.Empty)
  262. : user.Password;
  263. }
  264. private string GetLocalPasswordHash(User user)
  265. {
  266. return string.IsNullOrEmpty(user.EasyPassword)
  267. ? GetSha1String(string.Empty)
  268. : user.EasyPassword;
  269. }
  270. private bool IsPasswordEmpty(string passwordHash)
  271. {
  272. return string.Equals(passwordHash, GetSha1String(string.Empty), StringComparison.OrdinalIgnoreCase);
  273. }
  274. /// <summary>
  275. /// Gets the sha1 string.
  276. /// </summary>
  277. /// <param name="str">The STR.</param>
  278. /// <returns>System.String.</returns>
  279. private static string GetSha1String(string str)
  280. {
  281. using (var provider = SHA1.Create())
  282. {
  283. var hash = provider.ComputeHash(Encoding.UTF8.GetBytes(str));
  284. return BitConverter.ToString(hash).Replace("-", string.Empty);
  285. }
  286. }
  287. /// <summary>
  288. /// Loads the users from the repository
  289. /// </summary>
  290. /// <returns>IEnumerable{User}.</returns>
  291. private async Task<IEnumerable<User>> LoadUsers()
  292. {
  293. var users = UserRepository.RetrieveAllUsers().ToList();
  294. // There always has to be at least one user.
  295. if (users.Count == 0)
  296. {
  297. var name = MakeValidUsername(Environment.UserName);
  298. var user = InstantiateNewUser(name);
  299. user.DateLastSaved = DateTime.UtcNow;
  300. await UserRepository.SaveUser(user, CancellationToken.None).ConfigureAwait(false);
  301. users.Add(user);
  302. user.Policy.IsAdministrator = true;
  303. user.Policy.EnableRemoteControlOfOtherUsers = true;
  304. await UpdateUserPolicy(user, user.Policy, false).ConfigureAwait(false);
  305. }
  306. return users;
  307. }
  308. public UserDto GetUserDto(User user, string remoteEndPoint = null)
  309. {
  310. if (user == null)
  311. {
  312. throw new ArgumentNullException("user");
  313. }
  314. var passwordHash = GetPasswordHash(user);
  315. var hasConfiguredPassword = !IsPasswordEmpty(passwordHash);
  316. var hasConfiguredEasyPassword = !IsPasswordEmpty(GetLocalPasswordHash(user));
  317. var hasPassword = user.Configuration.EnableLocalPassword && !string.IsNullOrEmpty(remoteEndPoint) && _networkManager.IsInLocalNetwork(remoteEndPoint) ?
  318. hasConfiguredEasyPassword :
  319. hasConfiguredPassword;
  320. var dto = new UserDto
  321. {
  322. Id = user.Id.ToString("N"),
  323. Name = user.Name,
  324. HasPassword = hasPassword,
  325. HasConfiguredPassword = hasConfiguredPassword,
  326. HasConfiguredEasyPassword = hasConfiguredEasyPassword,
  327. LastActivityDate = user.LastActivityDate,
  328. LastLoginDate = user.LastLoginDate,
  329. Configuration = user.Configuration,
  330. ConnectLinkType = user.ConnectLinkType,
  331. ConnectUserId = user.ConnectUserId,
  332. ConnectUserName = user.ConnectUserName,
  333. ServerId = _appHost.SystemId,
  334. Policy = user.Policy
  335. };
  336. var image = user.GetImageInfo(ImageType.Primary, 0);
  337. if (image != null)
  338. {
  339. dto.PrimaryImageTag = GetImageCacheTag(user, image);
  340. try
  341. {
  342. _dtoServiceFactory().AttachPrimaryImageAspectRatio(dto, user, new List<ItemFields>
  343. {
  344. ItemFields.PrimaryImageAspectRatio
  345. });
  346. }
  347. catch (Exception ex)
  348. {
  349. // Have to use a catch-all unfortunately because some .net image methods throw plain Exceptions
  350. _logger.ErrorException("Error generating PrimaryImageAspectRatio for {0}", ex, user.Name);
  351. }
  352. }
  353. return dto;
  354. }
  355. public UserDto GetOfflineUserDto(User user)
  356. {
  357. var dto = GetUserDto(user);
  358. var offlinePasswordHash = GetLocalPasswordHash(user);
  359. dto.HasPassword = !IsPasswordEmpty(offlinePasswordHash);
  360. dto.OfflinePasswordSalt = Guid.NewGuid().ToString("N");
  361. // Hash the pin with the device Id to create a unique result for this device
  362. dto.OfflinePassword = GetSha1String((offlinePasswordHash + dto.OfflinePasswordSalt).ToLower());
  363. dto.ServerName = _appHost.FriendlyName;
  364. return dto;
  365. }
  366. private string GetImageCacheTag(BaseItem item, ItemImageInfo image)
  367. {
  368. try
  369. {
  370. return _imageProcessorFactory().GetImageCacheTag(item, image);
  371. }
  372. catch (Exception ex)
  373. {
  374. _logger.ErrorException("Error getting {0} image info for {1}", ex, image.Type, image.Path);
  375. return null;
  376. }
  377. }
  378. /// <summary>
  379. /// Refreshes metadata for each user
  380. /// </summary>
  381. /// <param name="cancellationToken">The cancellation token.</param>
  382. /// <returns>Task.</returns>
  383. public Task RefreshUsersMetadata(CancellationToken cancellationToken)
  384. {
  385. var tasks = Users.Select(user => user.RefreshMetadata(new MetadataRefreshOptions(), cancellationToken)).ToList();
  386. return Task.WhenAll(tasks);
  387. }
  388. /// <summary>
  389. /// Renames the user.
  390. /// </summary>
  391. /// <param name="user">The user.</param>
  392. /// <param name="newName">The new name.</param>
  393. /// <returns>Task.</returns>
  394. /// <exception cref="System.ArgumentNullException">user</exception>
  395. /// <exception cref="System.ArgumentException"></exception>
  396. public async Task RenameUser(User user, string newName)
  397. {
  398. if (user == null)
  399. {
  400. throw new ArgumentNullException("user");
  401. }
  402. if (string.IsNullOrEmpty(newName))
  403. {
  404. throw new ArgumentNullException("newName");
  405. }
  406. if (Users.Any(u => u.Id != user.Id && u.Name.Equals(newName, StringComparison.OrdinalIgnoreCase)))
  407. {
  408. throw new ArgumentException(string.Format("A user with the name '{0}' already exists.", newName));
  409. }
  410. if (user.Name.Equals(newName, StringComparison.Ordinal))
  411. {
  412. throw new ArgumentException("The new and old names must be different.");
  413. }
  414. await user.Rename(newName);
  415. OnUserUpdated(user);
  416. }
  417. /// <summary>
  418. /// Updates the user.
  419. /// </summary>
  420. /// <param name="user">The user.</param>
  421. /// <exception cref="System.ArgumentNullException">user</exception>
  422. /// <exception cref="System.ArgumentException"></exception>
  423. public async Task UpdateUser(User user)
  424. {
  425. if (user == null)
  426. {
  427. throw new ArgumentNullException("user");
  428. }
  429. if (user.Id == Guid.Empty || !Users.Any(u => u.Id.Equals(user.Id)))
  430. {
  431. throw new ArgumentException(string.Format("User with name '{0}' and Id {1} does not exist.", user.Name, user.Id));
  432. }
  433. user.DateModified = DateTime.UtcNow;
  434. user.DateLastSaved = DateTime.UtcNow;
  435. await UserRepository.SaveUser(user, CancellationToken.None).ConfigureAwait(false);
  436. OnUserUpdated(user);
  437. }
  438. public event EventHandler<GenericEventArgs<User>> UserCreated;
  439. private readonly SemaphoreSlim _userListLock = new SemaphoreSlim(1, 1);
  440. /// <summary>
  441. /// Creates the user.
  442. /// </summary>
  443. /// <param name="name">The name.</param>
  444. /// <returns>User.</returns>
  445. /// <exception cref="System.ArgumentNullException">name</exception>
  446. /// <exception cref="System.ArgumentException"></exception>
  447. public async Task<User> CreateUser(string name)
  448. {
  449. if (string.IsNullOrWhiteSpace(name))
  450. {
  451. throw new ArgumentNullException("name");
  452. }
  453. if (!IsValidUsername(name))
  454. {
  455. throw new ArgumentException("Usernames can contain letters (a-z), numbers (0-9), dashes (-), underscores (_), apostrophes ('), and periods (.)");
  456. }
  457. if (Users.Any(u => u.Name.Equals(name, StringComparison.OrdinalIgnoreCase)))
  458. {
  459. throw new ArgumentException(string.Format("A user with the name '{0}' already exists.", name));
  460. }
  461. await _userListLock.WaitAsync(CancellationToken.None).ConfigureAwait(false);
  462. try
  463. {
  464. var user = InstantiateNewUser(name);
  465. var list = Users.ToList();
  466. list.Add(user);
  467. Users = list;
  468. user.DateLastSaved = DateTime.UtcNow;
  469. await UserRepository.SaveUser(user, CancellationToken.None).ConfigureAwait(false);
  470. EventHelper.QueueEventIfNotNull(UserCreated, this, new GenericEventArgs<User> { Argument = user }, _logger);
  471. return user;
  472. }
  473. finally
  474. {
  475. _userListLock.Release();
  476. }
  477. }
  478. /// <summary>
  479. /// Deletes the user.
  480. /// </summary>
  481. /// <param name="user">The user.</param>
  482. /// <returns>Task.</returns>
  483. /// <exception cref="System.ArgumentNullException">user</exception>
  484. /// <exception cref="System.ArgumentException"></exception>
  485. public async Task DeleteUser(User user)
  486. {
  487. if (user == null)
  488. {
  489. throw new ArgumentNullException("user");
  490. }
  491. if (user.ConnectLinkType.HasValue)
  492. {
  493. await _connectFactory().RemoveConnect(user.Id.ToString("N")).ConfigureAwait(false);
  494. }
  495. var allUsers = Users.ToList();
  496. if (allUsers.FirstOrDefault(u => u.Id == user.Id) == null)
  497. {
  498. throw new ArgumentException(string.Format("The user cannot be deleted because there is no user with the Name {0} and Id {1}.", user.Name, user.Id));
  499. }
  500. if (allUsers.Count == 1)
  501. {
  502. throw new ArgumentException(string.Format("The user '{0}' cannot be deleted because there must be at least one user in the system.", user.Name));
  503. }
  504. if (user.Policy.IsAdministrator && allUsers.Count(i => i.Policy.IsAdministrator) == 1)
  505. {
  506. throw new ArgumentException(string.Format("The user '{0}' cannot be deleted because there must be at least one admin user in the system.", user.Name));
  507. }
  508. await _userListLock.WaitAsync(CancellationToken.None).ConfigureAwait(false);
  509. try
  510. {
  511. var configPath = GetConfigurationFilePath(user);
  512. await UserRepository.DeleteUser(user, CancellationToken.None).ConfigureAwait(false);
  513. try
  514. {
  515. _fileSystem.DeleteFile(configPath);
  516. }
  517. catch (IOException ex)
  518. {
  519. _logger.ErrorException("Error deleting file {0}", ex, configPath);
  520. }
  521. DeleteUserPolicy(user);
  522. // Force this to be lazy loaded again
  523. Users = await LoadUsers().ConfigureAwait(false);
  524. OnUserDeleted(user);
  525. }
  526. finally
  527. {
  528. _userListLock.Release();
  529. }
  530. }
  531. /// <summary>
  532. /// Resets the password by clearing it.
  533. /// </summary>
  534. /// <returns>Task.</returns>
  535. public Task ResetPassword(User user)
  536. {
  537. return ChangePassword(user, GetSha1String(string.Empty));
  538. }
  539. public Task ResetEasyPassword(User user)
  540. {
  541. return ChangeEasyPassword(user, GetSha1String(string.Empty));
  542. }
  543. public async Task ChangePassword(User user, string newPasswordSha1)
  544. {
  545. if (user == null)
  546. {
  547. throw new ArgumentNullException("user");
  548. }
  549. if (string.IsNullOrWhiteSpace(newPasswordSha1))
  550. {
  551. throw new ArgumentNullException("newPasswordSha1");
  552. }
  553. if (user.ConnectLinkType.HasValue && user.ConnectLinkType.Value == UserLinkType.Guest)
  554. {
  555. throw new ArgumentException("Passwords for guests cannot be changed.");
  556. }
  557. user.Password = newPasswordSha1;
  558. await UpdateUser(user).ConfigureAwait(false);
  559. EventHelper.FireEventIfNotNull(UserPasswordChanged, this, new GenericEventArgs<User>(user), _logger);
  560. }
  561. public async Task ChangeEasyPassword(User user, string newPasswordSha1)
  562. {
  563. if (user == null)
  564. {
  565. throw new ArgumentNullException("user");
  566. }
  567. if (string.IsNullOrWhiteSpace(newPasswordSha1))
  568. {
  569. throw new ArgumentNullException("newPasswordSha1");
  570. }
  571. user.EasyPassword = newPasswordSha1;
  572. await UpdateUser(user).ConfigureAwait(false);
  573. EventHelper.FireEventIfNotNull(UserPasswordChanged, this, new GenericEventArgs<User>(user), _logger);
  574. }
  575. /// <summary>
  576. /// Instantiates the new user.
  577. /// </summary>
  578. /// <param name="name">The name.</param>
  579. /// <returns>User.</returns>
  580. private User InstantiateNewUser(string name)
  581. {
  582. return new User
  583. {
  584. Name = name,
  585. Id = Guid.NewGuid(),
  586. DateCreated = DateTime.UtcNow,
  587. DateModified = DateTime.UtcNow,
  588. UsesIdForConfigurationPath = true
  589. };
  590. }
  591. private string PasswordResetFile
  592. {
  593. get { return Path.Combine(ConfigurationManager.ApplicationPaths.ProgramDataPath, "passwordreset.txt"); }
  594. }
  595. private string _lastPin;
  596. private PasswordPinCreationResult _lastPasswordPinCreationResult;
  597. private int _pinAttempts;
  598. private PasswordPinCreationResult CreatePasswordResetPin()
  599. {
  600. var num = new Random().Next(1, 9999);
  601. var path = PasswordResetFile;
  602. var pin = num.ToString("0000", CultureInfo.InvariantCulture);
  603. _lastPin = pin;
  604. var time = TimeSpan.FromMinutes(5);
  605. var expiration = DateTime.UtcNow.Add(time);
  606. var text = new StringBuilder();
  607. var localAddress = _appHost.LocalApiUrl ?? string.Empty;
  608. text.AppendLine("Use your web browser to visit:");
  609. text.AppendLine(string.Empty);
  610. text.AppendLine(localAddress + "/web/forgotpasswordpin.html");
  611. text.AppendLine(string.Empty);
  612. text.AppendLine("Enter the following pin code:");
  613. text.AppendLine(string.Empty);
  614. text.AppendLine(pin);
  615. text.AppendLine(string.Empty);
  616. text.AppendLine("The pin code will expire at " + expiration.ToLocalTime().ToShortDateString() + " " + expiration.ToLocalTime().ToShortTimeString());
  617. File.WriteAllText(path, text.ToString(), Encoding.UTF8);
  618. var result = new PasswordPinCreationResult
  619. {
  620. PinFile = path,
  621. ExpirationDate = expiration
  622. };
  623. _lastPasswordPinCreationResult = result;
  624. _pinAttempts = 0;
  625. return result;
  626. }
  627. public ForgotPasswordResult StartForgotPasswordProcess(string enteredUsername, bool isInNetwork)
  628. {
  629. DeletePinFile();
  630. var user = string.IsNullOrWhiteSpace(enteredUsername) ?
  631. null :
  632. GetUserByName(enteredUsername);
  633. if (user != null && user.ConnectLinkType.HasValue && user.ConnectLinkType.Value == UserLinkType.Guest)
  634. {
  635. throw new ArgumentException("Unable to process forgot password request for guests.");
  636. }
  637. var action = ForgotPasswordAction.InNetworkRequired;
  638. string pinFile = null;
  639. DateTime? expirationDate = null;
  640. if (user != null && !user.Policy.IsAdministrator)
  641. {
  642. action = ForgotPasswordAction.ContactAdmin;
  643. }
  644. else
  645. {
  646. if (isInNetwork)
  647. {
  648. action = ForgotPasswordAction.PinCode;
  649. }
  650. var result = CreatePasswordResetPin();
  651. pinFile = result.PinFile;
  652. expirationDate = result.ExpirationDate;
  653. }
  654. return new ForgotPasswordResult
  655. {
  656. Action = action,
  657. PinFile = pinFile,
  658. PinExpirationDate = expirationDate
  659. };
  660. }
  661. public async Task<PinRedeemResult> RedeemPasswordResetPin(string pin)
  662. {
  663. DeletePinFile();
  664. var usersReset = new List<string>();
  665. var valid = !string.IsNullOrWhiteSpace(_lastPin) &&
  666. string.Equals(_lastPin, pin, StringComparison.OrdinalIgnoreCase) &&
  667. _lastPasswordPinCreationResult != null &&
  668. _lastPasswordPinCreationResult.ExpirationDate > DateTime.UtcNow;
  669. if (valid)
  670. {
  671. _lastPin = null;
  672. _lastPasswordPinCreationResult = null;
  673. var users = Users.Where(i => !i.ConnectLinkType.HasValue || i.ConnectLinkType.Value != UserLinkType.Guest)
  674. .ToList();
  675. foreach (var user in users)
  676. {
  677. await ResetPassword(user).ConfigureAwait(false);
  678. if (user.Policy.IsDisabled)
  679. {
  680. user.Policy.IsDisabled = false;
  681. await UpdateUserPolicy(user, user.Policy, true).ConfigureAwait(false);
  682. }
  683. usersReset.Add(user.Name);
  684. }
  685. }
  686. else
  687. {
  688. _pinAttempts++;
  689. if (_pinAttempts >= 3)
  690. {
  691. _lastPin = null;
  692. _lastPasswordPinCreationResult = null;
  693. }
  694. }
  695. return new PinRedeemResult
  696. {
  697. Success = valid,
  698. UsersReset = usersReset.ToArray()
  699. };
  700. }
  701. private void DeletePinFile()
  702. {
  703. try
  704. {
  705. _fileSystem.DeleteFile(PasswordResetFile);
  706. }
  707. catch
  708. {
  709. }
  710. }
  711. class PasswordPinCreationResult
  712. {
  713. public string PinFile { get; set; }
  714. public DateTime ExpirationDate { get; set; }
  715. }
  716. public UserPolicy GetUserPolicy(User user)
  717. {
  718. var path = GetPolifyFilePath(user);
  719. try
  720. {
  721. lock (_policySyncLock)
  722. {
  723. return (UserPolicy)_xmlSerializer.DeserializeFromFile(typeof(UserPolicy), path);
  724. }
  725. }
  726. catch (DirectoryNotFoundException)
  727. {
  728. return GetDefaultPolicy(user);
  729. }
  730. catch (FileNotFoundException)
  731. {
  732. return GetDefaultPolicy(user);
  733. }
  734. catch (Exception ex)
  735. {
  736. _logger.ErrorException("Error reading policy file: {0}", ex, path);
  737. return GetDefaultPolicy(user);
  738. }
  739. }
  740. private UserPolicy GetDefaultPolicy(User user)
  741. {
  742. return new UserPolicy
  743. {
  744. EnableSync = true
  745. };
  746. }
  747. private readonly object _policySyncLock = new object();
  748. public Task UpdateUserPolicy(string userId, UserPolicy userPolicy)
  749. {
  750. var user = GetUserById(userId);
  751. return UpdateUserPolicy(user, userPolicy, true);
  752. }
  753. private async Task UpdateUserPolicy(User user, UserPolicy userPolicy, bool fireEvent)
  754. {
  755. // The xml serializer will output differently if the type is not exact
  756. if (userPolicy.GetType() != typeof(UserPolicy))
  757. {
  758. var json = _jsonSerializer.SerializeToString(userPolicy);
  759. userPolicy = _jsonSerializer.DeserializeFromString<UserPolicy>(json);
  760. }
  761. var path = GetPolifyFilePath(user);
  762. Directory.CreateDirectory(Path.GetDirectoryName(path));
  763. lock (_policySyncLock)
  764. {
  765. _xmlSerializer.SerializeToFile(userPolicy, path);
  766. user.Policy = userPolicy;
  767. }
  768. await UpdateConfiguration(user, user.Configuration, true).ConfigureAwait(false);
  769. }
  770. private void DeleteUserPolicy(User user)
  771. {
  772. var path = GetPolifyFilePath(user);
  773. try
  774. {
  775. lock (_policySyncLock)
  776. {
  777. _fileSystem.DeleteFile(path);
  778. }
  779. }
  780. catch (IOException)
  781. {
  782. }
  783. catch (Exception ex)
  784. {
  785. _logger.ErrorException("Error deleting policy file", ex);
  786. }
  787. }
  788. private string GetPolifyFilePath(User user)
  789. {
  790. return Path.Combine(user.ConfigurationDirectoryPath, "policy.xml");
  791. }
  792. private string GetConfigurationFilePath(User user)
  793. {
  794. return Path.Combine(user.ConfigurationDirectoryPath, "config.xml");
  795. }
  796. public UserConfiguration GetUserConfiguration(User user)
  797. {
  798. var path = GetConfigurationFilePath(user);
  799. try
  800. {
  801. lock (_configSyncLock)
  802. {
  803. return (UserConfiguration)_xmlSerializer.DeserializeFromFile(typeof(UserConfiguration), path);
  804. }
  805. }
  806. catch (DirectoryNotFoundException)
  807. {
  808. return new UserConfiguration();
  809. }
  810. catch (FileNotFoundException)
  811. {
  812. return new UserConfiguration();
  813. }
  814. catch (Exception ex)
  815. {
  816. _logger.ErrorException("Error reading policy file: {0}", ex, path);
  817. return new UserConfiguration();
  818. }
  819. }
  820. private readonly object _configSyncLock = new object();
  821. public Task UpdateConfiguration(string userId, UserConfiguration config)
  822. {
  823. var user = GetUserById(userId);
  824. return UpdateConfiguration(user, config, true);
  825. }
  826. private async Task UpdateConfiguration(User user, UserConfiguration config, bool fireEvent)
  827. {
  828. var path = GetConfigurationFilePath(user);
  829. // The xml serializer will output differently if the type is not exact
  830. if (config.GetType() != typeof(UserConfiguration))
  831. {
  832. var json = _jsonSerializer.SerializeToString(config);
  833. config = _jsonSerializer.DeserializeFromString<UserConfiguration>(json);
  834. }
  835. Directory.CreateDirectory(Path.GetDirectoryName(path));
  836. lock (_configSyncLock)
  837. {
  838. _xmlSerializer.SerializeToFile(config, path);
  839. user.Configuration = config;
  840. }
  841. if (fireEvent)
  842. {
  843. EventHelper.FireEventIfNotNull(UserConfigurationUpdated, this, new GenericEventArgs<User> { Argument = user }, _logger);
  844. }
  845. }
  846. }
  847. }