2021年2月20日土曜日

ユーザー管理用のAPIを呼び出す

 以前に管理サービスの禁止方法を記事にしました。管理サービスを禁止すると、色々と不便になりますが、最初に困るのはユーザー管理でしょうか。

Oracle APEXはユーザー管理を行うAPIを提供しているので、それを使うことで管理画面を自作することができます。試しに簡単なアプリを作ってみました。Oracle APEXが提供しているビューとAPIを使うことで比較的容易にアプリケーションは作れました。

とはいえ、管理サービスを禁止するくらいセキュリティについて意識するのであれば、ユーザー管理はOAuth2などの認証プロトコルを使用して、外部の認証サービスを使うようにすべきでしょう。そこまでいかなくても、自前で表を作ってユーザー情報を保存し、カスタム認証を実装しても良いのではないかと思います。

アプリケーション自体は単純な作りですが、ページ・アイテムが多く、それを手作りする必要があるので、最初にアプリケーションのエクスポートを紹介します。

https://github.com/ujnak/apexapps/blob/master/exports/sampleusermgmt.sql

では、作り方の方を紹介します。

最初に空のアプリケーションを作成します。名前はユーザー管理とします。


ホーム・ページに登録済みのユーザーを一覧する対話モード・レポートを作成します。一覧に使用するSQLは以下です。ビューAPEX_WORKSPACE_APEX_USERSの検索結果を表示しています。
select 
APEX_UTIL.GET_USER_ID("USER_NAME") "USER_ID",
"WORKSPACE_ID",
"WORKSPACE_NAME",
"WORKSPACE_DISPLAY_NAME",
"FIRST_SCHEMA_PROVISIONED",
"USER_NAME",
"FIRST_NAME",
"LAST_NAME",
"EMAIL",
"DATE_CREATED",
"DATE_LAST_UPDATED",
"AVAILABLE_SCHEMAS",
"IS_ADMIN",
"IS_APPLICATION_DEVELOPER",
"ACCOUNT_LOCKED",
"DESCRIPTION",
"PASSWORD_VERSION",
"ACCOUNT_EXPIRY",
"FAILED_ACCESS_ATTEMPTS",
"PROFILE_IMAGE_NAME",
"PROFILE_MIMETYPE",
"PROFILE_FILENAME",
"PROFILE_CHARSET"
from "APEX_WORKSPACE_APEX_USERS"
名前はユーザー一覧、ソースのタイプはSQL問合せです。


作成したページを実行すると、登録されているユーザーの一覧が表示されます。


次にフォームとなるページを作成します。静的コンテンツを使ってページを作ります。

ページ作成ウィザードを起動し、コンポーネントの空白ページを選びます。


名前をユーザー編集、ページ・モードをモーダル・ダイアログとします。オプションの静的コンテンツ・リージョンとして、リージョン1にユーザー編集を指定します。次に進みます。


ダイアログのページなので、ナビゲーションのプリファレンスとしては、このページとナビゲーション・メニューを関連付けないを選択します。次に進みます。


設定内容を確認して、終了をクリックします。


以上で、ダイアログとなるページが作成されました。作成された静的リージョンにページ・アイテムとボタンを配置します。


作成するページ・アイテムは以下です。

P2_USER_ID (非表示)、P2_WORKSPACE、P2_DEFAULT_SCHEMA、P2_USER_NAME、P2_FIRST_NAME、P2_LAST_NAME、P2_WEB_PASSWORD、P2_EMAIL_ADDRESS、P2_ALLOW_ACCESS_TO_SCHEMAS、P2_GROUPS、P2_DEVELOPER_ROLE、P2_DESCRIPTION、P2_ACCOUNT_EXPIRY、P2_ACCOUNT_LOCKED(切替え)、P2_FAILED_ACCESS_ATTEMPTS、P2_CHANGE_PASSWORD_ON_FIRST_USE(切替え)、P2_FIRST_PASSWORD_USE_OCCURED(切替え)

