Cifrado de extremo a extremo
Este tema incluye información detallada sobre el uso del cifrado de extremo a extremo en el Client SDK de Vonage Video para Windows:
- Configuración del secreto de cifrado
- Sucesos y errores
- Establecer una clave secreta en una sesión sin cifrado de extremo a extremo
Para obtener una visión general del cifrado de extremo a extremo, consulta este tema.
Configuración del secreto de cifrado
Las sesiones cifradas de extremo a extremo se crean mediante las API del servidor (véase Activación del cifrado mediante la API REST).
Antes de que el cliente publique o se suscriba, llame a la función Session.SetEncryptionSecret() método:
Session.SetEncryptionSecret("encryption-secret");
Session.Connect(TOKEN);
Una clave válida es una cadena de entre 8 y 256 caracteres. Puedes cambiar la clave llamando a la función Session.SetEncryptionSecret() el método de nuevo.
Sucesos y errores
Los eventos y errores son esenciales para gestionar el comportamiento del cifrado dirigido por el usuario. El cifrado de extremo a extremo utiliza el modelo de secreto compartido: se espera que todos los participantes en la sesión utilicen el mismo secreto para cifrar sus medios y descifrar los de los demás.
Si un cliente intenta conectarse a una sesión cifrada de extremo a extremo sin haber configurado un secreto de cifrado, el Session.Error El evento se envía con un código de error establecido en ErrorCode.EncryptionSecretMissing:
private void Session_Error(object sender, ErrorEventArgs error)
{
if (Error.ErrorCode == ErrorCode.EncryptionSecretMissing) {
// Notify the user that they cannot join the session
}
}
Session.Error += Session_Error;
Session.Connect(TOKEN);
Si un usuario intenta publicar en una sesión cifrada de extremo a extremo sin haber especificado un secreto de cifrado, al llamar a la función Session.Publish() da como resultado la función Publisher.Error el evento se envía con un error cuyo código está establecido en ErrorCode.EncryptionInternalError. Para garantizar la mejor experiencia de usuario, la aplicación debería validar una clave secreta facilitada por el usuario antes de llamar a la Session.Publish() método:
private void Publisher_Error(object sender, ErrorEventArgs error)
{
if (Error.ErrorCode == ErrorCode.EncryptionInternalError) {
// The application should communicate that the secret was not set.
}
}
Publisher.Error += Publisher_Error;
Session.Publish(Publisher);
Si un suscriptor no puede descodificar el contenido multimedia de una transmisión debido a una clave de cifrado incorrecta, el Subscriber.Error con un error cuyo código es ErrorCode.EncryptionSecretMismatch. Es importante comunicar al usuario que los medios no se están recibiendo debido a un desajuste de cifrado y no a un fallo de conexión o a un problema de audio/vídeo:
private void Subscriber_Error(object sender, ErrorEventArgs error)
{
if (Error.ErrorCode == ErrorCode.EncryptionSecretMismatch) {
// Activate a UI element communicating that there's been an encryption secret mismatch.
}
}
Subscriber.Error += Subscriber_Error;
Session.Subscribe(Subscriber);
Si un abonado encuentra un error interno al descifrar un paquete, el Subscriber.Error con un error cuyo código es ErrorCode.DecryptionInternalError.
Establecer una clave secreta en una sesión sin cifrado de extremo a extremo
Nota: Esta función está disponible a partir de la versión 2.36.0 del SDK.
Si una sesión no se ha creado con el cifrado de extremo a extremo activado, al establecer un secreto de cifrado para ella se produce un ErrorCode.EncryptionNotEnabled error. El momento en que se produce el error depende de cuándo se establece el secreto en relación con la conexión, la publicación y la suscripción.
Configuración de la clave secreta antes de conectarse
Solo se sabe si una sesión tiene activado el cifrado de extremo a extremo una vez que el cliente se conecta. Si llamas a Session.SetEncryptionSecret() Antes de establecer la conexión, la llamada se realiza con éxito y la sesión se establece con normalidad. El error se produce cuando el cliente publica o se suscribe: al llamar a Session.Publish() o Session.Subscribe() provoca un OpenTokException con el ErrorCode ajustado a ErrorCode.EncryptionNotEnabled:
try
{
Session.Publish(Publisher);
}
catch (OpenTokException ex) when (ex.ErrorCode == ErrorCode.EncryptionNotEnabled)
{
// The application should communicate that end-to-end encryption
// is not enabled for this session.
}
Configuración de la clave secreta tras la conexión
Si llamas Session.SetEncryptionSecret() Una vez que el cliente se ha conectado a una sesión sin cifrado de extremo a extremo, el secreto no se establece y el método lanza un OpenTokException con el ErrorCode ajustado a ErrorCode.EncryptionNotEnabled:
try
{
Session.SetEncryptionSecret("encryption-secret");
}
catch (OpenTokException ex) when (ex.ErrorCode == ErrorCode.EncryptionNotEnabled)
{
// The application should communicate that end-to-end encryption
// is not enabled for this session.
}
Configuración de la clave secreta al publicar o suscribirse
Si llamas Session.SetEncryptionSecret() Mientras el cliente ya esté publicando o suscrito, la llamada falla tal y como se ha descrito anteriormente, y todos los editores y suscriptores activos también se eliminan de la sesión. El Publisher.Error Se envía un evento por cada editor, y el Subscriber.Error Se envía un evento por cada suscriptor, con un error cuyo código está establecido en ErrorCode.EncryptionNotEnabled.
Recuperación tras el error
La sesión sigue siendo válida tras cualquiera de estos errores. Para volver a publicar o suscribirte, borra el secreto llamando a Session.SetEncryptionSecret() con null. A continuación, ese mismo objeto Publisher se puede pasar a Session.Publish() otra vez:
Session.SetEncryptionSecret(null);
Session.Publish(Publisher);