timoreo/olm
1
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Merge branch 'rav/group_chat_js_bindings'

Browse source
This commit is contained in:
Richard van der Hoff 2016-05-26 13:58:14 +01:00
commit 952a3e15cf
8 changed files with 697 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

11
Makefile
View file

@ -15,7 +15,7 @@ JS_TARGET := javascript/olm.js
JS_EXPORTED_FUNCTIONS := javascript/exported_functions.json JS_EXPORTED_FUNCTIONS := javascript/exported_functions.json
PUBLIC_HEADERS := include/olm/olm.h PUBLIC_HEADERS := include/olm/olm.h include/olm/outbound_group_session.h include/olm/inbound_group_session.h
SOURCES := $(wildcard src/*.cpp) $(wildcard src/*.c) \ SOURCES := $(wildcard src/*.cpp) $(wildcard src/*.c) \
lib/crypto-algorithms/sha256.c \ lib/crypto-algorithms/sha256.c \
@ -34,7 +34,9 @@ FUZZER_DEBUG_BINARIES := $(patsubst $(BUILD_DIR)/fuzzers/fuzz_%,$(BUILD_DIR)/fuz
TEST_BINARIES := $(patsubst tests/%,$(BUILD_DIR)/tests/%,$(basename $(TEST_SOURCES))) TEST_BINARIES := $(patsubst tests/%,$(BUILD_DIR)/tests/%,$(basename $(TEST_SOURCES)))
JS_OBJECTS := $(addprefix $(BUILD_DIR)/javascript/,$(OBJECTS)) JS_OBJECTS := $(addprefix $(BUILD_DIR)/javascript/,$(OBJECTS))
JS_PRE := $(wildcard javascript/*pre.js) JS_PRE := $(wildcard javascript/*pre.js)
JS_POST := $(wildcard javascript/*post.js) JS_POST := javascript/olm_outbound_group_session.js \
javascript/olm_inbound_group_session.js \
javascript/olm_post.js
CPPFLAGS += -Iinclude -Ilib CPPFLAGS += -Iinclude -Ilib
# we rely on <stdint.h>, which was introduced in C99 # we rely on <stdint.h>, which was introduced in C99
@ -106,7 +108,8 @@ js: $(JS_TARGET)
$(JS_TARGET): $(JS_OBJECTS) $(JS_PRE) $(JS_POST) $(JS_EXPORTED_FUNCTIONS) $(JS_TARGET): $(JS_OBJECTS) $(JS_PRE) $(JS_POST) $(JS_EXPORTED_FUNCTIONS)
$(EMCC_LINK) \ $(EMCC_LINK) \
--pre-js $(JS_PRE) --post-js $(JS_POST) \ $(foreach f,$(JS_PRE),--pre-js $(f)) \
$(foreach f,$(JS_POST),--post-js $(f)) \
-s "EXPORTED_FUNCTIONS=@$(JS_EXPORTED_FUNCTIONS)" \ -s "EXPORTED_FUNCTIONS=@$(JS_EXPORTED_FUNCTIONS)" \
$(JS_OBJECTS) -o $@ $(JS_OBJECTS) -o $@
@ -122,7 +125,7 @@ fuzzers: $(FUZZER_BINARIES) $(FUZZER_DEBUG_BINARIES)
.PHONY: fuzzers .PHONY: fuzzers
$(JS_EXPORTED_FUNCTIONS): $(PUBLIC_HEADERS) $(JS_EXPORTED_FUNCTIONS): $(PUBLIC_HEADERS)
perl -MJSON -ne '/(olm_[^( ]*)\(/ && push @f, "_$$1"; END { print encode_json \@f }' $^ > $@.tmp perl -MJSON -ne '$$f{"_$$1"}=1 if /(olm_[^( ]*)\(/; END { @f=sort keys %f; print encode_json \@f }' $^ > $@.tmp
mv $@.tmp $@ mv $@.tmp $@
all: test js lib debug all: test js lib debug

17
javascript/README.md
View file

@ -23,3 +23,20 @@ Example:
bob_session.create_inbound(bob, bob_message); bob_session.create_inbound(bob, bob_message);
var plaintext = bob_session.decrypt(message_1.type, bob_message); var plaintext = bob_session.decrypt(message_1.type, bob_message);
bob.remove_one_time_keys(bob_session); bob.remove_one_time_keys(bob_session);
Group chat:
var outbound_session = new Olm.OutboundGroupSession();
outbound_session.create();
// exchange these over a secure channel
var session_id = group_session.session_id();
var session_key = group_session.session_key();
var message_index = group_session.message_index();
var inbound_session = new Olm.InboundGroupSession();
inbound_session.create(message_index, session_key);
var ciphertext = outbound_session.encrypt("Hello");
var plaintext = inbound_session.decrypt(ciphertext);

8
javascript/demo/demo.css Normal file
View file

@ -0,0 +1,8 @@
div.user {
width: 500px;
float: left;
overflow: scroll;
margin: 0px 20px 0px 0px;
border: 1px solid black;
padding: 5px;
}

61
javascript/demo/group_demo.html Normal file
View file

@ -0,0 +1,61 @@
<html>
<head>
<link rel="stylesheet" type="text/css" href="demo.css"/>
<script src="../olm.js"></script>
<script src="group_demo.js"></script>
</head>
<body>
<div id="user1" class="user">
<h1>User1</h1>
<textarea class="user_plain_input"></textarea>
<button class="user_encrypt">Encrypt</button>
<h2>Outgoing</h2>
<h3>One-to-one output</h3>
<div class="user_cipher_output"></div>
<h3>Group output</h3>
<div class="group_output"></div>
<h2>Incoming</h2>
<h3>One-to-one Received</h3>
<div class="user_cipher_input"></div>
<h3>Group received</h3>
<div class="group_input"></div>
<h2>Tasks</h2>
<div class="user_progress"></div>
</div>
<div id="user2" class="user">
<h1>User 2</h1>
<textarea class="user_plain_input"></textarea>
<button class="user_encrypt">Encrypt</button>
<h2>Outgoing</h2>
<h3>One-to-one output</h3>
<div class="user_cipher_output"></div>
<h3>Group output</h3>
<div class="group_output"></div>
<h2>Incoming</h2>
<h3>One-to-one Received</h3>
<div class="user_cipher_input"></div>
<h3>Group received</h3>
<div class="group_input"></div>
<h2>Tasks</h2>
<div class="user_progress"></div>
</div>
</body>
</html>

421
javascript/demo/group_demo.js Normal file
View file

@ -0,0 +1,421 @@
/* Javascript parts of the group demo. To use, load group_demo.html in your
* browser.
*/
function buttonAndTextElement(buttonLabel, textContent, clickHandler) {
var el = document.createElement("div");
var button = document.createElement("button");
el.appendChild(button);
button.appendChild(document.createTextNode(buttonLabel));
var message_element = document.createElement("tt");
el.appendChild(message_element);
var content = document.createTextNode(textContent);
message_element.appendChild(content);
el.addEventListener("click", clickHandler, false);
return el;
}
function DemoUser(name) {
this.name = name;
this.olmAccount = new Olm.Account();
this.olmAccount.create();
/* a list of the people in our chat */
this.peers = [];
/* for each peer, a one-to-one session - indexed by id key and created on
* demand */
this.peerSessions = {}
/* for each peer, info on their sender session - indexed by id key and
* session id */
this.peerGroupSessions = {};
/* our outbound group session */
this.groupSession = undefined;
/* a list of pending tasks */
this.tasks = [];
this.taskWorker = undefined;
}
DemoUser.prototype._progress = function(message) {
var progress = this.progressElement;
var message_element = document.createElement("pre");
var start_content = document.createTextNode(message + "...");
function start() {
message_element.appendChild(start_content);
progress.appendChild(message_element);
}
function done(res) {
var done_content = document.createTextNode(message + "..." + res);
message_element.replaceChild(done_content, start_content);
}
return {start:start, done:done};
};
DemoUser.prototype._do_tasks = function() {
var self = this;
var task = self.tasks.shift();
var desc = task[0];
var func = task[1];
var callback = task[2];
var p = self._progress(desc);
p.start();
function done() {
p.done("Done");
if (callback) {
try {
callback.apply(undefined, arguments)
} catch (e) {
console.error("Uncaught exception in callback", e.stack || e);
}
}
start_tasks();
}
// sleep 50ms before actually doing the task
self.taskWorker = window.setTimeout(function() {
try {
task[1](done);
} catch (e) {
console.error("Uncaught exception in task", e.stack || e);
p.done("Failed: "+e);
start_tasks();
}
}, 50);
function start_tasks() {
if (self.tasks.length == 0) {
self.taskWorker = undefined;
return;
}
self.taskWorker = window.setTimeout(self._do_tasks.bind(self), 50);
}
}
/**
* add a function "task" to this user's queue of things to do.
*
* task is called with a single argument 'done' which is a function to call
* once the task is complete.
*
* 'callback' is called once the task is complete, with any arguments that
* were passed to 'done'.
*/
DemoUser.prototype.addTask = function(description, task, callback) {
this.tasks.push([description, task, callback]);
if(!this.taskWorker) {
this._do_tasks();
}
};
DemoUser.prototype.addPeer = function(peer) {
this.peers.push(peer);
};
DemoUser.prototype.getIdKey = function() {
var keys = JSON.parse(this.olmAccount.identity_keys());
return keys.curve25519;
};
DemoUser.prototype.generateKeys = function(callback) {
var self = this;
this.addTask("generate one time key", function(done) {
self.olmAccount.generate_one_time_keys(1);
done();
}, callback);
};
DemoUser.prototype.getOneTimeKey = function() {
var self = this;
var keys = JSON.parse(self.olmAccount.one_time_keys())
.curve25519;
for (key_id in keys) {
if (keys.hasOwnProperty(key_id)) {
return keys[key_id];
}
}
throw new Error("No one-time-keys generated");
};
/* ************************************************************************
*
* one-to-one messaging
*/
/**
* retrieve, or initiate, a one-to-one session to a given peer
*/
DemoUser.prototype.getPeerSession = function(peer, callback) {
var self = this;
var peerId = peer.getIdKey();
if (this.peerSessions[peerId]) {
callback(this.peerSessions[peerId]);
return;
}
this.addTask("get peer keys", function(done) {
key = peer.getOneTimeKey();
done(key);
}, function(ot_key) {
self.addTask("create peer session", function(done) {
var session = new Olm.Session();
session.create_outbound(self.olmAccount, peerId, ot_key);
self.peerSessions[peerId] = session;
done(session);
}, callback);
});
};
/**
* encrypt a one-to-one message and prepare it for sending to a peer
*/
DemoUser.prototype.sendToPeer = function(peer, message, callback) {
var self = this;
this.getPeerSession(peer, function(session) {
self.addTask("encrypt one-to-one message", function(done) {
var encrypted = session.encrypt(message);
var packet = {
sender_key: self.getIdKey(),
ciphertext: encrypted,
};
var json = JSON.stringify(packet);
var el = buttonAndTextElement("send", json, function(ev) {
peer.receiveOneToOne(json);
});
self.cipherOutputDiv.appendChild(el);
done();
}, callback);
});
};
/**
* handler for receiving a one-to-one message
*/
DemoUser.prototype.receiveOneToOne = function(jsonpacket) {
var self = this;
var el = buttonAndTextElement("decrypt", jsonpacket, function(ev) {
var sender = JSON.parse(jsonpacket).sender_key;
self.decryptOneToOne(jsonpacket, function(result) {
var el2 = document.createElement("tt");
el.appendChild(el2);
var content = document.createTextNode(" -> "+result);
el2.appendChild(content);
var body = JSON.parse(result);
// create a new inbound session if we don't yet have one
if (!self.peerGroupSessions[sender] ||
!self.peerGroupSessions[sender][body.session_id]) {
self.createInboundSession(
sender, body.session_id, body.message_index, body.session_key
);
}
});
});
this.cipherInputDiv.appendChild(el);
};
/**
* add a task to decrypt a one-to-one message. Calls the callback with the
* decrypted plaintext
*/
DemoUser.prototype.decryptOneToOne = function(jsonpacket, callback) {
var self = this;
self.addTask("decrypt one-to-one message", function(done) {
var packet = JSON.parse(jsonpacket);
var peerId = packet.sender_key;
var session = self.peerSessions[peerId];
var plaintext;
if (session) {
plaintext = session.decrypt(packet.ciphertext.type, packet.ciphertext.body);
done(plaintext);
return;
}
if (packet.ciphertext.type != 0) {
throw new Error("Unknown one-to-one session");
}
session = new Olm.Session();
session.create_inbound(self.olmAccount, packet.ciphertext.body);
self.peerSessions[peerId] = session;
plaintext = session.decrypt(packet.ciphertext.type, packet.ciphertext.body);
done(plaintext);
}, callback)
};
/* ************************************************************************
*
* group messaging
*/
/**
* retrieve, or initiate, an outbound group session
*/
DemoUser.prototype.getGroupSession = function() {
if (this.groupSession) {
return this.groupSession;
}
this.groupSession = new Olm.OutboundGroupSession();
this.groupSession.create();
var keymsg = {
"session_id": this.groupSession.session_id(),
"session_key": this.groupSession.session_key(),
"message_index": this.groupSession.message_index(),
};
var jsonmsg = JSON.stringify(keymsg);
for (var i = 0; i < this.peers.length; i++) {
var peer = this.peers[i];
this.sendToPeer(peer, jsonmsg);
}
return this.groupSession;
};
/**
* add a task to create an inbound group session
*/
DemoUser.prototype.createInboundSession = function(
peer_id, session_id, message_index, session_key, callback
) {
var self = this;
this.addTask("init inbound session", function(done) {
session = new Olm.InboundGroupSession();
session.create(message_index, session_key);
if (!self.peerGroupSessions[peer_id]) {
self.peerGroupSessions[peer_id] = {};
}
self.peerGroupSessions[peer_id][session_id] = session;
done(session);
}, callback);
};
/**
* handler for receiving a group message
*/
DemoUser.prototype.receiveGroup = function(jsonpacket) {
var self = this;
var el = buttonAndTextElement("decrypt", jsonpacket, function(ev) {
self.decryptGroup(jsonpacket, function(result) {
var el2 = document.createElement("tt");
el.appendChild(el2);
var content = document.createTextNode(" -> "+result);
el2.appendChild(content);
});
});
this.groupInputDiv.appendChild(el);
};
/**
* add a task to decrypt a received group message. Calls the callback with the
* decrypted plaintext
*/
DemoUser.prototype.decryptGroup = function(jsonpacket, callback) {
var self = this;
this.addTask("decrypt group message", function(done) {
var packet = JSON.parse(jsonpacket);
var sender = packet.sender_key;
var session_id = packet.session_id;
var peer_sessions = self.peerGroupSessions[sender];
if (!peer_sessions) {
throw new Error("No sessions for sender "+sender);
}
var session = peer_sessions[session_id];
if (!session) {
throw new Error("Unknown session id " + session_id);
}
var plaintext = session.decrypt(packet.body);
done(plaintext);
}, callback);
};
/**
* add a task to encrypt, and prepare for sending, a group message.
*
* Will create a group session if necessary
*/
DemoUser.prototype.encrypt = function(message) {
var self = this;
var session = this.getGroupSession();
self.addTask("encrypt group message", function(done) {
var encrypted = session.encrypt(message);
var packet = {
sender_key: self.getIdKey(),
session_id: session.session_id(),
body: encrypted,
};
var json = JSON.stringify(packet);
var el = buttonAndTextElement("send", json, function(ev) {
for (var i = 0; i < self.peers.length; i++) {
var peer = self.peers[i];
peer.receiveGroup(json);
}
});
self.groupOutputDiv.appendChild(el);
done();
});
};
function initUserDiv(demoUser, div) {
demoUser.progressElement = div.getElementsByClassName("user_progress")[0];
demoUser.cipherOutputDiv = div.getElementsByClassName("user_cipher_output")[0];
demoUser.cipherInputDiv = div.getElementsByClassName("user_cipher_input")[0];
demoUser.groupOutputDiv = div.getElementsByClassName("group_output")[0];
demoUser.groupInputDiv = div.getElementsByClassName("group_input")[0];
var plain_input = div.getElementsByClassName("user_plain_input")[0];
var encrypt = div.getElementsByClassName("user_encrypt")[0];
encrypt.addEventListener("click", function() {
demoUser.encrypt(plain_input.value);
}, false);
}
function startDemo() {
var user1 = new DemoUser();
initUserDiv(user1, document.getElementById("user1"));
user1.generateKeys();
var user2 = new DemoUser();
initUserDiv(user2, document.getElementById("user2"));
user2.generateKeys();
user1.addPeer(user2);
user2.addPeer(user1);
}
document.addEventListener("DOMContentLoaded", startDemo, false);

2
javascript/demo.html → javascript/demo/one_to_one_demo.html
View file

@ -1,6 +1,6 @@
<html> <html>
<head> <head>
<script src="olm.js"></script> <script src="../olm.js"></script>
<script> <script>
document.addEventListener("DOMContentLoaded", function (event) { document.addEventListener("DOMContentLoaded", function (event) {
function progress(who, message) { function progress(who, message) {

78
javascript/olm_inbound_group_session.js Normal file
View file

@ -0,0 +1,78 @@
function InboundGroupSession() {
var size = Module['_olm_inbound_group_session_size']();
this.buf = malloc(size);
this.ptr = Module['_olm_inbound_group_session'](this.buf);
}
function inbound_group_session_method(wrapped) {
return function() {
var result = wrapped.apply(this, arguments);
if (result === OLM_ERROR) {
var message = Pointer_stringify(
Module['_olm_inbound_group_session_last_error'](arguments[0])
);
throw new Error("OLM." + message);
}
return result;
}
}
InboundGroupSession.prototype['free'] = function() {
Module['_olm_clear_inbound_group_session'](this.ptr);
free(this.ptr);
}
InboundGroupSession.prototype['pickle'] = restore_stack(function(key) {
var key_array = array_from_string(key);
var pickle_length = inbound_group_session_method(
Module['_olm_pickle_inbound_group_session_length']
)(this.ptr);
var key_buffer = stack(key_array);
var pickle_buffer = stack(pickle_length);
inbound_group_session_method(Module['_olm_pickle_inbound_group_session'])(
this.ptr, key_buffer, key_array.length, pickle_buffer, pickle_length
);
return Pointer_stringify(pickle_buffer, pickle_length);
});
InboundGroupSession.prototype['unpickle'] = restore_stack(function(key, pickle) {
var key_array = array_from_string(key);
var key_buffer = stack(key_array);
var pickle_array = array_from_string(pickle);
var pickle_buffer = stack(pickle_array);
inbound_group_session_method(Module['_olm_unpickle_inbound_group_session'])(
this.ptr, key_buffer, key_array.length, pickle_buffer,
pickle_array.length
);
});
InboundGroupSession.prototype['create'] = restore_stack(function(message_index, session_key) {
var key_array = array_from_string(session_key);
var key_buffer = stack(key_array);
inbound_group_session_method(Module['_olm_init_inbound_group_session'])(
this.ptr, message_index, key_buffer, key_array.length
);
});
InboundGroupSession.prototype['decrypt'] = restore_stack(function(
message
) {
var message_array = array_from_string(message);
var message_buffer = stack(message_array);
var max_plaintext_length = session_method(
Module['_olm_group_decrypt_max_plaintext_length']
)(this.ptr, message_buffer, message_array.length);
// caculating the length destroys the input buffer.
// So we copy the array to a new buffer
var message_buffer = stack(message_array);
var plaintext_buffer = stack(max_plaintext_length);
var plaintext_length = session_method(Module["_olm_group_decrypt"])(
this.ptr,
message_buffer, message_array.length,
plaintext_buffer, max_plaintext_length
);
return Pointer_stringify(plaintext_buffer, plaintext_length);
});
olm_exports['InboundGroupSession'] = InboundGroupSession;

104
javascript/olm_outbound_group_session.js Normal file
View file

@ -0,0 +1,104 @@
function OutboundGroupSession() {
var size = Module['_olm_outbound_group_session_size']();
this.buf = malloc(size);
this.ptr = Module['_olm_outbound_group_session'](this.buf);
}
function outbound_group_session_method(wrapped) {
return function() {
var result = wrapped.apply(this, arguments);
if (result === OLM_ERROR) {
var message = Pointer_stringify(
Module['_olm_outbound_group_session_last_error'](arguments[0])
);
throw new Error("OLM." + message);
}
return result;
}
}
OutboundGroupSession.prototype['free'] = function() {
Module['_olm_clear_outbound_group_session'](this.ptr);
free(this.ptr);
}
OutboundGroupSession.prototype['pickle'] = restore_stack(function(key) {
var key_array = array_from_string(key);
var pickle_length = outbound_group_session_method(
Module['_olm_pickle_outbound_group_session_length']
)(this.ptr);
var key_buffer = stack(key_array);
var pickle_buffer = stack(pickle_length);
outbound_group_session_method(Module['_olm_pickle_outbound_group_session'])(
this.ptr, key_buffer, key_array.length, pickle_buffer, pickle_length
);
return Pointer_stringify(pickle_buffer, pickle_length);
});
OutboundGroupSession.prototype['unpickle'] = restore_stack(function(key, pickle) {
var key_array = array_from_string(key);
var key_buffer = stack(key_array);
var pickle_array = array_from_string(pickle);
var pickle_buffer = stack(pickle_array);
outbound_group_session_method(Module['_olm_unpickle_outbound_group_session'])(
this.ptr, key_buffer, key_array.length, pickle_buffer,
pickle_array.length
);
});
OutboundGroupSession.prototype['create'] = restore_stack(function(key) {
var random_length = session_method(
Module['_olm_init_outbound_group_session_random_length']
)(this.ptr);
var random = random_stack(random_length);
outbound_group_session_method(Module['_olm_init_outbound_group_session'])(
this.ptr, random, random_length
);
});
OutboundGroupSession.prototype['encrypt'] = restore_stack(function(plaintext) {
var plaintext_array = array_from_string(plaintext);
var message_length = outbound_group_session_method(
Module['_olm_group_encrypt_message_length']
)(this.ptr, plaintext_array.length);
var plaintext_buffer = stack(plaintext_array);
var message_buffer = stack(message_length);
outbound_group_session_method(Module['_olm_group_encrypt'])(
this.ptr,
plaintext_buffer, plaintext_array.length,
message_buffer, message_length
);
return Pointer_stringify(message_buffer, message_length);
});
OutboundGroupSession.prototype['session_id'] = restore_stack(function(key) {
var length = outbound_group_session_method(
Module['_olm_outbound_group_session_id_length']
)(this.ptr);
var session_id = stack(length);
outbound_group_session_method(Module['_olm_outbound_group_session_id'])(
this.ptr, session_id, length
);
return Pointer_stringify(session_id, length);
});
OutboundGroupSession.prototype['session_key'] = restore_stack(function(key) {
var key_length = outbound_group_session_method(
Module['_olm_outbound_group_session_key_length']
)(this.ptr);
var key = stack(key_length);
outbound_group_session_method(Module['_olm_outbound_group_session_key'])(
this.ptr, key, key_length
);
return Pointer_stringify(key, key_length);
});
OutboundGroupSession.prototype['message_index'] = function() {
var idx = outbound_group_session_method(
Module['_olm_outbound_group_session_message_index']
)(this.ptr);
return idx;
};
olm_exports['OutboundGroupSession'] = OutboundGroupSession;