MiHawk 🦅👁️ is simple and secure 🔒 Android Library to store and retrieve pair of key-value data with encryption , internally it use jetpack DataStore Preferences 💽 to store data.

Nedal Hasan Ibrahem

Last update: Sep 3, 2022

Related tags

Security & Decompiler android serialization key-value kotlin-android kotlin-coroutines encryption-decryption datastore-android

Overview

MiHawk

MiHawk 🦅 👁️ is simple and secure 🔒 Android Library to store and retrieve pair of key-value data with encryption , internally it use jetpack DataStore Preferences 💽 to store data.

Usage

Dependency

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

//Include the library in your build.gradle.YOUR_MODULE
dependencies {
   implementation 'com.github.nedaluof:MiHawk:1.0.0'
}

 - init MiHawk:
   MiHawk.init(context) //must called before any use of MiHawk else RuntimeException will be thrown
 
 - put data to MiHawk:
   MiHawk.put(key: String, value: T)
 
- get data from MiHawk:
  MiHawk.get(key: String, result: (T?) -> Unit)
  OR with default value:
  MiHawk.get(key: String, defaultValue: T,  result: (T?) -> Unit)
 
- remove data from MiHawk:
  MiHawk.remove(key: String, result: (Boolean) -> Unit)
 
- to check if data exist in MiHawk by key:
  MiHawk.contains(key: String, result: (Boolean) -> Unit)

- to delete all data saved in MiHawk:
  MiHawk.deleteAll(result: (Boolean) -> Unit)

Coming channgeess / Todos

Replace GSON with Moshi.
Make the MiHawk customizable.
Replace Facebook Conceal with alternative encryption algorithm.
Provide heavy unit test.
Provide simple UI that simulate the inputs to test.

License

Copyright 2021 Nedal Hasan ABDALLAH (NedaluOf)

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an 
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
either express or implied. See the License for the specific 
language governing permissions and limitations under the License.

~ Inspired from Hawk Library. ~

Create one-time links for securely sending data

Dead Drop Service Send One-Time Secrets in a secure way A Dead Drop service written in Kotlin / KTor. This service uses sjcl on client-side to encrypt

5 Jan 27, 2022

A simple android app that parses its own signature and displays it

SigDisplayer Usage Download the release APK or clone the repository and compile yourself. Sign the APK with your preferred keystore. Install and open

5 Oct 18, 2022

AndroidHybridCrypto is simple customizable Android implementation of hybrid cryptography (AES+RSA+Hash) recommended by OWASP.

AndroidHybridCrypto HybridCrypto is simple customizable Android implementation of hybrid cryptography (AES+RSA+Hash) recommended by OWASP. Usage Step

2 Sep 6, 2022

🔓 Kotlin version of the popular google/easypermissions wrapper library to simplify basic system permissions logic on Android M or higher.

327 Dec 30, 2022

Dex manipulation library

dexterity Description dexterity is a C library intended for manipulation and analysis of DEX files. It has python bindings for all basic DEX structure

93 Nov 25, 2022

Releases(1.2.2)

1.2.2(Sep 20, 2022)

Replacing old encryption methods

remove Facebook Conceal library

Adding MiAesCipherManager to handle encryption/decryption processes.
Source code(tar.gz)
Source code(zip)
1.1.2(Jun 18, 2022)
bugs fixed

introduce MiHawak Builder to make the library more customizable

Source code(tar.gz)
Source code(zip)
1.0.1(May 9, 2022)

Source code(tar.gz)
Source code(zip)
1.0.0(Dec 17, 2021)

initial release of MiHawk
Source code(tar.gz)
Source code(zip)