An open-source entry in TopGit's GitHub warehouse: signalapp/libsignal-protocol-java, 1.9k stars, Java.
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
A ratcheting forward secrecy protocol that works in synchronous and asynchronous messaging environments.
PreKeys
This protocol uses a concept called 'PreKeys'. A PreKey is an ECPublicKey and an associated unique
ID which are stored together by a server. PreKeys can also be signed.
At install time, clients generate a single signed PreKey, as well as a large list of unsigned
PreKeys, and transmit all of them to the server.
Sessions
Signal Protocol is session-oriented. Clients establish a "session," which is then used for
all subsequent encrypt/decrypt operations. There is no need to ever tear down a session once one
has been established.
Sessions are established in one of three ways:
PreKeyBundles. A client that wishes to send a message to a recipient can establish a session by
retrieving a PreKeyBundle for that recipient from the server.
PreKeySignalMessages. A client can receive a PreKeySignalMessage from a recipient and use it
to establish a session.
KeyExchangeMessages. Two clients can exchange KeyExchange messages to establish a session.
State
An established session encapsulates a lot of state between two clients. That state is maintained
in durable records which need to be kept for the life of the session.
State is kept in the following places:
Identity State. Clients will need to maintain the state of their own identity key pair, as well
as identity keys received from other clients.
PreKey State. Clients will need to maintain the state of their generated PreKeys.
Signed PreKey States. Clients will need to maintain the state of their signed PreKeys.
Session State. Clients will need to maintain the state of the sessions they have established.
Using libsignal-protocol
Configuration
On Android:
dependencies {
compile 'org.whispersystems:signal-protocol-android:(latest version number)'
}
For pure Java apps:
<dependency>
<groupId>org.whispersystems</groupId>
<artifactId>signal-protocol-java</artifactId>
<version>(latest version number)</version>
</dependency>
Install time
At install time, a libsignal client needs to generate its identity keys, registration id, and
prekeys.
IdentityKeyPair identityKeyPair = KeyHelper.generateIdentityKeyPair();
int registrationId = KeyHelper.generateRegistrationId();
List<PreKeyRecord> preKeys = KeyHelper.generatePreKeys(startId, 100);
SignedPreKeyRecord signedPreKey = KeyHelper.generateSignedPreKey(identityKeyPair, 5);
// Store identityKeyPair somewhere durable and safe.
// Store registrationId somewhere durable and safe.
// Store preKeys in PreKeyStore.
// Store signed prekey in SignedPreKeyStore.
Building a session
A libsignal client needs to implement four interfaces: IdentityKeyStore, PreKeyStore,
SignedPreKeyStore, and SessionStore. These will manage loading and storing of identity,
prekeys, signed prekeys, and session state.
Once those are implemented, building a session is fairly straightforward:
SessionStore sessionStore = new MySessionStore();
PreKeyStore preKeyStore = new MyPreKeyStore();
SignedPreKeyStore signedPreKeyStore = new MySignedPreKeyStore();
IdentityKeyStore identityStore = new MyIdentityKeyStore();
// Instantiate a SessionBuilder for a remote recipientId + deviceId tuple.
SessionBuilder sessionBuilder = new SessionBuilder(sessionStore, preKeyStore, signedPreKeyStore,
identityStore, recipientId, deviceId);
// Build a session with a PreKey retrieved from the server.
sessionBuilder.process(retrievedPreKey);
SessionCipher sessionCipher = new SessionCipher(sessionStore, recipientId, deviceId);
CiphertextMessage message = sessionCipher.encrypt("Hello world!".getBytes("UTF-8"));
deliver(message.serialize());
Legal things
Cryptography Notice
This distribution includes cryptographic software. The country in which you currently reside may have restrictions on the import, possession, use, and/or re-export to another country, of encryption software.
BEFORE using any encryption software, please check your country's laws, regulations and policies concerning the import, possession, or use, and re-export of encryption software, to see if this is permitted.
See http://www.wassenaar.org/ for more information.
The U.S. Government Department of Commerce, Bureau of Industry and Security (BIS), has classified this software as Export Commodity Control Number (ECCN) 5D002.C.1, which includes information security software using or performing cryptographic functions with asymmetric algorithms.
The form and manner of this distribution makes it eligible for export under the License Exception ENC Technology Software Unrestricted (TSU) exception (see the BIS Export Administration Regulations, Section 740.13) for both object code and source code.
License
Copyright 2013-2019 Open Whisper Systems
Licensed under the GPLv3: http://www.gnu.org/licenses/gpl-3.0.html
Does signalapp/libsignal-protocol-java have any tags?
TopGit's last sync did not record any GitHub topics for signalapp/libsignal-protocol-java. GitHub topics appear in the right sidebar of a repository page; that's the authoritative place to check.
How active is development on signalapp/libsignal-protocol-java?
The most recent commit recorded on signalapp/libsignal-protocol-java was 5.1 years ago, based on the GitHub push timestamp. The repository has 441 forks — one of the better signals of community interest.
How many stars does signalapp/libsignal-protocol-java have?
signalapp/libsignal-protocol-java has 1.9k GitHub stars — refresh the page for the live number, or check github.com/signalapp/libsignal-protocol-java. TopGit mirrors GitHub's count but does not claim minute-by-minute accuracy.
What language is signalapp/libsignal-protocol-java written in?
signalapp/libsignal-protocol-java is written primarily in Java. GitHub's language field is based on the largest share of bytes in the default branch.
Where do I read more about signalapp/libsignal-protocol-java?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/signalapp/libsignal-protocol-java is the definitive source.
Read full README in the tab above.
Want a second opinion on libsignal-protocol-java?
Ask an AI that can read this page — one click and you get its take on libsignal-protocol-java.