エンド・ツー・エンドの暗号化

このトピックでは、Vonage VideoのiOS用Swift Client SDKにおけるエンドツーエンド暗号化の使用方法について詳しく説明しています:

エンドツーエンド暗号化の概要については、以下を参照してください。 本題.

暗号化シークレットの設定

エンドツーエンド暗号化されたセッションは、サーバーAPIを使用して作成されます(参照: REST APIを使用して暗号化を有効にする).

クライアントがパブリッシュまたはサブスクライブする前に Session.setEncryptionSecret() メソッドを使用する:

var error: OTError?
session.setEncryptionSecret("encryption-secret", error: &error)
if (error)
{
    // Notify the user.
}

有効な秘密は8文字以上256文字以下の文字列である。シークレットを変更するには Session.setEncryptionSecret() メソッドをもう一度。

無効なシークレットを設定すると InvalidEncryptionSecret エラー。

イベントとエラー

イベントとエラーは、ユーザー主導の暗号化の動作を管理するために不可欠である。エンドツーエンドの暗号化は、共有秘密モデルを使用します。セッション内の全員が、自分のメディアを暗号化し、他の全員のメディアを復号化するために、同じ秘密を使用することが期待されています。

クライアントがエンドツーエンドで暗号化されたセッションに接続しようとし、接続前に暗号化シークレットを設定しなかった場合、次のコードが設定されたエラーが発生する。 EncryptionSecretMissing:

var error: OTError?
session.connect(withToken: token, error: &error)
if (error && (error.code ==EncryptionSecretMissing))
{
    // Notify the user of the error connecting.
}

暗号化シークレットを指定せずにエンドツーエンドで暗号化されたセッションを公開しようとした場合、次のように呼び出す。 [OTSession publish:error:] メソッドの結果は、エラーコードが EncryptionSecretMissing.最高のユーザーエクスペリエンスのために、アプリケーションは公開前にユーザーが提供した秘密を検証すべきである:

var error: OTError?
session.publish(publisher, error: &error)
if (error && (error.code == EncryptionSecretMissing))
{
    // The application should communicate that the secret was not set.
}

不正確な暗号化シークレットのために、加入者がストリームのメディアをデコードできない場合は [OTSubscriberKitDelegate subscriber:didFailWithError:] メッセージが送信される。 ErrorCode.EncryptionSecretMismatch.メディアを受信できないのは、暗号化の不一致によるものであり、接続障害やオーディオ/ビデオの問題ではないことをユーザーに伝えることが重要です:

// Implementation of [OTSubscriberKitDelegate subscriber:didFailWithError:]:
func subscriber(_ subscriber: OTSubscriberKit, didFailWithError error: OTError) {
	if (error.code == EncryptionSecretMismatch) {
    // Activate a UI element communicating that there's been an encryption secret mismatch.
	}
}

var error: OTError?
session.subscribe(subscriber!, error: &error)
// ...

サブスクライバーがパケットを復号化する際に内部エラーが発生した場合 [OTSubscriberKitDelegate subscriber:didFailWithError:] メッセージが送信される。 OTSubscriberDecryptionInternalError.

エンドツーエンド暗号化なしのセッションでシークレットを設定する

注: この機能は、SDK バージョン 2.36.0 以降で利用可能です。

エンドツーエンド暗号化が有効な状態でセッションが作成されていない場合、そのセッションに暗号化シークレットを設定しようとすると、「暗号化が有効になっていません」というエラーが発生します。このエラーが発生するタイミングは、接続、パブリッシュ、サブスクライブの各操作に対するシークレットの設定のタイミングによって異なります。

接続前にシークレットを設定する

セッションでエンドツーエンド暗号化が有効になっているかどうかは、クライアントが接続して初めて判明します。もし OTSession.setEncryptionSecret(_:error:) 接続前は、呼び出しは成功し、セッションは正常に接続されます。このエラーは、クライアントがパブリッシュまたはサブスクライブを行う際に報告されます:呼び出し OTSession.publish(_:error:) その結果、コードが次のように設定された状態でエラーが発生します。 OTPublisherErrorCode.encryptionNotEnabled、および呼び出し OTSession.subscribe(_:error:) その結果、コードが次のように設定された状態でエラーが発生します。 OTSubscriberErrorCode.encryptionNotEnabled:

var error: OTError?
session.publish(publisher, error: &error)
if let error = error, error.code == Int(OTPublisherErrorCode.encryptionNotEnabled.rawValue) {
    // The application should communicate that end-to-end encryption
    // is not enabled for this session.
}

接続後にシークレットを設定する

もし電話をかけるなら OTSession.setEncryptionSecret(_:error:) クライアントがエンドツーエンド暗号化のないセッションに接続した後、シークレットは設定されず、このメソッドはコードがに設定されたエラーを返します。 OTSessionErrorCode.encryptionNotEnabled:

var error: OTError?
session.setEncryptionSecret("encryption-secret", error: &error)
if let error = error, error.code == Int(OTSessionErrorCode.encryptionNotEnabled.rawValue) {
    // The application should communicate that end-to-end encryption
    // is not enabled for this session.
}

公開または購読時のシークレットの設定

もし電話をかけるなら OTSession.setEncryptionSecret(_:error:) クライアントがすでにパブリッシュまたはサブスクライブを行っている場合、前述のように呼び出しは失敗し、アクティブなすべてのパブリッシャーとサブスクライバーもセッションから削除されます。その OTPublisherKitDelegate.publisher(_:didFailWithError:) このメソッドは、コードが次のように設定されているエラーを持つ各パブリッシャーに対して呼び出されます。 OTPublisherErrorCode.encryptionNotEnabledそして OTSubscriberKitDelegate.subscriber(_:didFailWithError:) このメソッドは、コードが OTSubscriberErrorCode.encryptionNotEnabled.

エラーからの復旧

これらのエラーが発生しても、セッションは有効なままです。再度パブリッシュまたはサブスクライブするには、以下を呼び出してシークレットをクリアしてください。 OTSession.setEncryptionSecret(_:error:) と nil. その後、同じ OTPublisherKit オブジェクトを OTSession.publish(_:error:) 再び

var error: OTError?
session.setEncryptionSecret(nil, error: &error)
session.publish(publisher, error: &error)