Web Application Firewall:SDK を Harmony アプリケーションに統合する

1. ヘッダーファイルの追加

import { TigerTallyAPI, TTCode } from 'aliyuntigertally';
import { TTCaptcha, TTCaptchaOption, TTCaptchaListener} from 'aliyuntigertally';

2. データ署名の設定

1. WAF での保護ルールの構成を容易にするために、ユーザー ID を指定します。

   /**
    * ユーザーアカウントを設定します。
    *
    * @param account アカウント
    * @return エラーコード
    */
   public static setAccount(account: string): number

   • パラメーター:

     • account: ユーザーを識別する文字列。データ型: 文字列。非識別化されたフォーマットを使用することをお勧めします。

   • 戻り値: 設定が成功したかどうかを示します。データ型: 数値。値 0 は成功を示し、値 -1 は失敗を示します。

   • サンプルコード:

     // ゲストは setAccount を呼び出す必要はなく、直接 SDK を初期化できます。ユーザーがログオンした後、setAccount を呼び出して SDK を再初期化する必要があります。
     let account: string = "user001";
     TigerTallyAPI.setAccount(account);

2. SDK を初期化し、初期収集を実行します。

   初期化収集とは、デバイス情報が一度収集されることを意味します。必要に応じて init 関数を再度呼び出して、別の初期化収集を実行できます。

   /**
    * 初期化コールバック。
    */
   export interface TTInitListener {
     /**
      * SDK 状態コードコールバック。
      * @param code
      */
     onInitFinish: (code: number) => void;
   }
   
   /**
    * コールバック付きの SDK 初期化。
    *
    * @param ctx
    * @param userAppKey
    * @param options 様々なパラメーター。
    * @param listener
    */
   public static init(ctx: Context, userAppKey: string,
                      options: Map<string, string> | null,
                      listener: TTInitListener | null): number

   • パラメーター:

     • ctx: アプリに渡されるコンテキストを指定します。データ型: context。

     • userAppkey: SDK 認証キーを指定します。データ型: 文字列。

     • options: 情報収集のためのオプションパラメーター。データ型: Map<String,String>。デフォルト値は null です。次の表に、オプションパラメーターを示します。

       パラメーター	説明	例
       IPv6	IPv6 ドメイン名を使用してデバイス情報を報告するかどうかを指定します。有効な値: 0 (デフォルト): IPv4 ドメイン名が使用されます。 1: IPv6 ドメイン名が使用されます。	1
       Intl	中国本土以外で登録されたドメイン名を使用してデバイス情報を報告するかどうかを指定します。有効な値: 0: 中国本土に報告します (デフォルト値)。 1. 中国本土以外からの報告。	1

     • listener: SDK 初期化コールバックインターフェイス。データ型: TTInitListener。コールバックで初期化結果の特定のステータスを確認できます。デフォルト値は null です。

       TTCode	コード	説明
       TT_SUCCESS	0	SDK は初期化されています。
       TT_NOT_INIT	-1	SDK は初期化されていません。
       TT_NOT_PERMISSION	-2	SDK に必要な基本的な Harmony 権限が完全に付与されていません。
       TT_UNKNOWN_ERROR	-3	不明なシステムエラーが発生しました。
       TT_NETWORK_ERROR	-4	ネットワークエラーが発生しました。
       TT_NETWORK_ERROR_EMPTY	-5	ネットワークエラーが発生し、戻り値が空の文字列です。
       TT_NETWORK_ERROR_INVALID	-6	応答のフォーマットが無効です。
       TT_PARSE_SRV_CFG_ERROR	-7	システムがサーバー設定を解析できませんでした。
       TT_NETWORK_RET_CODE_ERROR	-8	ゲートウェイが応答を返せませんでした。
       TT_APPKEY_EMPTY	-9	appkey パラメーターが空です。
       TT_PARAMS_ERROR	-10	他のパラメーターが無効です。
       TT_FGKEY_ERROR	-11	システムがキーを計算できませんでした。
       TT_APPKEY_ERROR	-12	SDK バージョンがアプリキーのバージョンと一致しません。

   • 戻り値: 初期化結果。データ型: 数値。値 0 は成功を示し、値 -1 は失敗を示します。

   • サンプルコード:

     // appkey パラメーターは Alibaba Cloud によって割り当てられた認証キーを指定します。
     const appkey: string = "******";
     // オプションパラメーター。IPv6 ドメイン名または中国本土以外で登録されたドメイン名を使用してデバイス情報を報告するかどうかを指定できます。
     let options: Map<string, string> = new Map<string, string>();
     options.set("IPv6", "0");// IPv6 ドメイン名を使用します。
     options.set("Intl", "0");// 中国本土で登録されたドメイン名を使用します。
     
     // 初期収集。後続のタスクでデバイス情報を収集したい場合は、init 関数を再度呼び出します。
     let ret: number = TigerTallyAPI.init(getContext(this), appkey, options, null);

