PDFDigitalSign - PDFに電子署名します
PDFファイルに電子署名を付加します。
電子署名で使用する証明書は、管理コンソールで作成またはインポートしたユーザーの証明書を使用します。
また、長期署名や可視署名を付加することもできます。長期署名については「長期署名について」を、可視署名については「可視署名について」を参照してください。
■ストリーム情報
| 入力 | フォーマット | すべて |
|---|---|---|
| 接続数 | 1 | |
| 説明 | 入力ストリームは使用せず、すべて無視します。 | |
| 出力 | フォーマット | すべて |
| 説明 | 入力ストリームをそのまま出力します。 |
■コンポーネントプロパティ
| 名前 | プロパティ型 | マッピング | 説明 | ||||||
|---|---|---|---|---|---|---|---|---|---|
| PDFファイルパス | remoteFile | 入力＆出力 |
電子署名するPDFファイルのパスを指定します。区切り文字「\」と「/」は区別されません。
相対パスの場合は相対パスの起点 の指定に基づいて解釈されます。 例： directory/file.pdf C:\directory\file.pdf \\server\share\file.pdf |
||||||
| 保存先PDFファイルパス | remoteFile | 入力＆出力 |
保存先のPDFファイルのパスを指定します。
区切り文字「\」と「/」は区別されません。 相対パスの場合は相対パスの起点 の指定に基づいて解釈されます。 例： directory/file.pdf C:\directory\file.pdf \\server\share\file.pdf |
||||||
| ファイルパスの詳細設定 | group | - | ファイルパスの詳細設定を行うプロパティ群です。 | ||||||
| 相対パスの起点 | pathResolver | - |
相対パス指定の場合にベースフォルダーを指定します。
|
||||||
| 絶対パスを許可 | boolean | - | 絶対パスを許可するかどうか選択します。 | ||||||
| 「..」を許可 | boolean | - | 上のフォルダへ移動する記述に「..」を許可するかどうか選択します。 | ||||||
| パスワード | password | 入力＆出力 |
PDFファイルのパスワードを指定します。PDFファイルパスで指定したPDFファイルにパスワードが設定されている場合に使用します。
電子署名されたPDFファイルも同じパスワードで保護されます。 |
||||||
| 署名者の証明書 | string | 入力＆出力 |
署名者の証明書を指定します。
管理コンソールでユーザーの証明書を作成・インポートしたときにつけたエイリアス名を指定します。 |
||||||
| 署名者の場所 | string | 入力＆出力 |
電子署名を付加する場所の情報を指定します。
例：東京 |
||||||
| 署名理由 | string | 入力＆出力 |
電子署名を付加する理由を指定します。
例：受領済み |
||||||
| サーバーURL | string | 入力＆出力 | タイムスタンプサーバーのURLを指定します。 | ||||||
| ユーザー名 | string | 入力＆出力 | タイムスタンプサーバーのユーザー名を指定します。 | ||||||
| パスワード | password | 入力＆出力 | タイムスタンプサーバーのパスワードを指定します。 | ||||||
| 長期署名を付加 | boolean | 入力＆出力 |
長期署名を付加するかどうかを指定します。詳細は下記トピック 「長期署名について」を参照して下さい。
|
||||||
| プロキシ設定を使用 | boolean | 入力＆出力 |
管理コンソールで設定したプロキシ設定を使用するかどうかを指定します。
この設定は、サーバーURLが指定されている場合、または、長期署名を付加が「はい」の場合に使用されます。
|
||||||
| ハッシュアルゴリズム | choice | 入力＆出力 |
電子署名を作成する時のハッシュアルゴリズムを指定します。
署名者の証明書で指定した証明書の署名アルゴリズムが「DSA」の場合は自動的に「SHA1」となります。 また、サーバーURLが指定されている場合、タイムスタンプを作成する時のアルゴリズムとしても使用されます。
|
||||||
| 可視署名を付加 | boolean | 入力＆出力 |
可視署名を付加するかどうかを指定します。
可視署名はPDFの最後に新規ページを追加してそこに付加します。もしも、PDFにすでに電子署名が付加されていた場合は、最終ページに可視署名を付加します。
|
||||||
| 背景画像ファイルパス | remoteFile | 入力＆出力 |
可視署名の背景画像を指定します。
推奨サイズは幅300px、高さ215pxで、pngやjpgなど一般的な画像形式をサポートしています。 背景画像が指定されなかった場合は、コンポーネント標準の画像が使用されます。 相対パスの場合は相対パスの起点の指定に基づいて解釈されます。 |
||||||
| 標準フォントファイル | string | 入力＆出力 |
可視署名の標準フォントのファイル名（.ttc または .ttfファイル）を指定します。
デフォルトのフォントファイルは「YuGothR.ttc」です。 |
||||||
| 標準フォント名 | string | 入力＆出力 | 標準フォントファイルが .ttcファイルの場合に、可視署名の標準フォントのフォント名を指定します。
デフォルトのフォント名は「YuGothic-Regular」です。 |
||||||
| ボールドフォントファイル | string | 入力＆出力 |
可視署名のボールドフォントのファイル名（.ttc または .ttfファイル）を指定します。
可視署名のタイトル部分のフォントとして使用されます。 デフォルトのフォントファイルは「YuGothB.ttc」です。 |
||||||
| ボールドフォント名 | string | 入力＆出力 | ボールドフォントファイルが .ttcファイルの場合に、可視署名のボールドフォントのフォント名を指定します。
デフォルトのフォント名は「YuGothic-Bold」です。 |
||||||
| 上書きを許可 | boolean | 入力＆出力 | 保存先PDFファイルパス で指定したPDFファイルがすでに存在する場合の動作を指定します。初期値は「はい」です。
|
||||||
| 元のPDFファイルを削除する | boolean | 入力＆出力 |
コミット時にPDFファイルパスで指定したPDFファイルを削除するかどうか選択します。初期値は「いいえ」です。
|
■トランザクション処理
| コミット | 元のPDFファイルを削除する が「はい」の場合にPDFファイルパスのファイルを削除します。 |
|---|---|
| ロールバック | 何もしません。 |
■エラー処理
| タイプ | パラメーター | エラー処理フロー
へのストリーム | エラー
コード | 説明 |
|---|---|---|---|---|
| 汎用 | なし | コンポーネントの入力ストリーム | 3 | 保存先PDFファイルパスが指定されていなかった場合 |
| 4 | 対応していないアルゴリズムを指定した場合 | |||
| 5 | キーストアファイルが取得できない場合 | |||
| 6 | キーストアファイルが復元できない場合 | |||
| 7 | キーストア名が指定されていない場合 | |||
| 8 | 鍵が不正な場合 | |||
| 9 | PDFファイルパスで指定されたファイルがPDFファイルじゃない場合 | |||
| 10 | 電子署名を作れない場合 | |||
| 11 | キーストアが初期化されていない場合 | |||
| 12 | パスワードが不正な場合 | |||
| 13 | 署名者の証明書が不正な場合 | |||
| 14 | 署名に失敗した場合 | |||
| 15 | タイムスタンプを付加することができなかった場合 | |||
| 16 | If LTV revocation data could not be added. | |||
| 17 | 標準フォントファイルまたはボールドフォントファイルに指定されたフォントがサポートされていない場合 | |||
| 18 | 標準フォント名またはボールドフォント名で指定されたフォントが.ttcファイルに存在していなかった場合 | |||
| 19 | 元のPDFファイルを削除するが「はい」でPDFファイルパスで指定されたファイルが削除できなかった場合 | |||
| ファイルが存在しない | なし | コンポーネントの入力ストリーム | 1 | PDFファイルパスで指定されたPDFファイルが存在しなかった場合 |
| 出力先ファイルがすでに存在する | なし | コンポーネントの入力ストリーム | 2 | 上書きを許可が「いいえ」で、保存先PDFファイルパスで指定したファイルが既に存在している場合 |
■長期署名について
長期署名とは、電子署名に使用した証明書が期限切れになった後でも有効な電子署名です。
本コンポーネントでは、長期署名を付加を「はい」に指定することでPDFに長期署名を付加することができます。
長期署名を付加すると、証明書、証明書失効リスト（CRL）またはOSCP応答など電子署名の検証に必要なすべての情報が付加されます。
本コンポーネントではユーザーの証明書チェーン内のすべての証明書についてCRLまたはOSCP応答を取得します。そのため、管理コンソールで登録するユーザーの証明書には完全な証明書チェーンが含まれている必要があります。
CRLやOSCP応答を取得するために使用されるURLは各証明書に設定されているURLを使用します。
また、CRLやOCSP応答に付加されている電子署名がユーザーの証明書チェーンに含まれている証明書で検証できない場合は、長期署名の検証に必要なすべての情報を付加することができないため、本コンポーネントで付加した電子署名が長期署名とならないことがあります。長期署名は市販のPDFリーダー、PDFビューワーで確認することができますので、本コンポーネントの動作検証時などに事前に確認してください。
■可視署名について
可視署名を付加を「はい」に指定した場合、次の３つの要素を含む可視署名が付加されます。
- 背景画像として背景画像ファイルパスで指定された画像が使用されます。背景画像の推奨サイズは幅300px、高さ215pxです。
- 署名者の名前として署名者の証明書で指定された証明書のCNが使用されます。
- 署名の日時として署名を付加した日時が記されます。
可視署名の例
