Child pages
  • TSVツール操作手順書

目次



1.本資料の概要

本資料は国立情報学研究所の運営する電子証明書発行支援システムにて利用するTSVファイルの作成を支援するWebアプリケーション(以下、TSVツール)の操作・利用手順を記載したものである。

2.利用者向け情報

本章ではTSVツールの利用者向けの手順や説明を記載する。 TSVビューア機能、TSV作成機能について説明を行う。

2.1.TSVビューア機能

TSVビューア機能では、UPKI電子証明書自動発行支援システムからダウンロードした以下のファイルを閲覧することができる。

  • 全証明書ダウンロードファイル
  • サーバ証明書ダウンロードファイル
  • クライアント証明書ダウンロードファイル

2.1.1.TSVファイル読込

トップメニュー画面の「TSVビューア」をクリックする。


図1 トップメニュー - TSVビューア選択


「ファイル選択」をクリックし、読み込むTSVファイルを選択する。

図2 TSVビューア - ファイル選択


ファイルを選択後、「読込」をクリックすることで選択したTSVファイルの情報が表示される。

図3 TSVビューア - ファイル読込

2.1.2.キーワード検索

キーワード検索入力欄にキーワードを入力後、「絞り込む」をクリックすることでレコードの絞り込みを行うことが出来る。
この時、検索キーワードにマッチした文字列がハイライト表示される。

図4 TSVビューア - キーワード検索

2.1.3.詳細表示

レコード行をクリックすることで、当該レコードの詳細な情報を見ることが出来る。

図5 TSVビューア - レコード選択


図6 TSVビューア - レコード詳細


「ビューア終了」をクリックすることでTSVビューアを終了する。

図7 TSVビューア - 終了



2.2.TSV新規作成機能

トップメニュー画面の「作成開始」をクリックする。

図8 トップメニュー - TSV作成開始


種別選択画面に遷移後、新規作成タブが選択状態であることを確認する。

図9 種別選択 – 新規作成タブ

2.2.1.サーバ証明書

「証明書種別」のセレクトボックスが「サーバ証明書」を選択していることを確認する(図10番号1)。
その後、「証明書プロファイル」を選択する(図10番号2)。

図10 サーバ証明書


2.2.1.1.新規発行申請用TSVファイルの作成

「TSVファイル種別」のセレクトボックスが「新規発行申請用TSV」を選択していることを確認する(図11番号1)。
「この内容で作成を開始」をクリックすることでTSVの作成を開始する(図11番号2)。

図11 サーバ証明書 - 新規発行申請書用TSV

2.2.1.1.1.作成済みTSVファイル読込

「作成済みTSVファイル」の「ファイル選択」をクリックし、読み込むTSVファイルを選択する。

図12 サーバ証明書 - 新規発行申請用TSV – 作成済みTSV選択


ファイルを選択後、「読込」をクリックすることで、選択したTSVファイルの全レコードが、作成中のTSVの末尾に連結される。
また同一画面で複数のTSVファイルを読み込んだ場合、後から読み込んだTSVファイルのレコードが末尾になるように順次連結される。

2.2.1.1.2.CSRファイル読込

「CSRファイル読込」の「ファイル選択」をクリックし、読み込むCSRファイルを選択する。

図13 サーバ証明書 - 新規発行申請用TSV - CSRファイル選択


ファイルを選択後、「読込」をクリックすることで、選択したCSRファイルの情報から「CSR」、「主体者DN」、「サーバFQDN」を自動判別し、
CSR入力欄、主体者DN入力欄、サーバFQDN入力欄にそれぞれ設定される。

図14 サーバ証明書 - 新規発行申請用TSV - CSRファイル読込完了

2.2.1.1.3.データ入力

「CSR」、「主体者DN」、「サーバFQDN」、「利用管理者E-mail」、「利用管理者所属」、「Webサーバソフトウェア名等」をそれぞれ入力する。
「利用管理者氏名」、「dNSName」は必須入力ではないので必要があれば入力する(図15番号1)。
データ入力後、「完了」をクリックすることでTSVが作成される(図15番号2)。

図15 サーバ証明書 - 新規発行申請用TSV - データ入力

2.2.1.1.4.TSVファイル出力

TSV作成後、「ダウンロード」をクリックすることで、TSVファイルがダウンロードされる。

図16 サーバ証明書 - 新規発行申請用TSV - TSVファイル出力

2.2.1.1.5.終了

「終了」をクリックすることでTSVの作成を終了する。

図17 サーバ証明書 - 新規発行申請用TSV - 終了

2.2.1.2.更新申請用TSVファイルの作成

