サードパーティ認証情報
Transloadit では、クラウドバケットやサーバーからのファイル取り込みと、それらへのファイル書き出しに対応しています。認証には認証情報が必要です。書き出しでは、可能であれば書き込み専用の認証情報を使用してください。これらは、取り込み用および書き出し用の Robot
パラメーターに直接設定することもできます(多くの場合、key と secret を使用します)。ただし、代わりに Template 認証情報を使うことを推奨します。Template 認証情報では、認証情報を個別に保存し、一意の名前を付けて、credentials
Robot Parameter でその名前を参照します。詳しくは、各 Robot ドキュメントを確認してください。
Template 認証情報の使用は完全に任意です。
Template 認証情報 を用意したことで、次のことが可能になります。
- 共有する Template JSON に、プロバイダーのシークレットを含めずに済みます。
- 複数の Template 間で認証情報を簡単に再利用できます。
- Template を使わずに、Assembly Instructions を直接送信しやすくなります。Template の利用を推奨している点は変わりませんが、この方法なら毎回シークレットを送信せずにプロトタイピングできます。
- 漏えいした認証情報を 失効させ、すべての Template やコードを変更せずに差し替えできます。
- トークンを追加できます。クラウドプロバイダーによっては、Transloadit にアクセスを許可するために対話型の OAuth フローが必要です。Template 認証情報の Web インターフェースは、これに対応しています。
以下は、アカウントに my_s3_credentials と
my_youtube_credentials という名前で事前に保存してある Template 認証情報を使う
Assembly Instructions の例です。S3 バケットから動画を取り込み、YouTube に非公開動画としてアップロードします。
{
"steps": {
"imported": {
"robot": "/s3/import",
"credentials": "my_s3_credentials",
"path": "/some/path"
},
"exported": {
"robot": "/youtube/store",
"use": "imported",
"credentials": "my_youtube_credentials",
"title": "My processed video",
"description": "A video processed with Transloadit",
"category": "science & technology",
"keywords": "transloadit",
"visibility": "private"
}
}
}
Template 認証情報の作成方法
- Workspace の 認証情報 ページを開きます。新しい認証情報 を選択します。まだ 1 つも作成していない場合は、認証情報を追加 を選択します。
- サービスでプロバイダーを選択します。識別しやすい 名前 を入力し、プロバイダーの各項目を埋めます。
- 作成を選択します。キーやトークンを直接入力した場合、Console は認証情報を保存して認証情報一覧に戻ります。OAuth で接続する場合は、まずプロバイダー側に移動してアクセスを承認します。
保存した名前を、該当する取り込み用または書き出し用
Robot の credentials の値として使用してください。必要な値とプロバイダー権限については、Google Cloud Storage の設定ガイド、DigitalOcean Spaces の設定ガイド、または該当する Robot ドキュメントを参照してください。
Template 認証情報は、Transloadit がプロバイダーに対して認証するためのものです。ユーザーのアップロードを認可するものではありません。Auth Key ベースのブラウザーアップロードでは、バックエンドでリクエストを認可し、サーバー側に Auth Secret を保持したまま Signature Authentication を使用してください。アップローダーに Step を変更させたくない場合は、保存済み Template の "allow_steps_override": false を設定してください。
Vimeo
Console の Vimeo OAuth は、アップロードでは /vimeo/store と組み合わせて使用できます。/vimeo/import では、自身の Vimeo アプリで発行した個人アクセストークンが必要です。Vimeo が他メンバーの動画ファイルへのアクセスを許可するのは、パートナー OAuth アプリに限られます。Transloadit は Vimeo パートナーではありません。OAuth を繰り返しても、この権限は追加されません。
- 動画を所有している Vimeo アカウントで developer.vimeo.com/apps にサインインし、アプリを作成するか、既存の自分のアプリを選択します。
- Authentication で Generate Access Token を開き、Authenticated (you) を選択します。
- Public、Private、Video Files(
public、private、video_files)を選択します。トークンを/vimeo/storeでも使う場合は、Upload、Edit、Interact(upload、edit、interact)も選択し、アプリに Vimeo のアップロードアクセスがあることを確認してください。 - トークンを生成してコピーします。Console で Template 認証情報を作成し、Vimeo を選択して 個人アクセストークンを貼り付け を選び、Vimeo アクセストークン に貼り付けます。
- 識別しやすい名前で保存し、その名前を Robot の
credentialsの値として使用します。
保存時に、Vimeo アカウントとトークンのスコープが検証されます。トークンは
access_token として保存され、Console に再表示されることはありません。動画のダウンロードは引き続き Vimeo のプランと動画権限に依存します。オリジナル(source)のダウンロードには、Vimeo が元のアップロードを保持していることも必要です。詳しくは、Vimeo のトークンガイドを参照してください。
Vimeo の再接続
更新では OAuth は再開されず、追加のスコープも付与されません。再接続するには、削除で認証情報を削除してから、Template が引き続き参照できるよう同じ名前で再作成してください。Vimeo の認証情報を削除すると、同じトークンの他用途も含めて、Vimeo 側でそのトークンが失効します。再度貼り付ける前に、新しい個人アクセストークンを生成してください。失効処理に失敗した場合は削除も失敗し、再試行できます。更新でトークンを置き換えることも可能です。保存済みトークンを維持するには、トークン欄を空のままにしてください。
すべてにアクセスできる鍵は渡さないでください
いくつかのセキュリティ原則に従い、処理に必要な権限はできるだけ少なくしたいと考えています。たとえば Amazon S3 バケットにファイルを書き出す場合でも、その用途専用に書き込み権限しか持たない IAM ユーザーを作成することは十分可能です。権限を制限すれば、キーが漏えいしたときの被害を抑えられます。プロバイダー側で書き込み権限と読み取り権限または削除権限が一体になっている場合は、アカウント全体ではなく専用バケットに限定した認証情報を使用してください。