Port of Google's Ukey2 library enables secure device-to-device communication and handshake processes, tested against original C++ tests, facilitating encrypted message exchange between clients and servers.
This is a port of google/ukey2 library to support Kotlin Multiplatform
Handshake and Device to Device communication is ported and tested against the C++ test from the original library
You can add the dependency to your project by adding the following lines to your Gradle build file.
The library is available on Maven Central and you can add the coordinates to your commonMain source set.
repositories {
mavenCentral()
}
dependencies {
implementation("com.carlonzo.ukey2:ukey2-kmp:<latest version>")
}
The project currently supports the following platforms:
To create a new handshake session, use the following code:
val client = Ukey2Handshake.forInitiator(HandshakeCipher.P256_SHA512)
// Message 1 (Client Init)
var handshakeMessage = client.getNextHandshakeMessage()
sendMessageToServer(handshakeMessage)
// Message 2 (Server Init)
handshakeMessage = receiveMessageFromServer()
client.parseHandshakeMessage(handshakeMessage)
// Message 3 (Client Finish)
handshakeMessage = client.getNextHandshakeMessage()
sendMessageToServer(handshakeMessage)
// Get the auth string to show to the user for confirmation
val clientAuthString = client.getVerificationString(STRING_LENGTH)
showStringToUser(clientAuthString)
// Once verified using a different channel, finish the handshake
client.verifyHandshake()
connection = client.toConnectionContext()
val server = Ukey2Handshake.forResponder(HandshakeCipher.P256_SHA512)
// Message 1 (Client Init)
var handshakeMessage = receiveMessageFromClient()
server.parseHandshakeMessage(handshakeMessage)
// Message 2 (Server Init)
handshakeMessage = server.getNextHandshakeMessage()
sendMessageToServer(handshakeMessage)
// Message 3 (Client Finish)
handshakeMessage = receiveMessageFromClient()
server.parseHandshakeMessage(handshakeMessage)
// Get the auth string
val serverAuthString = server.getVerificationString(STRING_LENGTH)
showStringToUser(serverAuthString)
// Using out-of-band channel, verify auth string, then call:
server.verifyHandshake()
connection = server.toConnectionContext()
To run the tests against the official C++ implementation, you will need to build the C++ library using the Bazel command from the ukey2 root:
bazel build //src/main/cpp:ukey2_shell
and change the path of the binary wrapper pointed by BINARY_PATH in src/jvmTest/kotlin/Ukey2ShellCppWrapper.kt to the correct path of the ukey2_shell binary.
It should be <ukey2folder>/bazel-bin/src/main/cpp/ukey2_shell
Then you can run the tests using the following command:
./gradlew test
Surfaced from shared tags and platforms — no rankings paid for.