DeviceServlet.java

  1. /*
  2.  * Copyright (C) 2020-2024 by Savoir-faire Linux
  3.  *
  4.  * This program is free software; you can redistribute it and/or modify
  5.  * it under the terms of the GNU General Public License as published by
  6.  * the Free Software Foundation; either version 3 of the License, or
  7.  * (at your option) any later version.
  8.  *
  9.  * This program is distributed in the hope that it will be useful,
  10.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12.  * GNU General Public License for more details.
  13.  *
  14.  * You should have received a copy of the GNU General Public License
  15.  * along with this program.  If not, see <https://www.gnu.org/licenses/>.
  16.  */
  17. package net.jami.jams.server.servlets.api.auth.device;

  19. import static net.jami.jams.server.Server.certificateAuthority;
  20. import static net.jami.jams.server.Server.dataStore;

  22. import com.google.gson.Gson;
  23. import com.google.gson.JsonObject;

  25. import jakarta.servlet.ServletException;
  26. import jakarta.servlet.annotation.WebServlet;
  27. import jakarta.servlet.http.HttpServlet;
  28. import jakarta.servlet.http.HttpServletRequest;
  29. import jakarta.servlet.http.HttpServletResponse;

  31. import net.jami.jams.common.annotations.ScopedServletMethod;
  32. import net.jami.jams.common.objects.devices.Device;
  33. import net.jami.jams.common.objects.requests.DeviceRegistrationRequest;
  34. import net.jami.jams.common.objects.responses.DeviceRegistrationResponse;
  35. import net.jami.jams.common.objects.responses.DeviceRevocationResponse;
  36. import net.jami.jams.common.objects.user.AccessLevel;
  37. import net.jami.jams.common.serialization.adapters.GsonFactory;
  38. import net.jami.jams.common.serialization.tomcat.TomcatCustomErrorHandler;
  39. import net.jami.jams.server.core.workflows.RegisterDeviceFlow;
  40. import net.jami.jams.server.core.workflows.RevokeDeviceFlow;

  42. import java.io.IOException;

  44. @WebServlet("/api/auth/device/*")
  45. public class DeviceServlet extends HttpServlet {
  46.     private final Gson gson = GsonFactory.createGson();

  48.     /**
  49.      * @apiVersion 1.0.0
  50.      * @api {get} /api/auth/device Get device info
  51.      * @apiName getDevice
  52.      * @apiGroup Device
  53.      * @apiParam {path} deviceId id of the device
  54.      * @apiSuccess (200) {body} Device device information
  55.      * @apiSuccessExample {json} Success-Response: { "certificate":"pem_encoded_certificate",
  56.      *     "displayName":"My Galaxy S8", "deviceId":"6aec6252ad", "revoked":true }
  57.      * @apiError (500) {null} null Device was unable to be retrieved
  58.      */
  59.     @Override
  60.     protected void doGet(HttpServletRequest req, HttpServletResponse resp)
  61.             throws ServletException, IOException {
  62.         String username = req.getAttribute("username").toString();
  63.         String deviceId = req.getPathInfo().replace("/", "");

  65.         Device device =
  66.                 dataStore.getDeviceDao().getByDeviceIdAndOwner(deviceId, username).orElseThrow();

  68.         if (certificateAuthority.getLatestCRL().get() != null)
  69.             device.setRevoked(
  70.                     certificateAuthority
  71.                                     .getLatestCRL()
  72.                                     .get()
  73.                                     .getRevokedCertificate(
  74.                                             device.getCertificate().getSerialNumber())
  75.                             != null);
  76.         else device.setRevoked(false);

  78.         resp.getOutputStream().write(gson.toJson(device).getBytes());
  79.         resp.flushBuffer();
  80.     }

  82.     /**
  83.      * @apiVersion 1.0.0
  84.      * @api {post} /api/auth/device Enroll a device
  85.      * @apiName postDevice
  86.      * @apiGroup Device
  87.      * @apiParam {body} DeviceRegistrationRequest device registration request
  88.      * @apiParamExample {json} Request-Example: { "csr":"pem_encoded_csr", "deviceName":"My Galaxy
  89.      *     S8" }
  90.      * @apiSuccess (200) {body} DeviceRegistrationResponse registration response
  91.      * @apiError (500) {null} null Device was unable to be enrolled
  92.      * @apiSuccessExample {json} Success-Response: {
  93.      *     "certificateChain":"pem_encoded_certificate_chain", "displayName":"John Doe",
  94.      *     "nameServer":"https://mydomain.com", "deviceReceipt": "device_receipt_object",
  95.      *     "receiptSignature":"receipt_signature_object", "userPhoto":"base64_encoded_photo" }
  96.      */
  97.     @Override
  98.     @ScopedServletMethod(securityGroups = {AccessLevel.USER})
  99.     protected void doPost(HttpServletRequest req, HttpServletResponse resp) throws IOException {
  100.         Gson gson = GsonFactory.createGson();
  101.         String username = req.getAttribute("username").toString();

  103.         DeviceRegistrationRequest request =
  104.                 gson.fromJson(req.getReader(), DeviceRegistrationRequest.class);
  105.         DeviceRegistrationResponse devResponse =
  106.                 RegisterDeviceFlow.registerDevice(username, request);

  108.         if (devResponse == null) {
  109.             TomcatCustomErrorHandler.sendCustomError(
  110.                     resp, 500, "A server error occurred while enrolling the device.");
  111.             return;
  112.         }

  114.         String filteredJson = gson.toJson(devResponse);
  115.         JsonObject obj = gson.fromJson(filteredJson, JsonObject.class);

  117.         renameKeys(obj);

  119.         resp.getOutputStream().write((obj.toString()).getBytes());
  120.         resp.flushBuffer();
  121.     }

  123.     /**
  124.      * Modifies in place obj to rename a key
  125.      *
  126.      * @param obj
  127.      * @param oldKey
  128.      * @param newKey
  129.      */
  130.     private static void renameKey(JsonObject obj, String oldKey, String newKey) {
  131.         if (obj.get(oldKey) != null) {
  132.             obj.add(newKey, obj.get(oldKey));
  133.             obj.remove(oldKey);
  134.         }
  135.     }

  137.     /**
  138.      * Modifies in place obj to rename keys
  139.      *
  140.      * @param obj
  141.      */
  142.     public static void renameKeys(JsonObject obj) {
  143.         renameKey(obj, "videoEnabled", "Account.videoEnabled");
  144.         renameKey(obj, "publicInCalls", "DHTRelay.PublicInCalls");
  145.         renameKey(obj, "autoAnswer", "Account.autoAnswer");
  146.         renameKey(obj, "peerDiscovery", "Account.peerDiscovery");
  147.         renameKey(obj, "accountDiscovery", "Account.accountDiscovery");
  148.         renameKey(obj, "accountPublish", "Account.accountPublish");

  150.         renameKey(obj, "rendezVous", "Account.rendezVous");
  151.         renameKey(obj, "upnpEnabled", "Account.upnpEnabled");

  153.         renameKey(obj, "turnEnabled", "TURN.enable");
  154.         renameKey(obj, "turnServer", "TURN.server");
  155.         renameKey(obj, "turnServerUserName", "TURN.username");
  156.         renameKey(obj, "turnServerPassword", "TURN.password");
  157.         renameKey(obj, "proxyEnabled", "Account.proxyEnabled");
  158.         renameKey(obj, "proxyServer", "Account.proxyServer");
  159.         renameKey(obj, "dhtProxyListUrl", "Account.dhtProxyListUrl");
  160.         renameKey(obj, "displayName", "Account.displayName");
  161.         renameKey(obj, "defaultModerators", "Account.defaultModerators");
  162.         renameKey(obj, "uiCustomization", "Account.uiCustomization");
  163.     }

  165.     /**
  166.      * @apiVersion 1.0.0
  167.      * @api {put} /api/auth/device Change the name of a device
  168.      * @apiName putDevice
  169.      * @apiGroup Device
  170.      * @apiParam {path} deviceId id of the device
  171.      * @apiParam {query} deviceName new name for the device
  172.      * @apiSuccess (200) {null} null name changed successfully
  173.      * @apiError (500) {null} null device name was unable to be changed
  174.      */
  175.     @Override
  176.     protected void doPut(HttpServletRequest req, HttpServletResponse resp)
  177.             throws ServletException, IOException {
  178.         String username = req.getAttribute("username").toString();
  179.         String deviceId = req.getPathInfo().replace("/", "");
  180.         String deviceName = req.getParameter("deviceName");

  182.         if (dataStore.getDeviceDao().updateObject(deviceName, username, deviceId))
  183.             resp.setStatus(200);
  184.         else
  185.             TomcatCustomErrorHandler.sendCustomError(
  186.                     resp, 500, "A server error occurred while updating the device information.");
  187.     }

  189.     /**
  190.      * @apiVersion 1.0.0
  191.      * @api {delete} /api/auth/device Deactivate a device
  192.      * @apiName deleteDevice
  193.      * @apiGroup Device
  194.      * @apiParam {path} deviceId id of the device
  195.      * @apiSuccess (200) {null} null device deactivated successfully
  196.      * @apiError (500) {null} null device was unable to be deactivated
  197.      */
  198.     @Override
  199.     @ScopedServletMethod(securityGroups = {AccessLevel.USER})
  200.     protected void doDelete(HttpServletRequest req, HttpServletResponse resp)
  201.             throws ServletException, IOException {
  202.         String deviceId = req.getPathInfo().replace("/", "");
  203.         // If the device does not belong to the user throw a 403
  204.         String owner = req.getAttribute("username").toString();

  206.         long deviceIdCount =
  207.                 dataStore.getDeviceDao().getByOwner(owner).stream()
  208.                         .filter(device -> device.getDeviceId().equals(deviceId))
  209.                         .count();

  211.         if (deviceIdCount == 0) {
  212.             TomcatCustomErrorHandler.sendCustomError(
  213.                     resp, 403, "You do not have sufficient rights to revoke this device!");
  214.             return;
  215.         }

  217.         DeviceRevocationResponse devResponse = RevokeDeviceFlow.revokeDevice(owner, deviceId);
  218.         if (devResponse != null) {
  219.             resp.getOutputStream().write(gson.toJson(devResponse).getBytes());
  220.             resp.flushBuffer();
  221.         } else
  222.             TomcatCustomErrorHandler.sendCustomError(
  223.                     resp, 500, "A server error occurred while revoking the device.");
  224.     }
  225. }
Created with JaCoCo 0.8.11.202310140853