3. データに署名します。

   入力データに署名し、リクエスト認証用の wToken 文字列を返します。

   /**
    * データに署名します。
    *
    * @param type  データ型
    * @param input 署名するデータ
    * @return wToken
    */public static vmpSign(type: number, input: string): string

   • パラメーター:

     • type: 署名するデータの型を指定します。データ型: 数値。値を 0 に設定します。

     • input: 署名するデータを指定します。データ型: 文字列。リクエストボディを指定することをお勧めします。

   • 戻り値: wToken 文字列を示します。

   • サンプルコード:

     let body: string = "私はリクエストボディです。暗号化されているか否かにかかわらず！";
     let wtoken: string = TigerTallyAPI.vmpSign(0, body);

     説明

     1. 次のいずれかの wToken 文字列が返された場合、初期化中に例外が発生しました:

        1. you must call init first: init 関数が呼び出されていません。

        2. you must input correct data: 入力データが無効です。

        3. you must input correct type: 入力データの型が無効です。

        4. inner error: 内部システムエラーが発生しました。

3. 二次検証

1. 結果を確認します。

   応答の cookie および body フィールドに基づいて、二要素認証を実行するかどうかを決定します。ヘッダーには複数の Set-Cookie フィールドが含まれる場合があります。

   /**
    * 二要素認証が必要かどうかを確認します。
    *
    * @param cookie  cookie
    * @param body    body
    * @return 0: 不要。1: 必要。
    */
   public static cptCheck(cookie: string, body: string): number

   • パラメーター:

     • cookie: 応答のすべての cookie を指定します。データ型: 文字列。

     • body: 応答の body を指定します。データ型: 文字列。

   • 戻り値: 二要素認証が必要かどうかを示します。値 0 は二要素認証が不要であることを示します。値 1 は二要素認証が必要であることを示します。データ型: 数値。

   • サンプルコード:

     let cookie: string = "key1=value1;kye2=value2;";
     let body: string = "....";
     let recheck: number = TigerTallyAPI.cptCheck(cookie, body);

2. スライダーを作成します。

   cptCheck から返された結果に基づいてスライダーオブジェクトを作成するかどうかを決定します。TTCaptcha オブジェクトは show および dismiss メソッドを提供し、これらはスライダーウィンドウの表示と非表示に対応します。TTCaptchaOption はスライダーの設定可能なパラメーターをカプセル化し、TTCaptchaListener はスライダーの 2 つのコールバック状態を含みます。

   /**
    * スライダーを作成します。
    *
    * @param ctx
    * @param option パラメーター。
    * @param listener コールバック関数。
    * @return スライダー。
    */
   public static cptCreate(ctx: UIContext, option: TTCaptchaOption, listener: TTCaptchaListener): TTCaptcha
   
     
   /**
    * スライダー。
    */
   export class TTCaptcha {
       /**
        * スライダーを表示します。
        */
       public show(): void
   
       /**
        * スライダーを非表示にします。
        */
       public dismiss(): void
   }
   
   /**
    * スライダーのパラメーター。
    */
   export class TTCaptchaOption {
     // 空のエリアをクリックしてスライダーを非表示にできるかどうかを指定します。
     cancelable: boolean;
   
   }
   
   /**
    * コールバック関数。
    */
   export interface TTCaptchaListener {
     /**
      * 検証成功。
      *
      * @param captcha スライダー。
      * @param code デフォルト値はトレース ID です。
      */
     success: (captcha: TTCaptcha, code: string) => void;
   
     /**
      * 検証失敗または例外。
      *
      * @param captcha スライダー。
      * @param code エラーコード。
      */
     fail: (captcha: TTCaptcha, code: string) => void;
   }
   

   • パラメーター:

     • ctx: 現在のページの UI コンテキストを指定します。データ型: UIContext。

     • option: スライダーのパラメーターを指定します。データ型: TTCaptchaOption。

     • listener: スライダーステータスのコールバック関数を指定します。データ型: TTCaptchaListener。

   • 戻り値: スライダーを示します。データ型: TTCaptcha。

   • サンプルコード:

     let option: TTCaptchaOption = new TTCaptchaOption();
     // option.cancelable = false;
     
     let captcha: TTCaptcha = TigerTallyAPI.cptCreate(this.getUIContext(), option, {
       success: (captcha: TTCaptcha, code: string) => {
         console.log("captcha success:", code);
         captcha.dismiss();
       },
       fail: (captcha: TTCaptcha, code: string) => {
         console.log("captcha failed:", code);
         captcha.dismiss();
       }
     });
     captcha.show();

     説明

     • cptCreate メソッドは UI 操作を伴うため、メインスレッドで呼び出す必要があります。

     • 検証例外は、スライダーの読み込み時に例外が検出されたことを示します。検証失敗は、検証完了後に例外が検出されたことを示します。エラーコードは次のとおりです:

       • 1001: 検証に失敗しました。

       • 1002: システムエラーが発生しました。

       • 1003: パラメーターエラーが発生しました。

       • 1005: 検証はキャンセルされました。

       • 8001: スライダーの呼び出しエラーが発生しました。

       • 8002: 検証例外が発生しました。

       • 8004: ネットワークエラーが発生しました。