Setting the encryption secret
Les sessions cryptées de bout en bout sont créées à l'aide des API du serveur (voir Activation du cryptage à l'aide de l'option API REST).
Avant que le client ne publie ou ne s'abonne, appelez la fonction Session.SetEncryptionSecret() méthode :
Session.SetEncryptionSecret("encryption-secret");
Session.Connect(TOKEN);
Un secret valide est une chaîne de 8 à 256 caractères. Vous pouvez modifier le secret en appelant la fonction Session.SetEncryptionSecret() à nouveau.
Events and errors
Les événements et les erreurs sont essentiels pour gérer le comportement du chiffrement piloté par l'utilisateur. Le chiffrement de bout en bout utilise le modèle du secret partagé : tous les participants à la session sont censés utiliser le même secret pour chiffrer leurs données et déchiffrer celles des autres.
Si un client tente de se connecter à une session cryptée de bout en bout sans définir de secret de cryptage, l'événement Session.Error est envoyé avec un code d'erreur égal à 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 utilisateur tente de publier dans une session chiffrée de bout en bout sans avoir spécifié de secret de chiffrement, l'appel de la fonction Session.Publish() se traduit par l'utilisation de la fonction Publisher.Error est envoyé avec une erreur dont le code est défini comme suit ErrorCode.EncryptionInternalError. Pour une meilleure expérience utilisateur, l'application doit valider un secret fourni par l'utilisateur avant d'appeler la fonction Session.Publish() méthode :
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 abonné n'est pas en mesure de décoder les médias d'un flux en raison d'un secret de cryptage erroné, la fonction Subscriber.Error est envoyé avec une erreur dont le code est fixé à ErrorCode.EncryptionSecretMismatch. Il est important d'indiquer à l'utilisateur que le média n'est pas reçu en raison d'une erreur de cryptage et non d'une défaillance de la connexion ou d'un problème audio/vidéo :
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 abonné rencontre une erreur interne lors du décryptage d'un paquet, la fonction Subscriber.Error est envoyé avec une erreur dont le code est fixé à ErrorCode.DecryptionInternalError.
Setting a secret in a session without end-to-end encryption
Remarque : Cette fonctionnalité est disponible à partir de la version 2.36.0 du SDK.
Si une session n'a pas été créée avec le chiffrement de bout en bout activé, la définition d'un secret de chiffrement pour celle-ci entraîne une ErrorCode.EncryptionNotEnabled erreur. L'endroit où l'erreur se produit dépend du moment où le secret est défini par rapport à la connexion, à la publication et à l'abonnement.
Setting the secret before connecting
On ne sait si le chiffrement de bout en bout est activé pour une session qu'une fois que le client s'est connecté. Si vous appelez Session.SetEncryptionSecret() Avant l'établissement de la connexion, l'appel aboutit et la session s'établit normalement. L'erreur est signalée lorsque le client publie ou s'abonne : l'appel Session.Publish() ou Session.Subscribe() provoque une OpenTokException avec le ErrorCode fixé à 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.
}
Setting the secret after connecting
Si vous appelez Session.SetEncryptionSecret() Une fois que le client s'est connecté à une session sans chiffrement de bout en bout, le secret n'est pas défini et la méthode génère une exception OpenTokException avec le ErrorCode fixé à 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.
}
Setting the secret while publishing or subscribing
Si vous appelez Session.SetEncryptionSecret() lorsque le client est déjà en train de publier ou de s'abonner, l'appel échoue comme décrit ci-dessus, et tous les éditeurs et abonnés actifs sont également supprimés de la session. Le Publisher.Error Un événement est envoyé pour chaque éditeur, et le Subscriber.Error Un événement est envoyé pour chaque abonné, accompagné d'une erreur dont le code est défini sur ErrorCode.EncryptionNotEnabled.
Recovering from the error
La session reste valide après l'une de ces erreurs. Pour publier ou vous abonner à nouveau, effacez le secret en appelant Session.SetEncryptionSecret() avec null. Le même objet Publisher peut ensuite être transmis à Session.Publish() encore une fois :
Session.SetEncryptionSecret(null);
Session.Publish(Publisher);