「TSVファイル種別」のセレクトボックスが「更新申請用TSV」を選択していることを確認する(図18番号1)。
「この内容で作成を開始」をクリックすることでTSVの作成を開始する(図18番号2)。

図18 サーバ証明書 - 更新申請用TSV

2.2.1.2.1.作成済みTSVファイル読込

「作成済みTSVファイル」の「ファイル選択」をクリックし、読み込むTSVファイルを選択する。

図19 サーバ証明書 – 更新申請用TSV – 作成済みTSV読込


ファイルを選択後、「読込」をクリックすることで、選択したTSVファイルの全レコードが、作成中のTSVの末尾に連結される。
また同一画面で複数のTSVファイルを読み込んだ場合、後から読み込んだTSVファイルのレコードが末尾になるように順次連結される。

2.2.1.2.2.CSRファイル読込

「CSRファイル読込」の「ファイル選択」をクリックし、読み込むCSRファイルを選択する。

図20 サーバ証明書 - 更新申請用TSV - CSRファイル選択


ファイルを選択後、「読込」をクリックすることで、選択したCSRファイルの情報から「CSR」、「主体者DN」、「サーバFQDN」を自動判別し、
CSR入力欄、主体者DN入力欄、サーバFQDN入力欄にそれぞれ設定される。

図21 サーバ証明書 - 更新申請用TSV - CSRファイル読込完了

2.2.1.2.3.証明書ファイル読込

「証明書ファイル読込」の「ファイル選択」をクリックし、読み込む証明書ファイルを選択する。

図22 サーバ証明書 - 更新申請用TSV - 証明書ファイル選択


ファイルを選択後、「読込」をクリックすることで、選択した証明書ファイルの情報から「主体者DN」、「失効対象証明書シリアル番号」、「サーバFQDN」を自動判別し、
主体者DN入力欄、失効対象証明書シリアル番号入力欄、サーバFQDN入力欄にそれぞれ設定される。

図23 サーバ証明書 - 更新申請用TSV - 証明書ファイル読込完了

2.2.1.2.4.データ入力

「CSR」、「主体者DN」、「失効対象証明書シリアル番号」、「サーバFQDN」、「利用管理者E-mail」、「利用管理者所属」、「Webサーバソフトウェア名等」をそれぞれ入力する。
「利用管理者氏名」、「dNSName」は必須入力ではないので必要があれば入力する(図24番号1)。
データ入力後、「完了」をクリックすることでTSVが作成される(図24番号2)。

図24 サーバ証明書 - 更新申請用TSV - データ入力

2.2.1.2.5.TSVファイル出力

TSV作成後、「ダウンロード」をクリックすることで、TSVファイルがダウンロードされる。

図25 サーバ証明書 - 更新申請用TSV - TSVファイル出力

2.2.1.2.6.終了

「終了」をクリックすることでTSVの作成を終了する。

図26 サーバ証明書 - 更新申請用TSV - 終了

2.2.1.3.失効申請用TSVファイルの作成

「TSVファイル種別」のセレクトボックスが「失効申請用TSV」を選択していることを確認する(図27番号1)。
「この内容で作成を開始」をクリックすることでTSVの作成を開始する(図27番号2)。

図27 サーバ証明書 - 失効申請用TSV


TSVを作成するための情報をCSVファイルからインポートすることで、複数レコードの一括作成が出来る。
オプションエリア「CSVファイル」の「ファイル選択」をクリックし、読み込むCSVファイルを選択する。
CSVに記述した内容がレコードの「主体者DN」、「失効対象証明書シリアル番号」、「利用管理者E-mail」にそれぞれ設定される。
上記に加えてオプション欄の「失効理由」を選択、「失効理由コメント」を入力後、「CSVから作成を開始」をクリックすることで、TSVの作成を開始する。

図28 サーバ証明書 - 失効申請用TSV - CSV取込

2.2.1.3.1.作成済みTSVファイル読込

「作成済みTSVファイル」の「ファイル選択」をクリックし、読み込むTSVファイルを選択する。

図29 サーバ証明書 – 失効申請用TSV – 作成済みTSV読込


ファイルを選択後、「読込」をクリックすることで、選択したTSVファイルの全レコードが、作成中のTSVの末尾に連結される。
また同一画面で複数のTSVファイルを読み込んだ場合、後から読み込んだTSVファイルのレコードが末尾になるように順次連結される。

2.2.1.3.2.証明書ファイル読込

「証明書ファイル読込」の「ファイル選択」をクリックし、読み込む証明書ファイルを選択する。

図30 サーバ証明書 - 失効申請用TSV - 証明書ファイル選択


