Secure Preference Manager

Secure Preference Manager for android. It uses various Encryption to protect your application's Shared Preferences.

Code Quality Rank: L5

Programming language: Java

License: Apache License 2.0

Tags: Utility    

Latest version: v1.0.0

README

Secure-Pref-Manager

Secure Preference Manager is a simple Library to help you protect your Shared Preferences.

Secure Preference Manager for android. It uses various encryption techniques to protect your application's Shared Preferences.

Setup

Add jitpack to your project’s repositories.

repositories {
        // ...
        maven { url "https://jitpack.io" }
    }

Then add Secure-Pref-Manager to your Module’s dependencies

dependencies {
            compile 'com.github.prashantsolanki3:Secure-Pref-Manager:0.25'
    }

Usage

Initialize SecurePrefManager anywhere before using it.

• Basic Initialization

       new SecurePrefManagerInit.Initializer(getApplicationContext())
               .initialize();

• Recommended Initialization
  • AES Encryption by Default.
  • Auto Generated Key.

       new SecurePrefManagerInit.Initializer(getApplicationContext())
               .useEncryption(true)
               .initialize();

• Advance Initialization: Only if you wanna add Custom Encryption Methods.

       new SecurePrefManagerInit.Initializer(getApplicationContext())
               .useEncryption(true)
               .setCustomEncryption(new Encryptor(getApplicationContext()) {
                   @Override
                   public String encrypt(String s) throws Exception {
                       // Your Encryption Algorithm
                       return encryptedString;
                   }

                   @Override
                   public String decrypt(String s) throws Exception {
                       // Your Decryption Algorithm
                       return decryptedString;
                   }
               })
               .initialize();

Adding and Retrieving Preferences

• Adding

      SecurePrefManager.with(this)
              .set("user_name")
              .value("LoremIpsum")
              .go();
  

• Retrieving

        String userName = SecurePrefManager.with(this)
                .get("user_name")
                .defaultValue("unknown")
                .go();

Hide Preferences from 3rd Party applications (EXPERIMENTAL)

• Unhide Preferences when the activity starts

  @Override
  protected void onStart() {
      super.onStart();
      SecurePrefManager.with(getApplicationContext())
              .unhide(new HidePreferences.PreferenceUpdateListener() {
                  @Override
                  public void onFailure() {
                      Log.d("unhiding", "Failed");
                  }
  
                  @Override
                  public void onProgress(int p, int max) {
                      Log.d("unhiding", "Progress: " + p + "/" + max);
                  }
  
                  @Override
                  public void onSuccess() {
                      Log.d("unhiding", "Success");
                  }
              });
  }
  

• Hide preferences when leaving the activity

@Override
    protected void onPause() {
        SecurePrefManager.with(getApplicationContext())
                .hide(new HidePreferences.PreferenceUpdateListener() {
                    @Override
                    public void onFailure() {

                    }

                    @Override
                    public void onProgress(int p, int max) {

                    }

                    @Override
                    public void onSuccess() {

                    }
                });
    }

Have Fun!