見やすくなるようにレイアウトを変更しましょう。

次にボタンですが、

B_CREATE、B_SUBMIT、B_DELETE、B_CLOSE

の4つのボタンを作成します。それぞれ、作成、変更の適用、削除と閉じる、というラベルを割り与えます。B_CREATEは主キーであるP2_USER_IDがNULLの場合に表示し、B_SUBMIT、B_DELETEは反対にP2_USER_IDがNULLでない場合に表示するようサーバー側の条件を構成します。標準で、Create、Change、Delete、Closeとして推奨されているボタン位置があります。ただ、Deleteだけは作成と変更の適用から離すために、Closeの場所に配置しました。

次にレポートのページに戻り、ユーザーの新規登録のボタンを作成します。ボタン名をB_CREATEとし、ラベルを新規登録、ボタン位置は対話モード・レポートの検索バーの右に配置します。

動作のアクションはこのアプリケーションのページにリダイレクトを選択し、ターゲットはページ2として、フォームを作成したページを指定します。


選択した行の編集フォームを開くよう、対話モード・レポートのAttributesに含まれるリンクを設定します。リンク列はカスタム・ターゲットへのリンクを選択します。


ターゲットは、ページを2、アイテムの設定として名前をP2_USER_ID、値は#USER_ID#を設定します。キャッシュのクリアも2を設定します。


以上で画面に必要なコンポーネントは配置できました。

ここからが今回の本題です。フォームのページに戻ります。

ユーザー情報をフェッチし、ページ・アイテムに設定するプロセスを登録します。APIとしては、APEX_UTIL.FETCH_USERを呼び出します。ヘッダーの後にプロセスを作成し、以下のコードをソースとして設定します。名前をユーザー情報のフェッチとし、タイプはコードを実行を選びます。
DECLARE
    l_start_date                    DATE;
    l_end_date                      DATE;
    l_employee_id                   NUMBER(15,0);
    l_person_type                   VARCHAR2(1);
    l_groups                        VARCHAR2(1000);
BEGIN
    APEX_UTIL.FETCH_USER(
        p_user_id                       => :P2_USER_ID,
        p_workspace                     => :P2_WORKSPACE,
        p_user_name                     => :P2_USER_NAME,
        p_first_name                    => :P2_FIRST_NAME,
        p_last_name                     => :P2_LAST_NAME,
        p_web_password                  => :P2_WEB_PASSWORD,
        p_email_address                 => :P2_EMAIL_ADDRESS,
        p_start_date                    => l_start_date,
        p_end_date                      => l_end_date,
        p_employee_id                   => l_employee_id,
        p_allow_access_to_schemas       => :P2_ALLOW_ACCESS_TO_SCHEMAS,
        p_person_type                   => l_person_type,
        p_default_schema                => :P2_DEFAULT_SCHEMA,
        p_groups                        => l_groups,
        p_developer_role                => :P2_DEVELOPER_ROLE,
        p_description                   => :P2_DESCRIPTION,
        p_account_expiry                => :P2_ACCOUNT_EXPIRY,
        p_account_locked                => :P2_ACCOUNT_LOCKED,
        p_failed_access_attempts        => :P2_FAILED_ACCESS_ATTEMPTS,
        p_change_password_on_first_use  => :P2_CHANGE_PASSWORD_ON_FIRST_USE,
        p_first_password_use_occurred   => :P2_FIRST_PASSWORD_USE_OCCURED);
    select listagg(apex_util.get_group_name(column_value),':') into :P2_GROUPS
    from apex_string.split(l_groups, ':');
END;

左ペインをプロセス・ビューに切り替え、データ操作に関するプロセスを3つ追加します。

最初にユーザーを作成するプロセスを追加します。APEX_UTIL.CREATE_USERを呼び出します。名前をユーザーの作成とし、ボタン押下時はB_CREATEとして、作成ボタンがクリックされたときに実行します。実行するコードは以下になります。
DECLARE
    l_groups varchar2(1000);