ファイルを選択後、「読込」をクリックすることで、選択した証明書ファイルの情報から「主体者DN」、「失効対象証明書シリアル番号」を自動判別し、
主体者DN入力欄、失効対象証明書シリアル番号入力欄にそれぞれ設定される。

図31 サーバ証明書 - 失効申請用TSV - 証明書ファイル読込完了

2.2.1.3.3.データ入力

「主体者DN」、「失効対象証明書シリアル番号」、「利用管理者E-mail」をそれぞれ入力、「失効理由」の選択を行う。
「失効理由コメント」は必須入力ではないので必要があれば入力する(図32番号1)。
データ入力後、「完了」をクリックすることでTSVが作成される(図32番号2)。

図32 サーバ証明書 - 失効申請用TSV - データ入力

2.2.1.3.4.TSVファイル出力

TSV作成後、「ダウンロード」をクリックすることで、TSVファイルがダウンロードされる。

図33 サーバ証明書 - 失効申請用TSV - TSVファイル出力

2.2.1.3.5.終了

「終了」をクリックすることでTSVの作成を終了する。

図34 サーバ証明書 - 失効申請用TSV - 終了



2.2.2.クライアント証明書

「証明書種別」のセレクトボックスが「クライアント証明書」を選択していることを確認する(図35番号1)。
その後、「証明書プロファイル」と「発行方法」をそれぞれ選択する(図35番号2、番号3)。

図35 クライアント証明書

2.2.2.1.新規発行申請用TSVファイルの作成

「TSVファイル種別」のセレクトボックスが「新規発行申請用TSV」を選択していることを確認する。
「この内容で作成を開始」をクリックすることでTSVの作成を開始する。

図36 クライアント証明書 - 新規発行申請用TSV


「発行方法」に「2:P12一括」を選択した場合(図37番号1)、TSVを作成するための情報をCSVファイルからインポートすることで、複数レコードの一括作成が出来る。

オプションエリア「CSVファイル」の「ファイル選択」をクリックし、読み込むCSVファイルを選択する。
CSVに記述した内容がレコードの「主体者DN」、「利用管理者E-mail」、「利用管理者氏名」、「利用管理者所属」、「利用者氏名」、「利用者所属」、「利用者E-mail」、「P12ダウンロードファイル名」にそれぞれ設定される。
上記に加えてオプション欄の「登録機関名(英語)」、「都道府県名(英語)」、「市町村名(英語)」を入力後、「CSVから作成を開始」をクリックすることで、TSVの作成を開始する(図37番号2)。

図37 クライアント証明書 - 新規発行申請用TSV - CSV取込

2.2.2.1.1.作成済みTSV読込

「作成済みTSVファイル」の「ファイル選択」をクリックし、読み込むTSVファイルを選択する。

図38 クライアント証明書 – 新規発行申請用TSV – 作成済みTSV読込


ファイルを選択後、「読込」をクリックすることで、選択したTSVファイルの全レコードが、作成中のTSVの末尾に連結される。
また同一画面で複数のTSVファイルを読み込んだ場合、後から読み込んだTSVファイルのレコードが末尾になるように順次連結される。

2.2.2.1.2.データ入力

「発行方法」を選択、「主体者DN」、「利用管理者E-mail」、「利用者E-mail」、「利用管理者所属」、「P12ダウンロードファイル名」をそれぞれ入力する。
「利用管理者氏名」、「利用者氏名」、「利用者所属」、「アクセスPIN」は必須入力ではないので必要があれば入力する。
また「発行方法」に「2:P12一括」を選択した場合は、「利用者E-mail」の入力は任意となる(図39番号1)。
データ入力後、「完了」をクリックすることでTSVが作成される。(図39番号2)

図39 クライアント証明書 - 新規発行申請用TSV - データ入力

2.2.2.1.3.TSVファイル出力

TSV作成後、「ダウンロード」をクリックすることで、TSVファイルがダウンロードされる。

図40 クライアント証明書 - 新規発行申請用TSV - TSVファイル出力

2.2.2.1.4.終了

「終了」をクリックすることでTSVの作成を終了する。

図41 クライアント証明書 - 新規発行申請用TSV - 終了

2.2.2.2.更新申請用TSVファイルの作成

「TSVファイル種別」のセレクトボックスが「更新申請用TSV」を選択していることを確認する。
「この内容で作成を開始」をクリックすることでTSVの作成を開始する。

図42 クライアント証明書 - 更新申請用TSV


