End-to-end encrypted messaging and cryptography toolkit featuring a CLI for login, group management, messaging, key package handling, and configurable build-time crypto/cache policies.
Kalium currently uses the following compile-time Gradle properties:
Kalium release automation now publishes two separate build outputs:
Each GitHub release upload also includes a per-bundle SHA-256 manifest
(logic-android-aar-SHA256SUMS.txt / logic-kmp-SHA256SUMS.txt) and a matching
GitHub build provenance bundle (*-provenance-bundle.json).
The cli can be executed on the terminal of any machine that
satisfies the dependencies mentioned above, and is capable of actions like:
Just run make, which will download and compile dependencies listed above from source,
the output will be $PROJECT_ROOT$/native/libs
When running any tasks that require the native libraries (libsodium, cryptobox-c
and cryptobox4j), you need to pass their location as VM options like so:
-Djava.library.path=./path/to/native/libraries/mentioned/before
For example, if you want to run the task jvmTest and the libraries are in ./native/libs:
./gradlew jvmTest -Djava.library.path=./native/libs
You can see all commands and options by running login --help
./gradlew :sample:cli:assemble
java -jar cli/build/libs/cli.jar login --email <email> --password <password> listen-group
or if you want the jar file deleted after your run:
./gradlew :sample:cli:run --console=plain --quiet --args="login --email <email> --password <password> listen-group"
For running on arm64 mac
./gradlew :sample:cli:macosArm64Binaries
./cli/build/bin/macosArm64/debugExecutable/cli.kexe login
We use and try to maintain our codestyle uniformed, so apart from having our checks in place in our CI. You can have live feedback using the IDE, here is how:
IntelliJ -> Settings -> Plugins -> Marketplace -> Search and install "Detekt"
Settings -> Tools -> Detekt -> set: (replace $PROJECT_ROOT accordingly to your machine)
or
You can run locally in your terminal:
./gradlew clean detekt
USE_UNIFIED_CORE_CRYPTO
false (see gradle.properties)core-crypto-kmp artifact (true) or platform-specific crypto artifacts (false)../gradlew <task> -PUSE_UNIFIED_CORE_CRYPTO=true
kalium.providerCacheScope
GLOBAL: process-global caches shared across provider instances.LOCAL: each provider instance keeps its own cache.UserStorageProviderUserAuthenticatedNetworkProvider./gradlew <task> -Pkalium.providerCacheScope=GLOBAL
logic-android-aar./gradlew :logic:bundleAndroidMainAar -PUSE_UNIFIED_CORE_CRYPTO=false
logic-kmpcore-crypto-kmp dependency, so USE_UNIFIED_CORE_CRYPTO must be true../gradlew :logic:bundleAndroidMainAar :logic:jvmJar :logic:allMetadataJar :logic:sourcesJar :logic:assembleKaliumLogicReleaseXCFramework -PUSE_UNIFIED_CORE_CRYPTO=true
Usage: cliapplication login [OPTIONS] COMMAND [ARGS]...
Options:
-e, --email TEXT Account email
-p, --password TEXT Account password
--environment TEXT Choose backend environment: can be production, staging
or an URL to a server configuration
-h, --help Show this message and exit
Commands:
create-group
listen-group
delete-client
add-member
remove-member
console
refill-key-packages
mark-as-read Mark a conversation as read
update-supported-protocols
%%{
init: {
'theme': 'neutral'
}
}%%
graph LR
:logic["logic"]
subgraph :core
:core:common["common"]
:core:data["data"]
:core:logger["logger"]
:core:util["util"]
:core:cryptography["cryptography"]
:core:common["common"]
:core:cryptography["cryptography"]
:core:libsodium["libsodium"]
:core:data["data"]
end
subgraph :data
:data:persistence["persistence"]
:data:network["network"]
:data:network-util["network-util"]
:data:persistence["persistence"]
:data:persistence-test["persistence-test"]
:data:data-mappers["data-mappers"]
:data:protobuf["protobuf"]
:data:persistence-test["persistence-test"]
:data:network-model["network-model"]
:data:network-util["network-util"]
:data:network["network"]
:data:network-model["network-model"]
:data:data-mappers["data-mappers"]
end
subgraph :domain
:domain:work["work"]
:domain:calling["calling"]
:domain:cells["cells"]
:domain:backup["backup"]
:domain:nomaddevice["nomaddevice"]
:domain:userstorage["userstorage"]
:domain:usernetwork["usernetwork"]
:domain:userstorage["userstorage"]
:domain:work["work"]
:domain:nomaddevice["nomaddevice"]
:domain:usernetwork["usernetwork"]
:domain:backup["backup"]
:domain:cells["cells"]
subgraph :messaging
:domain:messaging:hooks["hooks"]
:domain:messaging:sending["sending"]
:domain:messaging:hooks["hooks"]
:domain:messaging:sending["sending"]
end
end
subgraph :test
:test:data-mocks["data-mocks"]
:test:data-mocks["data-mocks"]
:test:mocks["mocks"]
:test:mocks["mocks"]
end
:core:common --> :core:data
:core:common --> :core:logger
:core:common --> :core:util
:core:common --> :data:persistence
:core:common --> :data:network
:core:common --> :data:network-util
:core:common --> :core:cryptography
:domain:messaging:hooks --> :core:data
:domain:messaging:hooks --> :core:common
:domain:messaging:hooks --> :core:logger
:data:persistence --> :core:logger
:data:persistence --> :core:util
:data:persistence-test --> :data:persistence
:logic --> :core:common
:logic --> :domain:work
:logic --> :core:data
:logic --> :data:network-util
:logic --> :core:logger
:logic --> :domain:calling
:logic --> :data:network
:logic --> :data:data-mappers
:logic --> :core:cryptography
:logic --> :data:persistence
:logic --> :data:protobuf
:logic --> :core:util
:logic --> :domain:cells
:logic --> :domain:backup
:logic --> :domain:nomaddevice
:logic --> :domain:userstorage
:logic --> :domain:usernetwork
:logic --> :domain:messaging:sending
:logic --> :domain:messaging:hooks
:logic --> :data:persistence-test
:logic --> :test:data-mocks
:domain:userstorage --> :data:persistence
:domain:userstorage --> :core:util
:domain:userstorage --> :core:data
:domain:work --> :core:common
:domain:work --> :core:data
:domain:work --> :core:logger
:domain:work --> :core:util
:test:data-mocks --> :core:data
:test:data-mocks --> :data:persistence
:test:data-mocks --> :data:network-model
:test:data-mocks --> :core:util
:domain:nomaddevice --> :core:common
:domain:nomaddevice --> :data:protobuf
:domain:nomaddevice --> :domain:messaging:hooks
:domain:nomaddevice --> :domain:usernetwork
:domain:nomaddevice --> :domain:userstorage
:domain:nomaddevice --> :data:persistence
:data:network-util --> :core:logger
:test:mocks --> :data:network-model
:domain:messaging:sending --> :core:common
:domain:messaging:sending --> :core:data
:domain:messaging:sending --> :core:logger
:domain:messaging:sending --> :core:util
:domain:usernetwork --> :data:network
:core:cryptography --> :core:logger
:core:cryptography --> :core:libsodium
:domain:backup --> :core:libsodium
:domain:backup --> :data:protobuf
:data:network --> :data:network-model
:data:network --> :core:logger
:data:network --> :data:protobuf
:data:network --> :core:util
:data:network --> :data:network-util
:data:network --> :test:mocks
:data:network-model --> :core:logger
:data:network-model --> :core:util
:core:data --> :data:network-model
:core:data --> :core:util
:domain:cells --> :core:common
:domain:cells --> :data:network
:domain:cells --> :core:data
:domain:cells --> :core:util
:domain:cells --> :data:persistence
:data:data-mappers --> :core:data
:data:data-mappers --> :data:protobuf
:data:data-mappers --> :data:persistence
:data:data-mappers --> :core:cryptography
:data:data-mappers --> :data:network-model
:data:data-mappers --> :core:util
classDef kotlin-multiplatform fill:#C792EA,stroke:#fff,stroke-width:2px,color:#fff;
class :core:common kotlin-multiplatform
class :core:data kotlin-multiplatform
class :core:logger kotlin-multiplatform
class :core:util kotlin-multiplatform
class :data:persistence kotlin-multiplatform
class :data:network kotlin-multiplatform
class :data:network-util kotlin-multiplatform
class :core:cryptography kotlin-multiplatform
class :domain:messaging:hooks kotlin-multiplatform
class :data:persistence-test kotlin-multiplatform
class :logic kotlin-multiplatform
class :domain:work kotlin-multiplatform
class :domain:calling kotlin-multiplatform
class :data:data-mappers kotlin-multiplatform
class :data:protobuf kotlin-multiplatform
class :domain:cells kotlin-multiplatform
class :domain:backup kotlin-multiplatform
class :domain:nomaddevice kotlin-multiplatform
class :domain:userstorage kotlin-multiplatform
class :domain:usernetwork kotlin-multiplatform
class :domain:messaging:sending kotlin-multiplatform
class :test:data-mocks kotlin-multiplatform
class :data:network-model kotlin-multiplatform
class :test:mocks kotlin-multiplatform
class :core:libsodium kotlin-multiplatform
Surfaced from shared tags and platforms — no rankings paid for.