portal user guide ja 2016-11download.asteriskresearch.com/3.0.3/portal_user... · secureassist...

77
SecureAssist Enterprise Portal User Guide November 2016 (日本語参考訳)

Upload: others

Post on 30-Jun-2020

1 views

Category:

Documents


0 download

TRANSCRIPT

Page 1: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

SecureAssist Enterprise Portal User Guide November 2016 (日本語参考訳)

Page 2: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

Copyright © 2016 by Codiscope, LLC. All rights reserved. 本文書のいかなる部分も著作権者の書面による事前の許可なしに、電子的、機械的、複写、記録あるいはその他の形式や手段によ

って送信されたあらゆる電子検索システムへ複製、変更、保存することはできません。

Codiscopeは、本文書に関連するあらゆる知的財産権への独占権を有するものとします。 本文書の情報は、予告なく変更されるものとし、Codiscopeによる誓約として解釈されないものとします。Codiscopeは、文書に関して、明示または黙示にかかわらず、一切の保証責任を負わないものとし、間接的、偶発的、結果的損害(利益の損失、資産の使用による損失、ビ

ジネスチャンスの損失、データの損失、ユーザの顧客によるまたはその代理による請求な

ど)を含むあらゆる損害に対して責任を負わないものとします。

Codiscopeと Codiscopeのロゴは、Codiscope,LLCの商標です。その他の会社名、製品名は、それぞれの所有者の商標です。

Codiscope, LLC 20 Park Plaza, Suite 1400 Boston, MA 02116 Phone: + 1 (617) 804-5428 [email protected]

www.codiscope.com

Page 3: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

Table of Contents

SecureAssist Enterprise Portal Setup ............................................. 1 Installation ..................................................................................... 1 Main and Reporting Databases .......................................................... 1 Database Setup ................................................................................ 2 Initial Configuration ....................................................................... 10 Upgrade Instructions ....................................................................... 13

1 Log in to SecureAssist .......................................................... 21 Getting Started ............................................................................... 21 Portal Navigation ............................................................................ 21

2 Statistics ............................................................................ 22 Project Statistics ............................................................................. 22 User Statistics ................................................................................ 25 Timeseries .................................................................................... 26

3 Reports .............................................................................. 29 Project Reports ............................................................................... 29 User Reports .................................................................................. 34

4 Rulepacks .......................................................................... 38

5 Manage ............................................................................. 42 Portal Users ................................................................................... 42 Plugin User Groups ......................................................................... 44 Roles ............................................................................................ 45 Account ......................................................................................... 48

6 Settings ............................................................................. 49 LDAP Configuration ........................................................................ 49 Feature Configuration ..................................................................... 50 Plugin Users .................................................................................. 52

7 More Support ...................................................................... 54

Appendix A: Roles and Associated Permissions ........................... 55

Appendix B: Permission Descriptions ......................................... 56

Appendix C: Audit Log .............................................................. 57

Appendix D: API Functionality ................................................... 58 Authentication ............................................................................... 59 Generate Project Report .................................................................. 61 Get Project List .............................................................................. 65 Number of Active Developers ........................................................... 67 Number of Projects Scanned ............................................................. 68 Number of Project Defects ............................................................... 69 Top Number of Findings .................................................................. 71 Most Viewed Guidance .................................................................... 73

Page 4: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

SecureAssist Enterprise Portal Setup SecureAssist Enterprise Portalは、組織が SecureAssistプラグインライセンス、ルールパック、およびツール設定を管理できるようにする

集中型ポータルサイトです。また、ユーザにより見つけられたセキ

ュリティ上の脆弱性およびその後の経過に関し、一元化された報告

を提供します。

Installation このセクションでは、Codiscope の SecureAssistEnterprise PortalとCodiscopeの SecureAssist Eclipseの更新サイトのインストールについて説明します。Portalおよび更新サイトは、同じアプリケーションサーバで展開でき、別々のサーバに展開することもできます。本文書

は、これらが同じサーバにインストールされていることを前提とし

ています。

Main and Reporting Databases SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用の、独立したセカンダリデータベースを設定するオプションを利用

できます。これにより、より大規模に SecureAssistを展開した際のEnterprise Portalパフォーマンスをより向上させることができます。レポーティングデータベースを設定した場合は、予定されたアクテ

ィブなレポート要求はすべてそこで実行されます。メインデータベ

ースは、登録、アクティベーション、ルールパック要求などを処理

します。

セカンダリレポーティングデータベースの使用はオプションです。 SecureAssist Enterprise Portal用の 1つのデータベースのみを設定すると、すべてのレポート要求がメインデータベースに送られます。

重要!以下の点は、Portalにデータベースを実装する上で重要です。

§ レポーティングデータベースを設定する際は、データの一貫

性を保つためにメインデータベースとレポーティングデータ

ベース間でレプリケーションを設定する必要があります。レ

プリケーションが設定されていない場合、実行されたレポー

トにはデータが含まれません。 § メインデータベースとレポーティングデータベースは、レポ

ート要求がメインデータベースのハイパーバイザー/サーバの機能やパフォーマンスに影響を与えないように、2つの別々の場所/ 2つの異なるハイパーバイザーで設定する必要があります。

Page 5: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

Database Setup

Configure Main Database Connection レポーティングデータベースを設定する際は、メインデータベース

へのインポート前にメインデータベースとレポーティングデータベ

ース間のレプリケーションを設定する必要があります。以下の図

は、データベース接続画面を示しています。

Page 6: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

Configure Database

Database Instructions

MySQL MySQLデータベースとユーザの設定 1. コマンドプロンプトから "mysql"コマンドを MySQLスーパーユーザとし

て実行します。: mysql -u root -p

2. 空の CSA Portalデータベーススキーマを作成します。‘portal_csa’を選択したデータベース名に置き換えます。: CREATE DATABASE portal_csa;

3. CSA Portalデータベースユーザを作成します。: GRANT ALL PRIVILEGES ON portal_csa.* TO ‘csauser’@’localhost’ IDENTIFIED BY ‘csauserpassword’; オプション:‘portal_csa’を上記の手順で作成したデータベースの名前に置き換えます。さらに、 'csauser'と 'csauserpassword'をユーザ名とパスワードに置き換えます。 SecureAssist Enterprise Portalが MySQLデータベースサーバと同じサーバ上で実行されていない場合は、‘localhost’をSecureAssistサーバのホスト名または IPアドレスに置き換えます。

MySQLデータベースのインポートスクリプトの実行

レポーティングデータベースを設定する場合、メインデータベースでのデータ

ベースインポートの前にメインデータベースとレポーティングデータベース間

のレプリケーションを設定する必要があります。

「実働データベース」のみを「レポーティングデータベース」なしで使用して

いる場合は、以下の手順に従ってください。 1. CSA Portalデータベーススキーマを作成し、コマンドプロンプトから次の

コマンドを MySQLスーパーユーザとして実行して、データベースをインポートします。

「実働データベース」は portal_csaです。 mysql -u root -p portal_csa < path_to/portal_csa_mysql.sql mysql -u root -p portal_csa < path_to/portal_csa_mysql_aggregation.sql § portal_csa’は上記の手順 2で作成したデータベーススキーマに置き換えてください。

§ ‘path_to’は portal_csa_mysql.sqlファイルのパスに置き換えてください。

「実働データベース」と「レポーティングデータベース」を使用している場合

は、以下の手順に従ってください。 1. CSA Portalデータベーススキーマを作成し、コマンドプロンプトから次の

コマンドを MySQLスーパーユーザとして実行し、データベースをインポートします。

「実働データベース」は portal_csaです。

「レポーティングデータベース」は portal_csa です。(プライマリデータベースと同じ名前ですが、別の場所にレプリケートされます)

「実働データベース」でのコマンド: mysql -u root -p portal_csa < path_to/portal_csa_mysql.sql 「レポーティングデータベース」でのコマンド: mysql -u root -p portal_csa < path_to/portal_csa_mysql_aggregation.sql § ‘portal_csa’ は上記の手順 2で作成したデータベーススキーマに置き換えてください。

§ ‘path_to’ は portal_csa_mysql.sql か portal_csa_mysql_aggregation ファイルのパスに置き換えてください。

Oracle データベースとユーザの設定 (Oracle 12cのみ)

オペレーションとレポートが異なるデータベースにある場合は、両方のデータ

ベースでこのプロセスを繰り返します。1. sqlplus `sqlplus / as sysdba` を開き、そこから残りの手順を実行します。

Page 7: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

Database Instructions

(portal_csaとは異なるスキーマ識別子を使用する場合は、portal_csaを以下のコマンド中でもデータベーススクリプトのカスタムスキーマ名と同

じく置き換えてください)。 2. CONNECT system/manager AS sysdba;

3. ALTERSESSIONSET"_oracle_script"=true4. CREATE USER portal_csa IDENTIFIED BY Passw0rd DEFAULT

TABLESPACE USERS TEMPORARY TABLESPACE TEMP; 5. GRANT CREATE SESSION, RESOURCE, CREATE VIEW, CREATE

MATERIALIZED VIEW, CREATE SYNONYM TO portal_csa; 6. ALTER USER portal_csa2 QUOTA UNLIMITED ON USERS; データベースとユーザの設定(Oracle 12cを除くすべてのバージョン)

1. データベース名、ユーザ、パスワード(パスワード変更が必要な場合)を変更するには、

<CSA_Portal_Package>/DatabaseScripts/portal_csa_oracle.sql.にある Oracle固有の SQLスクリプトを変更します。(データベースのインポートプロセスを実行する前に、必要なユーザ名とパスワードでこのスクリプトを変

更してください。)

2. CSA Portalデータベースへの接続に使用するユーザの認証情報を変更するには、SQLスクリプトの以下の行を変更します。: CREATE USER portal_csa IDENTIFIED BY Passw0rd DEFAULT TABLESPACE USERS TEMPORARY TABLESPACE TEMP; オプション: ‘portal_csa’と‘Passw0rd’ を任意のユーザ名とパスワードで置き換えます。以下の行をすべて 新情報で更新してください。: connect portal_csa/Passw0rd;

SQLデータベースのインポートスクリプトの実行 1. 次のコマンドを使用して sysdba として SQL*Plus にログインします。:

sqlplus /as sysdba 2. SQLスクリプトの実行結果をログ出力するには、spool をオンにします。:

spool /<path>/<to>/log.txt ; 3. SQLスクリプトを実行します。: @/<path>/<to>/portal_csa_oracle.sql 4. spoolをオフにします。: spool off; 5. SQL*Plusを終了します。: exit;

6. SQLエラーがないことを検証するため、スクリプト実行出力でログファイルを確認します。

Configure Reporting Database Connection SecureAssist Enterprise Portalは現在、MySQLレプリケーションのみを公式サポートしています。MySQL Database Serverレプリケーションの文書ついては、以下のサイトを参照してください。

§ MySQL 5.6: http://dev.mysql.com/doc/refman/5.6/en/replication.html

§ MySQL 5.7: http://dev.mysql.com/doc/refman/5.7/en/replication.html

レポーティングデータベースを正常に動作させるには、データベー

スのレプリケーションが必要です。

§ データベース接続設定前に、レプリケーションを設定する必

要があります。

Page 8: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

§ Enterprise Portalデータベースをセットアップする前に、データベースを「実働データベース」と「レポーティングデータ

ベース」にインポートする必要があります。

Configure Secure HTTP SecureAssist Enterprise Portalは、HTTPと Secure HTTP(HTTPS)をサポートしています。Codiscopeは HTTPSの使用を推奨しています。HTTPSを使用して Apache Tomcat Webサーバを設定する方法については、Webサーバのマニュアルを参照してください。インストールまたはアップグレードに先立ち、Codiscopeは 小ヒープサイズの 1GBの設定を推奨しています。

Deploy SecureAssist Portal これらは、 小および 大ヒープサイズを 1024 MBに設定するApache Tomcatアプリケーションサーバのための指示です。

Increase Tomcat Heap Size for a Command-Line Tomcat Instance 1. %CATALINA_HOME/bin フォルダに、"setenv.bat" または

"setenv.sh"という名前のファイルを作成し、CATALINA_OPTS をメモリ設定に設定します。 a. On Windows: "set CATALINA_OPTS='-Xms1024 –

Xmx1024m -Xss1024k -XX:PermSize=256m -XX:MaxPermSize=512m -XX:+UseConcMarkSweepGC -XX:+CMSClassUnloadingEnabled'"

b. On Linux: "export CATALINA_OPTS='-Xms1024m –Xmx1024m -Xss1024k -XX:PermSize=256m -XX:MaxPermSize=512m -XX:+UseConcMarkSweepGC -XX:+CMSClassUnloadingEnabled'"

Increase Tomcat Heap Size for a Windows Service Tomcat Instance 1. %CATALINA_HOME%\bin\ディレクトリで

Tomcat<version#>w.exe を実行し、初期メモリプールと最大メモリプールフィールドに 1024と入力します。

Page 9: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