BEGIN
    select listagg(apex_util.get_group_id(column_value),':') into l_groups
    from apex_string.split(:P2_GROUPS, ':');
    APEX_UTIL.CREATE_USER
    (
        p_user_name                     => :P2_USER_NAME,
        p_first_name                    => :P2_FIRST_NAME,
        p_last_name                     => :P2_LAST_NAME,
        p_description                   => :P2_DESCRIPTION,
        p_email_address                 => :P2_EMAIL_ADDRESS,
        p_web_password                  => :P2_WEB_PASSWORD,
        p_group_ids                     => l_groups,
        p_developer_privs               => :P2_DEVELOPER_ROLE,
        p_default_schema                => :P2_DEFAULT_SCHEMA,
        p_allow_access_to_schemas       => :P2_ALLOW_ACCESS_TO_SCHEMAS,
        p_change_password_on_first_use  => :P2_CHANGE_PASSWORD_ON_FIRST_USE
    );
END;

ユーザーの更新では、APEX_UTIL.EDIT_USERを呼び出します。ボタンB_SUBMITが押された時に実行します。
declare
  l_groups varchar2(1000);
BEGIN
select listagg(apex_util.get_group_id(column_value),':') into l_groups
from apex_string.split(:P2_GROUPS, ':');
APEX_UTIL.EDIT_USER (
    p_user_id                       => :P2_USER_ID,
    p_user_name                     => :P2_USER_NAME,
    p_first_name                    => :P2_FIRST_NAME,
    p_last_name                     => :P2_LAST_NAME,
    p_web_password                  => :P2_WEB_PASSWORD,
    p_new_password                  => :P2_WEB_PASSWORD,
    p_email_address                 => :P2_EMAIL_ADDRESS,
--    p_start_date                    => l_start_date,
--    p_end_date                      => l_end_date,
--    p_employee_id                   => l_employee_id,
    p_allow_access_to_schemas       => :P2_ALLOW_ACCESS_TO_SCHEMAS,
--    p_person_type                   => l_person_type,
    p_default_schema                => :P2_DEFAULT_SCHEMA,
    p_group_ids                     => l_groups,
    p_developer_roles               => :P2_DEVELOPER_ROLE,
    p_description                   => :P2_DESCRIPTION,
    p_account_expiry                => :P2_ACCOUNT_EXPIRY,
    p_account_locked                => :P2_ACCOUNT_LOCKED,
    p_failed_access_attempts        => :P2_FAILED_ACCESS_ATTEMPTS,
    p_change_password_on_first_use  => :P2_CHANGE_PASSWORD_ON_FIRST_USE,
    p_first_password_use_occurred   => :P2_FIRST_PASSWORD_USE_OCCURED);
END;

ユーザーの削除では、APEX_UTIL.REMOVE_USERを呼び出します。ボタンB_DELETEがクリックされたときに実行します。
BEGIN
    APEX_UTIL.REMOVE_USER(p_user_id=> :P2_USER_ID);
END;

最後にダイアログを閉じるプロセスを追加します。


レポートのページにダイアログがクローズしたときに、レポートをリフレッシュする動的アクションを定義します。動的アクション・ビューを開き、ダイアログのクローズで動的アクションを作成します。

名前はレポートのリフレッシュとし、タイミングのイベントはダイアログのクローズ、選択タイプはリージョン、リージョンはユーザー一覧とします。


Trueアクションを作成します。アクションはリフレッシュ、影響を受ける要素は、選択タイプがリージョン、リージョンはユーザー一覧になります。


以上でアプリケーションは完成です。

アプリケーションを実行し、ユーザーを登録しようとすると、以下のエラーが発生します。

APIコールは禁止されています。 管理者に連絡してください。


