PapaTutuWawa/omemo_dart
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: Improve documentation

Browse Source
This commit is contained in:
PapaTutuWawa 2022-08-03 16:50:27 +02:00
parent 45d0c57305
commit f897431692
1 changed files with 62 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

116
lib/src/double_ratchet.dart
View File

@ -72,7 +72,9 @@ class OmemoDoubleRatchet {
final Map<SkippedKey, List<int>> mkSkipped = {}; final Map<SkippedKey, List<int>> mkSkipped = {};
/// This is performed by the initiating entity /// Create an OMEMO session using the Signed Pre Key [spk], the shared secret [sk] that
/// was obtained using a X3DH and the associated data [ad] that was also obtained through
/// a X3DH.
static Future<OmemoDoubleRatchet> initiateNewSession(OmemoPublicKey spk, List<int> sk, List<int> ad) async { static Future<OmemoDoubleRatchet> initiateNewSession(OmemoPublicKey spk, List<int> sk, List<int> ad) async {
final dhs = await OmemoKeyPair.generateNewPair(KeyPairType.x25519); final dhs = await OmemoKeyPair.generateNewPair(KeyPairType.x25519);
final dhr = spk; final dhr = spk;
@ -92,11 +94,12 @@ class OmemoDoubleRatchet {
); );
} }
/// This is performed by the accepting entity /// Create an OMEMO session that was not initiated by the caller using the used Signed
/// Pre Key keypair [spk], the shared secret [sk] that was obtained through a X3DH and
/// the associated data [ad] that was also obtained through a X3DH.
static Future<OmemoDoubleRatchet> acceptNewSession(OmemoKeyPair spk, List<int> sk, List<int> ad) async { static Future<OmemoDoubleRatchet> acceptNewSession(OmemoKeyPair spk, List<int> sk, List<int> ad) async {
final dhs = spk;
return OmemoDoubleRatchet( return OmemoDoubleRatchet(
dhs, spk,
null, null,
sk, sk,
null, null,
@ -108,6 +111,53 @@ class OmemoDoubleRatchet {
); );
} }
Future<List<int>?> _trySkippedMessageKeys(OMEMOMessage header, List<int> ciphertext) async {
final key = SkippedKey(
OmemoPublicKey.fromBytes(header.dhPub, KeyPairType.x25519),
header.n,
);
if (mkSkipped.containsKey(key)) {
final mk = mkSkipped[key]!;
mkSkipped.remove(key);
return decrypt(mk, ciphertext, concat([sessionAd, header.writeToBuffer()]), sessionAd);
}
return null;
}
Future<void> _skipMessageKeys(int until) async {
if (nr + maxSkip < until) {
throw SkippingTooManyMessagesException();
}
if (ckr != null) {
while (nr < until) {
final newCkr = await kdfCk(ckr!, kdfCkNextChainKey);
final mk = await kdfCk(ckr!, kdfCkNextMessageKey);
ckr = newCkr;
mkSkipped[SkippedKey(dhr!, nr)] = mk;
nr++;
}
}
}
Future<void> _dhRatchet(OMEMOMessage header) async {
pn = header.n;
ns = 0;
nr = 0;
dhr = OmemoPublicKey.fromBytes(header.dhPub, KeyPairType.x25519);
final newRk = await kdfRk(rk, await dh(dhs, dhr!, 0));
rk = newRk;
ckr = newRk;
dhs = await OmemoKeyPair.generateNewPair(KeyPairType.x25519);
final newNewRk = await kdfRk(rk, await dh(dhs, dhr!, 0));
rk = newNewRk;
cks = newNewRk;
}
/// Encrypt [plaintext] using the Double Ratchet.
Future<RatchetStep> ratchetEncrypt(List<int> plaintext) async { Future<RatchetStep> ratchetEncrypt(List<int> plaintext) async {
final newCks = await kdfCk(cks!, kdfCkNextChainKey); final newCks = await kdfCk(cks!, kdfCkNextChainKey);
final mk = await kdfCk(cks!, kdfCkNextMessageKey); final mk = await kdfCk(cks!, kdfCkNextMessageKey);
@ -126,65 +176,23 @@ class OmemoDoubleRatchet {
); );
} }
Future<List<int>?> trySkippedMessageKeys(OMEMOMessage header, List<int> ciphertext) async { /// Decrypt a [ciphertext] that was sent with the header [header] using the Double
final key = SkippedKey( /// Ratchet. Returns the decrypted (raw) plaintext.
OmemoPublicKey.fromBytes(header.dhPub, KeyPairType.x25519), ///
header.n, /// Throws an SkippingTooManyMessagesException if too many messages were to be skipped.
);
if (mkSkipped.containsKey(key)) {
final mk = mkSkipped[key]!;
mkSkipped.remove(key);
return decrypt(mk, ciphertext, concat([sessionAd, header.writeToBuffer()]), sessionAd);
}
return null;
}
Future<void> skipMessageKeys(int until) async {
if (nr + maxSkip < until) {
throw SkippingTooManyMessagesException();
}
if (ckr != null) {
while (nr < until) {
final newCkr = await kdfCk(ckr!, kdfCkNextChainKey);
final mk = await kdfCk(ckr!, kdfCkNextMessageKey);
ckr = newCkr;
mkSkipped[SkippedKey(dhr!, nr)] = mk;
nr++;
}
}
}
Future<void> dhRatchet(OMEMOMessage header) async {
pn = header.n;
ns = 0;
nr = 0;
dhr = OmemoPublicKey.fromBytes(header.dhPub, KeyPairType.x25519);
final newRk = await kdfRk(rk, await dh(dhs, dhr!, 0));
rk = newRk;
ckr = newRk;
dhs = await OmemoKeyPair.generateNewPair(KeyPairType.x25519);
final newNewRk = await kdfRk(rk, await dh(dhs, dhr!, 0));
rk = newNewRk;
cks = newNewRk;
}
Future<List<int>> ratchetDecrypt(OMEMOMessage header, List<int> ciphertext) async { Future<List<int>> ratchetDecrypt(OMEMOMessage header, List<int> ciphertext) async {
// Check if we skipped too many messages // Check if we skipped too many messages
final plaintext = await trySkippedMessageKeys(header, ciphertext); final plaintext = await _trySkippedMessageKeys(header, ciphertext);
if (plaintext != null) { if (plaintext != null) {
return plaintext; return plaintext;
} }
if (header.dhPub != await dhr?.getBytes()) { if (header.dhPub != await dhr?.getBytes()) {
await skipMessageKeys(header.pn); await _skipMessageKeys(header.pn);
await dhRatchet(header); await _dhRatchet(header);
} }
await skipMessageKeys(header.n); await _skipMessageKeys(header.n);
final newCkr = await kdfCk(ckr!, kdfCkNextChainKey); final newCkr = await kdfCk(ckr!, kdfCkNextChainKey);
final mk = await kdfCk(ckr!, kdfCkNextMessageKey); final mk = await kdfCk(ckr!, kdfCkNextMessageKey);
ckr = newCkr; ckr = newCkr;