Display build info endpoint

config.docker.js

@@ -21,7 +21,8 @@ const {
   INAT_AWS_OPENDATA_REGION,
   INAT_AWS_OPENDATA_ACL,
   INAT_TAXA_FILE_PATH,
-  INAT_SEEK_EXCEPTION_LIST_ID
+  INAT_SEEK_EXCEPTION_LIST_ID,
+  INAT_INTERNAL_IP_RANGES
 } = process.env;
 
 module.exports = {
@@ -69,5 +70,6 @@ module.exports = {
     host: INAT_ES_HOST ? `http://${INAT_ES_HOST}:9200` : "http://localhost:9200"
   },
   cacheDir: "/home/inaturalist/api/cache",
-  seekExceptionListID: INAT_SEEK_EXCEPTION_LIST_ID || 0
+  seekExceptionListID: INAT_SEEK_EXCEPTION_LIST_ID || 0,
+  internalIPs: INAT_INTERNAL_IP_RANGES || ""
 };

lib/controllers/v2/build_info_controller.js

@@ -0,0 +1,19 @@
+const process = require( "process" );
+const util = require( "../../util" );
+
+const index = async req => {
+  if ( !util.isInternalRequest( req ) ) {
+    throw util.httpError( 401, "Unauthorized" );
+  }
+  const buildInfoJSON = {
+    git_branch: process.env.GIT_BRANCH,
+    git_commit: process.env.GIT_COMMIT,
+    image_tag: process.env.IMAGE_TAG,
+    build_date: process.env.BUILD_DATE
+  };
+  return buildInfoJSON;
+};
+
+module.exports = {
+  index
+};

lib/util.js

@@ -2,6 +2,7 @@
 const _ = require( "lodash" );
 const moment = require( "moment" );
 const md5 = require( "md5" );
+const ipRangeCheck = require( "ip-range-check" );
 const config = require( "../config" );
 const Logstasher = require( "./logstasher" );
 
@@ -502,6 +503,15 @@ const util = class util {
     return true;
   }
 
+  static isInternalRequest( req ) {
+    const internalIPs = config.internalIPs || "";
+    const allowedRanges = internalIPs.split( "," );
+    const clientIp = req.headers["x-forwarded-for"] || req.connection.remoteAddress;
+    console.log( "### internalIPs = " + allowedRanges );
+    console.log( "### clientIp = " + clientIp );
+    return allowedRanges.some( range => ipRangeCheck( clientIp, range ) );
+  }
+
   // Utility to look up IDs from UUIDs to forward requests to the v1 API
   static async uuidsToSerialIds( req, model ) {
     // eslint-disable-next-line global-require

openapi/paths/v2/build_info.js

@@ -0,0 +1,34 @@
+const j2s = require( "joi-to-swagger" );
+const BuildInfoController = require( "../../../lib/controllers/v2/build_info_controller" );
+
+module.exports = sendWrapper => {
+  async function GET( req, res ) {
+    const results = await BuildInfoController.index( req );
+    sendWrapper( req, res, null, results );
+  }
+
+  GET.apiDoc = {
+    tags: ["BuildInfo"],
+    summary: "Display build information",
+    responses: {
+      200: {
+        description: "Build information",
+        content: {
+          "application/json": {
+            schema: {
+              $ref: "#/components/schemas/BuildInfo"
+            }
+          }
+        }
+      },
+      default: {
+        $ref: "#/components/responses/Error"
+      }
+    },
+    "x-unpublished": true
+  };
+
+  return {
+    GET
+  };
+};

openapi/schema/request/build_info.js

@@ -0,0 +1,3 @@
+const Joi = require( "joi" );
+
+module.exports = Joi.object( ).keys( {} );

openapi/schema/response/build_info.js

@@ -0,0 +1,8 @@
+const Joi = require( "joi" );
+
+module.exports = Joi.object( ).keys( {
+  git_branch: Joi.string( ),
+  git_commit: Joi.string( ),
+  image_tag: Joi.string( ),
+  build_date: Joi.string( )
+} ).unknown( false );

package.json

@@ -43,6 +43,7 @@
     "handlebars": "^4.7.7",
     "inaturalistjs": "github:inaturalist/inaturalistjs",
     "intl": "^1.2.5",
+    "ip-range-check": "^0.2.0",
     "joi": "^17.5.0",
     "joi-to-swagger": "^6.1.1",
     "js-yaml": "^4.1.0",