RestListener.cs 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563
  1. using System.Net;
  2. using System.Reflection;
  3. using System.Security.Cryptography.X509Certificates;
  4. using GenHTTP.Api.Content;
  5. using GenHTTP.Api.Infrastructure;
  6. using GenHTTP.Api.Protocol;
  7. using GenHTTP.Engine;
  8. using GenHTTP.Modules.IO;
  9. using GenHTTP.Modules.IO.FileSystem;
  10. using GenHTTP.Modules.IO.Streaming;
  11. using GenHTTP.Modules.Practices;
  12. using InABox.Clients;
  13. using InABox.Core;
  14. using InABox.Database;
  15. using InABox.Remote.Shared;
  16. using InABox.Server.WebSocket;
  17. using InABox.WebSocket.Shared;
  18. using RequestMethod = GenHTTP.Api.Protocol.RequestMethod;
  19. namespace InABox.API
  20. {
  21. public class RestHandler : IHandler
  22. {
  23. private readonly List<string> endpoints;
  24. private readonly List<string> operations;
  25. private int? WebSocketPort;
  26. public RestHandler(IHandler parent, int? webSocketPort)
  27. {
  28. WebSocketPort = webSocketPort;
  29. Parent = parent;
  30. endpoints = new();
  31. operations = new();
  32. var types = CoreUtils.TypeList(
  33. x => x.IsSubclassOf(typeof(Entity))
  34. && x.GetInterfaces().Contains(typeof(IRemotable))
  35. );
  36. var DBTypes = DbFactory.SupportedTypes();
  37. foreach (var t in types)
  38. if (DBTypes.Contains(t.EntityName().Replace(".", "_")))
  39. {
  40. operations.Add(t.EntityName().Replace(".", "_"));
  41. endpoints.Add(string.Format("List{0}", t.Name));
  42. endpoints.Add(string.Format("Load{0}", t.Name));
  43. endpoints.Add(string.Format("Save{0}", t.Name));
  44. endpoints.Add(string.Format("MultiSave{0}", t.Name));
  45. endpoints.Add(string.Format("Delete{0}", t.Name));
  46. endpoints.Add(string.Format("MultiDelete{0}", t.Name));
  47. }
  48. endpoints.Add("QueryMultiple");
  49. }
  50. private RequestData GetRequestData(IRequest request)
  51. {
  52. var data = new RequestData();
  53. if (request.Query.TryGetValue("format", out var formatString) && Enum.TryParse<SerializationFormat>(formatString, out var format))
  54. {
  55. data.RequestFormat = format;
  56. }
  57. return data;
  58. }
  59. /// <summary>
  60. /// The main handler for the server; an HTTP request comes in, an HTTP response goes out.
  61. /// </summary>
  62. /// <param name="request"></param>
  63. /// <returns></returns>
  64. public ValueTask<IResponse?> HandleAsync(IRequest request)
  65. {
  66. try
  67. {
  68. switch (request.Method.KnownMethod)
  69. {
  70. case RequestMethod.GET:
  71. case RequestMethod.HEAD:
  72. var current = request.Target.Current?.Value;
  73. if (String.Equals(current,"update"))
  74. {
  75. request.Target.Advance();
  76. current = request.Target.Current?.Value;
  77. }
  78. switch (current)
  79. {
  80. case "operations" or "supported_operations":
  81. return new ValueTask<IResponse?>(GetSupportedOperations(request).Build());
  82. case "classes" or "supported_classes":
  83. return new ValueTask<IResponse?>(GetSupportedClasses(request).Build());
  84. case "version" or "releasenotes" or "release_notes" or "install" or "install_desktop":
  85. return new ValueTask<IResponse?>(GetUpdateFile(request).Build());
  86. case "info":
  87. return new ValueTask<IResponse?>(GetServerInfo(request).Build());
  88. }
  89. Logger.Send(LogType.Error, request.Client.IPAddress.ToString(),
  90. string.Format("GET/HEAD request to endpoint '{0}' is unresolved, because it does not exist", current));
  91. return new ValueTask<IResponse?>(request.Respond().Status(ResponseStatus.NotFound).Build());
  92. case RequestMethod.POST:
  93. var target = request.Target.Current;
  94. if (target is not null)
  95. {
  96. var data = GetRequestData(request);
  97. return target.Value switch
  98. {
  99. "validate" => new ValueTask<IResponse?>(Validate(request, data).Build()),
  100. "check_2fa" => new ValueTask<IResponse?>(Check2FA(request, data).Build()),
  101. "notify" => new ValueTask<IResponse?>(GetNotify(request, data).Build()),
  102. _ => HandleDatabaseRequest(request),
  103. };
  104. }
  105. return new ValueTask<IResponse?>(request.Respond().Status(ResponseStatus.NotFound).Build());
  106. }
  107. return new ValueTask<IResponse?>(request.Respond().Status(ResponseStatus.MethodNotAllowed).Header("Allow", "GET, POST, HEAD").Build());
  108. }
  109. catch(Exception e)
  110. {
  111. Logger.Send(LogType.Error, "", CoreUtils.FormatException(e));
  112. return new ValueTask<IResponse?>(request.Respond().Status(ResponseStatus.InternalServerError).Build());
  113. }
  114. }
  115. /// <summary>
  116. /// Returns a JSON list of operation names; used for checking support of operations client side
  117. /// </summary>
  118. /// <param name="request"></param>
  119. /// <returns></returns>
  120. private IResponseBuilder GetSupportedOperations(IRequest request)
  121. {
  122. var serialized = Core.Serialization.Serialize(endpoints, true) ?? "";
  123. return request.Respond()
  124. .Type(new FlexibleContentType(ContentType.ApplicationJson))
  125. .Content(new ResourceContent(Resource.FromString(serialized).Build()));
  126. }
  127. /// <summary>
  128. /// Returns a JSON list of class names; used for checking support of operations client side
  129. /// </summary>
  130. /// <param name="request"></param>
  131. /// <returns></returns>
  132. private IResponseBuilder GetSupportedClasses(IRequest request)
  133. {
  134. var serialized = Serialization.Serialize(operations) ?? "";
  135. return request.Respond()
  136. .Type(new FlexibleContentType(ContentType.ApplicationJson))
  137. .Content(new ResourceContent(Resource.FromString(serialized).Build()));
  138. }
  139. /// <summary>
  140. /// Returns the Splash Logo and Color Scheme for this Database
  141. /// </summary>
  142. /// <param name="request"></param>
  143. /// <returns></returns>
  144. private IResponseBuilder GetServerInfo(IRequest request)
  145. {
  146. InfoResponse response = RestService.Info(new InfoRequest());
  147. var serialized = Core.Serialization.Serialize(response, true) ?? "";
  148. return request.Respond()
  149. .Type(new FlexibleContentType(ContentType.ApplicationJson))
  150. .Content(new ResourceContent(Resource.FromString(serialized).Build()));
  151. }
  152. /// <summary>
  153. /// Gets port for web socket
  154. /// </summary>
  155. /// <param name="request"></param>
  156. /// <returns></returns>
  157. private IResponseBuilder GetNotify(IRequest request, RequestData data)
  158. {
  159. var requestObj = Deserialize<NotifyRequest>(request.Content, data.RequestFormat, true);
  160. if (!CredentialsCache.SessionExists(requestObj.Credentials.Session))
  161. {
  162. return request.Respond().Status(ResponseStatus.NotFound);
  163. }
  164. var response = new NotifyResponse
  165. {
  166. Status = StatusCode.OK,
  167. SocketPort = WebSocketPort
  168. };
  169. var serialized = Serialization.Serialize(response);
  170. return request.Respond()
  171. .Type(new FlexibleContentType(ContentType.ApplicationJson))
  172. .Content(new ResourceContent(Resource.FromString(serialized).Build()));
  173. }
  174. #region Authentication
  175. private IResponseBuilder Validate(IRequest request, RequestData data)
  176. {
  177. var requestObj = Deserialize<ValidateRequest>(request.Content, data.RequestFormat, true);
  178. var response = RestService.Validate(requestObj);
  179. var serialized = Serialization.Serialize(response);
  180. return request.Respond()
  181. .Type(FlexibleContentType.Get(ContentType.ApplicationJson))
  182. .Content(new ResourceContent(Resource.FromString(serialized).Build()));
  183. }
  184. private IResponseBuilder Check2FA(IRequest request, RequestData data)
  185. {
  186. var requestObj = Deserialize<Check2FARequest>(request.Content, data.RequestFormat, true);
  187. var response = RestService.Check2FA(requestObj);
  188. var serialized = Serialization.Serialize(response);
  189. return request.Respond()
  190. .Type(FlexibleContentType.Get(ContentType.ApplicationJson))
  191. .Content(new ResourceContent(Resource.FromString(serialized).Build()));
  192. }
  193. #endregion
  194. #region Database
  195. private static MethodInfo GetMethod(string name) =>
  196. typeof(RestHandler).GetMethod(name, BindingFlags.NonPublic | BindingFlags.Static)
  197. ?? throw new Exception($"Invalid method '{name}'");
  198. private static readonly List<Tuple<string, MethodInfo>> methodMap = new()
  199. {
  200. new("List", GetMethod(nameof(List))),
  201. new("Save", GetMethod(nameof(Save))),
  202. new("Delete", GetMethod(nameof(Delete))),
  203. new("MultiSave", GetMethod(nameof(MultiSave))),
  204. new("MultiDelete", GetMethod(nameof(MultiDelete)))
  205. };
  206. private class RequestData
  207. {
  208. public SerializationFormat RequestFormat { get; set; }
  209. }
  210. private static QueryResponse<T> List<T>(IRequest request, RequestData data) where T : Entity, new()
  211. {
  212. var requestObject = Deserialize<QueryRequest<T>>(request.Content, data.RequestFormat, true);
  213. return RestService<T>.List(requestObject);
  214. }
  215. private static SaveResponse<T> Save<T>(IRequest request, RequestData data) where T : Entity, new()
  216. {
  217. var requestObject = Deserialize<SaveRequest<T>>(request.Content, data.RequestFormat, true);
  218. return RestService<T>.Save(requestObject);
  219. }
  220. private static DeleteResponse<T> Delete<T>(IRequest request, RequestData data) where T : Entity, new()
  221. {
  222. var requestObject = Deserialize<DeleteRequest<T>>(request.Content, data.RequestFormat, true);
  223. return RestService<T>.Delete(requestObject);
  224. }
  225. private static MultiSaveResponse<T> MultiSave<T>(IRequest request, RequestData data) where T : Entity, new()
  226. {
  227. var requestObject = Deserialize<MultiSaveRequest<T>>(request.Content, data.RequestFormat, true);
  228. return RestService<T>.MultiSave(requestObject);
  229. }
  230. private static MultiDeleteResponse<T> MultiDelete<T>(IRequest request, RequestData data) where T : Entity, new()
  231. {
  232. var requestObject = Deserialize<MultiDeleteRequest<T>>(request.Content, data.RequestFormat, true);
  233. return RestService<T>.MultiDelete(requestObject);
  234. }
  235. private static MultiQueryResponse QueryMultiple(IRequest request, RequestData data)
  236. {
  237. var requestObject = Deserialize<MultiQueryRequest>(request.Content, data.RequestFormat, true);
  238. return RestService.QueryMultiple(requestObject, false);
  239. }
  240. private static T Deserialize<T>(Stream? stream, SerializationFormat requestFormat, bool strict = false)
  241. {
  242. if (stream is null)
  243. throw new Exception("Stream is null");
  244. if (requestFormat == SerializationFormat.Binary && typeof(T).IsAssignableTo(typeof(ISerializeBinary)))
  245. {
  246. return (T)Serialization.ReadBinary(typeof(T), stream);
  247. }
  248. else
  249. {
  250. var str = new StreamReader(stream).ReadToEnd();
  251. return Serialization.Deserialize<T>(str, strict)
  252. ?? throw new Exception("Deserialization failed");
  253. }
  254. }
  255. private IResponseBuilder SerializeResponse(IRequest request, SerializationFormat responseFormat, Response? result)
  256. {
  257. if (responseFormat == SerializationFormat.Binary && result is ISerializeBinary binary)
  258. {
  259. var stream = new MemoryStream();
  260. binary.SerializeBinary(new BinaryWriter(stream));
  261. var response = request.Respond()
  262. .Type(new FlexibleContentType(ContentType.ApplicationOctetStream))
  263. .Content(stream, (ulong?)stream.Length, () => new ValueTask<ulong?>((ulong)stream.GetHashCode()));
  264. return response;
  265. }
  266. else
  267. {
  268. var serialized = Serialization.Serialize(result);
  269. var response = request.Respond()
  270. .Type(new FlexibleContentType(ContentType.ApplicationJson))
  271. .Content(new ResourceContent(Resource.FromString(serialized).Build()));
  272. return response;
  273. }
  274. }
  275. /// <summary>
  276. /// Handler for all database requests
  277. /// </summary>
  278. /// <param name="request"></param>
  279. /// <returns></returns>
  280. private ValueTask<IResponse?> HandleDatabaseRequest(IRequest request)
  281. {
  282. var responseFormat = SerializationFormat.Json;
  283. if (request.Query.TryGetValue("responseFormat", out var formatString) && Enum.TryParse<SerializationFormat>(formatString, out var format))
  284. {
  285. responseFormat = format;
  286. }
  287. var requestData = GetRequestData(request);
  288. var endpoint = request.Target.Current?.Value ?? "";
  289. if (endpoint.StartsWith("QueryMultiple"))
  290. {
  291. var result = QueryMultiple(request, requestData);
  292. return new ValueTask<IResponse?>(SerializeResponse(request, responseFormat, result).Build());
  293. }
  294. foreach (var (name, method) in methodMap)
  295. if (endpoint.Length > name.Length && endpoint.StartsWith(name))
  296. {
  297. var entityName = endpoint[name.Length..];
  298. var entityType = GetEntity(entityName);
  299. if (entityType != null)
  300. {
  301. if (entityType.IsAssignableTo(typeof(ISecure)))
  302. {
  303. Logger.Send(LogType.Error, "", $"{entityType} is a secure entity. Request failed from IP {request.Client.IPAddress}");
  304. return new ValueTask<IResponse?>(request.Respond().Status(ResponseStatus.NotFound).Build());
  305. }
  306. var resolvedMethod = method.MakeGenericMethod(entityType);
  307. var result = resolvedMethod.Invoke(null, new object[] { request, requestData }) as Response;
  308. return new ValueTask<IResponse?>(SerializeResponse(request, responseFormat, result).Build());
  309. }
  310. Logger.Send(LogType.Error, request.Client.IPAddress.ToString(),
  311. $"Request to endpoint '{endpoint}' unresolved, because '{entityName}' is not a valid entity");
  312. return new ValueTask<IResponse?>(request.Respond().Status(ResponseStatus.NotFound).Build());
  313. }
  314. Logger.Send(LogType.Error, request.Client.IPAddress.ToString(), $"Request to endpoint '{endpoint}' unresolved, because the method does not exist");
  315. return new ValueTask<IResponse?>(request.Respond().Status(ResponseStatus.NotFound).Build());
  316. }
  317. private Dictionary<string, Type>? _persistentRemotable;
  318. private Type? GetEntity(string entityName)
  319. {
  320. _persistentRemotable ??= CoreUtils.TypeList(
  321. e => e.IsSubclassOf(typeof(Entity)) &&
  322. e.GetInterfaces().Contains(typeof(IRemotable)) &&
  323. e.GetInterfaces().Contains(typeof(IPersistent))).ToDictionary(x => x.Name, x => x);
  324. return _persistentRemotable.GetValueOrDefault(entityName);
  325. }
  326. #endregion
  327. #region Installer
  328. private IResponseBuilder GetUpdateFile(IRequest request)
  329. {
  330. var endpoint = request.Target.Current;
  331. string? filename = null;
  332. switch (endpoint?.Value)
  333. {
  334. case "version":
  335. filename = Path.Combine(CoreUtils.GetCommonAppData(), "update/version.txt");
  336. break;
  337. case "releasenotes" or "release_notes":
  338. filename = Path.Combine(CoreUtils.GetCommonAppData(), "update/Release Notes.txt");
  339. break;
  340. case "install" or "install_desktop":
  341. filename = Path.Combine(CoreUtils.GetCommonAppData(), "update/PRSDesktopSetup.exe");
  342. break;
  343. }
  344. if (filename is null) return request.Respond().Status(ResponseStatus.NotFound);
  345. if (File.Exists(filename))
  346. {
  347. return request.Respond()
  348. .Header("Content-Disposition", $"attachment; filename={Path.GetFileName(filename)}")
  349. .Content(new ResourceContent(
  350. new FileResource(new FileInfo(filename), null, null)));
  351. }
  352. return request.Respond().Status(ResponseStatus.NotFound);
  353. }
  354. #endregion
  355. #region GenHTTP stuff
  356. public IHandler Parent { get; }
  357. public ValueTask PrepareAsync()
  358. {
  359. return new ValueTask();
  360. }
  361. public IEnumerable<ContentElement> GetContent(IRequest request)
  362. {
  363. return Enumerable.Empty<ContentElement>();
  364. }
  365. #endregion
  366. }
  367. public class RestHandlerBuilder : IHandlerBuilder<RestHandlerBuilder>
  368. {
  369. private readonly List<IConcernBuilder> _Concerns = new();
  370. private int? WebSocketPort;
  371. public RestHandlerBuilder(int? webSocketPort)
  372. {
  373. WebSocketPort = webSocketPort;
  374. }
  375. public RestHandlerBuilder Add(IConcernBuilder concern)
  376. {
  377. _Concerns.Add(concern);
  378. return this;
  379. }
  380. public IHandler Build(IHandler parent)
  381. {
  382. return Concerns.Chain(parent, _Concerns, p => new RestHandler(p, WebSocketPort));
  383. }
  384. }
  385. class RestNotifier : Notifier
  386. {
  387. private WebSocketServer SocketServer;
  388. public int Port => SocketServer.Port;
  389. public RestNotifier(int port)
  390. {
  391. SocketServer = new WebSocketServer(port);
  392. SocketServer.Poll += SocketServer_Poll;
  393. }
  394. private void SocketServer_Poll(NotifyState.Session session)
  395. {
  396. Poll(session.SessionID);
  397. }
  398. public void Start()
  399. {
  400. SocketServer.Start();
  401. }
  402. public void Stop()
  403. {
  404. SocketServer.Stop();
  405. }
  406. protected override void NotifyAll<TNotification>(TNotification notification)
  407. {
  408. SocketServer.Push(notification);
  409. }
  410. protected override void NotifySession(Guid session, Type TNotification, object? notification)
  411. {
  412. SocketServer.Push(session, TNotification, notification);
  413. }
  414. protected override void NotifySession<TNotification>(Guid session, TNotification notification)
  415. {
  416. SocketServer.Push(session, notification);
  417. }
  418. protected override IEnumerable<Guid> GetUserSessions(Guid userID)
  419. {
  420. return CredentialsCache.GetUserSessions(userID);
  421. }
  422. protected override IEnumerable<Guid> GetSessions(Platform platform)
  423. {
  424. return SocketServer.GetSessions(platform);
  425. }
  426. }
  427. public static class RestListener
  428. {
  429. private static IServerHost? host;
  430. private static X509Certificate2? certificate;
  431. private static RestNotifier? notifier;
  432. public static X509Certificate2? Certificate { get => certificate; }
  433. public static void Start()
  434. {
  435. host?.Start();
  436. notifier?.Start();
  437. }
  438. public static void Stop()
  439. {
  440. host?.Stop();
  441. notifier?.Stop();
  442. }
  443. public static void InitCertificate(ushort port, X509Certificate2 certificate)
  444. {
  445. RestListener.certificate = certificate;
  446. host?.Bind(IPAddress.Any, port, certificate);
  447. }
  448. public static void InitCertificate(ushort port, string certificateFile)
  449. {
  450. InitCertificate(port, new X509Certificate2(certificateFile));
  451. }
  452. public static void InitPort(ushort port)
  453. {
  454. host?.Bind(IPAddress.Any, port);
  455. }
  456. /// <summary>
  457. /// Clears certificate and host information, and stops the listener.
  458. /// </summary>
  459. public static void Clear()
  460. {
  461. host?.Stop();
  462. host = null;
  463. notifier?.Stop();
  464. notifier = null;
  465. certificate = null;
  466. }
  467. public static void Init(int webSocketPort)
  468. {
  469. if(webSocketPort != 0)
  470. {
  471. notifier = new RestNotifier(webSocketPort);
  472. Notify.Notifier = notifier;
  473. }
  474. host = Host.Create();
  475. host.Handler(new RestHandlerBuilder(notifier?.Port))
  476. .Defaults();
  477. }
  478. }
  479. }