Update data format to match BDF spec.

2026-02-13 19:29:06 +01:00 · 2016-01-04 15:29:57 +00:00
parent 25c9cff8d6
commit 7be7ce8eda
36 changed files with 338 additions and 409 deletions
--- a/briar-core/src/org/briarproject/sync/AuthorFactoryImpl.java
+++ b/briar-core/src/org/briarproject/sync/AuthorFactoryImpl.java
@@ -2,8 +2,8 @@ package org.briarproject.sync;

 import org.briarproject.api.crypto.CryptoComponent;
 import org.briarproject.api.crypto.MessageDigest;
-import org.briarproject.api.data.Writer;
-import org.briarproject.api.data.WriterFactory;
+import org.briarproject.api.data.BdfWriter;
+import org.briarproject.api.data.BdfWriterFactory;
 import org.briarproject.api.identity.Author;
 import org.briarproject.api.identity.AuthorFactory;
 import org.briarproject.api.identity.AuthorId;
@@ -18,14 +18,14 @@ import javax.inject.Inject;
 class AuthorFactoryImpl implements AuthorFactory {

 	private final CryptoComponent crypto;
-	private final WriterFactory writerFactory;
+	private final BdfWriterFactory bdfWriterFactory;
 	private final Clock clock;

 	@Inject
-	AuthorFactoryImpl(CryptoComponent crypto, WriterFactory writerFactory,
+	AuthorFactoryImpl(CryptoComponent crypto, BdfWriterFactory bdfWriterFactory,
 			Clock clock) {
 		this.crypto = crypto;
-		this.writerFactory = writerFactory;
+		this.bdfWriterFactory = bdfWriterFactory;
 		this.clock = clock;
 	}

@@ -41,7 +41,7 @@ class AuthorFactoryImpl implements AuthorFactory {

 	private AuthorId getId(String name, byte[] publicKey) {
 		ByteArrayOutputStream out = new ByteArrayOutputStream();
-		Writer w = writerFactory.createWriter(out);
+		BdfWriter w = bdfWriterFactory.createWriter(out);
 		try {
 			w.writeListStart();
 			w.writeString(name);
--- a/briar-core/src/org/briarproject/sync/AuthorReader.java
+++ b/briar-core/src/org/briarproject/sync/AuthorReader.java
@@ -3,8 +3,8 @@ package org.briarproject.sync;
 import org.briarproject.api.FormatException;
 import org.briarproject.api.crypto.CryptoComponent;
 import org.briarproject.api.crypto.MessageDigest;
+import org.briarproject.api.data.BdfReader;
 import org.briarproject.api.data.ObjectReader;
-import org.briarproject.api.data.Reader;
 import org.briarproject.api.identity.Author;
 import org.briarproject.api.identity.AuthorId;

@@ -21,7 +21,7 @@ class AuthorReader implements ObjectReader<Author> {
 		messageDigest = crypto.getMessageDigest();
 	}

-	public Author readObject(Reader r) throws IOException {
+	public Author readObject(BdfReader r) throws IOException {
 		// Set up the reader
 		DigestingConsumer digesting = new DigestingConsumer(messageDigest);
 		r.addConsumer(digesting);
--- a/briar-core/src/org/briarproject/sync/GroupFactoryImpl.java
+++ b/briar-core/src/org/briarproject/sync/GroupFactoryImpl.java
@@ -2,8 +2,8 @@ package org.briarproject.sync;

 import org.briarproject.api.crypto.CryptoComponent;
 import org.briarproject.api.crypto.MessageDigest;
-import org.briarproject.api.data.Writer;
-import org.briarproject.api.data.WriterFactory;
+import org.briarproject.api.data.BdfWriter;
+import org.briarproject.api.data.BdfWriterFactory;
 import org.briarproject.api.sync.Group;
 import org.briarproject.api.sync.GroupFactory;
 import org.briarproject.api.sync.GroupId;
@@ -18,12 +18,12 @@ import static org.briarproject.api.sync.MessagingConstants.GROUP_SALT_LENGTH;
 class GroupFactoryImpl implements GroupFactory {

 	private final CryptoComponent crypto;
-	private final WriterFactory writerFactory;
+	private final BdfWriterFactory bdfWriterFactory;

 	@Inject
-	GroupFactoryImpl(CryptoComponent crypto, WriterFactory writerFactory) {
+	GroupFactoryImpl(CryptoComponent crypto, BdfWriterFactory bdfWriterFactory) {
 		this.crypto = crypto;
-		this.writerFactory = writerFactory;
+		this.bdfWriterFactory = bdfWriterFactory;
 	}

 	public Group createGroup(String name) {
@@ -34,7 +34,7 @@ class GroupFactoryImpl implements GroupFactory {

 	public Group createGroup(String name, byte[] salt) {
 		ByteArrayOutputStream out = new ByteArrayOutputStream();
-		Writer w = writerFactory.createWriter(out);
+		BdfWriter w = bdfWriterFactory.createWriter(out);
 		try {
 			w.writeListStart();
 			w.writeString(name);
--- a/briar-core/src/org/briarproject/sync/GroupReader.java
+++ b/briar-core/src/org/briarproject/sync/GroupReader.java
@@ -3,8 +3,8 @@ package org.briarproject.sync;
 import org.briarproject.api.FormatException;
 import org.briarproject.api.crypto.CryptoComponent;
 import org.briarproject.api.crypto.MessageDigest;
+import org.briarproject.api.data.BdfReader;
 import org.briarproject.api.data.ObjectReader;
-import org.briarproject.api.data.Reader;
 import org.briarproject.api.sync.Group;
 import org.briarproject.api.sync.GroupId;

@@ -21,7 +21,7 @@ class GroupReader implements ObjectReader<Group> {
 		messageDigest = crypto.getMessageDigest();
 	}

-	public Group readObject(Reader r) throws IOException {
+	public Group readObject(BdfReader r) throws IOException {
 		DigestingConsumer digesting = new DigestingConsumer(messageDigest);
 		// Read and digest the data
 		r.addConsumer(digesting);
--- a/briar-core/src/org/briarproject/sync/MessageFactoryImpl.java
+++ b/briar-core/src/org/briarproject/sync/MessageFactoryImpl.java
@@ -4,9 +4,9 @@ import org.briarproject.api.crypto.CryptoComponent;
 import org.briarproject.api.crypto.MessageDigest;
 import org.briarproject.api.crypto.PrivateKey;
 import org.briarproject.api.crypto.Signature;
+import org.briarproject.api.data.BdfWriter;
+import org.briarproject.api.data.BdfWriterFactory;
 import org.briarproject.api.data.Consumer;
-import org.briarproject.api.data.Writer;
-import org.briarproject.api.data.WriterFactory;
 import org.briarproject.api.identity.Author;
 import org.briarproject.api.sync.Group;
 import org.briarproject.api.sync.Message;
@@ -32,14 +32,14 @@ class MessageFactoryImpl implements MessageFactory {
 	private final Signature signature;
 	private final SecureRandom random;
 	private final MessageDigest messageDigest;
-	private final WriterFactory writerFactory;
+	private final BdfWriterFactory bdfWriterFactory;

 	@Inject
-	MessageFactoryImpl(CryptoComponent crypto, WriterFactory writerFactory) {
+	MessageFactoryImpl(CryptoComponent crypto, BdfWriterFactory bdfWriterFactory) {
 		signature = crypto.getSignature();
 		random = crypto.getSecureRandom();
 		messageDigest = crypto.getMessageDigest();
-		this.writerFactory = writerFactory;
+		this.bdfWriterFactory = bdfWriterFactory;
 	}

 	public Message createAnonymousMessage(MessageId parent, Group group,
@@ -69,7 +69,7 @@ class MessageFactoryImpl implements MessageFactory {
 			throw new IllegalArgumentException();
 		// Serialise the message to a buffer
 		ByteArrayOutputStream out = new ByteArrayOutputStream();
-		Writer w = writerFactory.createWriter(out);
+		BdfWriter w = bdfWriterFactory.createWriter(out);
 		// Initialise the consumers
 		CountingConsumer counting = new CountingConsumer(MAX_PAYLOAD_LENGTH);
 		w.addConsumer(counting);
@@ -113,14 +113,14 @@ class MessageFactoryImpl implements MessageFactory {
 				timestamp, out.toByteArray(), bodyStart, body.length);
 	}

-	private void writeGroup(Writer w, Group g) throws IOException {
+	private void writeGroup(BdfWriter w, Group g) throws IOException {
 		w.writeListStart();
 		w.writeString(g.getName());
 		w.writeRaw(g.getSalt());
 		w.writeListEnd();
 	}

-	private void writeAuthor(Writer w, Author a) throws IOException {
+	private void writeAuthor(BdfWriter w, Author a) throws IOException {
 		w.writeListStart();
 		w.writeString(a.getName());
 		w.writeRaw(a.getPublicKey());
--- a/briar-core/src/org/briarproject/sync/MessageReader.java
+++ b/briar-core/src/org/briarproject/sync/MessageReader.java
@@ -2,8 +2,8 @@ package org.briarproject.sync;

 import org.briarproject.api.FormatException;
 import org.briarproject.api.UniqueId;
+import org.briarproject.api.data.BdfReader;
 import org.briarproject.api.data.ObjectReader;
-import org.briarproject.api.data.Reader;
 import org.briarproject.api.identity.Author;
 import org.briarproject.api.sync.Group;
 import org.briarproject.api.sync.MessageId;
@@ -28,7 +28,7 @@ class MessageReader implements ObjectReader<UnverifiedMessage> {
 		this.authorReader = authorReader;
 	}

-	public UnverifiedMessage readObject(Reader r) throws IOException {
+	public UnverifiedMessage readObject(BdfReader r) throws IOException {
 		CopyingConsumer copying = new CopyingConsumer();
 		CountingConsumer counting = new CountingConsumer(MAX_PAYLOAD_LENGTH);
 		r.addConsumer(copying);
--- a/briar-core/src/org/briarproject/sync/PacketReaderFactoryImpl.java
+++ b/briar-core/src/org/briarproject/sync/PacketReaderFactoryImpl.java
@@ -1,7 +1,7 @@
 package org.briarproject.sync;

+import org.briarproject.api.data.BdfReaderFactory;
 import org.briarproject.api.data.ObjectReader;
-import org.briarproject.api.data.ReaderFactory;
 import org.briarproject.api.sync.PacketReader;
 import org.briarproject.api.sync.PacketReaderFactory;
 import org.briarproject.api.sync.SubscriptionUpdate;
@@ -13,21 +13,21 @@ import javax.inject.Inject;

 class PacketReaderFactoryImpl implements PacketReaderFactory {

-	private final ReaderFactory readerFactory;
+	private final BdfReaderFactory bdfReaderFactory;
 	private final ObjectReader<UnverifiedMessage> messageReader;
 	private final ObjectReader<SubscriptionUpdate> subscriptionUpdateReader;

 	@Inject
-	PacketReaderFactoryImpl(ReaderFactory readerFactory,
+	PacketReaderFactoryImpl(BdfReaderFactory bdfReaderFactory,
 			ObjectReader<UnverifiedMessage> messageReader,
 			ObjectReader<SubscriptionUpdate> subscriptionUpdateReader) {
-		this.readerFactory = readerFactory;
+		this.bdfReaderFactory = bdfReaderFactory;
 		this.messageReader = messageReader;
 		this.subscriptionUpdateReader = subscriptionUpdateReader;
 	}

 	public PacketReader createPacketReader(InputStream in) {
-		return new PacketReaderImpl(readerFactory, messageReader,
+		return new PacketReaderImpl(bdfReaderFactory, messageReader,
 				subscriptionUpdateReader, in);
 	}
 }
--- a/briar-core/src/org/briarproject/sync/PacketReaderImpl.java
+++ b/briar-core/src/org/briarproject/sync/PacketReaderImpl.java
@@ -4,9 +4,9 @@ import org.briarproject.api.FormatException;
 import org.briarproject.api.TransportId;
 import org.briarproject.api.TransportProperties;
 import org.briarproject.api.UniqueId;
+import org.briarproject.api.data.BdfReader;
+import org.briarproject.api.data.BdfReaderFactory;
 import org.briarproject.api.data.ObjectReader;
-import org.briarproject.api.data.Reader;
-import org.briarproject.api.data.ReaderFactory;
 import org.briarproject.api.sync.Ack;
 import org.briarproject.api.sync.MessageId;
 import org.briarproject.api.sync.Offer;
@@ -48,7 +48,7 @@ class PacketReaderImpl implements PacketReader {

 	private enum State { BUFFER_EMPTY, BUFFER_FULL, EOF }

-	private final ReaderFactory readerFactory;
+	private final BdfReaderFactory bdfReaderFactory;
 	private final ObjectReader<UnverifiedMessage> messageReader;
 	private final ObjectReader<SubscriptionUpdate> subscriptionUpdateReader;
 	private final InputStream in;
@@ -57,11 +57,11 @@ class PacketReaderImpl implements PacketReader {
 	private State state = State.BUFFER_EMPTY;
 	private int payloadLength = 0;

-	PacketReaderImpl(ReaderFactory readerFactory,
+	PacketReaderImpl(BdfReaderFactory bdfReaderFactory,
 			ObjectReader<UnverifiedMessage> messageReader,
 			ObjectReader<SubscriptionUpdate> subscriptionUpdateReader,
 			InputStream in) {
-		this.readerFactory = readerFactory;
+		this.bdfReaderFactory = bdfReaderFactory;
 		this.messageReader = messageReader;
 		this.subscriptionUpdateReader = subscriptionUpdateReader;
 		this.in = in;
@@ -111,7 +111,7 @@ class PacketReaderImpl implements PacketReader {
 		if (!hasAck()) throw new FormatException();
 		// Set up the reader
 		InputStream bais = new ByteArrayInputStream(payload, 0, payloadLength);
-		Reader r = readerFactory.createReader(bais);
+		BdfReader r = bdfReaderFactory.createReader(bais);
 		// Read the start of the payload
 		r.readListStart();
 		// Read the message IDs
@@ -141,7 +141,7 @@ class PacketReaderImpl implements PacketReader {
 		if (!hasMessage()) throw new FormatException();
 		// Set up the reader
 		InputStream bais = new ByteArrayInputStream(payload, 0, payloadLength);
-		Reader r = readerFactory.createReader(bais);
+		BdfReader r = bdfReaderFactory.createReader(bais);
 		// Read and build the message
 		UnverifiedMessage m = messageReader.readObject(r);
 		if (!r.eof()) throw new FormatException();
@@ -157,7 +157,7 @@ class PacketReaderImpl implements PacketReader {
 		if (!hasOffer()) throw new FormatException();
 		// Set up the reader
 		InputStream bais = new ByteArrayInputStream(payload, 0, payloadLength);
-		Reader r = readerFactory.createReader(bais);
+		BdfReader r = bdfReaderFactory.createReader(bais);
 		// Read the start of the payload
 		r.readListStart();
 		// Read the message IDs
@@ -187,7 +187,7 @@ class PacketReaderImpl implements PacketReader {
 		if (!hasRequest()) throw new FormatException();
 		// Set up the reader
 		InputStream bais = new ByteArrayInputStream(payload, 0, payloadLength);
-		Reader r = readerFactory.createReader(bais);
+		BdfReader r = bdfReaderFactory.createReader(bais);
 		// Read the start of the payload
 		r.readListStart();
 		// Read the message IDs
@@ -217,7 +217,7 @@ class PacketReaderImpl implements PacketReader {
 		if (!hasSubscriptionAck()) throw new FormatException();
 		// Set up the reader
 		InputStream bais = new ByteArrayInputStream(payload, 0, payloadLength);
-		Reader r = readerFactory.createReader(bais);
+		BdfReader r = bdfReaderFactory.createReader(bais);
 		// Read the start of the payload
 		r.readListStart();
 		// Read the version
@@ -239,7 +239,7 @@ class PacketReaderImpl implements PacketReader {
 		if (!hasSubscriptionUpdate()) throw new FormatException();
 		// Set up the reader
 		InputStream bais = new ByteArrayInputStream(payload, 0, payloadLength);
-		Reader r = readerFactory.createReader(bais);
+		BdfReader r = bdfReaderFactory.createReader(bais);
 		// Read and build the subscription update
 		SubscriptionUpdate u = subscriptionUpdateReader.readObject(r);
 		if (!r.eof()) throw new FormatException();
@@ -255,7 +255,7 @@ class PacketReaderImpl implements PacketReader {
 		if (!hasTransportAck()) throw new FormatException();
 		// Set up the reader
 		InputStream bais = new ByteArrayInputStream(payload, 0, payloadLength);
-		Reader r = readerFactory.createReader(bais);
+		BdfReader r = bdfReaderFactory.createReader(bais);
 		// Read the start of the payload
 		r.readListStart();
 		// Read the transport ID and version
@@ -280,7 +280,7 @@ class PacketReaderImpl implements PacketReader {
 		if (!hasTransportUpdate()) throw new FormatException();
 		// Set up the reader
 		InputStream bais = new ByteArrayInputStream(payload, 0, payloadLength);
-		Reader r = readerFactory.createReader(bais);
+		BdfReader r = bdfReaderFactory.createReader(bais);
 		// Read the start of the payload
 		r.readListStart();
 		// Read the transport ID
@@ -289,15 +289,15 @@ class PacketReaderImpl implements PacketReader {
 		TransportId id = new TransportId(idString);
 		// Read the transport properties
 		Map<String, String> p = new HashMap<String, String>();
-		r.readMapStart();
-		for (int i = 0; !r.hasMapEnd(); i++) {
+		r.readDictionaryStart();
+		for (int i = 0; !r.hasDictionaryEnd(); i++) {
 			if (i == MAX_PROPERTIES_PER_TRANSPORT)
 				throw new FormatException();
 			String key = r.readString(MAX_PROPERTY_LENGTH);
 			String value = r.readString(MAX_PROPERTY_LENGTH);
 			p.put(key, value);
 		}
-		r.readMapEnd();
+		r.readDictionaryEnd();
 		// Read the version number
 		long version = r.readInteger();
 		if (version < 0) throw new FormatException();
--- a/briar-core/src/org/briarproject/sync/PacketWriterFactoryImpl.java
+++ b/briar-core/src/org/briarproject/sync/PacketWriterFactoryImpl.java
@@ -1,6 +1,6 @@
 package org.briarproject.sync;

-import org.briarproject.api.data.WriterFactory;
+import org.briarproject.api.data.BdfWriterFactory;
 import org.briarproject.api.sync.PacketWriter;
 import org.briarproject.api.sync.PacketWriterFactory;

@@ -10,14 +10,14 @@ import javax.inject.Inject;

 class PacketWriterFactoryImpl implements PacketWriterFactory {

-	private final WriterFactory writerFactory;
+	private final BdfWriterFactory bdfWriterFactory;

 	@Inject
-	PacketWriterFactoryImpl(WriterFactory writerFactory) {
-		this.writerFactory = writerFactory;
+	PacketWriterFactoryImpl(BdfWriterFactory bdfWriterFactory) {
+		this.bdfWriterFactory = bdfWriterFactory;
 	}

 	public PacketWriter createPacketWriter(OutputStream out) {
-		return new PacketWriterImpl(writerFactory, out);
+		return new PacketWriterImpl(bdfWriterFactory, out);
 	}
 }
--- a/briar-core/src/org/briarproject/sync/PacketWriterImpl.java
+++ b/briar-core/src/org/briarproject/sync/PacketWriterImpl.java
@@ -1,7 +1,7 @@
 package org.briarproject.sync;

-import org.briarproject.api.data.Writer;
-import org.briarproject.api.data.WriterFactory;
+import org.briarproject.api.data.BdfWriter;
+import org.briarproject.api.data.BdfWriterFactory;
 import org.briarproject.api.sync.Ack;
 import org.briarproject.api.sync.Group;
 import org.briarproject.api.sync.MessageId;
@@ -36,13 +36,13 @@ import static org.briarproject.api.sync.PacketTypes.TRANSPORT_UPDATE;
 // This class is not thread-safe
 class PacketWriterImpl implements PacketWriter {

-	private final WriterFactory writerFactory;
+	private final BdfWriterFactory bdfWriterFactory;
 	private final OutputStream out;
 	private final byte[] header;
 	private final ByteArrayOutputStream payload;

-	PacketWriterImpl(WriterFactory writerFactory, OutputStream out) {
-		this.writerFactory = writerFactory;
+	PacketWriterImpl(BdfWriterFactory bdfWriterFactory, OutputStream out) {
+		this.bdfWriterFactory = bdfWriterFactory;
 		this.out = out;
 		header = new byte[HEADER_LENGTH];
 		header[0] = PROTOCOL_VERSION;
@@ -78,7 +78,7 @@ class PacketWriterImpl implements PacketWriter {

 	public void writeAck(Ack a) throws IOException {
 		assert payload.size() == 0;
-		Writer w = writerFactory.createWriter(payload);
+		BdfWriter w = bdfWriterFactory.createWriter(payload);
 		w.writeListStart();
 		w.writeListStart();
 		for (MessageId m : a.getMessageIds()) w.writeRaw(m.getBytes());
@@ -96,7 +96,7 @@ class PacketWriterImpl implements PacketWriter {

 	public void writeOffer(Offer o) throws IOException {
 		assert payload.size() == 0;
-		Writer w = writerFactory.createWriter(payload);
+		BdfWriter w = bdfWriterFactory.createWriter(payload);
 		w.writeListStart();
 		w.writeListStart();
 		for (MessageId m : o.getMessageIds()) w.writeRaw(m.getBytes());
@@ -107,7 +107,7 @@ class PacketWriterImpl implements PacketWriter {

 	public void writeRequest(Request r) throws IOException {
 		assert payload.size() == 0;
-		Writer w = writerFactory.createWriter(payload);
+		BdfWriter w = bdfWriterFactory.createWriter(payload);
 		w.writeListStart();
 		w.writeListStart();
 		for (MessageId m : r.getMessageIds()) w.writeRaw(m.getBytes());
@@ -118,7 +118,7 @@ class PacketWriterImpl implements PacketWriter {

 	public void writeSubscriptionAck(SubscriptionAck a) throws IOException {
 		assert payload.size() == 0;
-		Writer w = writerFactory.createWriter(payload);
+		BdfWriter w = bdfWriterFactory.createWriter(payload);
 		w.writeListStart();
 		w.writeInteger(a.getVersion());
 		w.writeListEnd();
@@ -128,7 +128,7 @@ class PacketWriterImpl implements PacketWriter {
 	public void writeSubscriptionUpdate(SubscriptionUpdate u)
 			throws IOException {
 		assert payload.size() == 0;
-		Writer w = writerFactory.createWriter(payload);
+		BdfWriter w = bdfWriterFactory.createWriter(payload);
 		w.writeListStart();
 		w.writeListStart();
 		for (Group g : u.getGroups()) {
@@ -145,7 +145,7 @@ class PacketWriterImpl implements PacketWriter {

 	public void writeTransportAck(TransportAck a) throws IOException {
 		assert payload.size() == 0;
-		Writer w = writerFactory.createWriter(payload);
+		BdfWriter w = bdfWriterFactory.createWriter(payload);
 		w.writeListStart();
 		w.writeString(a.getId().getString());
 		w.writeInteger(a.getVersion());
@@ -155,10 +155,10 @@ class PacketWriterImpl implements PacketWriter {

 	public void writeTransportUpdate(TransportUpdate u) throws IOException {
 		assert payload.size() == 0;
-		Writer w = writerFactory.createWriter(payload);
+		BdfWriter w = bdfWriterFactory.createWriter(payload);
 		w.writeListStart();
 		w.writeString(u.getId().getString());
-		w.writeMap(u.getProperties());
+		w.writeDictionary(u.getProperties());
 		w.writeInteger(u.getVersion());
 		w.writeListEnd();
 		writePacket(TRANSPORT_UPDATE);
--- a/briar-core/src/org/briarproject/sync/SubscriptionUpdateReader.java
+++ b/briar-core/src/org/briarproject/sync/SubscriptionUpdateReader.java
@@ -1,9 +1,9 @@
 package org.briarproject.sync;

 import org.briarproject.api.FormatException;
+import org.briarproject.api.data.BdfReader;
 import org.briarproject.api.data.Consumer;
 import org.briarproject.api.data.ObjectReader;
-import org.briarproject.api.data.Reader;
 import org.briarproject.api.sync.Group;
 import org.briarproject.api.sync.GroupId;
 import org.briarproject.api.sync.SubscriptionUpdate;
@@ -26,7 +26,7 @@ class SubscriptionUpdateReader implements ObjectReader<SubscriptionUpdate> {
 		this.groupReader = groupReader;
 	}

-	public SubscriptionUpdate readObject(Reader r) throws IOException {
+	public SubscriptionUpdate readObject(BdfReader r) throws IOException {
 		// Set up the reader
 		Consumer counting = new CountingConsumer(MAX_PAYLOAD_LENGTH);
 		r.addConsumer(counting);