Merge pull request #312 from bcgov/feature/get-public-objects-no-auth

GET /object: allow no-auth access

Author: norrisng-bc

app/src/controllers/object.js

@@ -3,6 +3,7 @@ const cors = require('cors');
 const { v4: uuidv4, NIL: SYSTEM_USER } = require('uuid');
 
 const {
+  AuthType,
   DEFAULTCORS,
   DownloadMode,
   MAXCOPYOBJECTLENGTH,
@@ -26,7 +27,8 @@ const {
   mixedQueryToArray,
   toLowerKeys,
   getBucket,
-  renameObjectProperty
+  renameObjectProperty,
+  hasOnlyPermittedKeys
 } = require('../components/utils');
 const utils = require('../db/models/utils');
 
@@ -1057,10 +1059,34 @@ const controller = {
       };
       // if scoping to current user permissions on objects
       if (getConfigBoolean('server.privacyMask')) {
+
+        if (req.currentUser.authType === AuthType.NONE) {
+
+          const permittedPublicSearchParams = ['bucketId', 'objectId', 'public', 'page', 'limit', 'sort'];
+
+          // no-auth requests MUST have all of the following:
+          //  (a) only the permitted search params; (b) ?public=true; (c) an object or bucket id
+          if (!hasOnlyPermittedKeys(req.query, permittedPublicSearchParams) || !params.public ||
+            !(params.bucketId || params.id)) {
+            throw new Problem(403, {
+              detail: 'User lacks permission to complete this action',
+              instance: req.originalUrl
+            });
+          }
+        }
         params.userId = await userService.getCurrentUserId(getCurrentIdentity(req.currentUser, SYSTEM_USER));
       }
+
       const response = await objectService.searchObjects(params);
-      res.setHeader('X-Total-Rows', response.total).status(200).json(response.data);
+
+      if (req.currentUser.authType === AuthType.NONE) {
+        const redactedFields = ['path', 'createdBy', 'updatedBy', 'lastSyncedDate'];
+        const redactedResponseData = response.data.map(object => utils.redactSecrets(object, redactedFields));
+        res.setHeader('X-Total-Rows', response.total).status(200).json(redactedResponseData);
+      }
+      else {
+        res.setHeader('X-Total-Rows', response.total).status(200).json(response.data);
+      }
     } catch (error) {
       next(error);
     }

app/src/docs/v1.api-spec.yaml

@@ -411,10 +411,16 @@ paths:
           $ref: "#/components/responses/Error"
     get:
       summary: Search for objects
-      description: >-
+      description: |
         Returns a list of objects matching all search criteria across all known
         versions of objects. Search criteria on string attributes will match on
         partial results and ignore case sensitivity.
+
+        This endpoint can be used without authentication. If so, some response attributes (`path`, `createdBy`, `updatedBy`, and
+        `lastSynceDate`) are redacted. The following restrictions also apply:
+        * Only the following query parameters are allowed: `bucketId`, `objectId`, `public`, `page`, `limit`, `sort`
+        * `public` must be `true`
+        * An `objectId` or `publicId` must be provided
       operationId: searchObjects
       tags:
         - Object

app/src/routes/v1/object.js

@@ -28,7 +28,6 @@ router.put('/',
 
 /** Search for objects */
 router.get('/',
-  requireSomeAuth,
   objectValidator.searchObjects,
   checkS3BasicAccess,
   (req, res, next) => {