Deploy Using Tomcat Manager Tomcatのインスタンスが Tomcat ウェブアプリケーションマネージャで実行されている場合は、ブラウザインタフェースを使用して

Portalを展開できます。

1. %CATALINA_HOME%/conf/tomcat_users.xmlで、manager-guiという名前のロールを作成し、このロールにユーザを割り当

てます。 その後、Tomcatインスタンスを再起動します。.

<tomcat-users><role rolename=“manager-gui”/><user username=“USERNAME” password=“PASSWORD” roles=“manager-gui”/></tomcat-users>

2. インターネットブラウザで、Tomcatホームページに移動します。(デフォルトでは http://apache_tomcat_hostname:8080/にあります)

3. Manager Appのリンクをクリックします。ユーザ名とパスワードの入力を求められます(上記の手順 1)。

4. ユーザ名とパスワードを入力します。Web Application Managerページがロードされます。

5. WAR file to deploy(WARファイルの配備)セクションに移動し、Browse(選択)をクリックします。

6. CSA Portal ウェブアプリケーションWARファイルを選択し、Open(開く)をクリック、次に Deploy(展開)をクリックします。Tomcatが Portalの展開を完了すると、アプリケーションのセクションに一覧表示され、すぐに利用でき

Page 10: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

ます。

Page 11: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

Deploy on a Running Tomcat Server 実行中の Tomcatサーバで SecureAssist Enterprise Portalを展開するには、以下の手順を実行します。

1. Tomcatの/conf/ディレクトリにある server.xmlファイルのautoDeployattribute を true に設定します。WARファイルがデプロイメントディレクトリにコピーされると、ホストはウェ

ブアプリケーションを展開します。 デフォルトのデプロイメントディレクトリは、 %CATALINA_HOME%/webappsです。

2. Portalを展開するには CSA_Server.warfile を%CATALINA_HOME%/webappsにコピーします。

3. Tomcatが Enterprise Portalの展開を終了した後、%CATALINA_HOME%/webappsの下に CSA_Server directory を作成します。

Deploy Using WebSphere SecureAssist Enterprise PortalをWebSphere(8.5.X)アプリケーションサーバに展開するには、以下の手順に従います。(アプリケーショ

ンを展開する前に、ヒープスペースを 1 GB以上に設定することを推奨します)。

1. Increase Heap Space.

a. WebSphere アプリケーションサーバ管理コンソールを開始します。

b. Servers(サーバ )> Application servers(アプリケーションサーバ)> server1 > Java and Process Management( Javaおよびプロセス管理)> Process Definition(プロセス管理)> Java Virtual Machine(Java 仮想マシン)へ移動します。

c. 初期ヒープサイズと 大ヒープサイズを少なくとも 1024 MBに設定します。

d. Apply(適用)をクリックします。 e. OKをクリックします。 f. Save(保存)をクリックし、

“Save directly to the master configuration.”(マスターコンフィギュレーションに直接保存)をクリックします。

g. WebSphereを再起動します。

2. Deploy SecureAssist Enterprise Portal EAR File.

a. WebSphere アプリケーションサーバ管理コンソールを開始します。

b. 画面の左側にあるナビゲーションメニューで、アプリケーションセクションから Global Deployment Settings(グローバル展開設定)を選択します。

c. Monitor directory to automatically deploy applications(アプリケーション自動展開のためのモニタディレ

クトリ)チェックボックスをチェックします。 d. Apply(適用)をクリックします。

Page 12: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

e. Save(保存)をクリックし、"Save directly to the master configuration." (マスターコンフィギュレーションに直接保存)をクリックします。

f. WebSphereを再起動します。 g. WebSphereが再起動したら、EARファイルを

WebSphere/AppServer/profiles/AppSrv04/monitoredDeployableApps/servers/server1にコピーします。

h. 数分後、WebSphere アプリケーションサーバ管理コンソールを開始します。

i. アプリケーションが展開され、実行されていることを確

認するには、ナビゲーションメニューから Applications(アプリケーション)> Applications Type(アプリケーションタイプ )> WebSphere enterprise applicationsを選択します。

j. http://<server>:<port>/CSA_Server/ に移動します。(例えば http://localhost:9080/CSA_Server/)

3. Optional. Import SSL certificate to support Secure LDAP.

a. WebSphere アプリケーションサーバ管理コンソールを開始します。

b. 画面左側のナビゲーションメニューで、セキュリティセクションから SSL certificate and key management(SSL証明書とキー管理)を選択します。

c. Related Items(関連項目)セクションの, Key stores and certificates(キーストアと証明書)をクリックします。

d. NodeDefaultKeyStoreを選択し、追加プロパティセクションで Signer Certificates(署名者証明書)をクリックします。

e. Signer Certificate(署名者証明書)テーブルで、Retrieve from Port(ポートから取得)をクリックします。

f. DAPSサーバのホスト名、ポート、キーの別名を入力し、Retrieve signer information(署名者情報の取得)をクリックします。

g. OKをクリックします。 h. Save(保存)をクリックし、"Save directly to the master

configuration." (マスターコンフィギュレーションに直接保存) をクリックします。

i. Key stores and certificates(キーストアと証明書)に戻り、NodeDefaultTrustStoreの手順(d)―(h)を繰り返します。

j. Websphereを再起動します。

Install MySQL Database Connector SecureAssist Enterprise Portalを MySQLデータベースに接続するには、MySQL Connector / J(MySQLデータベースの公式 JDBCドライバ)が必要です。Oracleデータベースを使用する場合は、この手順は不要です。

MySQLコネクタをインストールするには、以下の手順を実行します。

Page 13: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

1. http://dev.mysql.com/downloads/connector/j/に移動し、MySQL Connector / Jをダウンロードします。

2. 前の手順でダウンロードしたアーカイブを展開して、その中にある mysql-connector-java-5.x.x-bin.jarファイルを/CSA_Server/WEB-INF/libディレクトリにコピーします。

Deploy Codiscope SecureAssist Eclipse Update Site SecureAssist Eclipse更新サイトをポータルへ展開するには、Portalに付属の/ updateフォルダをコピーして、CSA_Serverフォルダのすぐ隣に置きます。Enterprise Portalから離れたサーバに展開するには、更新ディレクトリが HTTPまたは HTTPSを介してアクセス可能であることを確認します。

更新サイトの URLを表示するようポータルを設定するには、eclipseUpdateUrlの値を更新サイトの URLに変更し、eclipseUpdateTextの値を表示したいリンクに変更します。これは、SecureAssistの展開の WEB_INF/jsp/includesディレクトリにあるindex.jspファイルと login.jspファイルで実行する必要があります。変更を有効にするには、サーバを再起動する必要があります。

重要!ポータルにアップデートサイトを展開する際は、/ updateフォルダを CSA_Serverディレクトリ内ではなく隣に置きます。

Initial Configuration

Configure Logging Log4j構成ファイルは/CSA_Server/WEBINF/classes/log4j.xmlファイルに格納されています。

このファイルを編集し、デプロイメント環境に適したファイルにす

ることができます。

log4j.xmlには、ポータル管理者がカスタマイズできる log4j Appenderが 2つあります。

§ Appender “file(ファイル)”: 汎用ログです。 デフォルトでは、CSA_PORTAL.logに追加されます。

§ Appender “audit(監視)”: ポータルユーザのアクティビティを監視するためのログです。デフォルトでは、

CSA_PORTAL_AUDIT.csvに追加されます。(詳細は、添付 Cを参照してください)。

log4jの設定の詳細については、log4jのマニュアルを参照してください。

注意: ロギング構成ファイルに対する変更は、TomcatアプリケーションサーバまたはWebSphereアプリケーションサーバの再起動後にのみ有効です。

Page 14: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

Initial Configuration SecureAssist Enterprise Portalを正常に展開した後は、ブラウザを開いて http://<Host>:<Port>/CSA_Serverに移動し、ポータルの設定を完了します。以下の表に、設定が必要な項目を示します。

Item Description

License Terms 利用規約を読み、I Agree(同意する)をクリックして続行してください。

Product License SecureAssist Enterprise Portalのライセンスは特定のサーバに関連付けられており、そのサーバでのみ使用できます。再ホスティング

が必要な場合は、Codiscopeサポート([email protected])までご連絡ください。サーバライセンスは、SecureAssistフルフィルメント電子メールの一部としてお客様に送信されます。

サーバライセンスファイルを受信したら、 Browse(参照)をクリックしてサーバライセンスファイルを選択し、Enterprise Portalのセットアップ中にライセンスアクティベーション/アップロード画面で、Upload(アップロード)をクリックします。

Database Setup データベース接続の設定前に、上記の「データベースの設定」の

説明に従って、データベーススキーマを設定しデータベースユー

ザを作成する必要があります。すべてのフィールドに入力して

Save(保存)をクリックします。

例: Database Type: MySQL

“Production Database” Server: jdbc:mysql://<db_server>:3306 Database/Schema Name: portal_csa Database User: csauser

“Reporting Database” (optional) Server: jdbc:mysql://<db_server>:3306 Database/Schema Name: portal_csa Database User: csauser

Database Type: Oracle Server: jdbc:oracle:thin:@<db_server>:1521:orcl Database/Schema Name: portal_csa Database User: portal_csa

Administrator Account Setup

初期設定の 後の手順では、管理者アカウントを作成する必要が

あります。Administrator Type [管理者の種類]で[LDAP User (LDAPユーザ)]または[Local User (ローカルユーザ)]を選択し、該当フィールドに入力します。

§ Local user Username(ユーザ名)、Password(パスワード)、および Password Confirmation(パスワードの確認)を入力し、Save(保存)をクリックします。

§ LDAP user Authentication & Security (認証とセキュリティ)設定、Server(サーバ)設定、LDAP Login (LDAPログイン)設定、管理者の認証情報(Username(ユーザ名)、Password(パスワード)、Password Confirmation(パスワード確認))を入力し、Save(保存)をクリックします。

まずローカルユーザアカウントを設定し、次にポータルの LDAP接続を設定できます。LDAPを設定した後に、元のローカルユーザアカウントを無効にすることができます。

Page 15: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

初期設定が正常に完了すると、インデックスページにリダイレクト

され、作成した管理者の認証情報を使用してログインできます。

Configure Link on Index Page インデックスページには、SecureAssist Eclipse IDEプラグインをインストールまたは更新できる場所へのリンクのあるセクションがあり

ます。また、IntelliJと Visual Studioに別々のリンクを設定することもできますが、必須ではありません。

リンクを設定するには、/CSA_Server/WEB-INF/jsp/includes/に移動します。index.jspファイルを開き、以下の行を編集して、プラグインをインストールできる正しい URLにします。

リンクを表示しない場合は、値を空のままにします。

Page 16: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

Upgrade Instructions このセクションでは、SecureAssist Enterprise Portalを現在のバージョンから 新バージョンにアップグレードする方法について説明しま

す。データベースとサーバのアップグレード手順については、以下

のセクションを参照してください。適切な Portal機能を使用するには、アプリケーションサーバとデータベースコンポーネントの両方

をアップグレードする必要があります。

注: 以前のバージョンから SecureAssist 2.4または 2.4.1にアップグレードするには、新しい Enterprise Portalライセンスを再発行する必要があります。 SecureAssist 2.4または 2.4.1の新しいライセンスについては、[email protected]までお問い合わせください。

バージョン 2.5から以降のバージョンへのアップグレードを実行する場合、SecureAssist 2.5以降のインストールで提供されるLicense .jarファイルを使用します。

Application Upgrade 以下の手順に従って Portalをアップグレードします。

重要! データベースをアップグレードする前に、Apache TomcatまたはWebSphereアプリケーションサーバを必ず停止してください。

注 : バグを解消するために構成を変更している場合(たとえば、hibernate.cfgファイル)、アップグレード展開においても同じ変更を行う必要があります。

注 : SecureAssist 3.0では、%CATALINA_HOME%/webapps/CSA_Server/WEB-INFディレクトリにある cron.propertiesファイルが追加されています。cron.propertiesファイルを変更してアップグレード後に使用する予定がある場合は、これらの

変更を復元した cron.propertiesファイルに含める必要があります。

含まれる追加項目は以下のとおりです。

§ com.cigital.csa.cron.aggregate.enable=true § com.cigital.csa.cron.aggregate.interval=24 § com.cigital.csa.cron.aggregate.hour=0 § com.cigital.csa.cron.aggregate.minute=0 § com.cigital.csa.cron.aggregate.second=0

Tomcat Application Server 1. Apache Tomcatを停止します。 2. バックアップディレクトリを作成します。 3. 以下のディレクトリ/ファイルをバックアップします。

a. 以下のディレクトリとファイルをバックアップフォルダにコピーします。 - %CATALINA_HOME%/webapps/CSA_Server/key-file - %CATALINA_HOME%/webapps/CSA_Server/stats - %CATALINA_HOME%/webapps/CSA_Server/rulepacks - %CATALINA_HOME%/webapps/CSA_Server/WEB-

INF/lib/mysql-connector-java-5.x.x.jar

Page 17: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

b. %CATALINA_HOME%/webapps/CSA_Server/WEB-INF/フォルダから以下のファイルをバックアップフォルダにコピ

ーします。 - cron.properties - db.properties - <company_name>-SecureAssist-PriKey.der - SecureAssist.license - classes/log4j.xml (オプション、手順 9cを参照)

4. %CATALINA_HOME%/webappsフォルダから CSA_Server.warファイルを削除します。

5. %CATALINA_HOME%/webapps/CSA_Serverフォルダを削除します。

6. 新しい CSA_Server.warファイルを%CATALINA_HOME%/webapps フォルダにコピーしてサーバデプロイメントを実行するか、Tomcat Managerから warファイルを展開します。

7. 後述の「Database Upgrade」セクションの指示に従って、データベースをアップグレードします。

8. Apache Tomcatを起動します。 9. 以下のディレクトリ/ファイルを復元します。

a. 以下のディレクトリを%CATALINA_HOME%/webapps/CSA_Server: にコピーします。 - <backup>/key-file - <backup>/stats - <backup>/rulepacks

b. 以下のファイルを%CATALINA_HOME%/webapps/CSA_Server/WEB-INF:にコピーします。 - <backup>/cron.properties (このファイルの追加については、セクションの冒頭の注意を参照してください)

- <backup>/db.properties - <backup>/<company>-SecureAssist-PriKey.der - <backup>/SecureAssist.license

c. ファイル <backup>/log4j.xml を %CATALINA_HOME%/webapps/CSA_Server/WEBINF/classes/ にコピーします。 注: 2.3以前のバージョンからアップグレードする場合、リリース 2.3の Log4j構成ファイルには、ロギング構成を改善するための追加のロガーが含まれています。以前

のバージョンのファイルと置き換えるのではなく、新し

い log4j.xmlを設定することをお勧めします。 10. バックアップフォルダからコピーされたすべてのディレクトリとファイルが、Tomcatを実行しているユーザによって読み書き可能であることを確認します(たとえば、chown tomcat:tomcat path/to/file)。

11. MySQLコネクタ(mysql-connector-java-5.x.x.jar)を %CATALINA_HOME%/webapps/CSA_Server/WEB-INF/lib/ にコピーします。 注: MySQLを使用していない場合は、コピーを入手してインストールする必要はありません。

12. Apache Tomcatワークキャッシュを削除します。(e.g., /var/cache/tomcat6/work/Catalina/localhost/CSA_Server/*, <tomcat>/work/Catalina/localhost/CSA_Server/*).

13. Apache Tomcatを再起動します。

Page 18: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

Websphere Application Server 1. WebSphere アプリケーションサーバ (WAS) を停止します。 2. バックアップディレクトリを作成します。 3. 以下のディレクトリとファイルのバックアップ

a. 以下のディレクトリとファイルをバックアップフォルダにコピーします。 - /CSA_Server/key-file - /CSA_Server/stats - /CSA_Server/rulepacks - /CSA_Server/WEB-INF/lib/mysql-connector-java-5.x.x.jar

b. 以下のファイルを/CSA_Server/WEB-INF/ フォルダからバックアップフォルダにコピーします。 - cron.properties - db.properties - <company_name>-SecureAssist-PriKey.der - SecureAssist.license - classes/log4j.xml(オプション、手順 9cを参照)

4. WAS Server1フォルダから CSA_Server.EARファイルを削除します。

5. CSA_Serverフォルダを削除します。 6. 新しい CSA_Server.EARファイルをサーバ展開用 WAS Server1フォルダにコピーします。

7. 以下の「Database Upgrade」セクションの指示に従って、データベースをアップグレードします。

8. WebSphereアプリケーションサーバ (WAS) を開始します。 新しい CSA_Server.EARファイルは、再起動時に展開されます。

9. 以下ののディレクトリ/ファイルを復元します。 a. 以下のディレクトリを /CSA_Server: にコピーします。

- <backup>/key-file - <backup>/stats - <backup>/rulepacks

b. 以下のファイルを/CSA_Server/WEB-INFにコピーします。 - <backup>/cron.properties (このファイルの追加については、セクションの冒頭の注意を参照してください)

- <backup>/db.properties - <backup>/<company>-SecureAssist-PriKey.der - <backup>/SecureAssist.license

c. ファイル <backup>/log4j.xml を /CSA_Server/WEBINF/classes/ にコピーします。 注: バージョン 2.3以前のバージョンからアップグレードする場合、リリース 2.3の Log4j構成ファイルにはロギング構成を改善する追加のロガーが含まれています。

以前のバージョンのファイルと置き換えるのではなく、

新しい log4j.xmlを設定することをお勧めします。 10. MySQL コネクタ(mysql-connector-java-5.x.x.jar)を

/CSA_Server/WEB-INF/lib/にコピーします。 注: MySQLを使用していない場合は、コピーを入手してインストールする必要はありません。

11. WebSphereアプリケーションサーバ(WAS)を再始動します。

Page 19: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

Database Upgrade SecureAssist Portalの現在のバージョンによっては、いくつかのアップグレードスクリプトを実行する必要があります。SecureAssist Enterprise Portalは、以下のアップグレードパスをサポートしています(アップグレードスクリプトは、Enterprise Portal のアーカイブを展開した中の DatabaseScript/upgrade/にあります)。

注: 集計スクリプトはレポーティングデータベースで実行する必要がありますが、他のスクリプトは操作データベースで実行する必要

があります。 SecureAssistインスタンスで操作とレポーティングが同じデータベースにある場合は、両方を同じインスタンスにインスト

ールします。

重要! セカンダリレポーティングデータベースを設定する場合、データベース設定の前にレプリケーションを設定することを忘れない

でください。

Versions Upgrade Paths

3.0.2 から 3.0.3 次の順番でスクリプトを実行してください: '3.0.2_to_3.0.3'

3.0.1 から 3.0.3 次の順番でスクリプトを実行してください: ‘3.0.1_to_3.0.2’ '3.0.2_to_3.0.3'

3.0 から 3.0.3 次の順番でスクリプトを実行してください: ‘3.0_to_3.0.1’ ‘3.0.1_to_3.0.2’ '3.0.2_to_3.0.3'

2.5.1 から 3.0.3 次の順番でスクリプトを実行してください: ‘2.5.1_to_3.0.1’ ‘3.0.1_to_3.0.2’ aggregationスキーマは新規にインストールするため、このディレクトリの aggregation upgradeスクリプトは実行しないでください。 '3.0.2_to_3.0.3' `portal_csa_[db]_aggregation.sql` の [db] 部分は、お使いのデータベースに応じて mysql または oracle となります。

2.5.0 から 3.0.3 次の順番でスクリプトを実行してください: ‘2.4.1_to_2.5.1’ ‘2.5.1_to_3.0.1’ ‘3.0.1_to_3.0.2’ aggregationスキーマは新規にインストールするため、このディレクトリの aggregation upgradeスクリプトは実行しないでください。 '3.0.2_to_3.0.3' `portal_csa_[db]_aggregation.sql` の [db] 部分は、お使いのデータベースに応じて mysql または oracle となります。

2.4.1 から 3.0.3 次の順番でスクリプトを実行してください: ‘2.4.1_to_2.5.1’ ‘2.5.1_to_3.0.1’ ‘3.0.1_to_3.0.2’ aggregationスキーマは新規にインストールするため、このディレクトリの aggregation upgradeスクリプトは実行しないでください。 '3.0.2_to_3.0.3' `portal_csa_[db]_aggregation.sql` の [db] 部分は、お使いのデータベースに応じて mysql または oracle となります。

Page 20: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

Versions Upgrade Paths

2.4.0 から 3.0.3 次の順番でスクリプトを実行してください: ‘2.4.0_to_2.4.1’ ‘2.4.1_to_2.5.1’ ‘2.5.1_to_3.0.1’ ‘3.0.1_to_3.0.2’ aggregationスキーマは新規にインストールするため、このディレクトリの aggregation upgradeスクリプトは実行しないでください。 '3.0.2_to_3.0.3' `portal_csa_[db]_aggregation.sql` の [db] 部分は、お使いのデータベースに応じて mysql または oracle となります。

2.3.7, 2.3.8, 2.3.9 から 3.0.3

次の順番でスクリプトを実行してください: ‘2.3.7_to_2.4.0’ ‘2.4.0_to_2.4.1’ ‘2.4.1_to_2.5.1’ ‘2.5.1_to_3.0.1’ ‘3.0.1_to_3.0.2’ aggregationスキーマは新規にインストールするため、このディレクトリの aggregation upgradeスクリプトは実行しないでください。 '3.0.2_to_3.0.3' `portal_csa_[db]_aggregation.sql` の [db] 部分は、お使いのデータベースに応じて mysql または oracle となります。

2.3.6 から 3.0.3 次の順番でスクリプトを実行してください: ‘2.3.6_to_2.3.7’ ‘2.3.7_to_2.4.0’ ‘2.4.0_to_2.4.1’ ‘2.4.1_to_2.5.1’ ‘2.5.1_to_3.0.1’ ‘3.0.1_to_3.0.2’ aggregationスキーマは新規にインストールするため、このディレクトリの aggregation upgradeスクリプトは実行しないでください。 '3.0.2_to_3.0.3' `portal_csa_[db]_aggregation.sql` の [db] 部分は、お使いのデータベースに応じて mysql または oracle となります。

2.3.1 から 3.0.3 次の順番でスクリプトを実行してください: ‘2.3.1_to_2.3.6’ ‘2.3.6 to 2.3.7’ ‘2.3.7_to_2.4.0’ ‘2.4.0_to_2.4.1’ ‘2.4.1_to_2.5.1’ ‘2.5.1_to_3.0.1’ ‘3.0.1_to_3.0.2’ aggregationスキーマは新規にインストールするため、このディレクトリの aggregation upgradeスクリプトは実行しないでください。 '3.0.2_to_3.0.3' `portal_csa_[db]_aggregation.sql` の [db] 部分は、お使いのデータベースに応じて mysql または oracle となります。

Page 21: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

Versions Upgrade Paths

2.3 から 3.0.3 次の順番でスクリプトを実行してください: ‘2.3_to_2.3.1’ ‘2.3.1_to 2.3.6’ ‘2.3.6_to_2.3.7’ ‘2.3.7_to_2.4.0’ ‘2.4.0_to_2.4.1’ ‘2.4.1_to_2.5.1’ ‘2.5.1_to_3.0.1’ ‘3.0.1_to_3.0.2’ aggregationスキーマは新規にインストールするため、このディレクトリの aggregation upgradeスクリプトは実行しないでください。 '3.0.2_to_3.0.3' `portal_csa_[db]_aggregation.sql` の [db] 部分は、お使いのデータベースに応じて mysql または oracle となります。

2.2 から 3.0.3 次の順番でスクリプトを実行してください: ‘2.2_to_2.3.1’, ‘2.3.1_to_2.3.6’ ‘2.3.6_to_2.3.7’ ‘2.3.7_to_2.4.0’ ‘2.4.0_to_2.4.1’ ‘2.4.1_to_2.5.1’ ‘2.5.1_to_3.0.1’ ‘3.0.1_to_3.0.2’ aggregationスキーマは新規にインストールするため、このディレクトリの aggregation upgradeスクリプトは実行しないでください。 '3.0.2_to_3.0.3' `portal_csa_[db]_aggregation.sql` の [db] 部分は、お使いのデータベースに応じて mysql または oracle となります。

以下の手順に従って、データベースをアップグレードしてくださ

い。.

Page 22: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

Database Instructions

MySQL バージョン 3.0より前のバージョンからアップグレードする場合は、レプリケーションのない 1つの「実働データベース」しかありません。

「実働データベース」のみを「レポーティングデータベース」なしで使

用している場合は、以下の手順に従ってください。

1. データベースをアップグレードするには、以下のコマンドを実行します。

「実働データベース」は portal_csa です。 mysql -u root -p portal_csa < path_to/upgrade/{from_to_versions}/mysql_upgrade_{version}_to_{version}.sql mysql -u root -p portal_csa < /portal_csa_mysql_aggregation.sql

「レポーティングデータベース」とともに「実働データベース」を使用

している場合、またはその構成へアップグレードする場合は、以下の手

順に従ってください。

1. データベースをアップグレードするには、以下のコマンドを実行します。

「実働データベース」は portal_csaです。

「レポーティングデータベース」は、portal_csaです (別の場所にレプリケートされています)

「実働データベース」でのコマンド: mysql -u root -p portal_csa < path_to/upgrade/{from_to_versions}/mysql_upgrade_{version}_to_{version}.sql 「レポーティングデータベース」でのコマンド: mysql -u root -p portal_csa < /portal_csa_mysql_aggregation.sql

Oracle データベースとユーザを設定

1. データベース名、ユーザ、パスワードを変更するには(パスワードの変更が必要です)、以下の場所にある Oracle固有の SQLスクリプトを変更します。<CSA_Portal_Package>/DatabaseScripts/portal_csa_oracle.sql. (Please make sure to modify this script with desired username and password prior to running the database import process.)

2. CSA Portalデータベースへの接続に使用するユーザの資格情報を変更するには、SQLスクリプトの以下の行を変更します。CREATE USER portal_csa IDENTIFIED BY Passw0rd DEFAULT TABLESPACE USERS TEMPORARY TABLESPACE TEMP; オプション: ‘portal_csa’ と ‘Passw0rd’を選択したユーザ名とパスワードに置き換えます。以下の行をすべて 新の情報に更新してくだ

さい。:connect portal_csa/Passw0rd; SQLデータベースのインポートスクリプトの実行

1. 以下のコマンドを使用して sysdbaとして SQL * Plusにログインします。: sqlplus /as sysdba

2. SQLスクリプトの実行結果をログ出力するには、spoolをオンにします。: spool /<path>/<to>/log.txt ;

3. SQLスクリプトを実行します。 @/<path>/<to>/oracle_upgrade_{version}_to_{version}.sql and @/<path>/<to>/portal_csa_oraclel_aggregation.sql

4. spoolをオフにします。: spool off; 5. SQL * Plusを終了します。: exit; 6. エラーがないことを検証するために、SQLスクリプト実行出力でロ

グファイルを確認します。

Page 23: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用
Page 24: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

1 Log in to SecureAssist SecureAssistのログイン画面 http://<Host>:<Port>/CSA_Serverにユーザ名とパスワードを入力します。(管理ユーザアカウントは、Enterprise Serverの設定と構成の 後の手順で設定されたものです)

Getting Started 初に Portalにログオンすると、デフォルトで「開始」画面が開き

ます。画面には機能が表示されます。

Feature Description

Learn how it works SecureAssist Support画面とその関連文書へのリンクを提供します。

Install the SecureAssist Plugin

Eclipse、Visual Studio、および IntelliJプラグインのダウンロード用のリンクを提供します。

Activate SecureAssistプラグインライセンスを有効にする指示を示します。

Portal Navigation アプリケーションの左側にあるナビゲーションメニューを使用する

と、いつでも SecureAssist機能エリアにアクセスできます。機能エリアは以下のとおりです。

§ Statistics統計—確認された問題の数や種類、検索されたガイダンス、プロジェクトまたは個々のユーザにより修正された

脆弱性の履歴などが表示される即時レポーティング機能。 § Reportsレポート —管理者は、プロジェクトまたはユーザグループのための様々な事前定義レポートを作成できます。

§ Rulepacksルールパック —ライセンス済みの SecureAssistのクライアントに配布するため Portalにロードされた様々なルールパックを一覧表示します。

§ Manage管理— ユーザ、グループ、ロール、個人アカウントを管理するための画面を表示します。

§ Settings設定— アプリケーションを設定し、使用許諾契約を閲覧するための様々な設定を含んでいます。

§ Get Started開始— “ホームページ”

次章では、SecureAssist Enterprise Portalの機能について詳しく説明します。

Page 25: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

2 Statistics プラグイン機能とユーザアクティビティをカバーする統計は、定期

的に Portalに送信されます。この情報は、Portalサーバ上のデータベースに格納されており、多数の事前定義されたチャートやグラフを

表示・エクスポートできます。

Project Statistics Project Statistics(プロジェクト統計)画面では、プロジェクトごとに統計情報を即座に表示できます。

• Run Statistics for a Selected Project

1. Project Statistics(プロジェクト統計)ウィンドウに移動します。Select a Project(プロジェクトを選択)のフライアウトが自動で開きます。(フライアウトを手動で開くには Select a Project(プロジェクトを選択)ボタンをクリックします)。

2. 以下のいずれかによりプロジェクトを探します。

プロジェクトのリストをスクロールすること および /または 検索ボックスにテキストを入力して選択範囲をフィルタリン

グすること および /または フィルタアイコンをクリックして Java、Net、PHPで選択肢をフィルタリングすること

Page 26: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

3. 目的のプロジェクトの隣にある Select(選択)をクリックします。ダイアログボックスが閉じ、Project Statistics Options(プロジェクト統計オプション)ウィンドウにデフォルト情

報が表示されます。以下の表では、プロジェクト統計オプシ

ョンウィンドウの条件について説明します。

Field/Feature Description

Project 統計情報が提供される、選択中のプロジェクトを表示しま

す。 別のプロジェクトを選択するには、Change (変更)をクリックします。

File プロジェクトで現在選択されているファイルを表示します

(デフォルトでは全ファイル)。ファイルの選択を変更する

には、Change (変更)をクリックします。

Date Range 統計情報が提供される、選択された日付範囲を表示します

(デフォルトは現在の日付)。更新するには、日付のボック

スをクリックして新しい開始日および/または終了日を選択します。

Type 以下の 3種類の統計のいずれかを選択します。

§ Top Findings上位の検出結果 —選択したプロジェクトの上位 10件の結果。

§ File Scanファイルスキャン —見たい統計のプロジェクト内の個々のファイルを選択できます。(選択すると、

Sort by(並べ替え)はオプションになりません)

§ Suppression抑止—エンドユーザ、プロジェクト、プロジェクトファイルごとに抑止された問題を表示します。

Sort by 以下のいずれかの方法で結果を並べ替えるため選択します。

§ Categoryカテゴリ —トリガされた/実行されたルールのカテゴリ

§ Titleタイトル — 特定のルールの名前

Show Chart このボタンをクリックすると、選択した条件に基づいてチャ

ートが表示されます。

Download CSV チャートが表示されたら、このボタンをクリックしてデータ

を CSVファイルに保存します。

4. プロジェクト統計オプションウィンドウで、条件を選択します。

Page 27: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

5. Show Chart(チャートを見る)をクリックします。 SecureAssistは選択内容に基づいてグラフを表示します。

6. 必要に応じて、ユーザでレポート結果をフィルタリングします。

a. フィルタペインでは、1人以上のユーザをクリックしてハイライトします。

b. Update(更新)をクリックします。 レポートが更新され、選択したユーザのデータのみが表示されます。 注:ファイルスキャン統計の場合、データは 1人のユーザに対してのみ表示されます。

7. 必要に応じて、Download CSVをクリックして、データをCSVファイルに保存します。

Page 28: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

User Statistics User Statistics(ユーザ統計)画面では、一人のユーザの統計情報を表示できます。この画面にアクセスすると、すべてのプラグインユ

ーザのリストが表示されます(リストにはクライアントライセンス

に基づいて追加されます)。

• Find a User

1. ユーザリスト内のユーザをすばやく見つけるには、Find a User(ユーザを見つける)ボックスにテキストを入力します。リストは自動的にフィルタリングされ、テキストを含む

ユーザ名のみが表示されます。

• Run Statistics for a Single User

1. リストで目的のユーザの名前を探し、その隣にある Get Statistics(統計の取得)ボタン をクリックします。User Statistics Options(ユーザ統計オプション)ウィンドウには、デフォルトの情報が表示されます。以下の表は、このウィン

ドウの条件を示したものです。

Field/Feature Description

User 統計情報が提供される、選択中のユーザを表示します。

別のユーザを選択するには、Change(変更)をクリックします。

Date Range 統計情報が提供される、選択日付範囲を表示します(デ

フォルトは現在の日付)。更新するには、日付のボック

スをクリックして新しい開始日および/または終了日を選択します。

Page 29: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

Field/Feature Description

Type 以下のタイプの統計のいずれかを選択します。

§ User Sessionユーザセッション —タイムライン上のユーザの異なるセッションを表示します。開始点ま

たは終了点にカーソルを合わせると、タイムスタン

プが表示されます。

§ Scanned File Typesスキャンされたファイルの種類 — スキャンされたファイルを種類別に円グラフで表示します。

§ Searched Guidance検索されたガイダンス —チャートは、ガイダンスカテゴリと、指定した期間にユー

ザが検索した回数を表示します。ガイダンスが見つ

かったルールパックも示します。

§ Top Findings上位の検出結果 —選択したユーザの検出結果の上位 10件

§ Issues Reviewed問題のレビュー —グラフには、ユーザが見つけてレビューした問題の数が表示されま

す。プロジェクトの選択が必要です。

§ Issues Suppressed抑止された問題—. 特定の間隔、プロジェクト、ファイルに対して、ユーザが抑止し

た問題を表示します。プロジェクトの選択が必要で

す。

Sort by (available only when Top Findings or Issues Suppressed is selected)

結果を並べ替えるため、以下のいずれかの方法を選択し

ます。

§ Categoryカテゴリ —トリガされた/実行されたルールのカテゴリ

§ Titleタイトル — 特定のルールの名前

Select a Project (available only when Issues Reviewed or Issues Suppressed is selected)

このボタンをクリックしてプロジェクトを選択します。

Show Chart このボタンをクリックすると、選択した条件に基づいて

統計が表示されます。

Download CSV このボタンをクリックすると、データが CSVファイルに保存されます。

2. User Statistics Options(ユーザ統計オプション)ウィンドウから、検索条件の選択を行います。

3. Show Chart(チャートを見る)をクリックします。 SecureAssistは選択内容に基づいてグラフを表示します。

4. 必要に応じて、Download CSV(CSVをダウンロード)をクリックして、データを CSVファイルに保存します。

Timeseries Timeseries 画面では、選択した日付範囲および選択したプロジェクトの不具合/問題データのグラフを表示できます。

Page 30: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

問題の棒グラフは、特定の期間における、選択したプロジェクトの

問題の数と重大度を示しています。

下の、問題の重度の折れ線グラフは、時間の経過に対する問題の総

数(オレンジ色)とコードの行数(LOC、青色)の両方を表示します。

• Run the Issues and Issue Density Graphs

1. Timeseriesウィンドウに移動します。

2. Date Range(日付範囲)フィールドに、目的の期間の開始日と終了日を入力します。

3. Project Name(プロジェクト名)またはMeta(メタ)フィールドでは、テキストボックスに目的のプロジェクトまた

はメタデータを入力します。 重要! 完全で正確なプロジェクト名またはメタデータ名を入力する必要があります。

Page 31: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

4. Search(検索)をクリックします。 問題と問題の重度のグラフが画面に表示されます。

Page 32: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

3 Reports レポートには、プロジェクトとユーザの 2種類があります。 タイプごとにいくつかのレポートを生成することができます。

Project Reports プロジェクトレポートは、1つ以上の選択したプロジェクトに対して作成するレポートです。レポートを追加すると、アプリケーショ

ンは、新しいレポートのポップアップで選択した様々なレポートタ

イプを含む ZIPアーカイブを生成します。Project Reports(プロジェクトレポート)画面に移動すると、すでに実行されているレポート

パッケージの一覧が表示されます。初めてのアクセスの際は空白に

なります。

この画面からは、 初から新しいレポートを実行したり、以前実行

したレポートパッケージの詳細を表示したり、以前実行したレポー

トパッケージを再実行してダウンロードしたりすることができま

す。

• Find a Report

1. レポートリスト内のレポートをすばやく見つけるには、Find a Report(レポートを見つける)ボックスにテキストを入力します。リストは自動でフィルタリングされ、名前にテキ

ストが含まれているレポートのみが表示されます。

• View Details of Previously Run Report

1. レポートに関連付けられたプロジェクトを表示するには、そのレポートの行のプロジェクト列をクリックします。フィル

タのフライオーバーが右側に開き、選択したプロジェクト名

またはプロジェクトを選択するのに使用したメタデータが表

示されます。

Page 33: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

2. レポートのその他の詳細をすべて表示するには、Projects(プロジェクト)列を除くレポートの行の任意の場所をクリ

ックします。ポップアップが開き、レポート名、日付範囲、

レポートの種類、レポート実行時の開始時刻と終了時刻、レ

ポート実行の期間、ステータスが表示されます。

• Add a New Report

レポートを実行するには、レポートの種類を選択し、レポート

するプロジェクトを選択する必要があります。

1. プロジェクトレポート画面で、Add Report(レポートの追加)をクリックします。 新しいレポートのフライアウトが開きます。

2. Name(名前)にレポートのタイトルを入力します。この名前がレポート結果としてプロジェクトレポート画面に表示さ

れます。

3. Date Range(日付範囲)で、7日、30日、またはすべてのオプションのいずれかを選択します。

4. Report Types(レポートの種類)で、1つ以上の種類のレポートを選択します。

Types of Project Reports Description

Portfolio Summary Report 直近のプロジェクト/ソリューションのスキャン日に基づき、プロジェクトごとの不備、スキャンされたファイルの

数、コードの行数を一覧表示します。

Project Report 新のスキャン日付、不備の数、コードの行数、前回のス

キャンを実行した開発者など、プロジェクト/ソリューションレビューの一部としてスキャンされたすべてのファイル

を一覧表示します。

Project Defect Report プロジェクトごとの前回のプロジェクト/ソリューションレビュー中に発生したすべてのルールを一覧表示します。

Global Defect Report すべてのファイルで発生したすべてのルールを一覧表示し

ます。

5. Next(次へ)をクリックします(Next(次へ)は、名前を入力して少なくとも 1つのレポートタイプを選択した場合のみ使用できます)。フィルタのフライアウトが表示され、レ

ポート名のタイトルが上部に表示されます。このフライアウ

トを使用して、プロジェクト名またはメタデータで報告した

いプロジェクトをフィルタ処理します。各セクションのタイ

トルをクリックすると、関連するフィールドが表示されま

す。 注: メタデータは SecureAssistプラグインで設定され、SecureAssistプラグインから報告されます。詳細について

Page 34: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

は、SecureAssistプラグインのドキュメントを参照してください。

6. フィルタのフライアウトで、以下のいずれかの方法によりレポートを作成するプロジェクトを選択します。 Project Name (プロジェクト名)のセクションで、各プロジェクトの横にある Add (追加)ボタンをクリックして 1以上のプロジェクトを選択するか、Add All (すべてを追加)をクリックしてプロジェクトをすべて選択します。 または Metadata (メタデータ)のセクションで、メタデータ値を指定してプロジェクトを選択します。複数のキーと値のペア

が指定されている場合、フィルタはすべてのキーと値のペア

を満たすプロジェクトを検索します。

a. Key(キー)に、フィルタリングするフィールドを入力します。

b. Value(値)に目的のフィルタ値を入力します。 c. Add(追加)をクリックします。フィルタ条件は、追加機能の下のリストに追加されます。

d. 必要に応じて条件を追加します。

7. Save(保存)をクリックします。フィルタのフライアウトが閉じ、プロジェクトレポート画面に戻ります。新しいレポ

ートが画面上部に一覧表示され、Scheduled(予定)のステータスになります。レポートが生成されると、ステータスは

Complete(完了)に切り替わります(生成時間はレポートのサイズによって異なります)。

Page 35: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

• Download a Report

1. Project Reports(プロジェクトレポート)画面で、プロジェクト列を除く、目的のレポートの行の任意の場所をクリック

します。フライアウトが開き、レポート詳細と数個のアクシ

ョンボタンの一覧が表示されます。

2. フライアウトの一番下までスクロールして、Download Report. (レポートのダウンロード)をクリックします。レポート結果の ZIPファイルは自動的にダウンロードフォルダに保存されます。

3. ZIPファイルを開きます。選択したレポートタイプごとに別々の CSVファイルが表示されます。

注: ダウンロードされた ZIPファイルの名前は「ProjectReports」となり、実行日が追加され、CSVファイルの名前はレポートの種類によって指定されます。レポート名に入力した名前は、プ

ロジェクトレポート画面にのみ表示されます。

• Re-Run a Report

以前に実行したレポートと同じレポートを実行したい場合、Re-Run Report(レポートを再実行)により、実行できます。

1. Project Reports(プロジェクトレポート)画面で、プロジェクト列を除く、目的のレポートの行の任意の場所をクリック

します。フライアウトが開き、レポート詳細と数個のアクシ

ョンボタンの一覧が表示されます。

2. フライアウトの一番下までスクロールし、Re-Run Report(レポートを再実行)をクリックします。フィルタのフラ

イアウトが閉じ、プロジェクトレポート画面に戻ります。再

実行レポートは、画面の上部に、Scheduled(予定)のステータスで表示されます。レポートが生成されると、ステータ

スは Complete(完了)に切り替わります。 注:再実行レポートは、元の実行のものと同じ名前になります。つまり、プロジェクトレポートリストには同じ名前のも

のが 2つあります。

• Copy to New Report

Copy to New Report(新しいレポートへコピー)の機能は、基本的には「別名保存」の機能です。新しいレポートにコピーす

るときは、以前に作成したレポートの選択をデフォルト選択と

して使用して新しいレポートを作成します。新しいレポートを

保存する前にこれらの選択を編集したり、新しいレポート名を

作成したりすることができます。

1. Project Report(プロジェクトレポート)画面で、プロジェクト列を除く、目的のレポートの行の任意の場所をクリックし

Page 36: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

ます。フライアウトが開き、レポートの詳細と数個のアクシ

ョンボタンの一覧が表示されます。

2. フライアウトの一番下までスクロールし、Copy to New Report (新しいレポートにコピー)をクリックします。フライアウトが開き、以前に選択された日付範囲とレポート

タイプが表示されますが、レポート名は空白になります。

3. Name(名前)に新しいレポート名を入力します。

4. 必要に応じて、日付範囲とレポートタイプで選択を変更します。

5. Next(次へ)をクリックして、フィルタのフライアウトに進みます。

6. 必要に応じて、フィルタ条件を変更します。

7. Save(保存)をクリックします。フィルタのフライアウトが閉じ、プロジェクトレポート画面に戻ります。新しいレポ

ートは、画面上部にリストされ、Scheduled(予定)ステータスになります。レポートが生成されると、ステータスは

Complete(完了)に切り替わります。

• Delete a Report

1. Project Report(プロジェクトレポート)画面で、プロジェクト列を除く、目的のレポートの行の任意の場所をクリックし

ます。フライアウトが開き、レポートの詳細と数個のアクシ

ョンボタンの一覧が表示されます。

2. フライアウトの上部で、Delete Report(レポートの削除)をクリックします。削除を確認するポップアップが表示され

ます。

3. Yes, delete it(はい)をクリックして削除します。プロジェクトレポート画面に戻り、レポートインスタンスがリストか

ら削除されます。

Page 37: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

User Reports ユーザレポートは、1以上の選択したユーザグループに対して作成するレポートです。レポートを追加すると、アプリケーションは新

しいレポートのフライアウトで選択した様々なレポートタイプを含

む ZIPアーカイブを生成します。

User Reports(ユーザレポート)画面に移動すると、すでに実行されているレポートパッケージの一覧が表示されます。画面への初回ア

クセス時には空白になっています。

この画面では、 初から新しいレポートを実行したり、以前に実行

したレポートパッケージの詳細を表示したり、以前に実行したレポ

ートパッケージを再実行したりすることができます。

• Find a Report

1. レポートリストのレポートをすばやく見つけるには、Find a Report(レポートを見つける)ボックスにテキストを入力します。リストは自動でフィルタリングされ、名前にテキス

トが含まれるレポートのみが表示されます。

• View Details of Previously Run Report

1. レポートに関連付けられているユーザグループを表示するには、そのレポートの行の Users(ユーザ)列をクリックします。フィルタのフライオーバーが右側に開き、選択したユー

ザグループが表示されます。

2. レポートの他のすべての詳細を表示するには、ユーザ列を除くレポートの行の任意の場所をクリックします。フライアウ

トが開き、レポート名、日付範囲、レポートのタイプ、レポ

ート実行時の開始時刻と終了時刻、レポート実行の期間、ス

テータスが表示されます。

Page 38: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

• Add New Report

レポートを実行するには、レポートのタイプを選択し、レポー

トするユーザグループを選択する必要があります。

1. User Reports(ユーザレポート)画面で、Add Report(レポートの追加)をクリックします。新しいレポートのフライ

アウトが開きます。

2. Name(名前)にレポートのタイトルを入力します。

3. Date Range(日付範囲)で、以下のオプションのうちのいずれかを選択します;7日、30日、すべて

4. Report Types(レポートの種類)で、1つ以上の種類のレポートを選択します。

Types of User Reports Description

Developer File Coverage Report

開発者ごとのレビューしたファイルの数をタイプ別に一覧表示

します。

Developer Defect Report 開発者ごとのカテゴリ別の問題の総数を一覧表示します。

Developer Project Report 各開発者がスキャンしたすべてのファイルを一覧表示します。

レポートには、開発者がスキャンした 新の日付ファイル、不

備の数、抑止した回数、各ファイルのコードの行が含まれま

す。

Developer Usage Report ツールが開発者によって 初に使用された時間および 後に使

用された時間、不備の総数、抑止の回数を一覧表示します。

5. Next(次へ)をクリックします(Next(次へ)は、名前を入力して少なくとも 1つのレポートのタイプを選択した場合にのみ利用可能になります)。フライアウトのタイトルがレ

ポート名になり、Included Groupsセクションが表示されます。

6. Included Groupsセクションで、各グループの横にある Add (追加)ボタンをクリックして 1つ以上のグループを選択するか、Add All (すべて追加)をクリックしてグループをすべて選択します。

7. Save(保存)をクリックします。フィルタリングのフライアウトが閉じ、ユーザレポート画面に戻ります。新しいレポ

ートは、画面上部に一覧表示され、Scheduled(予定)のステータスになります。レポートが生成されると、ステータス

は Complete (完了)に切り替わります。

Page 39: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

• Download a Report

1. User Reports(ユーザレポート)画面で、ユーザ列を除く任意のレポートの行をクリックします。フライアウトが開き、

レポートの詳細と数個のアクションボタンの一覧が表示され

ます。

2. フライアウトの一番下までスクロールして、Download Report(レポートのダウンロード)をクリックします。レポート結果の ZIPファイルは自動的にダウンロードフォルダに保存されます。

3. ZIPファイルを開きます。選択したレポートタイプごとに別々の CSVファイルが表示されます。

注: ダウンロードした ZIPファイルの名前は "UserReports"で、実行日が追加され、CSVファイルの名前はレポートのタイプによって指定されます。レポート名に入力した名前は User Reports 画面にのみ表示されます。

• Re-Run an Existing Report

以前に実行したレポートと同じレポートを実行したい場合、Re-Run Report(レポートを再実行)により、実行できます。

1. User Reports(ユーザレポート)画面で、ユーザ列を除く任意のレポートの行をクリックします。フライアウトが開き、

レポートの詳細と数個のアクションボタンの一覧が表示され

ます。

2. フライアウトの一番下までスクロールし、Re-Run Report(レポートを再実行)をクリックします。フィルタのフラ

イアウトが閉じ、プロジェクトレポート画面に戻ります。再

実行レポートは、画面の上部に、Scheduled(予定)のステータスで表示されます。レポートが生成されると、ステータ

スは Complete(完了)に切り替わります。 注:再実行レポートは、元の実行のものと同じ名前になります。つまり、ユーザレポートリストには同じ名前のものが 2つあります。

• Copy to New Report

Copy to New Report (新しいレポートへコピー)の機能は、基本的には「別名保存」の機能です。新しいレポートにコピー

するときは、以前に作成したレポートの選択をデフォルト選択

として使用して新しいレポートを作成します。新しいレポート

を保存する前にこれらの選択を編集したり、新しいレポート名

を作成したりすることができます。

1. User Reports(ユーザレポート)画面で、ユーザ列を除く、目的のレポートの行の任意の場所をクリックします。フライ

Page 40: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

アウトが開き、レポートの詳細と数個のアクションボタンの

一覧が表示されます。

2. フライアウトの一番下までスクロールし、Copy to New Report (新しいレポートにコピー)をクリックします。フライアウトが開き、以前に選択された日付範囲とレポート

タイプが表示されますが、レポート名は空白になります。

3. Name(名前)に新しいレポート名を入力します。

4. 必要に応じて、日付範囲とレポートタイプの選択を変更します。

5. Next(次へ)をクリックします。レポートに含めるユーザのリストが表示されます。

6. Save(保存)をクリックします。フィルタのフライアウトが閉じ、ユーザレポート画面に戻ります。新しいレポート

は、画面上部にリストされ、Scheduled(予定)ステータスになります。レポートが生成されると、ステータスは

Complete(完了)に切り替わります。

• Delete a Report

1. User Reports(ユーザレポート)画面で、ユーザ列を除く、目的のレポートの行の任意の場所をクリックします。フライ

アウトが開き、レポートの詳細と数個のアクションボタンの

一覧が表示されます。

2. フライアウトの上部で、Delete Report(レポートの削除)をクリックします。削除を確認するポップアップが表示され

ます。

4. Yes, delete it(はい)をクリックして削除します。ユーザレポート画面に戻り、レポートインスタンスがリストから削除

されます。

Page 41: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

4 Rulepacks ルールパックは、SecureAssistプラグインがプロジェクトをスキャンするのに使用するルールやガイダンスを含む JARファイルです。ルールパックを有効または無効にすることにより、Portalで複数のルールパックをロードしたり、プラグインユーザに配布したりできま

す。ルールパックは、SecureAssistプラグインユーザの特定のグループに特化しても構いません。

SecureAssistはデフォルトのルールパックを提供していますが、SecureAssistプラグインとセットの Rulepack Configuratorを使用して独自のカスタムルールパックを作成・編集することもできます。

(Codiscopeのウェブサイトの Guides&Documentationページを開き、Rules&Rulepacksをクリックしてください。)

注: 1つ以上のデフォルトおよび/またはカスタムルールパックをアクティブにすることができます。グループ管理者の役割を持つユー

ザにルールパックをアップロードさせることで、ルールパックを特

定のグループに割り当てることもできます。

• Find a Rulepack

1. ルールパックのリストからルールパックをすばやく見つけるには、Find a Rulepack(ルールパックを見つける)ボックスにテキストを入力します。リストが自動的にフィルタリ

ングされ、名前にテキストが含まれているルールパックのみ

が表示されます。

• View Details of Rulepack

1. ルールパックのすべての詳細を表示するには、ルールパックの行の任意の場所をクリックします。フライアウトには以下

の詳細が表示されます。すべてのフィールドの値は Rulepack Configuratorで設定されており、Status(ステータス)を除き、SecureAssist Portalでは読み取り専用となっています。

Field Description

Name アッププロードされたルールパックの名前

Status (updateable) Enabled(有効)または Disabled(無効);左端に色付きのバーで示されます。一度に複数のルールパックを有効にするこ

とができます。ルールパックのステータスを変更するには、

このボタンをクリックします。

Version アップロードされたルールパックのバージョン番号

Plugin Support このルールパックでサポートされているプラグインのバージ

ョンのリスト

Type ルールパックのタイプ(デフォルトまたはカスタム)

Page 42: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

Field Description

Access アクセスレベル(Restricted(制限付き)または Unbounded(無制限))。制限付きのルールパックは、特定のプラグイ

ンユーザのみがアクセスできます。

Uploaded ルールパックがアップロードされた日付

• Upload a Rulepack

1. Rulepacks(ルールパック)画面で、Upload Rulepack(ルールパックのアップロード)をクリックします。

2. 目的のルールパックを探して参照し、Open(開く)をクリックしてルールパックをアップロードします。ルールパック

に戻ると、新しいルールパックが無効の状態でリストに表示

されます。

• Enable/Disable a Rulepack

重要! 古いバージョンには古いルールが含まれている可能性があるため、 新のルールパックを有効にし、すべての古いバージ

ョンを無効にすることを推奨します。

1. Rulepacks(ルールパック)画面で、アップロードされたルールパックのリストを表示します。有効なルールパックは、

左の余白に緑色のバーで示されます。無効なルールパック

は、茶色のバーで表示されます。

2. 目的のルールパックの行を1回クリックします。編集のフライアウトが右側に表示されます。

Page 43: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

3. Status(ステータス)で、Enabled(有効)または Disabled(無効)をクリックして、目的のステータスを選択しま

す。フライアウトがすぐに閉じられ、ルールパックのステー

タスが更新されます。ルールパックへの変更は、次にセッシ

ョンが開始される際にはユーザが利用できるようになってい

ます。

• Download a Rulepack to Edit on Your Machine

1. Rulepacks(ルールパック)画面で、目的のルールパックの行を 1回クリックします。編集のフライアウトが右側に表示されます。

2. Download(ダウンロード)をクリックします。ダウンロードを確認するポップアップが表示されます。

3. Keep(続ける)をクリックします。ルールパックファイルがコンピュータにダウンロードされます。Rulepack Configuratorを使用して編集できるようになります。

• Delete a Rulepack

ルールパックは、ルールパックを使用して実行された以前のプ

ロジェクトレポートがない場合にのみ削除できます。ルールパ

ックを含むプロジェクトレポートが生成された場合、ルールパ

ックを無効にすることはできますが削除することはできませ

ん。プロジェクトレポートは既存のアクティブなルールパック

に基づいています。

1. Rulepacks(ルールパック)画面で、目的のルールパックの行を 1回クリックします。編集のフライアウトが右側に表示されます。

2. Delete Rulepack(ルールパックの削除)をクリックします。削除を確認するポップアップが表示されます。

Page 44: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

3. OKをクリックします。フライアウトが終了し、ルールパックがリストから削除されます。

Page 45: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

5 Manage 管理機能を使用すると、個人アカウントだけでなく、SecureAssist Portalで使用されるユーザ、グループ、ロールを管理できます。

Portal Users Portal Users(ポータルユーザ)画面では、様々な SecureAssist Portalのユーザを管理できます。このユーザとは、プラグインユーザでは

なく、SecureAssistシステムの管理者(ポータル管理者、ルールパック管理者、プラグインユーザアクティビティに基づいてレポートを

表示および生成するユーザ)です。

デフォルトのポータルサーバ管理者以外のユーザは、ポータルデー

タベースに格納された資格情報に対して認証されるか、LDAPを使用して認証されるローカルユーザです。デフォルトのポータルサー

バ管理者は、常にローカルユーザです。ただし、他のポータルユー

ザが作成されると無効にできます。

• Find a Portal User

1. ポータルユーザリストのユーザをすばやく見つけるには、Find a Portal User(ポータルユーザを見つける)ボックスにテキストを入力します。リストは自動的にフィルタリング

され、名前にテキストが含まれるポータルユーザのみが表示

されます。

• Add a Portal User

1. Portal Users(ポータルユーザ)画面で、Add Portal User(ポータルユーザの追加)をクリックします。新規ユーザのフ

ライアウトが開きます。

2. Name(名前)にユーザ名を入力します。ユーザ名には文字と数字のみ入力でき、スペースや特殊文字は使用できませ

ん。

3. 新しいユーザのパスワードに一時パスワードを入力し、確認します。パスワードは、1以上の大文字、1以上の小文字、1以上の数字を含んだ 6文字以上のものでなければなりません。ユーザは、システムにログインするときにパスワードを

変更することができます。

4. Next(次へ)をクリックして続行します。ロールのフライアウトが開きます。

5. 関連するスライドボタンをクリックして、ユーザに割り当てるロールを選択し、Next(次へ)をクリックします。管理対象ユーザのフライアウトが開きます。

Page 46: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

6. 必要に応じて、管理する 1人以上のユーザを選択し、Next(次へ)をクリックします。

7. 必要に応じて、管理するプロジェクトを 1つ以上選択し、Save(保存)をクリックします。フライアウトが閉じ、新しいユーザがアクティブのステータスでアルファベット順に

ポータルユーザリストに追加されます。

• Activate/Deactivate a Portal User

1. Portal Users(ポータルユーザ)画面で、目的のポータルユーザの名前を 1回クリックします。編集のフライアウトが右側に表示されます。

2. ユーザのステータスを変更するには、Status(ステータス)の横にあるスライドボタンをクリックし、Save(保存)をクリックします。フライアウトが閉じ、ユーザの新

しいステータスがポータルユーザリストに表示されます。

• Change/Reset a Portal User’s Password

1. Portal Users(ポータルユーザ)画面で、目的のポータルユーザの名前を 1回クリックします。編集のフライアウトが右側に表示されます。

2. Change Password(パスワードの変更)をクリックします。New Password(新しいパスワード)フィールドとConfirm New Password(新しいパスワードの確認)フィールドが表示されます。

3. ユーザの新しいパスワードを入力して確認します。パスワードは、1以上の大文字、1以上の小文字、1以上の数字を含んだ 6文字以上のものでなければなりません。

4. Save(保存)をクリックします。フライアウトが終了し、ポータルユーストに戻ります。

• Edit a Portal User’s Assigned Roles

1. Portal Users(ポータルユーザ)画面で、目的のユーザの行のロール列を 1回クリックします。ロールのフライアウトが右側に表示されます。

2. 関連するスライドボタンをクリックして、ユーザに割り当てるロールを選択し、Save(保存)をクリックします。フライアウトが終了し、ユーザのロールの数がポータルユーザリ

ストで更新されます。

Page 47: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

• Edit a Portal User’s Managed Users

1. Portal Users(ポータルユーザ)画面で、目的のユーザの行のユーザ列を 1回クリックします。管理対象ユーザのフライアウトが表示されます。

2. Add(追加)と Remove(削除)ボタンをクリックして、ポータルユーザに割り当てるユーザを選択し、Save(保存)をクリックします。フライアウトが終了し、ポータル

ユーザのユーザ数がポータルユーザリストで更新されます。

Plugin User Groups Plugin User Groups(プラグインユーザグループ)画面では、SecureAssistのクライアント側のプラグインユーザのグループを作成・管理できます。ここで作成したグループは、SecureAssistポータルのユーザレポートセクションでデータをフィルタリングするのに

使用できます。デフォルトのユーザグループはないので、初回のプ

ラグインユーザグループの画面は空白になります。グループを追加

すると、画面にグループが一覧表示されます。

注: ここでプラグユーザグループに個人を割り当てることもでき、プラグインユーザ画面でプラグインユーザグループに個人を割り当て

ることもできます。

• Find a Plugin User Group

1. グループリストのプラグインユーザグループをすばやく見つけるには、Find a Group(グループを見つける)ボックスにテキストを入力します。リストは自動的にフィルタリング

され、名前にテキストが含まれているプラグインユーザグル

ープのみが表示されます。

• Add a Plugin User Group

1. Plugin User Groups(プラグインユーザグループ)画面で、Add Group(グループの追加)をクリックします。新しいユーザグループのフライアウトが開きます。

Page 48: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

2. Group Name(グループの名前)に、新しいグループの名前を入力します。

3. Description(説明)に、グループの簡単な説明を入力します。

4. グループに追加したいユーザの横にある Add(追加)ボタンをクリックしてグループに追加するか、Add All(全て追加)をクリックしてすべてのユーザを追加します。

5. [Save]をクリックします。フライアウトが終了し、新しいグループがプラグインユーザグループリストに追加されます。

• Edit a Plugin User Group

1. Plugin User Groups(プラグインユーザグループ)画面で、目

的のグループの横にある Edit(編集)ボタン をクリック

します。ユーザグループのフライアウトが開きます。

2. ユーザグループを適宜編集し、Save(保存)をクリックします。フライアウトが終了し、プラグインユーザグループリ

ストに戻ります。

• Delete a Plugin User Group

1. Plugin User Groups(プラグインユーザグループ)画面で、目

的のグループの横にある Edit(編集)ボタン をクリック

します。ユーザグループのフライアウトが開きます。

2. Delete Group(グループの削除)をクリックします。 削除を確認するポップアップが表示されます。

3. Yes, delete it(はい)をクリックして削除します。 ポップアップが閉じられ、ユーザグループがプラグインユーザグルー

プリストから削除されます。

Roles Roles(ロール)画面では、サーバ管理者がポータルユーザ画面でポータルユーザに割り当てる新しいカスタムロールを作成できます。

各グループのユーザに特定アクセス許可を割り当てて管理すること

ができます。

SecureAssistポータルには、GROUP_ADMIN、GROUP_STATS_VIEWER、SERVER_ADMIN、STATS_VIEWERの 4つのデフォルトロールがあります。これらの役割にそれぞれ割り当

てられているデフォルトの権限は、Appendixで確認できます。すべての権限のリストやその説明のリストも確認できます。

Page 49: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

• Find a Role

1. ロールリストでロールをすばやく見つけるには、Find a Role(ロールを見つける)ボックスにテキストを入力します。

リストは自動的にフィルタリングされ、名前にテキストが含

まれるロールだけが表示されます。

• Add a Role

1. Roles(ロール)画面で、Add Role(ロールの追加)をクリックします。新しいロールのフライアウトが開きます。

2. Name(名前)に固有のロール名を入力します。

3. 必要に応じて、Description(説明)に新しい役割の簡単な説明を入力します。

4. Next(次へ)をクリックします。権限についてのフライアウトが開きます。

5. 目的の権限を選択し、Save(保存)をクリックします(新しいロールを保存するには、少なくとも 1つの権限を選択する必要があります)。フライアウトが閉じ、新しいロールが

ロール画面に追加されます。

• Edit a Role’s Name or Description

1. Roles(ロール)画面で、編集するロールの Name(名前)をクリックします。編集のフライアウトが開きます。

2. Name(名前)や Description(説明)を編集し、Save(保存)をクリックします。フライアウトが終了し、変更が保

存されます。

• Edit a Role’s Permissions

1. Roles(ロール)画面で、編集するロールの行の Permissions(権限)の列をクリックします。権限についてのフライアウ

トが開きます。

2. 権限に対する必要な変更を行い、Save(保存)をクリックします。フライアウトが終了し、変更が保存されます。

• Delete a Role

1. Roles(ロール)画面で、削除するロールの Name(名前)をクリックします。編集についてのフライアウトが開きます。

2. Delete Role(ロールの削除)ボタンをクリックします。削除を確認するポップアップが表示されます。

Page 50: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

3. Yes, delete it(はい)をクリックして削除します。 フライアウトが終了し、ロールがロール画面から削除されます。

Page 51: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

Account Account(アカウント)画面では、ポータルでのパスワードを更新できます。

• Update Your Password

1. Account(アカウント)画面で、現在のパスワードをCurrent Passwordに入力します。

2. New Passwordに新しいパスワードを入力します。

3. Confirm New Passwordに新しいパスワードを再入力します。

4. Save(保存)をクリックします。

Page 52: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

6 Settings LDAP Configuration LDAP Configuration(設定)画面では、ポータルで LDAP認証を使用するように選択している場合、LDAP設定を行うことができます。

Section Feature Description

Authentication & Security

LDAP Authentication ポータルユーザとプラグインクライアントのサーバでの

LDAP認証を有効にします。 (注:プラグインクライアントは Feature Configurationでクライアント LDAPも選択している場合のみ、LDAPユーザ名で認証することができます)。

Secure LDAP このチェックボックスを選択すると、SSL接続を介してLDAP接続が実行されます。

Verify Server Certificate (セキュア LDAPが有効な場合にのみ表示されます)。

オフの場合、enterprise portalが LDAPサーバの証明書を検証しないことを示しています。

オンの場合、enterprise portalが LDAPサーバの証明書を検証することを示しています。

Server Server Name LDAP URLのスキームとホスト名

Port LDAPサーバが存在するポート

Timeout LDAPクエリがタイムアウトする秒単位での時間

Login Scope この設定は、LDAPの baseDNフィールドに類似しています。Enterprise Portalは、LDAPクエリの実行時、SUBTREE_SCOPEを使用し、これを変更することはできません。

Filter Expression LDAP検索フィルタ式は、照会される項目を制限します。

DN SECURITY_PRINCIPAL 設定と同様です。

Password これは、「ログイン DN」設定が指定されている場合に必要です。

管理者が入れない場合のリセット

管理者が入れない場合、このマスターLDAPパスワードを更新するには、データベースを手動で編集する必要がありま

す。

ldap_settings - > privileged_passwordをマスターアカウントのLDAPパスワードのプレーンテキストに変更します。ポータルで LDAPバインドが発生すると(たとえば、管理者がログインすると)、このパスワードはデータベースで暗号化パス

ワードに変更されます。

Page 53: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

Feature Configuration .以下の表は、さまざまな機能の設定を説明するものです。

Section Feature Description

Portal CSA Portal ユーザが IDEプラグイン/パッケージを有効にし、ポータルからライセンスファイルとルールパックを取得すること

ができます。

この機能を無効にすると、IDEプラグインは Enterprise Editionとして有効となりません。

Disable Autocomplete ウェブブラウザのオートコンプリート機能を回避

Workfactor ワークファクターは、ポータルユーザのパスワードをハッ

シングする際に使用します。このパラメータは、異なるア

ーキテクチャに対応し、コンピュータの高速化に伴って増

加します。このパラメータを高く設定しすぎると、ポータ

ルユーザがポータルにログインする機能が損なわれる可能

性があり、慎重に行う必要があります。

Salt Bytes ソルトサイズは、ポータルユーザのパスワードをハッシュ

する際に使用するものです。

Client Authentication

LDAP LDAPを使用して SecureAssistユーザを認証します。 SecureAssistプラグイン Enterprise Editionユーザをアクティブにするには、ユーザが Active Directory(アクティブディレクトリー)に存在していなければなりません。 注:この機能は、LDAP接続が設定されている場合にのみ有効にすることができます。

Email SecureAssistユーザを電子メールで認証します。Domains (ドメイン)フィールドに 1つ以上のドメインを入力します。複数のドメインはセミコロンで区切ります。

SecureAssistプラグイン Enterprise Editionユーザをアクティブにするには、ユーザの電子メールアドレスが組織のドメ

イン名と一致する必要があります。

Client License Renewal Period クライアントライセンスの日単位での更新期間

Support Email To サポート電子メールの送信に使用される電子メールアドレ

Subject サポート電子メールのデフォルトの件名

Statistics CSA SecureAssistプラグイン統計のポータルへの自動収集とアップロードを有効にします。

Anonymous 匿名モードで統計を収集します。即ち、統計はプロジェク

トにリンクされていますが、特定のユーザには関連付けら

れていません

Page 54: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

Section Feature Description

Local Configuration

Filters ユーザがフィルタ設定をローカルで変更できるようにしま

す(たとえば、フィルタやルールの無効化、重要度の変更

など)。

Review これを選択すると、ユーザはファイルをいつスキャンする

かを決めることができます(たとえば、開いたとき、保存

したとき、要求があったとき等)。

プラグインユーザが下記の Review Configuration(レビューコンフィギュレーション)の設定を引き継げるように

するには、この設定を「オフ」にする必要があります。

Review Configuration

Review on File Open ファイルレビューは、ファイルが開いたときに実行されま

す。

注:ユーザがこの設定を変更できないようにするには、

Review Configuration(レビューコンフィギュレーション)が無効になっていることを確認してください。

Review on File Save ファイルレビューはファイル保存時に実行されます。 注:ユーザがこの設定を変更できないようにするには、

Review Configuration(レビューコンフィギュレーション)が無効になっていることを確認してください。

Project Review プロジェクト、パッケージ、フォルダ全体のレビューは、

要求があれば実行されます。

Suppress Issue プラグインユーザが IDEセッションの期間中に問題を抑止できるようにします。

Allowed File Types for Eclipse-based IDEs

java SecureAssistプラグインユーザが Javaファイルをスキャンできるようにします。

jsp SecureAssistプラグインユーザが JSPファイルをスキャンできるようにします。

xml SecureAssistプラグインユーザが XMLファイルをスキャンできるようにします。

properties SecureAssistプラグインユーザがプロパティファイルをスキャンできるようにします。

ftl SecureAssist プラグインユーザが FTLファイルをスキャンできるようにします。

php SecureAssistプラグインユーザが PHPファイルをスキャンできるようにします。Eclipse PHPプラグインをインストールする必要があります。

Allowed File Types for Visual Studio

cs SecureAssistプラグインユーザが C#ファイルをスキャンできるようにします。

vb SecureAssistプラグインユーザが VB .NETファイルをスキャンできるようにします。

Page 55: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

Section Feature Description

aspx SecureAssistプラグインユーザが ASP.NETファイルをスキャンできるようにします。

config SecureAssistプラグインユーザが.NET構成ファイルをスキャンできるようにします。

Plugin Users Plugin Users(プラグインユーザ)画面には、プラグインまたはパッケージライセンス(各ユーザの IDEや OSを含む)が有効であるユーザのリストが表示されます。個々のユーザの詳細を閲覧するに

は、ユーザの行をクリックすると、情報を表示するフライアウトが

開きます。

• Find a User

1. プラグインユーザリストでユーザをすばやく見つけるには、Find a User(ユーザを見つける)ボックスにテキストを入力します。リストは自動的にフィルタリングされ、名前にテ

キストが含まれているユーザのみが表示されます。

• Add a User to a Plugin User Group

注:この画面や Plugin User Groups(プラグインユーザグループ)画面でユーザグループに個人を割り当てることができま

す。

1. プラグインユーザ画面で、行をクリックしてユーザを選択します。ユーザの詳細のフライアウトが開きます。

2. Group Assignments(グループアサインメント)で、ユーザを追加したいユーザグループの隣にある Add(追加)を 1つ以上クリックし、Save(保存)をクリックします。フライアウトが終了し、ユーザは選択されたグループに割り当てら

れます。

• Deactivate a User

プラグインユーザが無効になると、プロジェクトのスキャン結

果とデータはデータベースに保存されたままになり、レポート

に表示されます。

1. Plugin Users(プラグインユーザ)画面で、行をクリックしてユーザを選択します。ユーザの詳細のフライアウトが開き

ます。

2. Active(アクティブ)ボタンを切り替え、ユーザを無効としてマークします

Page 56: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

3. Save(保存)をクリックします。ユーザは現在無効としてマークされ、SecureAssistを使用している開発者の数が減ります。

Page 57: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

7 More Support We hope this document has helped you get started with SecureAssist. You can submit a support request at [email protected]. You will also find other manuals, release notes, system requirements, and more.

Thanks for using Codiscope SecureAssist!

Page 58: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

Appendix A: Roles and Associated Permissions Each user must be assigned at least one role. Each possible role is described below.

Role Name Permissions

GROUP_ADMIN PER_ADD_USER PER_DELETE_RULEPACK PER_DISABLE_RULEPACK PER_ENABLE_RULEPACK PER_UPLOAD_RULEPACK PER_VIEW_RULEPACK

GROUP_STATS_VIEWER PER_VIEW_USER_STATS PER_VIEW_PROJECT_STATS

SERVER_ADMIN PER_ADD_USER PER_EDIT_USER PER_DELETE_USER PER_RESET_LOCAL_USER_PASSWORD PER_ADD_ROLE PER_EDIT_ROLE PER_DELETE_ROLE PER_UPLOAD_RULEPACK PER_VIEW_ALL_RULEPACK PER_VIEW_RULEPACK PER_ENABLE_ALL_RULEPACK PER_DISABLE_ALL_RULEPACK

STATS_VIEWER PER_VIEW_ALL_STATS

Page 59: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

Appendix B: Permission Descriptions Each new Role is defined by the permissions selected. The Role Name must be unique.

Permission Name Description

PER_ADD_USER Allows adding user to the system.

PER_EDIT_USER Allows editing user in the system.

PER_DELETE_USER Allows deleting user from the system.

PER_RESET_LOCAL_USER_PASSWORD

Allows resetting local user password.

PER_ADD_ROLE Allows adding new role.

PER_EDIT_ROLE Allows editing existing role.

PER_DELETE_ROLE Allows deleting role.

PER_UPLOAD_RULEPACK Allows uploading rulepack.

PER_VIEW_ALL_RULEPACK Allows viewing all rulepacks uploaded to the server.

PER_VIEW_RULEPACK Allows viewing rulepacks uploaded by user.

PER_ENABLE_ALL_RULEPACK Allows enabling all rulepacks uploaded to the server.

PER_ENABLE_RULEPACK Allows enabling rulepacks uploaded to the server by user.

PER_DISABLE_ALL_RULEPACK Allows disabling all rulepacks uploaded to the server.

PER_DISABLE_RULEPACK Allows disabling rulepacks uploaded to the server by user.

PER_RESTRICT_ALL_RULEPACK Allows restricting access to all rulepacks uploaded to the server for all users.

PER_RESTRICT_RULEPACK Allows restricting access to rulepacks uploaded to the server by user for managed group of users.

PER_DELETE_ALL_RULEPACK Allows deleting any rulepack uploaded to the server.

PER_DELETE_RULEPACK Allows deleting rulepack uploaded to the server by user.

PER_VIEW_ALL_STATS Allows viewing all statistics.

PER_VIEW_USER_STATS Allows viewing statistics for managed users.

PER_VIEW_PROJECT_STATS Allows viewing statistics for managed projects.

PER_SYSTEM_ADMIN Allows editing server configuration.

Page 60: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

Appendix C: Audit Log The following table describes the columns of the “audit” appender log.

Column Description

Date Time of the event in coordinated universal time (UTC) with seconds granularity.

IP IP address of the portal user that performs the event.

User Portal user's ID.

Element Type Category of elements in the portal: § LDAP_SETTINGS § PLUGIN_USER § PLUGIN_USER_GROUP § PORTAL_SETTINGS § PORTAL_USER § REPORT § ROLE § RULEPACK

Element Name The specific name of the affected element.

Event The action taken on the element.

Description A description of the event containing details regarding which elements were impacted and how.

Success Indicates whether the user successfully completed the attempted task (true) or did not complete it (false)

Page 61: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

Appendix D: API Functionality For users who prefer to perform reporting tasks via an API, we provide guidance on the following pages.

Important! This feature is safe to use ONLY via HTTPS. Security will be greatly compromised if you use HTTP. No error will warn you if you fail to take this precaution.

The following diagram shows the intended use of the reporting API. First, a user must authenticate with the SecureAssist Enterprise Portal to obtain a token. For each subsequent request, this authentication token should be added to the request headers and will be verified by the server.

Page 62: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

Authentication 1. The client sends its credentials (email and password) to the server. 2. The server authenticates them and generates a fixed-length token with

an expiration date. 3. The server stores the previously generated token in map in memory. 4. The server sends previously generated token to the client. 5. In every request, the client sends that token to the server. 6. In each request, the server extracts the token from the incoming request,

and looks up the user identifier with the token to obtain the user information to do the authorization.

7. If the token is expired, the server generates a response with error message (401 Unauthorized).

Resource URL Example

POST{applicationcontext}/api/auth

Request

Request Headers

Header Value

X-Username The user’s name

X-Password The plaintext password

X-Requested-By true

Response HTTP/1.1 200 OK

Response Headers

Header Value

Content-Length 0

Date Timestamp

X-Auth-Token String with token

Example

Request Headers

Header Value

X-Requested-By true

X-Username testUser

X-Password 5P420D10ftZsFMj+i3X8KkXICHA=

Page 63: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

Response Headers

Header Value

Content-Length 0

Date Thu, 08 Oct 2015 14:06:48 GMT

X-Auth-Token s64vWEL/R/Azhv53/JIHx4zbF2E1aoNYd4AVs5cWO1w=

CURL Example curl-XPOST--header"X-Requested-By:true"--header"X-Username:csauser"--header"X-Password:mypassword"-khttps://myhost.com/CSA_Server/api/auth--head

Page 64: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

Generate Project Report

Resource URL Example POST{host}/api/report/project/{reporttypeid}

Request

{report type id} parameter

ID Value

PortfolioSummaryReport Portfolio Summary Report

ProjectReport Project Report

ProjectDefectReport Project Defect Report

GlobalDefectReport Global Defect Report

{report type id} parameter is case-insensitive. (PortfolioSummaryReport and portfoliosummaryreport are equally ignoring case).

Authentication Token authentication.

Request Headers

Header Value

X-Requested-By true

Content-Type application/json

X-Auth-Token The string with token

Request Body {"startDate":"{startdateYYYY-MM-DDorempty}","endDate":"{startdateYYYY-MM-DDorempty}","projectName":"{projectname}"}

Response 1. In case of sending invalid request, the server returns status 405 (or 401)

and string with error message.

Response Status Message Description

Page 65: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

Response Status Message Description

405 Method Not Allowed

Project report type can't be empty. Project report type value is not valid. Start date must be less than or equal to today's date or empty. End date must be less than or equal to today's date or empty. End date must be less than or equal to start date. Project report name can't be empty. Can't generate project report. Unable to find a scan using these parameters Unable to find a report type "<report type>".

In case of sending request with invalid parameters

401Unauthorized This request requires HTTP authentication. In case of sending request with invalid token

2. In case of sending valid request, the server returns status 200 and content of the report.

Response Headers

Header Value

Content-Type text/csv

Content-Length {content length}

Content-Disposition attachment; filename={file name}.csv

Date {timestamp}

Example URL: {host}/api/report/project/projectreport

Request Headers

Header Value

X-Requested-By true

Content-Type application/json

X-Auth-Token e0uRmveBif3W6ipWOojU/G1/FRJt8GhYqlApu/mM3+4=

Request Body {"startDate":"2015-08-10","endDate":"2015-10-05","projectName":"WebGoat-Legacy2"}

Response Status HTTP/1.1 200 OK

Page 66: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

Response Header

Header Value

Content-Type text/csv

Content-Length {content length}

Content-Disposition attachment; filename=ProjectScanReport.csv

Date Thu, 08 Oct 2015 13:53:01 GMT

Response Body SolutionName,ProjectName,FilePath,LastScanDate,LOC,#HighIssues,#MediumIssues,#LowIssues,TotalNumberofIssues,Developer,#High(Suppressed),#Medium(Suppressed),#Low(Suppressed),TotalNumberofSuppressedIssues,

----,WebGoat-Legacy2,src\main\webapp\lesson_solutions\ReflectedXSS_files\colorschememapping.xml,1Oct201508:32:56GMT,2,0,0,0,0,[email protected],0,0,0,0,

----,WebGoat-Legacy2,src\main\java\org\owasp\webgoat\lessons\BasicAuthentication.java,1Oct201508:32:49GMT,284,0,2,0,2,[email protected],0,0,0,0,

----,WebGoat-Legacy2,src\main\webapp\lesson_solutions\WsSqlInjection_files\colorschememapping.xml,1Oct201508:32:56GMT,2,0,0,0,0,[email protected],0,0,0,0,

----,WebGoat-Legacy2,src\main\webapp\lesson_solutions\HiddenFieldTampering_files\colorschememapping.xml,1Oct201508:32:56GMT,2,0,0,0,0,[email protected],0,0,0,0,

----,WebGoat-Legacy2,src\main\webapp\lesson_solutions\BlindSqlInjection_files\filelist.xml,1Oct201508:32:56GMT,18,0,0,0,0,[email protected],0,0,0,0,

----,WebGoat-Legacy2,src\main\java\org\owasp\webgoat\lessons\ForcedBrowsing.java,1Oct201508:32:44GMT,151,0,0,0,0,[email protected],0,0,0,0,

----,WebGoat-Legacy2,src\main\java\org\owasp\webgoat\service\ParameterService.java,1Oct201508:32:51GMT,68,0,0,0,0,[email protected],0,0,0,0,

----,WebGoat-Legacy2,src\main\java\org\owasp\webgoat\lessons\admin\SummaryReportCardScreen.java,1Oct201508:32:22GMT,315,0,1,0,1,[email protected],0,0,0,0,

----,WebGoat-Legacy2,src\main\java\org\owasp\webgoat\lessons\instructor\RoleBasedAccessControl\ViewProfile_i.java,1Oct201508:32:25GMT,134,0,3,0,3,[email protected],0,0,0,0,

----,WebGoat-Legacy2,src\main\webapp\lesson_solutions\DOMInjection_files\filelist.xml

Page 67: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

,1Oct201508:32:56GMT,18,0,0,0,0,[email protected],0,0,0,0,

----,WebGoat-Legacy2,src\main\java\org\owasp\webgoat\lessons\WsSAXInjection.java,1Oct201508:32:45GMT,228,1,2,0,3,[email protected],0,0,0,0,

----,WebGoat-Legacy2,pom.xml,1Oct201508:32:56GMT,339,0,0,0,0,[email protected],0,0,0,0,

----,WebGoat-Legacy2,src\main\java\org\owasp\webgoat\lessons\CsrfPromptByPass.java,1Oct201508:32:47GMT,186,0,0,0,0,[email protected],0,0,0,0,

----,WebGoat-Legacy2,src\main\java\org\owasp\webgoat\lessons\AbstractLesson.java,1Oct201508:32:45GMT,809,0,4,0,4,[email protected],0,0,0,0,

CURL Example curl-XPOST-d'{"projectName":"BigApp"}'--header"X-Requested-By:true"--header"Content-Type:application/json"--header"X-Auth-Token:EKfwFtSDISG7FGVPTP7rULyWcfd4/esP9YZ13amqKlo="-khttps://myhost.com/CSA_Server/api/report/project/PortfolioSummaryReport

Page 68: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

Get Project List

Resource URL

GET Rulepack/Get Example

GET{host}/api/projects

Request

Authentication Token Authentication

Request Headers

Header Required? Description

X-Requested-By Required To avoid CSRF attacks

X-Auth-Token Required The string with token

Response In case of HTTP 200 OK, Xml responds with the following schema.

Response {status:"success"or"failure"(ifduringthepreparationofthelistoferroroccurred),count:10,result:[{name:projectA,description:.....,},{name:projectB,description:.....,}]}

Page 69: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

Response Headers HTTP/1.1 200 OK

Header Value

Content-Type application/json

Content-Length {content length}

Date {timestamp}

Example

Request Headers

Header Value

X-Requested-By true

X-Auth-Token UA0om5rAOdt7ddI5YHJ3A+Nd3muRdjjPFU4QCxRpmPE=

Response Body {"status":"success","count":4,"result":[{"name":"Project1","description":""},{"name":"Project2","description":""},{"name":"Project3","description":""},{"name":"Project4","description":""}]}

CURL Example curl-XGET--header"X-Requested-By:true"--header"X-Auth-Token:EKfwFtSDISG7FGVPTP7rULyWcfd4/esP9YZ13amqKlo="--header“Content-Type:application/json"-khttps://myhost.com/CSA_Server/api/projects

Page 70: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

Number of Active Developers How many developers are using the tool? Number of active users over period of time (active = at least one file scanned).

Resource URL Example POST{host}/api/report/activeDevs/v1

Request Request Headers

Header Value

Content-Type application/json

X-Auth-Token The string with token

X-Requested-By true

Request Body {"startDate":"{startdateYYYY-MM-DDorempty}","endDate":"{startdateYYYY-MM-DDorempty}"}

Response HTTP/1.1 200 OK

Response Headers

Header Value

Content-Length length

Date timestamp

Content-Type application/json

Response Body {"userCount":{count}}

CURL Example curl-XPOST--header"X-Requested-By:true"--header"X-Auth-Token:EKfwFtSDISG7FGVPTP7rULyWcfd4/esP9YZ13amqKlo="--header“Content-Type:application/json"-d'{"startDate":"2015-11-04","endDate":"2015-11-05"}'-khttps://myhost.com/CSA_Server/api/report/activeDevs/v1

Page 71: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

Number of Projects Scanned The number of projects scanned on this Enterprise Portal.

Resource URL Example POST{host}/api/report/projects/v1

Request Request Headers

Header Value

Content-Type application/json

X-Auth-Token The string with token

X-Requested-By true

Request Body {"startDate":"{startdateYYYY-MMM-DDorempty}","endDate":"{startdateYYYY-MMM-DDorempty}","type":"{scannedornoscanned}"}

Response HTTP/1.1 200 OK

Response Headers

Header Value

Content-Length length

Date timestamp

Content-Type application/json

Response Body {"projectCount":{count}}

CURL Example curl-XPOST--header"X-Requested-By:true"--header"X-Auth-Token:EKfwFtSDISG7FGVPTP7rULyWcfd4/esP9YZ13amqKlo="--header"Content-Type:application/json"-d'{"type":"scanned","startDate":"2015-11-04","endDate":"2015-11-05"}'-khttps://myhost.com/CSA_Server/api/report/projects/v1

Page 72: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

Number of Project Defects The number of defects in a project.

Resource URL Example POST{host}/api/report/v1/defects

Request

Request Headers

Header Value

Content-Type application/json

X-Auth-Token The string with token

X-Requested-By true

Request Body (Choose either 'meta' or 'project', depending on whether you are querying based on metadata or a project name.) {"startDate":"{startdateYYYY-MM-DD}","endDate":"{YYYY-MM-DDorempty}","meta":{"key1":"val1","key2":"val2"},"project":"Projectname"}

Response HTTP/1.1 200 OK

Response Headers

Header Value

Content-Length length

Date timestamp

Content-Type application/json

Page 73: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

Response Body { "results":[{ "defect-hi":2, "defect-med":9, "defect-lo":22, "loc":2250, "date":"2016-02-12"},{ "defect-hi":3, "defect-med":14, "defect-lo":20, "loc":2175,"date":"2016-02-13"}, ...]}

CURL Example curl-XPOST--header"X-Requested-By:true"--header"Content-Type:application/json"--header"X-Auth-Token:yUyCkN1rCbFQK28FvWOsYW5T2yyeZCi4ijVnGdTKwBE="-d'{"startDate":"2016-02-12","endDate":"2016-02-23","project":"SampleProject"}'-khttps://myhost.com/CSA_Server/api/report/v1/defects

Page 74: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

Top Number of Findings Determines which rules have fired most frequently.

Resource URL Example POST{host}/api/report/v1/defects/topn

Request

Request Headers

Header Value

Content-Type application/json

X-Auth-Token The string with token

X-Requested-By true

Request Body (Choose either 'meta' or 'project', depending on whether you are querying based on metadata or a project name.) {"startDate":"{startdateYYYY-MMM-DD}","endDate":"{YYYY-MM-DDorempty}","meta":{"key1":"val1","key2":"val2"},"project":"Projectname","results":{minimum1}}

Response HTTP/1.1 200 OK

Response Headers

Header Value

Content-Length length

Date timestamp

Content-Type application/json

Page 75: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

Response Body {top_issues:[{rule_id:"CSADefaultRulepack_ver_2.5.1.20151217141219-CIGITAL-SIMPLEDATEFORMAT-RACE-CONDITION",count:142},{rule_id:"CSADefaultRulepack_ver_2.5.1.20151217141219-CIGITAL-QUALITY-CODE_CORRECTNESS-006",count:133}]}

CURL Example curl-XPOST--header"X-Requested-By:true"--header"Content-Type:application/json"--header"X-Auth-Token:yUyCkN1rCbFQK28FvWOsYW5T2yyeZCi4ijVnGdTKwBE="-d'{"startDate":"2016-02-12","endDate":"2016-02-23","project":"SampleProject","results":2}'-khttps://myhost.com/CSA_Server/api/report/v1/defects/topn

Page 76: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

Most Viewed Guidance Determines which rules have fired the most from a given date.

Resource URL Example POST{host}/api/report/v1/mostviewedrules

Request

Request Headers

Header Value

Content-Type application/json

X-Auth-Token The string with token

X-Requested-By true

Request Body (Choose either 'meta' , 'project', or 'user-group' depending on whether you are querying based on metadata , a project name, or a group of users.) {"start-date":"2016-01-01","end-date":"2016-01-02",(optional)"project:"ProjectName","meta":{"key1":"val1","key2":"val2"},"user-group":"groupname"}

Response HTTP/1.1 200 OK

Response Headers

Header Value

Content-Length length

Date timestamp

Content-Type application/json

Page 77: Portal User Guide ja 2016-11download.asteriskresearch.com/3.0.3/Portal_User... · SecureAssist Enterprise Portal v3.0以降では、ユーザは、レポート用 の、独立したセカンダリデータベースを設定するオプションを利用

Response Body {results:[{

"rule_id":CSADefaultRulepack_ver_2.5.1.20151218083753-CIGITAL-DOTNET-XML-LOADXML

"guidance":CSADefaultRulepack_ver_2.5.1.20151218083753/default/standards/xml-dtd-attack.xml

"num_viewed":2

},...]}

CURL Example curl-XPOST--header"X-Requested-By:true"--header"Content-Type:application/json"--header"X-Auth-Token:yUyCkN1rCbFQK28FvWOsYW5T2yyeZCi4ijVnGdTKwBE="-d'{"startDate":"2016-02-12","endDate":"2016-02-23","project":"SampleProject"}'-khttps://myhost.com/CSA_Server/api/report/v1/mostviewedrules