【feature】mvt解密支持SM4

Author: xiongjiaojiao

package.json

@@ -140,7 +140,7 @@
     "@mapbox/mapbox-gl-style-spec": "^14.3.0",
     "@mapbox/vector-tile": "1.3.1",
     "@supermap/iclient-common": "file:src/common",
-    "@supermap/tile-decryptor": "^0.0.2",
+    "@supermapgis/tile-decryptor": "^1.0.0",
     "@turf/center": "^6.5.0",
     "@turf/turf": "6.5.0",
     "canvg": "3.0.10",

src/common/package.json

@@ -15,7 +15,6 @@
   "license": "Apache-2.0",
   "dependencies": {
     "@antv/g6": "^4.8.14",
-    "@supermap/tile-decryptor": "^0.0.2",
     "echarts": "5.5.0",
     "fetch-ie8": "1.5.0",
     "fetch-jsonp": "1.1.3",

src/common/util/EncryptRequest.js

@@ -147,7 +147,7 @@ export class EncryptRequest {
  * @category  iServer Core
  * @description 获取矢量瓦片解密密钥
  * @param {string} serviceUrl - iServer 服务地址。例如：http://127.0.0.1:8090/iserver/services/xxx、http://127.0.0.1:8090/iserver/services/xxx/rest/maps、http://127.0.0.1:8090/iserver/services/xxx/restjsr/v1/vectortile。
- * @return {Promise} key - 矢量瓦片密钥。
+ * @return {Promise} options - 矢量瓦片密钥和加密算法类型。例如 { serviceKey, algorithm }。
  * @usage
  * ```
  * // 浏览器
@@ -166,7 +166,7 @@ export class EncryptRequest {
 export async function getServiceKey(serviceUrl) {
   try {
     const workspaceServerUrl = ((serviceUrl &&
-      serviceUrl.match(/.+(?=(\/restjsr\/v1\/vectortile\/|\/rest\/maps\/))/)) ||
+      serviceUrl.match(/.+(?=(\/restjsr\/v1\/vectortile\/|\/rest\/maps\/|\/rest\/data\/))/)) ||
       [])[0];
     if (!workspaceServerUrl) {
       return;
@@ -187,7 +187,14 @@ export async function getServiceKey(serviceUrl) {
       method: 'get',
       url: svckeyUrl
     });
-    return svcReponse.json();
+    const serviceKey = await svcReponse.json();
+    if (!serviceKey) {
+      return;
+    }
+    return {
+      serviceKey,
+      algorithm: matchRestData.serviceEncryptInfo.encrptSpec.algorithm
+    };
   } catch (error) {
     console.error(error);
   }

src/mapboxgl/core/MapExtend.js

@@ -16,8 +16,13 @@ export var MapExtend = (function () {
     mapboxgl.VectorTileSource.prototype.beforeLoad = async function (id, options) {
       const url = options && options.tiles && options.tiles[0];
       if (decryptSources.values.includes(id) && url) {
-        const decryptKey = await getServiceKey(url);
-        this.decryptKey = decryptKey;
+        const res = await getServiceKey(url);
+        if (res) {
+          this.decryptOptions = {
+            key: res.serviceKey,
+            algorithm: res.algorithm
+          };
+        }
       }
       this.beforeLoadBak(id, options);
     };

src/openlayers/overlay/VectorTileSuperMapRest.js

@@ -17,7 +17,7 @@ import GeoJSON from 'ol/format/GeoJSON';
 import * as olSize from 'ol/size';
 import Projection from 'ol/proj/Projection';
 import TileGrid from 'ol/tilegrid/TileGrid';
-import decryptTileUtil from '@supermap/tile-decryptor';
+import decryptTileUtil from '@supermapgis/tile-decryptor';
 
 /**
  * @class VectorTileSuperMapRest
@@ -34,7 +34,8 @@ import decryptTileUtil from '@supermap/tile-decryptor';
  * @param {(string|Object)} [options.attributions='Tile Data <span>© <a href='http://support.supermap.com.cn/product/iServer.aspx' target='_blank'>SuperMap iServer</a></span> with <span>© <a href='https://iclient.supermap.io' target='_blank'>SuperMap iClient</a></span>'] - 版权描述信息。
  * @param {Object} [options.format] - 瓦片的要素格式化。
  * @param {boolean} [options.withCredentials] - 请求是否携带 cookie。
- * @param {boolean} [options.decrypt] - 瓦片是否需要解密。
+ * @param {boolean|Function} [options.decrypt] - 瓦片解密。如果是 true 表示用内置的解密方法， 如 decrypt: true；如果是function 则是自定义解密如 decrypt: function ({ key, bytes })。
+ * @param {Function} [options.decryptCompletedFunction] - 解密完成后触发。如 decryptCompletedFunction(completeData)。
  * @extends {ol.source.VectorTile}
  * @usage
  */
@@ -386,15 +387,23 @@ export class VectorTileSuperMapRest extends VectorTile {
           const firstSource = Object.keys(options.style.sources)[0];
           serviceUrl = options.style.sources[firstSource].tiles[0];
         }
-        this.serviceKey = await getServiceKey(serviceUrl);
+        const res = await getServiceKey(serviceUrl);
+        if (res) {
+          this.decryptOptions = {
+            key: res.serviceKey,
+            algorithm: res.algorithm,
+            decrypt: typeof options.decrypt === 'boolean' ? undefined : options.decrypt,
+            decryptCompletedFunction: options.decryptCompletedFunction
+          };
+        }
       } catch (error) {
         console.error(error);
       }
     }
 
     _decryptMvt(mvtData) {
-      if (this.serviceKey) {
-        return decryptTileUtil(mvtData, this.serviceKey);
+      if (this.decryptOptions) {
+        return decryptTileUtil({ ...this.decryptOptions, arrayBuffer: mvtData });
       }
       return mvtData;
     }

src/openlayers/package.json

@@ -15,10 +15,11 @@
   "author": "SuperMap",
   "license": "Apache-2.0",
   "dependencies": {
+    "@supermap/iclient-common": "11.2.0",
+    "@supermapgis/tile-decryptor": "^1.0.0",
     "@turf/turf": "6.5.0",
     "mapv": "2.0.62",
     "ol": "7.5.2",
-    "@supermap/iclient-common": "11.2.0",
     "proj4": "2.11.0",
     "canvg": "3.0.10",
     "lodash.remove": "^4.7.0",

test/common/util/EncryptRequestSpec.js

@@ -1,5 +1,5 @@
 import { FetchRequest } from '../../../src/common/util/FetchRequest';
-import { EncryptRequest } from '../../../src/common/util/EncryptRequest';
+import { EncryptRequest, getServiceKey } from '../../../src/common/util/EncryptRequest';
 
 describe('EncryptRequest', () => {
   const serverUrl = 'http://fake.iserver.com/iserver';
@@ -71,4 +71,63 @@ describe('EncryptRequest', () => {
       });
     });
   });
+
+  it('getServiceKey', (done) => {
+    const serviceKey = 'l3nQtAUM4li87qMfO68exInHVFQ5gS3a6pb8ySIbib8=';
+    const encrptSpec = {
+      keyLength: 256,
+      attributes: 'abcd',
+      version: '1.1',
+      algorithm: 'AES'
+    };
+    const spyEncrypt = spyOn(EncryptRequest.prototype, 'request').and.callFake((options) => {
+      if (options.url.includes('keyID1')) {
+        return { json: () => Promise.resolve(serviceKey)};
+      }
+      return { json: () => Promise.resolve(null)};
+    });
+    const spyGet = spyOn(FetchRequest, 'get').and.callFake((url) => {
+      if (url.includes('map-China100')) { 
+        return Promise.resolve(
+          new Response(
+            JSON.stringify([
+              {
+                serviceEncryptInfo: {
+                  encrptSpec,
+                  updateTime: 'Fri Mar 15 08:52:15 CST 2024',
+                  encrptKeyID: 'keyID1'
+                },
+                name: 'map-China100/rest'
+              }
+            ])
+          )
+        );
+      }
+      return Promise.resolve(
+        new Response(
+          JSON.stringify([
+            {
+              serviceEncryptInfo: {
+                encrptSpec,
+                updateTime: 'Fri Mar 15 08:52:15 CST 2024',
+                encrptKeyID: 'keyID2'
+              },
+              name: 'data-china100/rest'
+            }
+          ])
+        )
+      );
+    });
+    getServiceKey('http://localhost:8090/iserver/services/map-China100/rest/maps/China').then(res => {
+      expect(res).not.toBeUndefined();
+      expect(res.serviceKey).toBe(serviceKey);
+      expect(res.algorithm).toBe(encrptSpec.algorithm);
+      getServiceKey('http://localhost:8090/iserver/services/data-China100/rest/data/datasources/China/datasets/Airport_pt').then(res => {
+        expect(res).toBeUndefined();
+        spyGet.calls.reset();
+        spyEncrypt.calls.reset();
+        done();
+      });
+    });
+  });
 });

test/mapboxgl/core/MapExtendSpec.js

@@ -236,7 +236,8 @@ describe('MapExtend mapboxgl', () => {
       decryptSources.add('B');
       expect(decryptSources.values).toEqual(['A', 'B']);
       await vectorSource.beforeLoad('A', source);
-      expect(vectorSource.decryptKey).toEqual('P8h08GonNjuCB4+CAykAGmLYwNsiv4G6H8KFrFi7Afk=');
+      expect(vectorSource.decryptOptions.key).toBe('P8h08GonNjuCB4+CAykAGmLYwNsiv4G6H8KFrFi7Afk=');
+      expect(vectorSource.decryptOptions.algorithm).toBe('AES');
     } catch (error) {
       expect(error).toEqual(new Error('mapbox-gl cannot support plane coordinate system.'));
     }

test/openlayers/overlay/VectorTileSuperMapRestSpec.js

@@ -59,19 +59,20 @@ const mapObject = {
 };
 describe('openlayers_VectorTileSuperMapRest', () => {
   var testDiv, map, vectorTileOptions, vectorTileSource, originalTimeout, vectorLayer, spyGet, spyPost, spyCommit;
+  const encrptSpec = {
+    keyLength: 256,
+    attributes: 'abcd',
+    version: '1.1',
+    algorithm: 'AES'
+  };
   const mockCallback = (testUrl) => {
     if ((url.match(/.+(?=(\/restjsr\/v1\/vectortile\/|\/rest\/maps\/))/) || [])[0] === testUrl) {
       return Promise.resolve(
         new Response(
           JSON.stringify([
             {
               serviceEncryptInfo: {
-                encrptSpec: {
-                  keyLength: 256,
-                  attributes: 'abcd',
-                  version: '1.1',
-                  algorithm: 'AES'
-                },
+                encrptSpec,
                 updateTime: 'Fri Mar 15 08:52:15 CST 2024',
                 encrptKeyID: 'keyIDNAME'
               },
@@ -175,7 +176,8 @@ describe('openlayers_VectorTileSuperMapRest', () => {
 
   it('mvt_decrypt ', (done) => {
     const spy = jasmine.createSpy('test');
-    const spyEncrypt = spyOn(EncryptRequest.prototype, 'request').and.callFake(() => ({ json: () => Promise.resolve('l3nQtAUM4li87qMfO68exInHVFQ5gS3a6pb8ySIbib8=')}));
+    const serviceKey = 'l3nQtAUM4li87qMfO68exInHVFQ5gS3a6pb8ySIbib8=';
+    const spyEncrypt = spyOn(EncryptRequest.prototype, 'request').and.callFake(() => ({ json: () => Promise.resolve(serviceKey)}));
     new MapService(url).getMapInfo((serviceResult) => {
       map = new Map({
         target: 'map',
@@ -185,10 +187,11 @@ describe('openlayers_VectorTileSuperMapRest', () => {
         })
       });
       vectorTileOptions = VectorTileSuperMapRest.optionsFromMapJSON(url, serviceResult.result);
-      vectorTileOptions.decrypt = true;
       vectorTileOptions.format = new MVT({
         featureClass: Feature
       });
+      vectorTileOptions.decrypt = function() { return []};
+      vectorTileOptions.decryptCompletedFunction = function() {};
       vectorTileOptions.tileLoadFunction = (tile) => {
         tile.setLoader(() => {
           spy();
@@ -204,7 +207,18 @@ describe('openlayers_VectorTileSuperMapRest', () => {
         expect(vectorTileOptions).not.toBeNull();
         expect(spy.calls.count()).toBe(1);
         expect(spyEncrypt).toHaveBeenCalled();
-        expect(vectorTileSource.serviceKey).not.toBeUndefined();
+        expect(vectorTileSource.decryptOptions).not.toBeUndefined();
+        expect(vectorTileSource.decryptOptions.key).toBe(serviceKey);
+        expect(vectorTileSource.decryptOptions.algorithm).toEqual(encrptSpec.algorithm);
+        expect(vectorTileSource.decryptOptions.decrypt).not.toBeUndefined();
+        expect(vectorTileSource.decryptOptions.decryptCompletedFunction).not.toBeUndefined();
+        let testData = new Uint8Array();
+        let resultData = vectorTileSource._decryptMvt(testData);
+        expect(resultData.slice(0).join(',')).toEqual(testData.slice(0).join(','));
+        vectorTileSource.decryptOptions = null;
+        testData = new Uint8Array([5, 10]);
+        resultData = vectorTileSource._decryptMvt(testData);
+        expect(resultData.slice(0).join(',')).toEqual(testData.slice(0).join(','));
         spy.calls.reset();
         spyEncrypt.calls.reset();
         done();