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 Android:

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 Session.setEncryptionSecret() método:

session.setEncryptionSecret("encryption-secret");
session.connect(TOKEN);

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() funcionar 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 um cliente tentar se conectar a uma sessão criptografada de ponta a ponta sem definir um segredo de criptografia, o SessionListener.onError() o manipulador de eventos é chamado com um código de erro definido como 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);

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 Session.publish() O método resulta no PublisherListener.onError() o manipulador de eventos está sendo chamado com um erro cujo código está definido como ErrorCode.EncryptionSecretMissing. Para garantir a melhor experiência do usuário, o aplicativo deve validar um segredo fornecido pelo usuário antes de chamar o Session.publish() método:

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

Se um assinante não conseguir decodificar o conteúdo de mídia de um stream devido a uma chave de criptografia incorreta, o SubscriberListener.onError() o manipulador de eventos é chamado 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 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);

Se o aplicativo tentar se inscrever sem definir um segredo de criptografia, o Subscriber.onError() o manipulador de eventos é chamado com um erro cujo código está definido como ErrorCode.EncryptionSecretMissing.

Se um assinante encontrar um erro interno ao descriptografar um pacote, o Subscriber.onError() o manipulador de eventos é chamado com um erro cujo código está definido como ErrorCode.DecryptionInternalError.

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 resulta em um ErrorCode.EncryptionNotEnabled erro. 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 Session.setEncryptionSecret() 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 Session.publish() ou Session.subscribe() resulta no SessionListener.onError() o manipulador de eventos está sendo chamado com um erro cujo código está definido como 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);

Definir a senha após a conexão

Se você ligar Session.setEncryptionSecret() depois que o cliente se conecta a uma sessão sem criptografia de ponta a ponta, o segredo não é definido e o SessionListener.onError() o manipulador de eventos é chamado com um erro cujo código está definido como ErrorCode.EncryptionNotEnabled.

Definir o segredo ao publicar ou assinar

Se você ligar Session.setEncryptionSecret() 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. Cada um deles relata o erro por meio de seu próprio onError() manipulador de eventos — PublisherListener.onError() para editoras e SubscriberListener.onError() para assinantes — com o código definido como 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.
  }
}

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 Session.setEncryptionSecret() com null. O mesmo objeto PublisherKit pode então ser passado para Session.publish() novamente:

session.setEncryptionSecret(null);
session.publish(publisher);