「発行方法」に「2:P12一括」を選択した場合(図43番号1)、TSVを作成するための情報をCSVファイルからインポートすることで、複数レコードの一括作成が出来る。
オプションエリア「CSVファイル」の「ファイル選択」をクリックし、読み込むCSVファイルを選択する。
CSVに記述した内容がレコードの「主体者DN」、「失効対象証明書シリアル番号」、「利用管理者E-mail」、「利用管理者氏名」、「利用管理者所属」、「利用者氏名」、
「利用者所属」、「利用者E-mail」、「P12ダウンロードファイル名」にそれぞれ設定される。

上記に加えてオプション欄の「登録機関名(英語)」、「都道府県名(英語)」、「市町村名(英語)」を入力後、
「CSVから作成を開始」をクリックすることで、TSVの作成を開始する(図43番号2)。

図43 クライアント証明書 - 更新申請用TSV - CSV取込

2.2.2.2.1.作成済みTSVファイル読込

作成済みTSVファイル」の「ファイル選択」をクリックし、読み込むTSVファイルを選択する。

図44 クライアント証明書 - 更新申請用TSV - 作成済みTSV読込


ファイルを選択後、「読込」をクリックすることで、選択したTSVファイルの全レコードが、作成中のTSVの末尾に連結される。
また同一画面で複数のTSVファイルを読み込んだ場合、後から読み込んだTSVファイルのレコードが末尾になるように順次連結される。

2.2.2.2.2.証明書ファイル読込

「証明書ファイル読込」の「ファイル選択」をクリックし、読み込む証明書ファイルを選択する。

図45 クライアント証明書 - 更新申請用TSV - 証明書ファイル選択


ファイルを選択後、「読込」をクリックすることで、選択した証明書ファイルの情報から「主体者DN」、「失効対象証明書シリアル番号」を自動判別し、
主体者DN入力欄、失効対象証明書シリアル番号入力欄にそれぞれ設定される。

図46 クライアント証明書 - 更新申請用TSV - 証明書ファイル読込完了

2.2.2.2.3.データ入力

「発行方法」を選択(図47番号1)、「主体者DN」、「失効対象証明書シリアル番号」、「利用管理者E-mail」、「利用者E-mail」、
「利用管理者所属」、「P12ダウンロードファイル名」をそれぞれ入力する。
「利用管理者氏名」、「利用者氏名」、「利用者所属」、「アクセスPIN」は必須入力ではないので必要があれば入力する。
「発行方法」に「2:P12一括」を選択した場合は、「利用者E-mail」の入力は任意となる(図47番号2)。

データ入力後、「完了」をクリックすることでTSVが作成される(図47番号3)。

図47 クライアント証明書 - 更新申請用TSV - データ入力

2.2.2.2.4.TSVファイル出力

TSV作成後、「ダウンロード」をクリックすることで、TSVファイルがダウンロードされる。

図48 クライアント証明書 - 更新申請用TSV - TSVファイル出力

2.2.2.2.5.終了

「終了」をクリックすることでTSVの作成を終了する。

図49 クライアント証明書 - 更新申請用TSV - 終了

2.2.2.3.失効申請用TSVファイルの作成

「TSVファイル種別」のセレクトボックスが「失効申請用TSV」を選択していることを確認する。
「この内容で作成を開始」をクリックすることでTSVの作成を開始する。

図50 クライアント証明書 - 失効申請用TSV


TSVを作成するための情報をCSVファイルからインポートすることで、複数レコードの一括作成が出来る。
オプションエリア「CSVファイル」の「ファイル選択」をクリックし、読み込むCSVファイルを選択する。
CSVに記述した内容がレコードの「主体者DN」、「失効対象証明書シリアル番号」、「利用管理者E-mail」にそれぞれ設定される。
上記に加えてオプション欄の「失効理由」を選択、「失効理由コメント」を入力後、「CSVから作成を開始」をクリックすることで、TSVの作成を開始する。

図51 クライアント証明書 - 失効申請用TSV - CSV取込

2.2.2.3.1.作成済みTSVファイル読込

作成済みTSVファイル」の「ファイル選択」をクリックし、読み込むTSVファイルを選択する。

図52 クライアント証明書 - 失効申請用TSV – 作成済みTSV読込

ファイルを選択後、「読込」をクリックすることで、選択したTSVファイルの全レコードが、作成中のTSVの末尾に連結される。
また同一画面で複数のTSVファイルを読み込んだ場合、後から読み込んだTSVファイルのレコードが末尾になるように順次連結される。

2.2.2.3.2.証明書ファイル読込

「証明書ファイル読込」の「ファイル選択」をクリックし、読み込む証明書ファイルを選択する。

図53 クライアント証明書 - 失効申請用TSV - 証明書ファイル選択


