Cifrado de extremo a extremo

Este tema incluye información detallada sobre el uso del cifrado de extremo a extremo en el Client SDK Swift de Vonage Video para iOS:

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:

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

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.

Si se establece un secreto no válido, se producirá un InvalidEncryptionSecret error.

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 el cliente intenta conectarse a una sesión cifrada de extremo a extremo y no configura el secreto de cifrado antes de conectarse, se producirá un error con el código establecido en EncryptionSecretMissing:

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

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 [OTSession publish:error:] El método genera un error cuyo código está establecido en EncryptionSecretMissing. Para obtener la mejor experiencia de usuario, la aplicación debe validar un secreto proporcionado por el usuario antes de publicarlo:

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

Si un suscriptor no puede descodificar el contenido multimedia de una transmisión debido a una clave de cifrado incorrecta, el [OTSubscriberKitDelegate subscriber:didFailWithError:] 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:

// 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)
// ...

Si un abonado encuentra un error interno al descifrar un paquete, el [OTSubscriberKitDelegate subscriber:didFailWithError:] con un error cuyo código es OTSubscriberDecryptionInternalError.

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 error que indica que «el cifrado no está activado». El momento en que aparece el error depende de cuándo se establezca 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 OTSession.setEncryptionSecret(_:error:) 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 OTSession.publish(_:error:) da lugar a un error con el código establecido en OTPublisherErrorCode.encryptionNotEnabled, y llamando a OTSession.subscribe(_:error:) da lugar a un error con el código establecido en 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.
}

Configuración de la clave secreta tras la conexión

Si llamas OTSession.setEncryptionSecret(_:error:) 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 devuelve un error con el código fijado en 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.
}

Configuración de la clave secreta al publicar o suscribirse

Si llamas OTSession.setEncryptionSecret(_:error:) 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 OTPublisherKitDelegate.publisher(_:didFailWithError:) El método se invoca para cada editor con un error cuyo código esté establecido en OTPublisherErrorCode.encryptionNotEnabled, y el OTSubscriberKitDelegate.subscriber(_:didFailWithError:) El método se invoca para cada suscriptor con un error cuyo código esté establecido en OTSubscriberErrorCode.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 OTSession.setEncryptionSecret(_:error:) con nil. A continuación, ese mismo objeto OTPublisherKit se puede pasar a OTSession.publish(_:error:) otra vez:

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