/ziti-sdk-android

Ziti SDK for Android

Primary LanguageKotlinApache License 2.0Apache-2.0

Ziggy using the ziti-sdk-android

Ziti SDK for JVM

The Ziti SDK for Android enables developers to easily and securely connect their Android applications to backend services over OpenZiti networks.

Contents

Release Notes

Obtaining SDK

The recommended way to use the Ziti SDK for Android in your project is to add the dependency using your favorite build tool. Our artifacts are hosted on Maven Central, so add the repo and dependency to your project. Make sure to use latest version from the top of this page.

Maven

<project>
   ....
   <repositories>
      ....
      <repository>
          <snapshots>
              <enabled>false</enabled>
          </snapshots>
          <id>central</id>
          <name>Maven Central</name>
          <url>https://repo.maven.apache.org/maven2/</url>
       </repository>
   </repositories>
   ....
   <dependencies>
      ...
      <dependency>
         <groupId>org.openziti</groupId>
         <artifactId>ziti-android</artifactId>
         <version>[0,)</version>
      </dependency>
   </dependencies>
   ....
</project>

Gradle

repositories {
    ...
    jcenter()
}
...
dependencies {
   ...
   implementation 'org.openziti:ziti-android:+' // todo use fixed version
}

Building from Source

Once you check out the project from GitHub, you can build it using gradle:

./gradlew build

# install into your local maven cache
./gradlew :ziti-android:install

Features

  • allows to develop applications that connect to services on NetFoundry Ziti Service mesh
  • strong identity support
  • transparent use -- in seamless mode connections to network resources are intercepted and routed over Ziti network for any Ziti service that identity has access to
  • written in Kotlin with Java-friendly API
  • read more in our docs

Enrollment

See background here

Java SDK provides a way to enroll and generate identity file. The default identity format for Java SDK is Java KeyStore stored as .p12/.pfx files, however it can use identity JSON files generated by ziti-enroller as well.

Enrolling creates two(or more) entries in Java KeyStore:

private key entry
client SSL private key/certificate identifying the application instance. this entry is stored with ziti://<controller_addr>/<id> alias (pkcs#12 - friendly name)
rootCA
root CA certificates used to validate Ziti controller and routers

Note:

This allows enrolling and storing multiple identity keys and certificates in a single key store (pkcs#12 file). However, typically an application instance would only have a single enrollment or identity

Android Support

Easiest way to start developing on Android with Ziti is to create your repo from our template project or just look at the code for inspiration.

Getting Help

Please use these community resources for getting help. We use GitHub issues for tracking bugs and feature requests and have limited bandwidth to address them.