ファイルを選択後、「読込」をクリックすることで、選択した証明書ファイルの情報から「主体者DN」、「失効対象証明書シリアル番号」を自動判別し、
主体者DN入力欄、失効対象証明書シリアル番号入力欄にそれぞれ設定される。

図54 クライアント証明書 - 失効申請用TSV - 証明書ファイル読込完了

2.2.2.3.3.データ入力

「主体者DN」、「失効対象証明書シリアル番号」、「利用管理者E-mail」をそれぞれ入力、「失効理由」の選択を行う。
「失効理由コメント」、「利用者E-mail」は必須入力ではないので必要があれば入力する(図55番号1)。
データ入力後、「完了」をクリックすることでTSVが作成される(図55番号2)。

図55 クライアント証明書 - 失効申請用TSV - データ入力

2.2.2.3.4.TSVファイル出力

TSV作成後、「ダウンロード」をクリックすることで、TSVファイルがダウンロードされる。

図56 クライアント証明書 - 失効申請用TSV - TSVファイル出力

2.2.2.3.5.終了

「終了」をクリックすることでTSVの作成を終了する。

図57 クライアント証明書 - 失効申請用TSV - 終了


2.2.3.利用管理者情報更新申請用TSV

「TSVファイル種別」のセレクトボックスが「利用管理者情報更新申請用TSV」を選択していることを確認する。
「この内容で作成を開始」をクリックすることでTSVの作成を開始する。

図58 利用管理者情報更新申請用TSV

発行済み証明書一覧のTSVを読込、現在有効な全ての証明書について利用管理者情報更新申請を行うTSVファイルの作成が出来る。
オプションエリア「発行済み証明書一覧TSVファイル」の「ファイル選択」をクリックし、読み込むTSVファイルを選択する。
TSVに記述した内容がレコードの「申請ID」、「サーバFQDN」、「利用管理者E-mail」、「利用管理者氏名」、「利用管理者所属」にそれぞれ設定される。

また「利用管理者氏名」、「利用管理者E-mail」に入力した内容と、「有効期限切れ」、「失効済み」ラジオボタン選択状態により、
利用管理者情報更新申請対象の証明書の絞り込みが出来る。

上記内容をそれぞれ入力後、「発行済み証明書一覧TSVから作成を開始」をクリックすることで、TSVの作成を開始する。

図59 利用管理者情報更新申請用TSV – TSV取込

2.2.3.1.作成済みTSVファイル読込

作成済みTSVファイル」の「ファイル選択」をクリックし、読み込むTSVファイルを選択する。

図60 利用管理者情報更新申請用TSV – 作成済みTSV読込


ファイルを選択後、「読込」をクリックすることで、選択したTSVファイルの全レコードが、作成中のTSVの末尾に連結される。
また同一画面で複数のTSVファイルを読み込んだ場合、後から読み込んだTSVファイルのレコードが末尾になるように順次連結される。

2.2.3.2.データ入力

「申請ID」の入力を行う。「サーバFQDN」、「利用管理者E-mail」、「利用管理者氏名」、「利用管理者所属」は必須入力ではないので必要があれば入力する(図61番号1)。
データ入力後、「完了」をクリックすることでTSVが作成される(図61番号2)。

図61 利用管理者情報更新申請用TSV – データ入力

2.2.3.3.利用管理者情報一括更新

利用管理者情報一括更新を行う場合、図84で示したTSV取込の際に検索条件を指定し、更新対象の利用管理者を抽出する必要がある。
上記を行いレコード編集画面に遷移した場合、「抽出したレコードを一括編集」が表示される。

図62 利用管理者情報更新申請用TSV - 抽出したレコードを一括編集


「抽出したレコードを一括編集」をクリックすると、レコード一括編集画面に遷移する。
上記画面で更新後の利用管理者情報を入力(図63番号1)し、完了をクリックすると(図63番号2)、抽出した利用管理者情報を入力内容で更新したTSVが作成される。

図63 利用管理者情報更新申請用TSV – レコード一括編集

2.2.3.4.TSVファイル出力

TSV作成後、「ダウンロード」をクリックすることで、TSVファイルがダウンロードされる。

図64 利用管理者情報更新申請用TSV – TSVファイル出力

2.2.3.5.終了

「終了」をクリックすることでTSVの作成を終了する。

図65 利用管理者情報更新申請用TSV – 終了


2.3.作成済みTSV編集

トップメニュー画面の「作成開始」をクリックする(図8参照)。
種別選択画面に遷移後、「作成済みTSVの編集」タブリンクをクリックし、種別選択画面作成済みTSV編集画面に遷移することを確認する。

図66 種別選択 – 作成済みTSV編集

