intra-mart Accel Platform 設定ファイルリファレンス 第23版 2019-08-01

認証設定(一般ユーザ用)

概要

一般ユーザ用のログイン処理で使用する設定を行います。
また、一般ユーザ・システム管理者共通のログアウト処理で使用する設定を行います。
モジュール
認証機能
フォーマットファイル(xsd)
WEB-INF/schema/certification-config.xsd
設定場所
WEB-INF/conf/certification-config/im_login.xml

<certification-config xmlns="http://www.intra-mart.jp/certification/certification-config"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="http://www.intra-mart.jp/certification/certification-config certification-config.xsd">

  <category name="im_login">
    <param>
      <param-name>url</param-name>
      <param-value>/login</param-value>
    </param>
    <param>
      <param-name>enable_cookie_store</param-name>
      <param-value>false</param-value>
    </param>
    <param>
      <param-name>enable_localstorage_store</param-name>
      <param-value>true</param-value>
    </param>
    <param>
      <param-name>enable_requested_target_url</param-name>
      <param-value>true</param-value>
    </param>
  </category>

  <category name="im_certification">
    <param>
      <param-name>url</param-name>
      <param-value>/certification</param-value>
    </param>
    <param>
      <param-name>enable_force_login_session_refresh</param-name>
      <param-value>true</param-value>
    </param>
  </category>

  <category name="im_logout">
    <param>
      <param-name>url</param-name>
      <param-value>/logout</param-value>
    </param>
    <param>
      <param-name>enable_requested_target_url</param-name>
      <param-value>true</param-value>
    </param>
  </category>

</certification-config>

自動ログインについて

自動ログインは、他システムやツールとの連携のため、ユーザコードとパスワードなどをパラメータとして指定することで、自動的にログイン処理を行いシステムにアクセスする手段を提供します。
intra-mart Accel Platform 標準の認証モジュールを使用してログイン画面と同じログイン処理を行います。また、ログイン後の画面遷移先をパラメータで指定できます。
自動ログイン機能は、セキュリティ上の理由からセキュア・トークンによるチェックが有効に設定されているため、初期状態では使用できません。
自動ログインを有効にするためには、「セキュア・トークンフィルタ設定 」で、ログイン実行ページURLを除外するよう設定してください。

注意

セキュリティ脆弱性について
自動ログインを利用することで、リクエストパラメータ中にパスワードが含まれるなど、セキュリティ上の脆弱性が生じます。
自動ログイン機能は、必要な場合のみ利用してください。
自動ログインは HTTP ベースのアクセスで行います。
以下の URL にアクセスするとログイン処理を行うことができます。
http://<HOST>:<PORT>/<CONTEXT>/certification
指定可能なリクエストパラメータは、以下の通りです。
  • im_user

    ユーザコードを指定するためのパラメータです。
  • im_password

    パスワードを指定するためのパラメータです。
  • im_url

    ログイン成功後に遷移する URL を指定するためのパラメータです。
    省略した場合は、ログインしたテナントのホーム URL に遷移します。
  • im_tenant_id

    テナントIDを指定するためのパラメータです。
    リクエスト情報を利用したテナント自動解決機能が有効な場合、指定は無視されます。
    リクエスト情報を利用したテナント自動解決機能が無効、かつ、指定を省略した場合は、デフォルトテナントが使用されます。

リファレンス

ログインページURL

カテゴリタグ名 (属性) category (im_login)
パラメータキータグ名 (キー名) param (url)
ログインページのURLを設定します。
初期設定から変更したい場合に設定します。

【設定項目】

<certification-config>
  <category name="im_login">
    <param>
      <param-name>url</param-name>
      <param-value>/login</param-value>
    </param>
  </category>
</certification-config>

必須項目
複数設定 ×

キータグ
<param-name>url</param-name>
値タグ
<param-value>/login</param-value>
設定値・設定する内容
ログインページのURLを設定します。コンテキストパスからの相対パスを設定します。
単位・型
文字列 (/aaa/bbb/ccc)
省略時のデフォルト値 なし
親タグ certification-config

注意

この設定の変更は推奨していません。
この設定を変更した場合は、web.xml の設定、および、利用している画面の設定を全て変更する必要がありますが、 intra-mart Accel Platform では web.xml の変更を推奨していません。ログイン画面を変更する場合は、URLの変更ではなく「ログインページプロバイダ 」の利用を検討してください。

