PGP暗号化
PGP暗号化を使用して、Varicent Incentivesストレージにエクスポートまたはインポートされるファイルの暗号化と復号を行います。
前提条件
SPMアプリケーションの各モデルには、PGPキーのセットを1つだけ含めることができます。
一連のPGPキーには、パブリックPGPキーと、Varicentが提供するパブリックPGPキーが含まれます。たとえば、実稼働環境、QA環境、および開発環境がある場合、各環境に対して一意のPGPキーセットを持つことができます。また、3つの環境すべてで同じセットを使用することもできます。ただし、1つの環境で複数のPGPキーペアを使用することはできません。Varicentは、環境ごとに1つのパブリックPGPキー、またはすべての環境に1つのパブリックPGPキーを提供します。
PGP暗号化が必要な場合は、nameパラメーターがに設定outboundされ、強度が2048ビットのパブリックPGPキーをVaricentに提供する必要があります。
PGP暗号化と復号化のスケジュール
PGP暗号化および復号化タスクは、システムツールとしてスケジューラーを介して実行されます。
両方のPGPアクションで、入力ファイルパスと出力ファイルパスのパラメーターを指定する必要があります。
スケジューラーを開き、タスクを追加するプロセスフォルダーを選択します。
[追加]アイコンをクリックします。
[タイプ]メニューから「システムツール」を選択します。
次の手順を実行して、タスクのスケジュールを設定できます。
タスクを実行する日、または曜日を選択します。
タスクを実行する時間を分刻みで選択します。
タスクを実行する月を選択します。
[使用可能なシステムツール]メニューで、「PGPEncrypt」または「PGPDecrypt」を選択します。
[入力ファイルパス]フィールドに、暗号化または復号化するファイルの場所を
<folder>/<file name>の形式で入力します。例：
Publication/payee.pdf注記
ファイルパスフィールドは大文字と小文字が区別されます。
[出力ファイルパス]に、ファイルを暗号化または復号化した後に配置する場所を入力します。また、
<folder>/<file name>の形式である必要があります。ヒント
SFTPファイルの基本パスとして、
Data、Document、Image、Publication、またはScriptを使用します。ワイルドカードパターンマッチングを使用する場合は、次の手順に従います。
[入力ファイルパス]フィールドに、暗号化または復号化するファイルの場所を
<folder>/<file name pattern>.の形式で入力します。例：
Data/payee*.pdfこのファイルパスは、payeeで始まり、.pdfで終わるDataフォルダー内のファイルと一致します。[出力ファイルパス]に、ファイルを暗号化または復号化した後に配置する場所を入力します。また、形式は
<folder>/<file name pattern>または<folder>である必要があります。例：
Data/*.gpg新しいファイル.gpgが名前に追加され、Dataフォルダーに書き込まれました。
[作成]をクリックします。
PGP暗号化自動化
PGP暗号化と復号化を自動化します。
自動化には、出力が作成され、ダウンストリーム・プロセスで消費される予定のファイル名が存在するときに競合が発生しないようにするための外部ツールが必要です。
例
この例は、SPMにインポートする必要があるPGP暗号化ファイルの基本的なワークフローをシミュレートし、PGP暗号化を使用して発行ファイルをエクスポートします。
前提条件
このワークフローには、外部ツール
remove_file.py が必要です。この外部ツールは、指定したファイルが存在する場合、そのファイルを削除します。
remove_timestamp.pyこの外部ツールは、指定したファイルプレフィックスの最新のタイムスタンプを検索し、削除します。
サンプル・ワークフロー
SFTP - ファイル
import.csv.pgpが/root/Dataフォルダーに移動されます。スケジューラー - 外部ツール
remove_file.py /root/Data/import.csvが、以前のスケジューラー実行から復号化されたファイルを削除します。スケジューラー -
/root/Data/import.csv.pgpと/root/Data/import.csvのファイルパスを持つシステムツールPGPDecryptが、新しくアップロードされたインポートファイルを復号化します。スケジューラー - 復号化されたインポートファイルで必要なタスクが実行されます。
スケジューラー - ファイル
report-timestamp.pdfが発行されます。スケジューラー - 外部ツール
remove_file.py /root/Publication/report.pdfが、前回のスケジューラー実行からファイルをクリーンアップします。スケジューラー - 外部ツール
remove_file.py /root/Publication/report.pdf.pgpが、前回のスケジューラー実行からファイルをクリーンアップします。スケジューラー - 外部ツール
remove_timestamp.py /root/Pubication/report.pdfが、直近に発行されたレポートファイルからタイムスタンプを除去します。スケジューラー -
/root/Publication/report.pdfと/root/Publication/report.pdf.pgpのファイルパスを持つシステムツールPGPEncryptが、発酵されたレポートファイルを暗号化します。SFTP - SPMアプリケーションからファイル
report.pdf.pgpをコピーできるようになりました。
ワイルドカードパターンの一致に関するルール
ワイルドカードパターンマッチングを使用する場合、入力ファイルパスと出力ファイルパスの両方にルールがあります。
入力ファイルのパス
有効なファイルパス
*を使用すると、同じ入力ファイルパスで複数のワイルドカードを使用できます。たとえば、次のファイルパスは有効です。
path/to/*_2018_*path/to/*.*
入力ファイルパスでは、接頭語と接尾語を使用できます。たとえば、次のファイルパスは有効です。
path/to/prefix*path/to/prefix*suffixpath/to/*suffix
無効なファイルパス
注意
ファイルパスは?を含んでいる必要があります
フォルダー名にワイルドカード・パターンの一致を使用することはできません。たとえば、path/*/file.txtは無効です。
ディレクトリー名にワイルドカードパターンの一致を使用することはできません。たとえば、有効なファイルパスpath/to/*がpath/to/innerfolder/sample_file.txtのファイルパスを見つけることができません。
スケジューラールール
ワイルドカード・パターンに一致するファイルがない場合、スケジュールしたタスクは成功します。
ワイルドカードパターンが複数のファイルに一致するが、ファイルを暗号化または復号化できない場合、そのパターンに一致する他のファイルを処理しようとして処理を続行します。スケジュールされたタスクは失敗します。
出力ファイルのパス
出力ファイルパスを持つディレクトリーは、入力ファイルパスにワイルドカードが含まれている場合にのみ使用できます。たとえば、path/subdirは、フォルダーが存在し、書き込みが可能な場合に有効です。
注記
出力ファイル名は、入力ファイル名と同じになります。
入力ファイルパスにワイルドカードも含まれている場合にのみ、出力ファイルパスでワイルドカードパターンの一致を使用できます。
入力にワイルドカードがある場合、出力ファイルのパスにもワイルドカードが必要です。
有効なファイルパス
出力ファイルパスには、1つのワイルドカード記号のみを使用できます。たとえば、次のファイルパスは有効です。
path/output/*path/to/prefix_*.txt
出力ファイル名には、接頭語と接尾語を使用できます。たとえば、次のファイルパスは有効です。
path/output/2018_11_28_*の結果は、ファイル名2018_11_28_ prefixになりますpath/output/*.gpgは、入力ファイルsample_file.txtおよびsample_file.test.txtを、path/output/sample_file.txt.gpgおよびpath/output/sample_file.test.txt.gpgにマッピングします。
無効なファイルパス
注意
ファイルパスは?を含んでいる必要があります
出力ファイルパスには、1つのワイルドカード記号のみを使用できます。たとえば、次のファイルパスは無効です。
path/to/*_2018_*path/to/*.*
フォルダー名にワイルドカード・パターンの一致を使用することはできません。例：path/*/result.gpg。
暗号化の例
ここでは、ワイルドカード・パターンの一致ありとなしの暗号化動作の例をいくつか示します。
次のファイルがあります。
Data/sample_fileData/sample_file.txtData/sample_file.2018.txtData/other_FILE
PGPEncryptは、Data/sample_file Data/output/sample_file.gpgはData/output/sample_file.gpgに単一の暗号化されたファイルを作成します。Data/outputディレクトリーが存在しない場合、暗号化は失敗します。
PGPEncryptData/sample*.*は、2つの暗号化されたファイルを作成します（data/outputディレクトリーが存在しない場合、暗号化は失敗します）。
Data/sample_file.txtがData/encrypted/sample_file.txtになりますData/sample_file.2018.txtがData/encrypted/sample_file.2018.txtになります
PGPEncryptData/* Data/encrypted/prefix_*.gpgは、次の暗号化されたファイルを作成します（data/outputディレクトリーが存在しない場合、暗号化は失敗します）。
Data/sample_fileがData/prefix_sample_file.gpgになりますData/sample_file.txtがData/prefix_sample_file.txt.gpgになりますData/sample_file.2018.txtがData/prefix_sample_file.2018.txt.gpgになりますData/other_FILEがData/prefix_other_FILE.gpgになります
PGPEncryptData/*file* Data/encrypted_*.gpgは、次の暗号化されたファイルを作成します。
Data/sample_fileがData/encrypted_sample_file.gpgになりますData/sample_file.txtがData/encrypted_sample_file.txt.gpgになりますData/sample_file.2018.txtがData/encrypted_sample_file.2018.txt.gpgになります
復号化の例
ここでは、ワイルドカード・パターンの一致ありとなしの復号化動作の例をいくつか示します。
次のファイルがあります。
Data/file1.txt.gpgData/file2.txt.gpgData/file3.csv.gpgData/file4.gpgData/results.2018Data/decrypted/Data/output/
PGPDecryptData/file1.txt.gpg Data/output/sample_file.txtは、Data/output/sample_file.txtで単一の復号化されたファイルを作成します。Data/outputディレクトリーが存在しない場合、復号化は失敗します。
PGPDecryptData/*.txt* Data/decrypted/*は、2つの復号化されたファイルを作成します。
Data/decrypted/file1.txtData/decrypted/file2.txt
PGPDecrypt Data/*.csv.gpg Data/decrypted/ここで、出力パスにワイルドカードがないと、Data/decrypted/file3.csv.gpgに復号化されたファイルが作成されます。
PGPD暗号Data/*.gpg Data/decrypted/Processed_*は、以下の復号化されたファイルを作成します。
Data/decrypted/Processed_file1.txtData/decrypted/Processed_file2.txtData/decrypted/Processed_file3.csvData/decrypted/Processed_file4
PGP暗号化または復号化のトラブルシューティング
PGP暗号化または復号化のトラブルシューティング
PGP暗号化または復号化タスクの失敗の、一般的な原因をトラブルシューティングします。
入力または出力ファイルのパスにスペースが含まれている
入力パスまたは出力パスにスペースが含まれている場合、PGP暗号化または復号化が失敗することがあります。
暗号化または復号化タスクが失敗します。
入力または出力ファイルのパスにスペースが含まれています。
パスを引用符で囲みます。例：“Data/2018 Quarter 3 results.xlsx”。
入力または出力ファイルのパスが、大文字小文字と一致しません
入力パスまたは出力パスで大文字と小文字が区別されない場合、PGP暗号化または復号化が失敗することがあります。
暗号化または復号化タスクが失敗します。
入力または出力ファイルのパスが大文字小文字と一致しません。
ファイルパスを確認します。ファイルパスでは、大文字と小文字が区別されます。ファイルパスが正確に一致するように更新します。
入力ファイルパスのみのワイルドカードパターン一致
入力ファイルパスにワイルドカードパターン一致が含まれている場合、PGP暗号化または復号化に失敗する可能性がありますが、出力ファイルパスには一致しません。以前のリリースでは、出力ファイルパスにワイルドカードがない入力ファイルパスでワイルドカードパターン一致がサポートされていました。この非推奨の定義を使用している場合は、スケジューラーのシステムツールを新しい定義に置き換える必要があります。
暗号化または復号化タスクが失敗します。
入力失敗パスにワイルドカードが含まれていますが、出力ファイルパスにはありません。
古いタスクを置き換える暗号化または復号化タスクを作成します。出力ファイルパスが、ワイルドカードパターンマッチングを使用していることを確認します。
タイプ | 検証 | 入力ファイルのパス | 出力ファイルのパス |
|---|---|---|---|
暗号化 | 無効 |
|
|
暗号化 | 有効 |
|
|
復号化 | 無効 |
|
|
復号化 | 有効 |
|
|
ディレクトリに書き込めません
指定したディレクトリに書き込む権限がない場合、PGPの暗号化または復号化が失敗する可能性があります。
暗号化または復号化タスクが失敗します。
ユーザーには、ディレクトリに書き込む権限がありません。
ディレクトリへの書き込みができるように、SFTP接続を介してディレクトリの権限を変更します。