Oracle APEXで作成したアプリケーションからは、管理系のAPIの呼び出しが禁止されています。こちらの制限を解除する必要があります。

アプリケーション定義のセキュリティを開き、データベース・セッションのセクションに含まれる、ランタイムAPIの使用状況のワークスペース・リポジトリを変更にチェックを入れます。


再度、アプリケーションを実行すると、表題にあるGIF動画のような動作になります。

APIの確認が目的なので、アプリケーションとしては改良の余地は多々あります。たとえば、パスワードを隠す、など。また、本アプリを本番環境にインストールするのは全くお勧めしません。あくまでサンプルです。

本記事は以上になります。Oracle APEXのアプリケーション開発の一助になれば幸いです。

完

2021年2月19日金曜日

動的アクションの非表示のセキュリティ上の効果について

ブラウザでJavaScriptコンソールを開き、APIを実行することにより、画面上から隠されている機能を実行できることについて解説します。

動作を確認するためにアプリケーションを作成します。EMP/DEPTのサンプル・データセットを使用します。

最初に空のアプリケーションを作成します。名前は任意です。今回はJavaScript API実行としました。表EMPの対話モード・レポートとフォームのページを追加します。ページの作成を開始します。

フォームからフォーム付きレポートを選びます。ページ属性の設定では、レポート・タイプは対話モード・レポート、フォーム・ページ・モードは標準を選びます。それ以外の設定は任意です。次に進みます。


ナビゲーションのプリファレンスに新規ナビゲーション・メニュー・エントリの作成を選び、次に進んで、データ・ソースとしてローカル・データベース、表/ビューの名前としてEMP (表) を選びます。次に進みます。


フォーム・ページの設定で、主キー列としてEMPNO (Number) を選択し、作成をクリックします。


ページが作成されたら、フォームのページをページ・デザイナで開きます。


フォームのページが開く際に、ページ・アイテムP3_SALとボタンDELETEを非表示にする動的アクションを定義します。左ペインで動的アクション・ビューを開き、ページのロード上で動的アクションの作成を実行します。


動的アクションの名前はページ初期化とし、Trueアクションをふたつ定義します。


作成するTrueアクションは、ひとつはアクションが非表示で影響を受ける要素の選択タイプをアイテム、アイテムとしてP3_SALを指定します。


もうひとつは、影響を受ける要素の選択タイプをボタン、ボタンとしてDELETEを指定します。


以上で確認のためのアプリケーションの準備が完了しました。

アプリケーションを実行し、作成した対話モード・レポートを開きます。ブラウザの開発ツールであるJavaScriptコンソールも開きます。


従業員の誰かを対象にフォームを開きます。動的アクションが実行され、ページ・アイテムP3_SALおよびボタンDELETEが表示されていないことが確認できます。


JavaScriptコンソールより、以下のコマンドを実行します。
$x_Show("P3_SAL");
ページ・アイテムP3_SALが表示されます。


続いて、以下のコマンドを実行します。
apex.submit("DELETE");

行の削除が実行され、レポート・ページに戻ります。


アプリケーションの利用者が、ブラウザの開発ツールからJavaScriptのAPIを直接実行することを止める方法はありません。

画面上に表示してはいけない情報は、認可、またはサーバー側の条件といった、サーバー側でページを生成する際に適用される条件を使用すれば、HTML自体が生成されなくなるため、JavaScript APIを呼び出しても表示されることはありません。


フォームと対話グリッドのAttributesに含まれる実行可能な操作、許可された行操作列、認可の編集を適切に設定していれば、JavaScriptコンソールからAPIを実行しても、表の操作は行われません。


対応策は以上になります。Oracle APEXのアプリケーション開発の一助になれば幸いです。

完

モーダル・ダイアログ上のページ・アイテムの値を開いたページに戻す

 モーダル・ダイアログ上のページ・アイテムの値を、それを開いたページのページ・アイテムに戻すには?という質問があったので、手順を記述します。

