Setup and Configuration

Adding the CX Library to your project

The library is available on Maven Central, so you can include it in your app the same way you include any other library. It is under the name com.privakey.cx:android, and the current version is 2.0.0. For instance, you can add it the following way:

Open build.gradle
Under dependencies, add: implementation 'com.privakey.cx:android:2.0.0'
Ensure you are reading from maven central. Under repositories, add mavenCentral()
Sync gradle

You should now have be able to use the PrivakeyCX library.

Library Configuration

After the CX aar has been added to the project it will need to be configured to point at your PrivakeyCX server. Other configuration options are Retrofit2 Connect time, read timeout, write timeout, The JWT validity period, and the Library log level.

These values are part of a file called privakey_config.properties. This file needs to be added to the applications res directory.

Right click res -> new -> Android Resource Directory
In the New Resource Directory dialog, set the name to raw, type raw and source set main.
Place the privakey_config.properties inside the newly created raw directory.

#The URL of your Privakey Instance. Must end with a /
PRIVAKEY_URL=https://<your.root.cx.server.domain>/

#HTTP Client Time Values, in seconds
CONNECT_TIME=60
READ_TIMEOUT=60
WRITE_TIMEOUT=60

#JWT Validity Minutes
JWT_VALIDITY_MINUTES=30

#Log Levels: -1:NONE, 0:ERROR, 1:WARN, 2:INFO, 3:DEBUG, 4:VERBOSE
LOG_LEVEL=4

Proguard

If you are using Proguard on your project you need to add the proguard rules for GSON, JJWT, OKHTTP, Retrofit2, and Retrofit Jackson. These rules may change depending on the release version and you should view the github or support sites for each dependency to keep up with the new Proguard rules.

Example

Below is an example of a proguard-rules.pro at the time this document was published

# Add project specific ProGuard rules here.
# You can control the set of applied configuration files using the
# proguardFiles setting in build.gradle.
#
# For more details, see
#   http://developer.android.com/guide/developing/tools/proguard.html

# If your project uses WebView with JS, uncomment the following
# and specify the fully qualified class name to the JavaScript interface
# class:
-keepclassmembers class fqcn.of.javascript.interface.for.webview {
   public *;
}

# Uncomment this to preserve the line number information for
# debugging stack traces.
#-keepattributes SourceFile,LineNumberTable

# If you keep the line number information, uncomment this to
# hide the original source file name.
#-renamesourcefileattribute SourceFile
-optimizationpasses 5

#When not preverifing in a case-insensitive filing system, such as Windows. Because this tool unpacks your processed jars, you should then use:
-dontusemixedcaseclassnames

#Specifies not to ignore non-public library classes. As of version 4.5, this is the default setting
-dontskipnonpubliclibraryclasses

#Preverification is irrelevant for the dex compiler and the Dalvik VM, so we can switch it off with the -dontpreverify option.
-dontpreverify

#The -optimizations option disables some arithmetic simplifications that Dalvik 1.0 and 1.5 can't handle. Note that the Dalvik VM also can't handle aggressive overloading (of static fields).
#To understand or change this check http://proguard.sourceforge.net/index.html#/manual/optimizations.html
-optimizations !code/simplification/arithmetic,!field/*,!class/merging/*,!code/allocation/variable

#Annotations for greendao and LineNumber for reports in play store
-keepattributes *Annotation*,LineNumberTable,InnerClasses,EnclosingMethod,EnclosingMethod,Signature

-keep class com.google.android.gms.measurement.** { *; }
-dontwarn com.google.android.gms.measurement.**

# Serializables
-keepnames class * implements java.io.Serializable

-keepclassmembers class * implements java.io.Serializable {
    static final long serialVersionUID;
    private static final java.io.ObjectStreamField[] serialPersistentFields;
    !static !transient <fields>;
    !private <fields>;
    !private <methods>;
    private void writeObject(java.io.ObjectOutputStream);
    private void readObject(java.io.ObjectInputStream);
    java.lang.Object writeReplace();
    java.lang.Object readResolve();
}

-keepclassmembers enum * {
    public static **[] values();
    public static ** valueOf(java.lang.String);
    public static ** getStatusId();
}

#Keep R
-keepclassmembers class **.R$* {
    public static <fields>;
}

#Jackson converted for retrofit
-keepnames class com.fasterxml.jackson.** { *; }
-keepnames class com.fasterxml.jackson.databind.** { *; }
-keepnames interface com.fasterxml.jackson.** { *; }
-dontwarn com.fasterxml.jackson.databind.**
-keep class org.codehaus.** { *; }

#retrofit2
-dontwarn retrofit2.**
-keep class retrofit2.** { *; }
-keepclasseswithmembers class * {
    @retrofit2.http.* <methods>;
}

#Gson
# Prevent proguard from stripping interface information from TypeAdapterFactory,
# JsonSerializer, JsonDeserializer instances (so they can be used in @JsonAdapter)
-keep class * implements com.google.gson.TypeAdapterFactory
-keep class * implements com.google.gson.JsonSerializer
-keep class * implements com.google.gson.JsonDeserializer
# Gson specific classes
-dontwarn sun.misc.**
#-keep class com.google.gson.stream.** { *; }

#OKHTTP
# OkHttp
-keep class com.squareup.okhttp.** { *; }
-keep interface com.squareup.okhttp.** { *; }
-dontwarn com.squareup.okhttp.**

#io.jsonwebtoken.jjwt
-keep class org.bouncycastle.** { *; }
-keepnames class org.bouncycastle.** { *; }
-dontwarn org.bouncycastle.**

-keep class io.jsonwebtoken.** { *; }
-keepnames class io.jsonwebtoken.* { *; }
-keepnames interface io.jsonwebtoken.* { *; }
-dontwarn javax.xml.bind.DatatypeConverter
-dontwarn io.jsonwebtoken.impl.Base64Codec

#BEGIN Exposed CX items
#We really shouldnt expose the entities. They are used as copy paste for whitelabel.
-keep class com.privakey.cx.core.database.model.** {*;}
-keep class com.privakey.cx.core.database.entity.** {*;}
-keep class com.privakey.cx.core.network.models.** {*;}
-keep class com.privakey.cx.callbacks.* {*;}
-keep class com.privakey.cx.Constants {*;}
#Release the constants with Exceptions.
-keep class com.privakey.cx.Constants$CallbackErrorStrings {*;}
-keep class com.privakey.cx.Constants$CallbackSuccessStrings {*;}
-keep class com.privakey.cx.PrivakeyBiometricAuthenticationHelper {*;}
-keep class com.privakey.cx.BiometricAuthenticationHelper { *; }
-keep interface com.privakey.cx.BiometricAuthenticationHelper$BiometricAuthenticationCallback {*;}
-keep class com.privakey.cx.messaging.PrivakeyMessagingService {*;}
-keep class com.privakey.cx.PrivakeyCX { *; }
#END Exposed CX items