2.3.1.TSVファイル読込

「ファイル選択」(図67番号1)をクリックし、読み込むTSVファイル選択後、「作成済みTSVの編集を開始」(図67番号2)をクリックすることで、
選択したTSVのレコード編集画面に遷移する。

図67 作成済みTSV編集 – TSVファイル読込


作成済みTSV編集画面で読込可能なTSVファイル種別と読込後に遷移する編集画面の対応を表1に示す。


表1 作成済みTSV編集 – 読込可能TSV種別

レコード編集画面の操作についてはTSV新規作成機能で説明した内容と同様であるため割愛する。

2.4.エラーが発生した場合には

TSVツールを利用中にエラーが発生した場合、図93のようにエラーメッセージが赤色で表示される。


図68 エラーメッセージ

TSVツール利用時によく目にすると思われるエラーメッセージ、またその原因をまとめた表については下記FAQページにて記載をしている。
https://meatwiki.nii.ac.jp/confluence/pages/viewpage.action?pageId=94346841


3.管理者向け情報

本章ではTSVツールの管理者向けの手順や説明を記載する。

3.1.セットアップ手順

ここではTSVツールを特定のサーバにセットアップする手順を記載する。
最低限の手順のみを記述するため、必要に応じて追加手順を実施されたい。

3.1.1.想定するセットアップ環境

本手順ではCentOS 6系OS環境下にTSVツールをセットアップする前提とする。
また、OSは既にインストール済み、sudoが利用可能なユーザ(operatorとする)が登録済みであるものとする。

また、予め以下のようにsudo実行時に環境変数PATHが引き継がれるよう設定しておくこと。

$ {
  echo ‘Defaults !secure_path’
  echo ‘Defaults env_keep += “PATH”’
  echo ‘operator ALL=(ALL) ALL’
  } | sudo tee -a /etc/sudoers.d/operator

3.1.1.1.SELinuxの無効化、iptablesの設定

SELinuxの無効化を行う。

$ sudo cp /etc/sysconfig/selinux{,.orig}
$ sudo vim /etc/sysconfig/selinux
$ sudo diff -u /etc/sysconfig/selinux{.orig,}
--- /etc/sysconfig/selinux.orig   2016-01-18 18:19:31.057356294 +0900
+++ /etc/sysconfig/selinux    2016-01-18 18:19:44.116354782 +0900
@@ -4,7 +4,7 @@
 #     enforcing - SELinux security policy is enforced.
 #     permissive - SELinux prints warnings instead of enforcing.
 #     disabled - No SELinux policy is loaded.
-SELINUX=enforcing
+SELINUX=disabled
 # SELINUXTYPE= can take one of these two values:
 #     targeted - Targeted processes are protected,
 #     mls - Multi Level Security protection.

iptablesの設定を行う。 以下ではTSVツールを80番ポートで実行するものとして記述する。

$ sudo cp /etc/sysconfig/iptables{,.orig}
$ sudo vim /etc/sysconfig/iptables
$ sudo diff -u /etc/sysconfig/iptables{.orig,}
--- /etc/sysconfig/iptables.orig  2016-01-18 18:20:37.038356384 +0900
+++ /etc/sysconfig/iptables   2016-01-18 18:20:48.782353332 +0900
@@ -8,6 +8,7 @@
 -A INPUT -p icmp -j ACCEPT
 -A INPUT -i lo -j ACCEPT
 -A INPUT -m state --state NEW -m tcp -p tcp --dport 22 -j ACCEPT
+-A INPUT -m state --state NEW -m tcp -p tcp --dport 80 -j ACCEPT
 -A INPUT -j REJECT --reject-with icmp-host-prohibited
 -A FORWARD -j REJECT --reject-with icmp-host-prohibited
 COMMIT

3.1.1.2.パッケージのインストール

3.1.1.2.1.EPELリポジトリの追加

外部リポジトリで提供されるパッケージを利用可能にする。
環境によって利用するrpmファイルが変わるため、以下のコマンドのうち "http://..." 以降は適宜読み替えること。

$ sudo rpm -ivh http://dl.fedoraproject.org/pub/epel/6/x86_64/epel-release-6-8.noarch.rpm

3.1.1.2.2.開発ツールのインストール

コンパイラやRubyやPassengerのビルドに必要なライブラリ等をインストールする。

$ sudo yum -y groupinstall "Development Tools"
$ sudo yum -y install openssl-devel readline-devel zlib-devel curl-devel libcurl-devel libyaml-devel

3.1.1.3.SQLiteのインストール

一時データの保存に利用するSQLiteをインストールする。

$ sudo yum -y install sqlite sqlite-devel

