2016.03.16 SecureAssist Enterprise Portal 導入ガイド Version 3.0 対応版 パッケージのダウンロード サーバーへのインストール 管理画面へのログインと基本設定
目次 本資料について SecureAssist Enterprise Portal 導入準備パッケージのダウンロード SecureAssist Enterprise Portalのインストール 1. MySQLのデータベース作成 2. Tomcatへのユーザー追加 3. Tomcatの環境設定 4. Tomcatにアクセス 5. WARファイルのデプロイ 6. database connectorの設定 7. Eclipse update siteのデプロイ SecureAssist Enterprise Portalでのライセンスの確認 1. プラグインユーザーの一覧表示 2. プラグインユーザーの詳細表示 SecureAssist Enterprise PortalのAPI 機能 API 一覧お問い合わせ SecureAssist Enterprise Portalの初期設定 1. ライセンスの確認と同意 2. ライセンスファイルのアップロード 3. データベース接続の設定 4. 管理者アカウントの作成 5. 管理者アカウントでログイン 6. ルールパックのアップロード 7. ルールパックの有効化 8. クライアント認証の設定 9. Indexページのリンク設定 2
本資料について 本資料では SecureAssist Enterprise Portal の導入に関わる 以下の範囲を取り扱います パッケージのダウンロード パッケージのインストール ライセンスのインストール 初期設定とライセンスの確認 また MySQL および Tomcat をインストール済みの Linux サーバー環境への 導入を前提に説明しています 3
SecureAssist Enterprise Portal 導入準備 4
SecureAssist Enterprise Portal 導入準備パッケージのダウンロード SecureAssist の Web サイトの Enterprise Portal Download ページに 最新版の Enterprise Portal のダウンロードリンクがあります ダウンロードした zip ファイルはインストールに備えて展開しておきます Asterisk Research Web サイト hops://secureassist.jp/ SecureAssist Enterprise Portal Download ページ hops://secureassist.jp/downloads/enterpriseportal/ 5
SecureAssist Enterprise Portal の インストール 6
SecureAssist Enterprise Portal のインストール 1. MySQL のデータベース作成 まず MySQL サーバーに Enterprise Portal 用のデータベースとユーザーを作成します 以下の db_name, user_name, localhost, password はお手元の環境に応じて入力してください 実行例 $ mysql -u root p mysql> CREATE DATABASE db_name; mysql> GRANT ALL PRIVILEGES ON db_name.* TO user_name@'localhost' IDENTIFIED BY 'password'; mysql> \q 続いて Enterprise Portal 用のテーブルを作成します Enterprise Portal の zip ファイルを展開した中にある DatabaseScript フォルダーに含まれてる portal_csa_mysql.sql と portal_csa_mysql_aggregawon.sql の二つの SQL ファイルを実行します 実行例 $ mysql -u root p db_name < DatabaseScript/portal_csa_mysql.sql $ mysql -u root p db_name < DatabaseScript/portal_csa_mysql_aggregation.sql 7
SecureAssist Enterprise Portal のインストール 2. Tomcat へのユーザー追加 Tomcat の設定ファイル tomcat-users.xml を開いて <tomcat-users> と </tomcat-users> との間に次の行を追加します <role rolename="manager-gui"/><user username="usrename" password="password" roles="manager-gui"/> 上記中の USERNAME と PASSWORD は適切に決めて設定してください 実行例 $ sudo vi /etc/tomcat7/tomcat-users.xml 8
SecureAssist Enterprise Portal のインストール 3. Tomcat の環境設定 Secure HTTP の設定 Enterprise Portal は hop および hops による通信に対応しています セキュリティの観点から hops による接続をお勧めいたします Tomcat のヒープサイズの設定 %CATALINA_HOME/bin に Linux の場合は setenv.sh を Windows の場合は setenv.bat を配置して 環境変数 CATALINA_OPTS でヒープサイズの設定を行います Linux の場合 ( 実際の設定では一行で書きます ) export CATALINA_OPTS='-Xms1024m -Xmx1024m -Xss1024k -XX:PermSize=256m -XX:MaxPermSize=512m -XX:+UseConcMarkSweepGC -XX:+CMSClassUnloadingEnabled' Windows の場合 ( 実際の設定では一行で書きます ) set CATALINA_OPTS='-Xms1024 -Xmx1024m -Xss1024k -XX:PermSize=256m -XX:MaxPermSize=512m -XX:+UseConcMarkSweepGC -XX:+CMSClassUnloadingEnabled' Tomcat の再起動 設定は Tomcat の起動時に反映されます ここまでの設定を有効にするため Tomcat を再起動してください 9
SecureAssist Enterprise Portal のインストール 4. Tomcat にアクセス Tomcat のデフォルトページにアクセスして Manager App のリンクをクリックします 先ほど設定した USERNAME と PASSWORD を入力して Tomcat Web アプリケーションマネージャの画面を表示します
SecureAssist Enterprise Portal のインストール 5. WAR ファイルのデプロイ 配備 の中にある WAR ファイルの配備 で Enterprise Portal の WAR ファイルを選択して 配備 ボタンをクリックします Enterprise Portal の WAR ファイルは Enterprise Portal の zip ファイルを展開した中にある WAR フォルダー内に CSA_Server.war というファイル名で存在します WAR ファイルがアップロードされデプロイが完了すると アプリケーション の中に /CSA_Server の行が表示されます 1. 選択 ボタンをクリックして WAR ファイルを選びます 2. 配備 ボタンをクリックします /CSA_Server の行が表示されます 11
SecureAssist Enterprise Portal のインストール 6. database connector の設定 MySQL database connector をダウンロードしてインストールします 1. hop://dev.mysql.com/downloads/connector/j から MySQL database connector をダウンロードします 2. ダウンロードしたファイルを展開した中に含まれる jar ファイルを CATALINA_HOME/webapps/CSA_Server/WEB-INF/lib フォルダーにコピーします 実行例 $ gzip -cd mysql-connector-java-5.1.38.tar.gz tar xf - $ sudo cp -i mysql-connector-java-5.1.38/mysql-connector-java-5.1.38-bin.jar /var/lib/tomcat7/webapps/csa_server/web-inf/lib/ 作業内容が Tomcat 環境に反映されるのは Tomcat の再起動後になります
SecureAssist Enterprise Portal のインストール 7. Eclipse update site のデプロイ Enterprise Portal のパッケージを展開した中に Eclipse Enterprise Plug-in のパッケージがあります このパッケージをさらに展開後 その中にある update フォルダーを CATALINA_HOME/webapps フォルダーにコピーします 実行例 $ unzip CSA_Eclipse_Enterprise_Plugin_v3.0_20160301.zip d CSA_Eclipse_Enterprise_Plugin $ sudo cp -ir CSA_Eclipse_Enterprise_Plugin/update/ /var/lib/tomcat7/webapps/ 作業内容が Tomcat 環境に反映されるのは Tomcat の再起動後になります
SecureAssist Enterprise Portal の 初期設定 14
SecureAssist Enterprise Portal の初期設定 1. ライセンスの確認と同意 Tomcat Web アプリケーションマネージャ の アプリケーション の /CSA_Server をクリックします ライセンスを確認して Agree ボタンをクリックします Agree ボタン 15
SecureAssist Enterprise Portal の初期設定 2. ライセンスファイルのアップロード Upload License ボタンをクリックします お客様のお手元にあるライセンスファイル (jar ファイル ) を選択するとアップロードが行われます Upload License ボタン 16
SecureAssist Enterprise Portal の初期設定 3. データベース接続の設定 Enterprise Portal 用に準備したデータベース接続の設定を入力して Save ボタンををクリックします 入力は Main Database ConnecWon 部分だけで OK です Main Database ConnecWon 未入力の状態で薄く表示されているものは 入力フォーマットの例示となっています 例示どおりで良い場合でも値を入力してください Save ボタン 17
SecureAssist Enterprise Portal の初期設定 4. 管理者アカウントの作成 ユーザー名とパスワード ( 確認用含めて 2 箇所 ) を入力後 Save ボタンをクリックして Portal の管理者アカウントを作成します Portal の管理者アカウントの作成が成功するとログイン画面に進みます Local Administrator : Portal のアカウントをこの Enterprise Portal で管理します LDAP Administrator : Portal のアカウントを LDAP で管理します Local Administrator での入力条件 ( 資料作成時点 ) Username: 6 文字以上の文字列 Password : 英大文字 英小文字 数字をそれぞれ最低 1 つ含む 6 文字以上の文字列 Confirm Password : Password と一致する文字列 Save ボタン 18
SecureAssist Enterprise Portal の初期設定 5. 管理者アカウントでログイン 1. Top 画面が表示されるので ログイン画面へのリンクをクリックしてログイン画面に移動します 2. Username と Password を入力して LOG IN ボタンをクリックしてログインします ログイン画面へのリンク LOG IN ボタン 19
SecureAssist Enterprise Portal の初期設定 6. ルールパックのアップロード 1. メニュー ( 画面左側 ) にある RULEPACKS のリンクをクリックしてルールパックの管理画面を表示します 2. Upload Rulepack ボタンをクリックしてルールパックのファイルを選択します ルールパックのファイルはEnterprise Portalのzipファイルを展開した中のRulepackフォルダーに含まれています 3. Upload Rulepack ボタンの表示が Uploading になりアップロードが始まるのでしばらく待ちます 4. アップロードが完了すると ルールパックの一覧に先ほどアップロードしたCSA Default Rule packが表示されます 5. アップロードしただけではルールパックは有効になっていません 有効化については次ページで説明します Upload Rulepack ボタン RULEPACKS リンクアップロードされた CSA Default Rule pack が表示されます この時点では まだ無効です 20
SecureAssist Enterprise Portal の初期設定 7. ルールパックの有効化 1. CSA Default Rule pack の行をクリックして設定編集のパネルを表示します 2. Status が Disabled になっているので Enabled をクリックします 3. CSA Default Rule pack が有効になり 一覧表示の左端部分が Enabled を表す緑色に変化します 1. 2. 3. Enabled をクリック 21
SecureAssist Enterprise Portal の初期設定 8. クライアント認証の設定 Eclipse Plug-inからEnterprise Portalにアクセスする際のクライアント認証で使うメールアドレスのドメイン部を入力します SETTINGS の Feature ConfiguraWon にある Client AuthenWcaWon の Email の Domains を 認証に使うメールアドレスのドメイン部に書き換えて 画面の下にある Save ボタンをクリックします また ここではスキャン対象として許可するファイルタイプの設定もできます SETTINGS 認証に使うメールアドレスのドメイン部を入力します Feature ConfiguraWon スクロールすると画面下部に Save ボタンがあります スキャン対象として許可するファイルタイプの設定 22
SecureAssist Enterprise Portal の初期設定 9. Index ページのリンク設定 Index ページにある Latest Eclipse Plugin のリンク先は /CSA_Server/WEB-INF/jsp/includes/ の index.jsp にある次の行を編集することで変更できます <c:set var="eclipseupdateurl" value="http://secureassist.codiscope.com/update"/> また リンクを表示したくない場合は value に空データを設定します ( この設定は Index ページのリンク先を変更するのみで システムの実際の動作には影響を与えません ) eclipseupdateurl 23
SecureAssist Enterprise Portal での ライセンスの確認 24
Enterprise Portal での Eclipse Plug-in の接続確認 1. プラグインユーザーの一覧表示 SETTINGS の Plugin Users で アクティベートされている Plugin 使用ユーザーを一覧表示できます Plugin 使用ユーザーの一覧表示 25
Enterprise Portal での Eclipse Plug-in の接続確認 2. プラグインユーザーの詳細表示 ライセンスの一覧表示の各行をクリックして それぞれの詳細を表示できます 詳細表示 クリック 26
SecureAssist Enterprise Portal の API 機能 27
SecureAssist Enterprise Portal の API 機能 API 一覧 SecureAssist Enterprise Portal は 外部のアプリケーションからアクセスして Enterprise Portal のレポート機能を利用するための API を提供しています 機能認証プロジェクトのレポート作成プロジェクトの一覧を取得アクティブな開発者数の取得スキャンされたプロジェクトの数を取得プロジェクト内で見つかった問題の数を取得よく指摘される問題の一覧を取得よく参照されるガイダンスの一覧を取得 リソースのURL 例 POST {applicawon context}/api/auth POST {host}/api/report/project/{report type id} GET {host}/api/projects POST {host}/api/report/acwvedevs/v1 POST {host}/api/report/projects/v1 POST {host}/api/report/v1/defects POST {host}/api/report/v1/defects/topn POST {host}/api/report/v1/mostviewedrules 各 API の詳細な使い方については Enterprise Portal Download ページ (hops://secureassist.jp/downloads/enterpriseportal/) にある Secure Assist Enterprise Portal API ガイド をご覧ください 28
お問い合わせ 株式会社アスタリスク リサーチ Asterisk Research, Inc. hops://www.asteriskresearch.com/ 本資料についてのお問い合わせ support@rsrch.jp その他のお問い合わせ パートナーシップ 提携トレーニング 研修サービス プロダクトのご購入ご購入後のサポート広報 取材依頼 partners@rsrch.jp edu@rsrch.jp sales@rsrch.jp support@rsrch.jp press@rsrch.jp 29