エンド・ツー・エンドの暗号化
このトピックでは、Vonage Video Android Client SDKにおけるエンドツーエンド暗号化の使用方法について詳しく説明しています:
エンドツーエンド暗号化の概要については、以下を参照してください。 本題.
暗号化シークレットの設定
エンドツーエンド暗号化されたセッションは、サーバーAPIを使用して作成されます(参照: REST APIを使用して暗号化を有効にする).
クライアントがパブリッシュまたはサブスクライブする前に Session.setEncryptionSecret() メソッドを使用する:
session.setEncryptionSecret("encryption-secret");
session.connect(TOKEN);
有効な秘密は8文字以上256文字以下の文字列である。シークレットを変更するには Session.setEncryptionSecret() 関数を再び使用する。
無効なシークレットを設定すると InvalidEncryptionSecret エラー。
イベントとエラー
イベントとエラーは、ユーザー主導の暗号化の動作を管理するために不可欠である。エンドツーエンドの暗号化は、共有秘密モデルを使用します。セッション内の全員が、自分のメディアを暗号化し、他の全員のメディアを復号化するために、同じ秘密を使用することが期待されています。
クライアントが暗号化シークレットを設定せずにエンドツーエンドで暗号化されたセッションに接続しようとすると SessionListener.onError() イベントハンドラは、エラーコードを ErrorCode.EncryptionSecretMissing:
// Implementation of SessionListener.onError():
@Override
public void onError(Session session, OpentokError opentokError) {
if (opentokError.getErrorCode() == ErrorCode.EncryptionSecretMissing) {
// Notify the user that they cannot join the session
}
}
session.connect(token);
暗号化シークレットを指定せずにエンドツーエンドで暗号化されたセッションを公開しようとした場合、次のように呼び出す。 Session.publish() メソッドの結果は PublisherListener.onError() イベントハンドラが、コードが次のように設定されたエラーを伴って呼び出されています。 ErrorCode.EncryptionSecretMissing.最高のユーザーエクスペリエンスを得るためには、アプリケーションは Session.publish() メソッドを使用する:
// Implementation of PublisherListener.onError():
@Override
public void onError(PublisherKit publisher, OpentokError opentokError) {
if (opentokError.getErrorCode() == ErrorCode.EncryptionInternalError) {
// The application should communicate that the secret was not set.
}
}
session.publish(publisher);
不正確な暗号化シークレットのために、加入者がストリームのメディアをデコードできない場合は SubscriberListener.onError() イベント・ハンドラがエラーで呼び出され、そのコードは次のように設定されている。 ErrorCode.EncryptionSecretMismatch.メディアを受信できないのは、暗号化の不一致によるものであり、接続障害やオーディオ/ビデオの問題ではないことをユーザーに伝えることが重要です:
// Implementation of Subscriber.onError():
@Override
public void onError(SubscriberKit publisher, OpentokError opentokError) {
if (opentokError.getErrorCode() == ErrorCode.EncryptionSecretMismatch) {
// Activate a UI element communicating that there's been an encryption secret mismatch.
}
}
session.subscribe(subscriber);
アプリケーションが暗号化シークレットを設定せずにサブスクリプションを試みた場合、 Subscriber.onError() イベント・ハンドラがエラーで呼び出され、そのコードは次のように設定されている。 ErrorCode.EncryptionSecretMissing.
サブスクライバーがパケットを復号化する際に内部エラーが発生した場合 Subscriber.onError() イベント・ハンドラがエラーで呼び出され、そのコードは次のように設定されている。 ErrorCode.DecryptionInternalError.
エンドツーエンド暗号化なしのセッションでシークレットを設定する
注: この機能は、SDK バージョン 2.36.0 以降で利用可能です。
エンドツーエンド暗号化が有効な状態でセッションが作成されなかった場合、そのセッションに暗号化シークレットを設定すると、 ErrorCode.EncryptionNotEnabled エラー。エラーが発生する場所は、接続、公開、および購読に対して、シークレットがいつ設定されたかによって異なります。
接続前にシークレットを設定する
セッションでエンドツーエンド暗号化が有効になっているかどうかは、クライアントが接続して初めて判明します。もし Session.setEncryptionSecret() 接続前は、呼び出しは成功し、セッションは正常に接続されます。このエラーは、クライアントがパブリッシュまたはサブスクライブを行う際に報告されます:呼び出し Session.publish() または Session.subscribe() その結果、 SessionListener.onError() イベントハンドラが、コードが次のように設定されたエラーを伴って呼び出されています。 ErrorCode.EncryptionNotEnabled:
// Implementation of SessionListener.onError():
@Override
public void onError(Session session, OpentokError opentokError) {
if (opentokError.getErrorCode() == ErrorCode.EncryptionNotEnabled) {
// The application should communicate that end-to-end encryption
// is not enabled for this session.
}
}
session.setEncryptionSecret("encryption-secret");
session.connect(TOKEN);
// ...
session.publish(publisher);
接続後にシークレットを設定する
もし電話をかけるなら Session.setEncryptionSecret() クライアントがエンドツーエンド暗号化のないセッションに接続した後、シークレットは設定されず、 SessionListener.onError() イベント・ハンドラがエラーで呼び出され、そのコードは次のように設定されている。 ErrorCode.EncryptionNotEnabled.
公開または購読時のシークレットの設定
もし電話をかけるなら Session.setEncryptionSecret() クライアントがすでにパブリッシュまたはサブスクライブを行っている場合、前述の通り呼び出しは失敗し、アクティブなすべてのパブリッシャーとサブスクライバーもセッションから削除されます。それぞれが独自の onError() イベントハンドラ — PublisherListener.onError() 出版社および SubscriberListener.onError() 購読者向け — コードが次のように設定されている場合 ErrorCode.EncryptionNotEnabled:
// Implementation of PublisherListener.onError():
@Override
public void onError(PublisherKit publisher, OpentokError opentokError) {
if (opentokError.getErrorCode() == ErrorCode.EncryptionNotEnabled) {
// The publisher has been removed from the session.
}
}
// Implementation of SubscriberListener.onError():
@Override
public void onError(SubscriberKit subscriber, OpentokError opentokError) {
if (opentokError.getErrorCode() == ErrorCode.EncryptionNotEnabled) {
// The subscriber has been removed from the session.
}
}
エラーからの復旧
これらのエラーが発生しても、セッションは有効なままです。再度パブリッシュまたはサブスクライブするには、以下を呼び出してシークレットをクリアしてください。 Session.setEncryptionSecret() と null. その後、その同じ PublisherKit オブジェクトを Session.publish() 再び
session.setEncryptionSecret(null);
session.publish(publisher);