3.1.1.4.Rubyのインストール

Rubyをインストールする場合、rpmを取得してインストールする、rvmやrbenvといったバージョン管理システムを使ってインストールする、
ソースコードからコンパイルしてインストールする、などの方法があり、どれを選択しても構わない。
本資料ではソースコードからコンパイルする方法を記述する。

$ sudo mkdir /opt/src
$ sudo chown operator:operator /oopt/srcc
$ cd /opt/src
$ curl -O https://cache.ruby-lang.org/pub/ruby/2.2/ruby-2.2.3.tar.gz
$ tar zxvf ruby-2.2.3.tar.gz
$ cd /opt/src/ruby-2.2.3
$ ./configure --prefx=/opt/ruby-2.2.3
$ make
$ sudo make install
$ sudo ln –s /opt/ruby-2.2.3 /opt/ruby
$ echo export PATH=/opt/ruby/bin:$PATH’ >> /home/operator/.bash_profile
$ echo export PATH=/opt/ruby/bin:$PATH’ | sudo tee –a /etc/profile.d/ruby.sh

一度ログアウトし再ログインする。sudoでrubyコマンドとgemコマンドが利用可能であることを確認する。

$ sudo ruby -v
ruby 2.2.3.p173 (2015-08-18 revision 51636) [x86_64-linux]
$ sudo gem -v
2.4.5.1

3.1.1.4.1.Bundlerのインストール

gemと呼ばれるRubyのライブラリ群を管理するためのツールであるBundlerをインストールする。

$ sudo gem install bundler --no-rdoc --no-ri

3.1.1.5.Apacheのインストール

WebサーバであるApacheをインストールする。

$ sudo yum install httpd

3.1.1.6.Phusion Passengerのインストール

アプリケーションサーバであるPassengerをインストールする。

$ sudo gem install passenger --no-rdoc --no-ri
$ sudo yum –y install httpd-devel apr-devel apr-util-devel
$ sudo passenger-install-apache2-module

インストールの途中で次のようなApacheの設定ファイル用のメッセージが表示されるため、記録しておくこと。

Please edit your Apache configuration file, and add these lines:
 
LoadModule passenger_module /opt/ruby-2.2.3/lib/ruby/gems/2.2.0/gems/passenger-5.0.23/buildout/apache2/mod_passenger.so
<IfModule mod_passenger.c>
  PassengerRoot /opt/ruby-2.2.3/lib/ruby/gems/2.2.0/gems/passenger-5.0.23
  PassengerDefaultRuby /opt/ruby-2.2.3/bin/ruby
</IfModule>
 
After you restart Apache, you are ready to deploy any number of web
applications on Apache, with a minimum amount of configuration!

3.1.1.7.Apacheの設定ファイルの追加

TSVツールを動かすためのApache用設定ファイルを作成する。
ここでは/etc/httpd/conf.d/以下の*.confファイルが自動で読み込まれるものとして記述する。
また、TSVツールのソースコードの配置場所を/var/lib以下とするものとして記述する。

/etc/httpd/conf.d/passenger.confに、Passengerのインストール時に表示された設定内容を記述する。
以下に例を示す。(環境によって異なるため、これをそのまま利用しないこと。)

LoadModule passenger_module /opt/ruby-2.2.3/lib/ruby/gems/2.2.0/gems/passenger-5.0.23/buildout/apache2/mod_passenger.so
<IfModule mod_passenger.c>
  PassengerRoot /opt/ruby-2.2.3/lib/ruby/gems/2.2.0/gems/passenger-5.0.23
  PassengerDefaultRuby /opt/ruby-2.2.3/bin/ruby
</IfModule>

ここではバーチャルホストでTSVツールを実行する例を示す。
/etc/httpd/conf.d/passenger.confに以下を記述する。 ポート番号やログファイルのパスなどは適宜変更すること。

Apacheのバージョンが2.2系の場合の例を以下に示す。

Listen 80
NameVirtualHost *:80
 
<VirtualHost *:80>
  ServerName localhost
  DocumentRoot /var/lib/tsv-tool/public
 
  <Directory /var/lib/tsv-tool/public>
    Options FollowSymLinks
    AllowOverride None
  </Directory>
 
  LogLevel info
  ErrorLog /var/log/httpd/tsvtool-error.log
  CustomLog /var/log/httpd/tsvtool-access.log combined
</VirtualHost>

Apacheのバージョンが2.4系の場合の例を以下に示す。

Listen 80
 