ユーザコードのCookie保存

カテゴリタグ名 (属性) category (im_login)
パラメータキータグ名 (キー名) param (enable_cookie_store)
ログイン画面で入力したユーザコードをCookieに保存して、再表示時に初期設定するかどうかを設定します。

【設定項目】

<certification-config>
  <category name="im_login">
    <param>
      <param-name>enable_cookie_store</param-name>
      <param-value>false</param-value>
    </param>
  </category>
</certification-config>

必須項目 ×
複数設定 ×

キータグ
<param-name>enable_cookie_store</param-name>
値タグ
<param-value>false</param-value>
設定値・設定する内容
true ユーザコードを Cookie に保存します。
false ユーザコードを Cookie に保存しません。
単位・型
真偽値 (true/false)
省略時のデフォルト値 false
親タグ certification-config

注意

ここで設定した値は、標準のログイン画面ページのプログラムで利用しています。
標準のログイン画面を変更した場合は、この設定は無視されます。

コラム

2018 Spring(Skylark) からは、enable_localstorage_store属性を有効にすることでユーザコードの保存先をlocalStorageに設定できるようになりました。
本設定とenable_localstorage_store属性をどちらも有効にした場合、本設定は無視されます。

ユーザコードのlocalStorage保存

カテゴリタグ名 (属性) category (im_login)
パラメータキータグ名 (キー名) param (enable_localstorage_store)
ログイン画面で入力したユーザコードをlocalStorageに保存して、再表示時に初期設定するかどうかを設定します。

【設定項目】

<certification-config>
  <category name="im_login">
    <param>
      <param-name>enable_localstorage_store</param-name>
      <param-value>true</param-value>
    </param>
  </category>
</certification-config>

必須項目 ×
複数設定 ×

キータグ
<param-name>enable_localstorage_store</param-name>
値タグ
<param-value>true</param-value>
設定値・設定する内容
true ユーザコードを localStorage に保存します。
false ユーザコードを localStorage に保存しません。
単位・型
真偽値 (true/false)
省略時のデフォルト値 false
親タグ certification-config

注意

ここで設定した値は、標準のログイン画面ページのプログラムで利用しています。
標準のログイン画面を変更した場合は、この設定は無視されます。

コラム

本設定は 2018 Spring(Skylark) から利用可能です。
2017 Winter(Rebecca) まではenable_cookie_storeのみ利用可能です。
本設定を有効にした場合、enable_cookie_storeの設定は無視されます。

ログイン実行ページURL

カテゴリタグ名 (属性) category (im_certification)
パラメータキータグ名 (キー名) param (url)
ログイン実行ページのURLを設定します。
初期設定から変更したい場合に設定します。

【設定項目】

<certification-config>
  <category name="im_certification">
    <param>
      <param-name>url</param-name>
      <param-value>/certification</param-value>
    </param>
  </category>
</certification-config>

必須項目
複数設定 ×

キータグ
<param-name>url</param-name>
値タグ
<param-value>/certification</param-value>
設定値・設定する内容
ログイン実行ページのURLを設定します。コンテキストパスからの相対パスを設定します。
単位・型
文字列 (/aaa/bbb/ccc)
省略時のデフォルト値 なし
親タグ certification-config

注意

この設定の変更は推奨していません。
この設定を変更した場合は、web.xml の設定、および、利用している画面の設定を全て変更する必要がありますが、 intra-mart Accel Platform では web.xml の変更を推奨していません。認証処理を変更する場合は、URLの変更ではなく「認証プロバイダ 」の利用を検討してください。

強制ログイン時のセッション再作成の有無

カテゴリタグ名 (属性) category (im_certification)
パラメータキータグ名 (キー名) param (enable_force_login_session_refresh)
強制ログイン時にセッションを再作成するかどうかを設定します。

コラム

intra-mart Accel Platform 2013 Winter 以前は、強制ログイン時にセッションが再作成されませんでした。
intra-mart Accel Platform 2013 Winter と同じ動作を行う場合は、明示的に false を設定してください。

【設定項目】

