Successfully reported this slideshow.
We use your LinkedIn profile and activity data to personalize ads and to show you more relevant ads. You can change your ad preferences anytime.

SecureAssist Enterprise Portal 導入ガイド

1,695 views

Published on

SecureAssist Enterprise Portalを通して、IDEプラグインとしてSecureAssistを活用している開発チームを管理し、プロジェクト状況の統計データの取得や、ルールパックのアップデート、独自のルールセットの追加・共有が可能になります。

本資料は、SecureAssistのEnterprise Portalのサーバーへのインストールからセットアップまでの導入プロセスを説明します。

2016.03.16 - 3.0対応版
2015.11 - 2.5対応版
2015.08 - 2.4対応版
2015.06 - 初版

Published in: Software
  • Be the first to comment

  • Be the first to like this

SecureAssist Enterprise Portal 導入ガイド

  1. 1. パッケージのダウンロード サーバーへのインストール 管理画面へのログインと基本設定 2016.03.16 SecureAssist Enterprise Portal 導入ガイド Version 3.0対応版
  2. 2. 目次 2 本資料について 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. ライセンスファイルのアップロード  3. データベース接続の設定  4. 管理者アカウントの作成  5. 管理者アカウントでログイン  6. ルールパックのアップロード  7. ルールパックの有効化  8. クライアント認証の設定  9. Indexページのリンク設定 SecureAssist Enterprise Portalでのライセンスの確認  1. プラグインユーザーの一覧表示  2. プラグインユーザーの詳細表示 SecureAssist Enterprise PortalのAPI機能  API一覧 お問い合わせ
  3. 3. 本資料について 本資料では、SecureAssist Enterprise Portalの導入に関わる、 以下の範囲を取り扱います。 –  パッケージのダウンロード –  パッケージのインストール –  ライセンスのインストール –  初期設定とライセンスの確認 また、MySQLおよびTomcatをインストール済みの、Linuxサーバー環境への 導入を前提に説明しています。 3
  4. 4. SecureAssist Enterprise Portal 導入準備 4
  5. 5. SecureAssist Enterprise Portal導入準備 パッケージのダウンロード 5 SecureAssistのWebサイトのEnterprise Portal Downloadページに、 最新版のEnterprise Portalのダウンロードリンクがあります。 ダウンロードしたzipファイルはインストールに備えて展開しておきます。 Asterisk Research Webサイト hOps://secureassist.jp/ SecureAssist Enterprise Portal Downloadページ hOps://secureassist.jp/downloads/enterpriseportal/
  6. 6. SecureAssist Enterprise Portalの インストール 6
  7. 7. SecureAssist Enterprise Portalのインストール 1. MySQLのデータベース作成 7 まず、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
  8. 8. SecureAssist Enterprise Portalのインストール 2. Tomcatへのユーザー追加 8 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
  9. 9. 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
  10. 10. SecureAssist Enterprise Portalのインストール 4. Tomcatにアクセス Tomcatのデフォルトページにアクセスして「Manager App」のリンクをクリックします。 先ほど設定した USERNAME と PASSWORD を入力して、 Tomcat Webアプリケーションマネージャの画面を表示します。
  11. 11. SecureAssist Enterprise Portalのインストール 5. WARファイルのデプロイ 11 「配備」の中にある「WARファイルの配備」でEnterprise PortalのWARファイルを選択して、 「配備」ボタンをクリックします。 Enterprise PortalのWARファイルは、Enterprise Portalのzipファイルを展開した中にある WARフォルダー内に「CSA_Server.war」というファイル名で存在します。 WARファイルがアップロードされデプロイが完了すると、「アプリケーション」の中に 「/CSA_Server」の行が表示されます。 1. 「選択」ボタンをクリックしてWARファイルを選びます。 2. 「配備」ボタンをクリックします。 「/CSA_Server」の行が表示されます。
  12. 12. 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の再起動後になります。
  13. 13. 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の再起動後になります。
  14. 14. SecureAssist Enterprise Portalの 初期設定 14
  15. 15. SecureAssist Enterprise Portalの初期設定 1. ライセンスの確認と同意 15 「Agree」ボタン 「Tomcat Webアプリケーションマネージャ」の「アプリケーション」の「/CSA_Server」をクリックします。 ライセンスを確認して「Agree」ボタンをクリックします。
  16. 16. SecureAssist Enterprise Portalの初期設定 2. ライセンスファイルのアップロード 16 「Upload License」ボタンをクリックします。 お客様のお手元にあるライセンスファイル(jarファイル)を選択するとアップロードが行われます。 「Upload License」ボタン
  17. 17. SecureAssist Enterprise Portalの初期設定 3. データベース接続の設定 17 Enterprise Portal用に準備したデータベース接続の設定を入力して、 「Save」ボタンををクリックします。 入力は「Main Database ConnecWon」部分だけでOKです。 「Save」ボタン 未入力の状態で薄く表示されているものは、 入力フォーマットの例示となっています。 例示どおりで良い場合でも値を入力してください。 Main Database ConnecWon
  18. 18. SecureAssist Enterprise Portalの初期設定 4. 管理者アカウントの作成 18 ユーザー名とパスワード(確認用含めて2箇所)を入力後、「Save」ボタンをクリックしてPortalの管理者アカウントを作成します。 Portalの管理者アカウントの作成が成功するとログイン画面に進みます。 「Save」ボタン Local Administratorでの入力条件(資料作成時点) Username: 6文字以上の文字列 Password : 英大文字、英小文字、数字をそれぞれ最低1つ含む6文字以上の文字列 Confirm Password : Passwordと一致する文字列 Local Administrator : PortalのアカウントをこのEnterprise Portalで管理します。 LDAP Administrator : PortalのアカウントをLDAPで管理します。
  19. 19. SecureAssist Enterprise Portalの初期設定 5. 管理者アカウントでログイン 19 1. Top画面が表示されるので、ログイン画面へのリンクをクリックしてログイン画面に移動します。 2. 「Username」と「Password」を入力して「LOG IN」ボタンをクリックしてログインします。 ログイン画面へのリンク 「LOG IN」ボタン
  20. 20. SecureAssist Enterprise Portalの初期設定 6. ルールパックのアップロード 20 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が表示されます。 この時点では、まだ無効です。
  21. 21. SecureAssist Enterprise Portalの初期設定 7. ルールパックの有効化 21 1.  「CSA Default Rule pack」の行をクリックして設定編集のパネルを表示します。 2.  「Status」が「Disabled」になっているので「Enabled」をクリックします。 3.  「CSA Default Rule pack」が有効になり、一覧表示の左端部分が「Enabled」を表す緑色に変化します。 「Enabled」をクリック 1. 2. 3.
  22. 22. SecureAssist Enterprise Portalの初期設定 8. クライアント認証の設定 22 Eclipse Plug-inからEnterprise Portalにアクセスする際のクライアント認証で使うメールアドレスのドメイン部を入力します。 「SETTINGS」の「Feature ConfiguraWon」にある「Client AuthenWcaWon」の「Email」の「Domains」を、認証に使うメールアドレスの ドメイン部に書き換えて、画面の下にある「Save」ボタンをクリックします。 また、ここではスキャン対象として許可するファイルタイプの設定もできます。 認証に使うメールアドレスの ドメイン部を入力します。 「SETTINGS」 「Feature ConfiguraWon」 スクロールすると画面下部に 「Save」ボタンがあります。 スキャン対象として許可するファイルタイプの設定
  23. 23. 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ページのリンク先を変更するのみで、システムの実際の動作には影響を与えません。) 23 eclipseUpdateUrl
  24. 24. SecureAssist Enterprise Portalでの ライセンスの確認 24
  25. 25. Enterprise PortalでのEclipse Plug-inの接続確認 1. プラグインユーザーの一覧表示 25 「SETTINGS」の「Plugin Users」で、アクティベートされているPlugin使用ユーザーを 一覧表示できます。 Plugin使用ユーザーの一覧表示
  26. 26. Enterprise PortalでのEclipse Plug-inの接続確認 2. プラグインユーザーの詳細表示 26 ライセンスの一覧表示の各行をクリックして、それぞれの詳細を表示できます。 クリック 詳細表示
  27. 27. SecureAssist Enterprise Portalの API機能 27
  28. 28. SecureAssist Enterprise PortalのAPI機能 API一覧 28 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ガイド」をご覧ください。
  29. 29. お問い合わせ 29 本資料についてのお問い合わせ support@rsrch.jp パートナーシップ・提携 partners@rsrch.jp トレーニング・研修 edu@rsrch.jp サービス・プロダクトのご購入 sales@rsrch.jp ご購入後のサポート support@rsrch.jp 広報・取材依頼 press@rsrch.jp その他のお問い合わせ 株式会社アスタリスク・リサーチ Asterisk Research, Inc. hOps://www.asteriskresearch.com/

×