目次
本資料は国立情報学研究所の運営する電子証明書発行支援システムにて利用するTSVファイルの作成を支援するWebアプリケーション(以下、TSVツール)の操作・利用手順を記載したものである。
本章ではTSVツールの利用者向けの手順や説明を記載する。 TSVビューア機能、TSV作成機能について説明を行う。
TSVビューア機能では、UPKI電子証明書自動発行支援システムからダウンロードした以下のファイルを閲覧することができる。
トップメニュー画面の「TSVビューア」をクリックする。 図1 トップメニュー - TSVビューア選択 「ファイル選択」をクリックし、読み込むTSVファイルを選択する。 図2 TSVビューア - ファイル選択 ファイルを選択後、「読込」をクリックすることで選択したTSVファイルの情報が表示される。 図3 TSVビューア - ファイル読込 |
キーワード検索入力欄にキーワードを入力後、「絞り込む」をクリックすることでレコードの絞り込みを行うことが出来る。 図4 TSVビューア - キーワード検索 |
レコード行をクリックすることで、当該レコードの詳細な情報を見ることが出来る。 図5 TSVビューア - レコード選択 図6 TSVビューア - レコード詳細 「ビューア終了」をクリックすることでTSVビューアを終了する。 図7 TSVビューア - 終了 |
トップメニュー画面の「作成開始」をクリックする。
図8 トップメニュー - TSV作成開始
種別選択画面に遷移後、新規作成タブが選択状態であることを確認する。
図9 種別選択 – 新規作成タブ
「証明書種別」のセレクトボックスが「サーバ証明書」を選択していることを確認する(図10番号1)。
その後、「証明書プロファイル」を選択する(図10番号2)。
図10 サーバ証明書
「TSVファイル種別」のセレクトボックスが「新規発行申請用TSV」を選択していることを確認する(図11番号1)。 図11 サーバ証明書 - 新規発行申請書用TSV 2.2.1.1.1.作成済みTSVファイル読込「作成済みTSVファイル」の「ファイル選択」をクリックし、読み込むTSVファイルを選択する。 図12 サーバ証明書 - 新規発行申請用TSV – 作成済みTSV選択 ファイルを選択後、「読込」をクリックすることで、選択したTSVファイルの全レコードが、作成中のTSVの末尾に連結される。 2.2.1.1.2.CSRファイル読込「CSRファイル読込」の「ファイル選択」をクリックし、読み込むCSRファイルを選択する。 図13 サーバ証明書 - 新規発行申請用TSV - CSRファイル選択 ファイルを選択後、「読込」をクリックすることで、選択したCSRファイルの情報から「CSR」、「主体者DN」、「サーバFQDN」を自動判別し、 図14 サーバ証明書 - 新規発行申請用TSV - CSRファイル読込完了 2.2.1.1.3.データ入力「CSR」、「主体者DN」、「サーバFQDN」、「利用管理者E-mail」、「利用管理者所属」、「Webサーバソフトウェア名等」をそれぞれ入力する。 図15 サーバ証明書 - 新規発行申請用TSV - データ入力 2.2.1.1.4.TSVファイル出力TSV作成後、「ダウンロード」をクリックすることで、TSVファイルがダウンロードされる。 図16 サーバ証明書 - 新規発行申請用TSV - TSVファイル出力 2.2.1.1.5.終了「終了」をクリックすることでTSVの作成を終了する。 図17 サーバ証明書 - 新規発行申請用TSV - 終了 |
「TSVファイル種別」のセレクトボックスが「更新申請用TSV」を選択していることを確認する(図18番号1)。 図18 サーバ証明書 - 更新申請用TSV 2.2.1.2.1.作成済みTSVファイル読込「作成済みTSVファイル」の「ファイル選択」をクリックし、読み込むTSVファイルを選択する。 図19 サーバ証明書 – 更新申請用TSV – 作成済みTSV読込 ファイルを選択後、「読込」をクリックすることで、選択したTSVファイルの全レコードが、作成中のTSVの末尾に連結される。 2.2.1.2.2.CSRファイル読込「CSRファイル読込」の「ファイル選択」をクリックし、読み込むCSRファイルを選択する。 図20 サーバ証明書 - 更新申請用TSV - CSRファイル選択 ファイルを選択後、「読込」をクリックすることで、選択したCSRファイルの情報から「CSR」、「主体者DN」、「サーバFQDN」を自動判別し、 図21 サーバ証明書 - 更新申請用TSV - CSRファイル読込完了 2.2.1.2.3.証明書ファイル読込「証明書ファイル読込」の「ファイル選択」をクリックし、読み込む証明書ファイルを選択する。 図22 サーバ証明書 - 更新申請用TSV - 証明書ファイル選択 ファイルを選択後、「読込」をクリックすることで、選択した証明書ファイルの情報から「主体者DN」、「失効対象証明書シリアル番号」、「サーバFQDN」を自動判別し、 図23 サーバ証明書 - 更新申請用TSV - 証明書ファイル読込完了 2.2.1.2.4.データ入力「CSR」、「主体者DN」、「失効対象証明書シリアル番号」、「サーバFQDN」、「利用管理者E-mail」、「利用管理者所属」、「Webサーバソフトウェア名等」をそれぞれ入力する。 図24 サーバ証明書 - 更新申請用TSV - データ入力 2.2.1.2.5.TSVファイル出力TSV作成後、「ダウンロード」をクリックすることで、TSVファイルがダウンロードされる。 図25 サーバ証明書 - 更新申請用TSV - TSVファイル出力 2.2.1.2.6.終了「終了」をクリックすることでTSVの作成を終了する。 図26 サーバ証明書 - 更新申請用TSV - 終了 |
「TSVファイル種別」のセレクトボックスが「失効申請用TSV」を選択していることを確認する(図27番号1)。 図27 サーバ証明書 - 失効申請用TSV TSVを作成するための情報をCSVファイルからインポートすることで、複数レコードの一括作成が出来る。 図28 サーバ証明書 - 失効申請用TSV - CSV取込 2.2.1.3.1.作成済みTSVファイル読込「作成済みTSVファイル」の「ファイル選択」をクリックし、読み込むTSVファイルを選択する。 図29 サーバ証明書 – 失効申請用TSV – 作成済みTSV読込 ファイルを選択後、「読込」をクリックすることで、選択したTSVファイルの全レコードが、作成中のTSVの末尾に連結される。 2.2.1.3.2.証明書ファイル読込「証明書ファイル読込」の「ファイル選択」をクリックし、読み込む証明書ファイルを選択する。 図30 サーバ証明書 - 失効申請用TSV - 証明書ファイル選択 ファイルを選択後、「読込」をクリックすることで、選択した証明書ファイルの情報から「主体者DN」、「失効対象証明書シリアル番号」を自動判別し、 図31 サーバ証明書 - 失効申請用TSV - 証明書ファイル読込完了 2.2.1.3.3.データ入力「主体者DN」、「失効対象証明書シリアル番号」、「利用管理者E-mail」をそれぞれ入力、「失効理由」の選択を行う。 図32 サーバ証明書 - 失効申請用TSV - データ入力 2.2.1.3.4.TSVファイル出力TSV作成後、「ダウンロード」をクリックすることで、TSVファイルがダウンロードされる。 図33 サーバ証明書 - 失効申請用TSV - TSVファイル出力 2.2.1.3.5.終了「終了」をクリックすることでTSVの作成を終了する。 図34 サーバ証明書 - 失効申請用TSV - 終了 |
「証明書種別」のセレクトボックスが「クライアント証明書」を選択していることを確認する(図35番号1)。
その後、「証明書プロファイル」と「発行方法」をそれぞれ選択する(図35番号2、番号3)。
図35 クライアント証明書
「TSVファイル種別」のセレクトボックスが「新規発行申請用TSV」を選択していることを確認する。 図36 クライアント証明書 - 新規発行申請用TSV 「発行方法」に「2:P12一括」を選択した場合(図37番号1)、TSVを作成するための情報をCSVファイルからインポートすることで、複数レコードの一括作成が出来る。 オプションエリア「CSVファイル」の「ファイル選択」をクリックし、読み込むCSVファイルを選択する。 図37 クライアント証明書 - 新規発行申請用TSV - CSV取込 2.2.2.1.1.作成済みTSV読込「作成済みTSVファイル」の「ファイル選択」をクリックし、読み込むTSVファイルを選択する。 図38 クライアント証明書 – 新規発行申請用TSV – 作成済みTSV読込 ファイルを選択後、「読込」をクリックすることで、選択したTSVファイルの全レコードが、作成中のTSVの末尾に連結される。 2.2.2.1.2.データ入力「発行方法」を選択、「主体者DN」、「利用管理者E-mail」、「利用者E-mail」、「利用管理者所属」、「P12ダウンロードファイル名」をそれぞれ入力する。 図39 クライアント証明書 - 新規発行申請用TSV - データ入力 2.2.2.1.3.TSVファイル出力TSV作成後、「ダウンロード」をクリックすることで、TSVファイルがダウンロードされる。 図40 クライアント証明書 - 新規発行申請用TSV - TSVファイル出力 2.2.2.1.4.終了「終了」をクリックすることでTSVの作成を終了する。 図41 クライアント証明書 - 新規発行申請用TSV - 終了 |
「TSVファイル種別」のセレクトボックスが「更新申請用TSV」を選択していることを確認する。 図42 クライアント証明書 - 更新申請用TSV 「発行方法」に「2:P12一括」を選択した場合(図43番号1)、TSVを作成するための情報をCSVファイルからインポートすることで、複数レコードの一括作成が出来る。 上記に加えてオプション欄の「登録機関名(英語)」、「都道府県名(英語)」、「市町村名(英語)」を入力後、 図43 クライアント証明書 - 更新申請用TSV - CSV取込 2.2.2.2.1.作成済みTSVファイル読込作成済みTSVファイル」の「ファイル選択」をクリックし、読み込むTSVファイルを選択する。 図44 クライアント証明書 - 更新申請用TSV - 作成済みTSV読込 ファイルを選択後、「読込」をクリックすることで、選択したTSVファイルの全レコードが、作成中のTSVの末尾に連結される。 2.2.2.2.2.証明書ファイル読込「証明書ファイル読込」の「ファイル選択」をクリックし、読み込む証明書ファイルを選択する。 図45 クライアント証明書 - 更新申請用TSV - 証明書ファイル選択 ファイルを選択後、「読込」をクリックすることで、選択した証明書ファイルの情報から「主体者DN」、「失効対象証明書シリアル番号」を自動判別し、 図46 クライアント証明書 - 更新申請用TSV - 証明書ファイル読込完了 2.2.2.2.3.データ入力「発行方法」を選択(図47番号1)、「主体者DN」、「失効対象証明書シリアル番号」、「利用管理者E-mail」、「利用者E-mail」、 データ入力後、「完了」をクリックすることでTSVが作成される(図47番号3)。 図47 クライアント証明書 - 更新申請用TSV - データ入力 2.2.2.2.4.TSVファイル出力TSV作成後、「ダウンロード」をクリックすることで、TSVファイルがダウンロードされる。 図48 クライアント証明書 - 更新申請用TSV - TSVファイル出力 2.2.2.2.5.終了「終了」をクリックすることでTSVの作成を終了する。 図49 クライアント証明書 - 更新申請用TSV - 終了 |
「TSVファイル種別」のセレクトボックスが「失効申請用TSV」を選択していることを確認する。 図50 クライアント証明書 - 失効申請用TSV TSVを作成するための情報をCSVファイルからインポートすることで、複数レコードの一括作成が出来る。 図51 クライアント証明書 - 失効申請用TSV - CSV取込 2.2.2.3.1.作成済みTSVファイル読込作成済みTSVファイル」の「ファイル選択」をクリックし、読み込むTSVファイルを選択する。 図52 クライアント証明書 - 失効申請用TSV – 作成済みTSV読込 ファイルを選択後、「読込」をクリックすることで、選択したTSVファイルの全レコードが、作成中のTSVの末尾に連結される。 2.2.2.3.2.証明書ファイル読込「証明書ファイル読込」の「ファイル選択」をクリックし、読み込む証明書ファイルを選択する。 図53 クライアント証明書 - 失効申請用TSV - 証明書ファイル選択 ファイルを選択後、「読込」をクリックすることで、選択した証明書ファイルの情報から「主体者DN」、「失効対象証明書シリアル番号」を自動判別し、 図54 クライアント証明書 - 失効申請用TSV - 証明書ファイル読込完了 2.2.2.3.3.データ入力「主体者DN」、「失効対象証明書シリアル番号」、「利用管理者E-mail」をそれぞれ入力、「失効理由」の選択を行う。 図55 クライアント証明書 - 失効申請用TSV - データ入力 2.2.2.3.4.TSVファイル出力TSV作成後、「ダウンロード」をクリックすることで、TSVファイルがダウンロードされる。 図56 クライアント証明書 - 失効申請用TSV - TSVファイル出力 2.2.2.3.5.終了「終了」をクリックすることでTSVの作成を終了する。 図57 クライアント証明書 - 失効申請用TSV - 終了 |
「TSVファイル種別」のセレクトボックスが「利用管理者情報更新申請用TSV」を選択していることを確認する。
「この内容で作成を開始」をクリックすることでTSVの作成を開始する。
図58 利用管理者情報更新申請用TSV
発行済み証明書一覧のTSVを読込、現在有効な全ての証明書について利用管理者情報更新申請を行うTSVファイルの作成が出来る。 また「利用管理者氏名」、「利用管理者E-mail」に入力した内容と、「有効期限切れ」、「失効済み」ラジオボタン選択状態により、 上記内容をそれぞれ入力後、「発行済み証明書一覧TSVから作成を開始」をクリックすることで、TSVの作成を開始する。 図59 利用管理者情報更新申請用TSV – TSV取込 2.2.3.1.作成済みTSVファイル読込作成済みTSVファイル」の「ファイル選択」をクリックし、読み込むTSVファイルを選択する。 図60 利用管理者情報更新申請用TSV – 作成済みTSV読込 ファイルを選択後、「読込」をクリックすることで、選択したTSVファイルの全レコードが、作成中のTSVの末尾に連結される。 2.2.3.2.データ入力「申請ID」の入力を行う。「サーバFQDN」、「利用管理者E-mail」、「利用管理者氏名」、「利用管理者所属」は必須入力ではないので必要があれば入力する(図61番号1)。 図61 利用管理者情報更新申請用TSV – データ入力 2.2.3.3.利用管理者情報一括更新利用管理者情報一括更新を行う場合、図84で示したTSV取込の際に検索条件を指定し、更新対象の利用管理者を抽出する必要がある。 図62 利用管理者情報更新申請用TSV - 抽出したレコードを一括編集 「抽出したレコードを一括編集」をクリックすると、レコード一括編集画面に遷移する。 図63 利用管理者情報更新申請用TSV – レコード一括編集 2.2.3.4.TSVファイル出力TSV作成後、「ダウンロード」をクリックすることで、TSVファイルがダウンロードされる。 図64 利用管理者情報更新申請用TSV – TSVファイル出力 2.2.3.5.終了「終了」をクリックすることでTSVの作成を終了する。 図65 利用管理者情報更新申請用TSV – 終了 |
トップメニュー画面の「作成開始」をクリックする(図8参照)。 図66 種別選択 – 作成済みTSV編集 2.3.1.TSVファイル読込「ファイル選択」(図67番号1)をクリックし、読み込むTSVファイル選択後、「作成済みTSVの編集を開始」(図67番号2)をクリックすることで、 図67 作成済みTSV編集 – TSVファイル読込 作成済みTSV編集画面で読込可能なTSVファイル種別と読込後に遷移する編集画面の対応を表1に示す。 表1 作成済みTSV編集 – 読込可能TSV種別
レコード編集画面の操作についてはTSV新規作成機能で説明した内容と同様であるため割愛する。 |
TSVツールを利用中にエラーが発生した場合、図93のようにエラーメッセージが赤色で表示される。
図68 エラーメッセージ
TSVツール利用時によく目にすると思われるエラーメッセージ、またその原因をまとめた表については下記FAQページにて記載をしている。
https://meatwiki.nii.ac.jp/confluence/pages/viewpage.action?pageId=94346841
本章ではTSVツールの管理者向けの手順や説明を記載する。
ここではTSVツールを特定のサーバにセットアップする手順を記載する。
最低限の手順のみを記述するため、必要に応じて追加手順を実施されたい。
3.1.1.想定するセットアップ環境本手順ではCentOS 6系OS環境下にTSVツールをセットアップする前提とする。 また、予め以下のようにsudo実行時に環境変数PATHが引き継がれるよう設定しておくこと。
3.1.1.1.SELinuxの無効化、iptablesの設定SELinuxの無効化を行う。
iptablesの設定を行う。 以下ではTSVツールを80番ポートで実行するものとして記述する。
3.1.1.2.パッケージのインストール3.1.1.2.1.EPELリポジトリの追加外部リポジトリで提供されるパッケージを利用可能にする。
3.1.1.2.2.開発ツールのインストールコンパイラやRubyやPassengerのビルドに必要なライブラリ等をインストールする。
3.1.1.3.SQLiteのインストール一時データの保存に利用するSQLiteをインストールする。
3.1.1.4.RubyのインストールRubyをインストールする場合、rpmを取得してインストールする、rvmやrbenvといったバージョン管理システムを使ってインストールする、
一度ログアウトし再ログインする。sudoでrubyコマンドとgemコマンドが利用可能であることを確認する。
3.1.1.4.1.Bundlerのインストールgemと呼ばれるRubyのライブラリ群を管理するためのツールであるBundlerをインストールする。
3.1.1.5.ApacheのインストールWebサーバであるApacheをインストールする。
3.1.1.6.Phusion PassengerのインストールアプリケーションサーバであるPassengerをインストールする。
インストールの途中で次のようなApacheの設定ファイル用のメッセージが表示されるため、記録しておくこと。
3.1.1.7.Apacheの設定ファイルの追加TSVツールを動かすためのApache用設定ファイルを作成する。 /etc/httpd/conf.d/passenger.confに、Passengerのインストール時に表示された設定内容を記述する。
ここではバーチャルホストでTSVツールを実行する例を示す。 Apacheのバージョンが2.2系の場合の例を以下に示す。
Apacheのバージョンが2.4系の場合の例を以下に示す。
また、以下にドキュメントルート以外でTSVツールを動作させるための設定例をApacheのバージョンが2.2系の場合を例にして以下に示す。
以下のコマンドで設定内容に問題がないかを確認する。
3.1.1.8.ソースコードの配置、ライブラリのインストール、設定ファイルの作成Apacheに設定した通り、/var/lib配下にソースコードを配置し、TSVツール用のライブラリをインストールする。
TSVツール用の設定ファイルを作成する。
必要があれば設定を変更する。
Apacheを実行するユーザグループで読み書きできるようオーナーを変更する。
ソースコード配置後、Apacheを再起動する。
|
以下にTSVツールのソースコード中、主要なディレクトリやファイルについて記載する。
表3 TSVツールディレクトリ構成
Gemfile | アプリケーションに必要なgemファイルを定義。 |
Rakefile | rakeコマンドで実行可能なタスクを定義。 |
app.rb | アプリケーションのメインファイル。これをロードすることで実行に必要なすべてのファイルをロードする。 |
config/ | アプリケーションの設定ファイルを格納。 |
config/config.yml | アプリケーションの設定ファイル。 |
config/config.yml.example | アプリケーションの設定ファイルの基となるファイル。 |
アプリケーションのエントリポイント。 | |
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テンプレートを格納。 |
TSVツールではユーザによるインターフェースデザインを可能とする機能を提供している。
以下のパスにカスタマイズCSSファイルを配置することで、スタイルシートの機能の範囲内で任意のデザイン変更が可能である。
(以下はTSVツールのソースコードを/var/lib以下に配置したという前提のパスである。)
|