Criptografia de ponta a ponta

Este tópico inclui detalhes sobre como usar a criptografia de ponta a ponta no Client SDK do cliente Vonage Video para iOS:

Para obter uma visão geral da criptografia de ponta a ponta, consulte esse assunto.

Configurando o segredo de criptografia

As sessões com criptografia de ponta a ponta são criadas por meio de APIs do servidor (consulte Ativando a criptografia por meio da API REST).

Antes que o cliente publique ou se inscreva, chame o [OTSession setEncryptionSecret:error:] método:

OTError *error = nil;
[_session setEncryptionSecret:@"encryption-secret" error:&error];
if (error)
{
    // Notify the user.
}

Um segredo válido é uma sequência de caracteres com comprimento entre 8 e 256 caracteres. Você pode alterar o segredo chamando a função Session.setEncryptionSecret() método novamente.

Definir um segredo inválido resultará em um InvalidEncryptionSecret erro.

Eventos e erros

Eventos e erros são essenciais para gerenciar o comportamento da criptografia orientada pelo usuário. A criptografia de ponta a ponta utiliza o modelo de segredo compartilhado: espera-se que todos os participantes da sessão utilizem o mesmo segredo para criptografar seus dados e descriptografar os dados dos demais participantes.

Se o cliente tentar se conectar a uma sessão criptografada de ponta a ponta e não definir o segredo de criptografia antes da conexão, ocorrerá um erro com o código definido como EncryptionSecretMissing:

OTError *error = nil;
[_session connectWithToken:kToken error:&error];
if (error && (error.code == EncryptionSecretMissing))
{
    // Notify the user of the error connecting.
}

Se um usuário tentar publicar em uma sessão criptografada de ponta a ponta sem ter especificado um segredo de criptografia, ao chamar a função [OTSession publish:error:] O método gera um erro cujo código está definido como OTPublisherEncryptionSecretMissing. Para garantir a melhor experiência do usuário, o aplicativo deve validar um segredo fornecido pelo usuário antes da publicação:

OTError *error = nil;
[_session publish:_publisher error:&error];
if (error && (error.code == OTPublisherEncryptionSecretMissing))
{
    // The application should communicate that the secret was not set.
}

Se um assinante não conseguir decodificar o conteúdo de mídia de um stream devido a uma chave de criptografia incorreta, o [OTSubscriberKitDelegate subscriber:didFailWithError:] a mensagem é enviada com um erro cujo código está definido como ErrorCode.EncryptionSecretMismatch. É importante informar ao usuário que a mídia não está sendo recebida devido a uma incompatibilidade de criptografia e não por causa de uma falha na conexão ou de um problema de áudio/vídeo:

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

[_session subscribe:_subscriber error:&error];
// ...

Se um assinante encontrar um erro interno ao descriptografar um pacote, o [OTSubscriberKitDelegate subscriber:didFailWithError:] a mensagem é enviada com um erro cujo código está definido como OTSubscriberDecryptionInternalError.

Definir um segredo em uma sessão sem criptografia de ponta a ponta

Observação: Esse recurso está disponível a partir da versão 2.36.0 do SDK.

Se uma sessão não tiver sido criada com a criptografia de ponta a ponta ativada, definir um segredo de criptografia para ela resultará em um erro do tipo “criptografia não ativada”. O momento em que o erro ocorre depende de quando o segredo é definido em relação à conexão, à publicação e à assinatura.

Definir a senha antes de se conectar

Só é possível saber se uma sessão tem a criptografia de ponta a ponta ativada depois que o cliente se conecta. Se você chamar [OTSession setEncryptionSecret:error:] antes da conexão, a chamada é bem-sucedida e a sessão é estabelecida normalmente. O erro é relatado quando o cliente publica ou se inscreve: ao chamar [OTSession publish:error:] resulta em um erro com o código definido como OTPublisherEncryptionNotEnabled, e ligando para [OTSession subscribe:error:] resulta em um erro com o código definido como OTSubscriberEncryptionNotEnabled:

OTError *error = nil;
[_session publish:_publisher error:&error];
if (error && (error.code == OTPublisherEncryptionNotEnabled))
{
    // The application should communicate that end-to-end encryption
    // is not enabled for this session.
}

Definir a senha após a conexão

Se você ligar [OTSession setEncryptionSecret:error:] depois que o cliente se conecta a uma sessão sem criptografia de ponta a ponta, o segredo não é definido e o método retorna um erro com o código definido como OTSessionEncryptionNotEnabled:

OTError *error = nil;
[_session setEncryptionSecret:@"encryption-secret" error:&error];
if (error && (error.code == OTSessionEncryptionNotEnabled))
{
    // The application should communicate that end-to-end encryption
    // is not enabled for this session.
}

Definir o segredo ao publicar ou assinar

Se você ligar [OTSession setEncryptionSecret:error:] enquanto o cliente já estiver publicando ou assinando, a chamada falha conforme descrito acima, e todos os publicadores e assinantes ativos também são removidos da sessão. O [OTPublisherKitDelegate publisher:didFailWithError:] é enviada uma mensagem a cada editor com um erro cujo código está definido como OTPublisherEncryptionNotEnabled, e o [OTSubscriberKitDelegate subscriber:didFailWithError:] é enviada uma mensagem a cada assinante com um erro cujo código está definido como OTSubscriberEncryptionNotEnabled.

Recuperação após o erro

A sessão permanece válida após qualquer um desses erros. Para publicar ou assinar novamente, limpe o segredo chamando [OTSession setEncryptionSecret:error:] com nil. O mesmo objeto OTPublisherKit pode então ser passado para [OTSession publish:error:] novamente:

OTError *error = nil;
[_session setEncryptionSecret:nil error:&error];
[_session publish:_publisher error:&error];