cnamway/kryptographer

Secure data in Android. Encryption/Decryption with AndroidKeyStore.

Kryptographer

Gradle Setup

In your project level build.gradle

allprojects {
    repositories {
        maven { url 'https://jitpack.io' }
    }
}

In your app level build.gradle

dependencies {
    implementation 'com.sonhvp:kryptographer:0.5.0'
}

By default, library uses asymmetric key with RSA/ECB/PKCS1Padding and symmetric key with AES/CBC/PKCS7Padding to encrypt/decrypt data.

API 19+	API 23+
Asymmetric Key (2048 bits)	Symmetric Key (256 bits)
RSA/ECB/PKCS1Padding	AES/CBC/PKCS7Padding

Basic Usage

Initialize in your Application.onCreate() method

class App : Application() {
    override fun onCreate() {
        super.onCreate()
        Kryptographer.initWithDefaultKeys(this@App)
    }
}

class MainActivity : AppCompatActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)

        val text = "123$%^{}@abc"
        val encryptedText = Kryptographer.defaultSymmetricKey().encrypt(text)
        val decryptedText = Kryptographer.defaultSymmetricKey().decrypt(encryptedText)
    }
}

Advanced Usage

class App : Application() {
    override fun onCreate() {
        super.onCreate()
        Kryptographer.init(this@App)

        Kryptographer.initKeys(
            this@App,
            asymmetricKey {
                alias = "MyAsymmetricKey"
                keySize = 1024
            },
            symmetricKey {
                alias = "MySymmetricKey"
                keySize = 128
            }
        )
    }
}

class MainActivity : AppCompatActivity() {
    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)

        val text = "123$%^{}@abc"
        val encryptedText = Kryptographer.getKey("MyAsymmetricKey").encrypt(text)
        val decryptedText = Kryptographer.getKey("MyAsymmetricKey").decrypt(encryptedText)
    }
}

//Get key aliases
val keyAliases = Kryptographer.getKeyAliases()

//Delete key
Kryptographer.deleteAllKeys()
Kryptographer.deleteKey("alias")

//Check if the key resides inside secure hardware
Kryptographer.getKey("MyAsymmetricKey).isInsideSecureHardware()

License

Copyright 2019 Son Huynh. Licensed under the Apache License, Version 2.0