<VirtualHost *:80>
  ServerName localhost
  DocumentRoot /var/lib/tsv-tool/public
 
  <Directory /var/lib/tsv-tool/public>
    Options FollowSymLinks
    AllowOverride None
    Require all granted
  </Directory>
 
  LogLevel info
  ErrorLog /var/log/httpd/tsvtool-error.log
  CustomLog /var/log/httpd/tsvtool-access.log combined
</VirtualHost>

また、以下にドキュメントルート以外でTSVツールを動作させるための設定例をApacheのバージョンが2.2系の場合を例にして以下に示す。

Listen 80
NameVirtualHost *:80
 
<VirtualHost *:80>
  ServerName localhost
  DocumentRoot /var/lib/my_php_app/  # 既存のアプリケーション
  PassengerEnabled off               # サブディレクトリでのみPassengerを有効にするためoff
  PassengerAppRoot /var/lib/tsv-tool    # TSVツールのルートディレクトリを設定
  Alias /tsv-tool/ /var/lib/tsv-tool/public/  # http://.../tsv-tool/ 上でTSVツールを動作させる
  RackBaseURI /tsv-tool               # TSVツールのベースURIを設定
 
  <Directory /var/lib/my_php_app/>
    DirectoryIndex index.html index.php
    Options FollowSymLinks
    AllowOverride None
  </Directory>
 
  <Directory /var/lib/tsv-tool/ >
    PassengerEnabled on  # TSVツールのディレクトリに限りPassengerを有効にする
    Options FollowSymLinks
    AllowOverride None
  </Directory>
</VirtualHost>

以下のコマンドで設定内容に問題がないかを確認する。

$ sudo /etc/init.d/httpd configtest

3.1.1.8.ソースコードの配置、ライブラリのインストール、設定ファイルの作成

Apacheに設定した通り、/var/lib配下にソースコードを配置し、TSVツール用のライブラリをインストールする。

$ cd /var/lib/tsv-tool
$ bundle install

TSVツール用の設定ファイルを作成する。

$ cp config/config.yml{.example,}

必要があれば設定を変更する。

$ vi config/config.yml

Apacheを実行するユーザグループで読み書きできるようオーナーを変更する。

$ sudo chown -R apache:apache /var/lib/tsv-tool

ソースコード配置後、Apacheを再起動する。

$ sudo /etc/init.d/httpd graceful


3.2.ディレクトリ構成

以下にTSVツールのソースコード中、主要なディレクトリやファイルについて記載する。

表3 TSVツールディレクトリ構成

Gemfile

アプリケーションに必要なgemファイルを定義。

Rakefile

rakeコマンドで実行可能なタスクを定義。

app.rb

アプリケーションのメインファイル。これをロードすることで実行に必要なすべてのファイルをロードする。

config/

アプリケーションの設定ファイルを格納。

config/config.yml

アプリケーションの設定ファイル。

config/config.yml.example

アプリケーションの設定ファイルの基となるファイル。

config.ru

アプリケーションのエントリポイント。

controllers/

ユーザからの入力を受け取りmodelsやviews配下への命令へ変換する処理を担うクラスを格納。

controllers/create.rb

TSV作成機能に関するcontroller。

controllers/root.rb

メインメニューやキャンセル機能に関するcontroller。

controllers/viewer.rb

TSVビューア機能に関するcontroller。

lib/

ライブラリファイルを格納。

lib/helpers/

ヘルパー関連のファイルを格納。

lib/helpers/db_helper.rb

DB(一時データ用)操作に関するヘルパーを定義。

lib/helpers/view_helper.rb

画面やメッセージなど見た目に関するヘルパーを定義。

lib/helpers.rb

上記に該当しない全体的なヘルパーなどを定義。

log/

アプリケーションログの書き込み先。

models/

アプリケーションデータやロジックに関する処理を担うクラスを格納。

models/record.rb

TSVファイルのレコードに関する処理を定義。

models/tsv_file.rb

TSVファイルに関する処理を定義。

public/

公開フォルダ。

public/css/

スタイルシートを格納。

public/js/

javascriptファイルを格納。

spec/

テストコードを格納。

tmp/

一時データを格納。

views/

画面表示に利用されるHTMLのテンプレートを格納。

views/create/

TSV作成機能関連のHTMLテンプレートを格納。

views/viewer/

TSVビューア機能関連のHTMLテンプレートを格納。

3.3.カスタマイズCSSの配置

TSVツールではユーザによるインターフェースデザインを可能とする機能を提供している。
以下のパスにカスタマイズCSSファイルを配置することで、スタイルシートの機能の範囲内で任意のデザイン変更が可能である。
(以下はTSVツールのソースコードを/var/lib以下に配置したという前提のパスである。)

/var/lib/tsv-tool/public/css/customize.css

  • No labels