Skip to content

Commit

Permalink
Update to reflect client-only status.
Browse files Browse the repository at this point in the history
  • Loading branch information
int08h committed Feb 10, 2017
1 parent 31f48cf commit 523ff4a
Show file tree
Hide file tree
Showing 7 changed files with 10 additions and 440 deletions.
19 changes: 6 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
# Nearenough
**Nearenough** is a Java implementation of the
[Roughtime](https://roughtime.googlesource.com/roughtime) secure time synchronization protocol. It
provides both a Roughtime client and a (work-in-progress) Roughtime server.
**Nearenough** is a Java client of the [Roughtime](https://roughtime.googlesource.com/roughtime)
secure time synchronization protocol.

Nearenough aims to be 100% interoperable with the wider Roughtime ecosystem.

Expand All @@ -19,7 +18,7 @@ created by Adam Langley and Robert Obryk.
Nearenough bundles all required dependencies in the `lib` directory. Add those `.jar` files to
your IDE's project classpath. Building is IDE-only for the moment.

## Client Quickstart
## Quickstart

### Client Examples
See [`examples/NioClient.java`](../master/examples/NioClient.java) and
Expand Down Expand Up @@ -57,22 +56,16 @@ if (client.isResponseValid()) {
See the javadocs in [`RoughtimeClient.java`](../master/src/nearenough/client/RoughtimeClient.java)
for more information.

## Server Quickstart

Server is a work-in-progress. Check back!

## Implementation Status
Nearenough is not stable yet. Expect significant changes as the code evolves.
Nearenough is stable.

* Protocol - Client protocol is feature complete. Server protocol needs some work, mostly around
Merkle tree handling.
* Protocol - Client protocol is feature complete.
* Client - Feature complete except for ecosystem-style request chaining.
* Server - Just getting started

## Contributors
* Stuart Stock, original author and current maintainer (stuart {at} int08h.com)

If you would like to contribute to Nearenough, please see the guidlines in
If you would like to contribute to Nearenough, please see the guidelines in
[CONTRIBUTING.md](../master/CONTRIBUTING.md).

## Copyright and License
Expand Down
8 changes: 4 additions & 4 deletions ROADMAP.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ Features and changes under consideration. Not necessarily in order.

* Mutation testing using PIT http://pitest.org/

* Remove Netty dependency in client and protocol. While server will always need Netty, having a
dependency-free client and protocol seems worthwhile as it opens up the possibility of use
on Android. This would mean using either ByteBuffer or byte[] in place of ByteBuf.
* Remove Netty dependency in client and protocol. Having a dependency-free client and protocol seems
worthwhile as it opens up the possibility of use on Android. This would mean using either
ByteBuffer or byte[] in place of ByteBuf.

* Further towards potential use on Android, remove the few Java 8 features from the codebase. This
only makes sense if above the client and protocol changes are made first.
Expand All @@ -21,5 +21,5 @@ Features and changes under consideration. Not necessarily in order.
Non-features, will not be implemented:

* Logging in the client and protocol. I have little desire to wade into the tire fire that is Java
logging. My stance is that it's a choice client code should make. TBD on the server code.
logging. My stance is that it's a choice client code should make.

177 changes: 0 additions & 177 deletions src/nearenough/server/LongTermKey.java

This file was deleted.

28 changes: 0 additions & 28 deletions src/nearenough/server/clock/ClockSource.java

This file was deleted.

27 changes: 0 additions & 27 deletions src/nearenough/server/clock/SystemClock.java

This file was deleted.

51 changes: 0 additions & 51 deletions src/nearenough/server/clock/TestingClock.java

This file was deleted.

Loading

0 comments on commit 523ff4a

Please sign in to comment.