サンプル・データセットのEMP/DEPT表を利用して、モーダル・ダイアログを開いて新規に従業員を登録し、そこで割り当てられる従業員番号を、モーダル・ダイアログを開いたページのページ・アイテムに戻します。

実装を行う元になるアプリケーションを作成します。SQLワークショップからオブジェクト・ブラウザを開き、EMP表を選択します。そこで、アプリケーションの作成を実行します。

アプリケーション作成ウィザードが開いたら、アプリケーションの作成を実行します。すべてデフォルトで構いませんが、アプリケーションの名前は変更した方が良いでしょう。

作成されたページの中に表EMPを更新するフォームのページが含まれます。このページを呼び出して、従業員を作成する新たなページを作成します。

ページの作成を実行します。

コンポーネントの空白ページを選択します。次に進みます。

ページの名前をダイアログ戻り値とし、ページ・モードは標準、オプションの静的コンテンツ・リージョンを開き、リージョン1としてダイアログ戻り値(リージョンの名前になります)を設定します。これでページの作成と同時に静的リージョンが1つ追加されます。次に進みます。


ナビゲーションのプリファレンスとして、新規ナビゲーション・メニュー・エントリの作成を選択し、次に進みます。


内容を確認して、終了をクリックします。


ページが作成されたら、静的リージョンに従業員番号を保持するページ・アイテムP7_EMPNOを作成します。タイプはテキスト・フィールド、ラベルは従業員番号とします。


続いて、従業員を登録するダイアログを開くボタンを作成します。名前をB_CREATE、ラベルは従業員登録とします。動作のアクションとして、このアプリケーションのページにリダイレクトを選択し、ターゲットの設定を行います。今回はフォームのページが5なので、ページは5、キャッシュのクリアにも5を設定し、OKをクリックします。一旦、この状態でページを保存します。


以上で、従業員登録のボタンをクリックするとフォームが開き、従業員を登録できるところまで、ページの作成ができています。

これから従業員番号をモーダル・ダイアログから元のページに戻す実装を行います。

フォームのページを開いて、開発者ツール・バーよりページの編集を実行します。ページ・デザイナが開きます。


左ペインにてプロセス・ビューを開き、ダイアログを閉じるという名前のプロセスを選択します。右ペインのプロパティ・エディタの設定に含まれる戻すアイテムに、従業員番号であるP5_EMPNOを設定します。ダイアログ側の設定は以上です。ページを保存します。


ダイアログ戻り値のページを再度ページ・デザイナで開きます。左ペインで動的アクション・ビューを開き、ダイアログのクローズのタイミングで実行される動的アクションを登録します。

名前を従業員番号の設定とし、タイミングはイベントがダイアログのクローズ、選択タイプはリージョン、リージョンは(ダイアログを開いたボタンのある)ダイアログ戻り値という名前のリージョンを設定します。


Trueアクションを設定します。アクションは値の設定を選択します。設定のタイプの設定として、Dialog Return Itemを選択します。これでダイアログのクローズというプロセスに設定した、P5_EMPNOの値を受け取ることができます。戻りアイテムにP5_EMPNOを設定します。現在編集中のページにあるページ・アイテムではないので、選択リストからはカスタム・ページを選んでページ番号5を指定して、P5_EMPNOを見つけます。直接、文字入力することもできます。


値の元となるページ・アイテムの設定に続いて、設定先となるページ・アイテムを設定します。影響を受ける要素として、選択タイプをアイテム、アイテムをP7_EMPNOとします。


以上で設定は完了です。ページを実行すると、最初のGIF動画になります。

アプリケーションのエクスポートを以下に置きました。実行にはサンプル・スキーマのEMP/DEPTが必要です。

https://github.com/ujnak/apexapps/blob/master/exports/dialogreturnitem.sql

Oracle APEXのアプリケーション開発の一助になれば幸いです。

完