<certification-config>
  <category name="im_certification">
    <param>
      <param-name>enable_force_login_session_refresh</param-name>
      <param-value>true</param-value>
    </param>
  </category>
</certification-config>

必須項目 ×
複数設定 ×

キータグ
<param-name>enable_force_login_session_refresh</param-name>
値タグ
<param-value>true</param-value>
設定値・設定する内容
true 強制ログイン時にセッションを再作成します。
false 強制ログイン時にセッションを再作成しません。
単位・型
真偽値 (true/false)
省略時のデフォルト値 true
親タグ certification-config

リクエストパラメータによる画面遷移サポートの有無(ログイン時)

カテゴリタグ名 (属性) category (im_login)
パラメータキータグ名 (キー名) param (enable_requested_target_url)
リクエストパラメータによる画面遷移サポートの有無を設定します。
この設定により、以下の機能の有効無効を切り替えます。
  • ログイン画面表示時に、リクエストパラメータ「im_url」を指定することで、ログイン後に指定された画面へ遷移する。
  • ログイン実行時(「/certification」アクセス時)に、リクエストパラメータ「im_url」を指定することで、ログイン成功後に指定された画面へ遷移する。

【設定項目】

<certification-config>
  <category name="im_login">
    <param>
      <param-name>enable_requested_target_url</param-name>
      <param-value>true</param-value>
    </param>
  </category>
</certification-config>

必須項目 ×
複数設定 ×

キータグ
<param-name>enable_requested_target_url</param-name>
値タグ
<param-value>true</param-value>
設定値・設定する内容
true リクエストパラメータ「im_url」を指定した画面への遷移を可能とします。
false リクエストパラメータ「im_url」を指定した画面への遷移を不可とします。
単位・型
真偽値 (true/false)
省略時のデフォルト値
true
親タグ certification-config

コラム

この設定とは別に、リクエストパラメータで指定されたURLが外部URLだった場合に遷移可能かどうかの設定があります。
「認証外部ページURL許可リスト設定」を参照してください。

ログアウト実行ページURL

カテゴリタグ名 (属性) category (im_logout)
パラメータキータグ名 (キー名) param (url)
ログアウト実行ページのURLを設定します。
初期設定から変更したい場合に設定します。
この設定は、一般ユーザ/システム管理者共通の設定です。

【設定項目】

<certification-config>
  <category name="im_logout">
    <param>
      <param-name>url</param-name>
      <param-value>/logout</param-value>
    </param>
  </category>
</certification-config>

必須項目
複数設定 ×

キータグ
<param-name>url</param-name>
値タグ
<param-value>/logout</param-value>
設定値・設定する内容
ログアウト実行ページのURLを設定します。コンテキストパスからの相対パスを設定します。
単位・型
文字列 (/aaa/bbb/ccc)
省略時のデフォルト値 なし
親タグ certification-config

注意

この設定の変更は推奨していません。
この設定を変更した場合は、web.xml の設定、および、利用している画面の設定を全て変更する必要がありますが、 intra-mart Accel Platform では web.xml の変更を推奨していません。

リクエストパラメータによる画面遷移サポートの有無(ログアウト時)

カテゴリタグ名 (属性) category (im_logout)
パラメータキータグ名 (キー名) param (enable_requested_target_url)
リクエストパラメータによる画面遷移サポートの有無を設定します。
ログアウト時に、リクエストパラメータ「im_url」を指定することで、指定の画面へ遷移可能とするかどうかを設定します。

【設定項目】

<certification-config>
  <category name="im_logout">
    <param>
      <param-name>enable_requested_target_url</param-name>
      <param-value>true</param-value>
    </param>
  </category>
</certification-config>

必須項目 ×
複数設定 ×

キータグ
<param-name>enable_requested_target_url</param-name>
値タグ
<param-value>true</param-value>
設定値・設定する内容
true リクエストパラメータ「im_url」を指定した画面への遷移を可能とします。
false リクエストパラメータ「im_url」を指定した画面への遷移を不可とします。
単位・型
真偽値 (true/false)
省略時のデフォルト値
true
親タグ certification-config

コラム

この設定とは別に、リクエストパラメータで指定されたURLが外部URLだった場合に遷移可能かどうかの設定があります。
「認証外部ページURL許可リスト設定」を参照してください。