PFLockScreen

Additional

Language
Java
Version
1.0.0-beta5 (Apr 30, 2019)
Created
Feb 14, 2018
Updated
Aug 3, 2019
Owner
Aleksandr Nikiforov (thealeksandr)
Contributors
Aleksandr Nikiforov (thealeksandr)
Maikuolan
2
Activity
Badge
Generate
Download
Source code
APK file

Announcement

PFLockScreen-Android

Feel free to ask questions add issues. If I don't respond to an issue or PR, feel free to ping me or send me Direct Message on twitter @thealeksandr. If you create issue it would be nice if you SUBSCRIBE FOR UPDATES. So we can discuss it.

Please support with a Star :D

Beta 5 Update - Landscape Orientation Support (April 29, 2019)

  • Added UI for Landscape orientation
  • Optional vibration for wrong code
  • Optional animation for wrong code
  • Fix bug with Next button

Min SDK Version - 15

PFLockScreen - Lock Screen Library for Android Application. Library support pin code and fingerprint authorization for API level 23+.

Add library to your project

allprojects {
 repositories {
  ...
  maven { url 'https://jitpack.io' }
 }
}
dependencies {
 compile 'com.github.thealeksandr:PFLockScreen-Android:1.0.0-beta5'
}

Create pin code

Creating lock screen fragment in create mode.

PFLockScreenFragment fragment = new PFLockScreenFragment();
PFFLockScreenConfiguration.Builder builder = new PFFLockScreenConfiguration.Builder(this)
    .setMode(PFFLockScreenConfiguration.MODE_CREATE);
fragment.setConfiguration(builder.build());
fragment.setCodeCreateListener(new PFLockScreenFragment.OnPFLockScreenCodeCreateListener() {
 @Override
  public void onCodeCreated(String encodedCode) {
  //TODO: save somewhere;
 }
});
//TODO: show fragment;

After user created pin code. The library will encode it using Android Key Store and return an encoded string in PFLockScreenFragment.OnPFLockScreenCodeCreateListener. All you have to do is save encoded string somewhere - database, SharedPreferences, Android Account etc.

Show authorization screen

Creating lock screen fragment in authorization mode is same as in creation mode, but instead of MODE_CREATE use MODE_AUTH.

PFFLockScreenConfiguration.Builder(this).setMode(PFFLockScreenConfiguration.MODE_AUTH);

Configure screen

PFFLockScreenConfiguration.Builder builder = new PFFLockScreenConfiguration.Builder(this)
            .setTitle("Unlock")
            .setUseFingerprint(true).
            .setMode(PFFLockScreenConfiguration.MODE_AUTH)
            .setCodeLength(6)
            .setLeftButton("Can't remeber",
               new View.OnClickListener() {
                  @Override
                    public void onClick(View v) {

                    }
                });

setTitle(String) - set custom string on the top of the screen. setUseFingerprint(boolean) - by default fingerprint button will be shown for all device 23+ with a fingerprint sensor. If you don't want use fingerprint at all set false. setMode(PFLockScreenMode) - MODE_CREATE or MODE_AUTH. See details above. setCodeLength(int) - set the length of the pin code. By default, length is 4. Minimum length is 4. setLeftButton(String, View.OnClickListener) - set string for the left button and ClickListener.

Check if pin code encryption key exist

boolean isExist = PFSecurityManager.getInstance().getPinCodeHelper().isPinCodeEncryptionKeyExist();

An encryption key is needed to encode/decode pin code and stored in Android KeyStore.

Delete pin code encryption key.

You need to delete encryption key if you delete/reset pin code.

PFSecurityManager.getInstance().getPinCodeHelper().delete();

Don't use PFFingerprintPinCodeHelper.getInstance().isPinCodeExist() directly.

PFPinCodeViewModel

Also you can use PFPinCodeViewModel() for the same methods. ViewModel wrapper around PinCodeHelper that returns LiveData objects.

Custom encryption. NEW! NEW! NEW!

Now you can create your custom encryption if for some reasons the one I have doesn't meet your app requarements:

You need to override java IPFPinCodeHelper interface. That has four methods:

void encodePin(Context context, String pin, PFPinCodeHelperCallback<String> callBack);     
void checkPin(Context context, String encodedPin, String pin, PFPinCodeHelperCallback<Boolean> callback);        
void delete(PFPinCodeHelperCallback<Boolean> callback);      
void isPinCodeEncryptionKeyExist(PFPinCodeHelperCallback<Boolean> callback);         

encodePin - method where you encode pin.isPinCodeEncryptionKeyExist - if you have any encryprion keys or something else you're using to encrpt your key here you check if all keys you need are exists. Haven't beed deleted or anyting. This method is only for your own logic. Basically to check if you're code can be decrypted.delete - deletePinCode and all related stuff.
checkPin - to check if pin is valid.


All methods take callback as a parameter in case if you want implement something async like server side or whatever.

UI Customization

You can customize buttons, backgrounds, etc. To do that, use attributes in your activity theme:

pf_key_button - style object for key buttons (0-9) pf_lock_screen - style object for the background. Use it to set custom background. pf_fingerprint_button - style object for fingerprint button. You can set custom drawable, paddings, etc. pf_delete_button - style object for delete/backspace button. You can set custom drawable, paddings, etc. pf_code_view - style object to customize code view. (The view from the top of the screen). The view itself is set of check boxes. To customize it use a custom selector with checked states.pf_hint (NEW) - style object for hint button (Can't remember).pf_next (NEW) - style object for next button.
pf_title (NEW) - style object for title.


Examples:

 <style name="AppTheme" parent="Theme.AppCompat.Light.NoActionBar">
    <!-- Some of your styles. -->
    <item name="pf_key_button">@style/MyLockScreenButtonStyle</item>
    <item name="pf_fingerprint_button">@style/MyLockScreenFingerprintButtonStyle</item>
    <item name="pf_delete_button">@style/MyLockScreenDeleteButtonStyle</item>
    <item name="pf_lock_screen">@style/MyLockScreenStyle</item>
    <item name="pf_code_view">@style/MyLockScreenCodeStyle</item>
</style>


 <style name="MyLockScreenStyle">
    <item name="android:background">@drawable/screen_background</item>
</style>

<style name="MyLockScreenButtonStyle">
    <item name="android:textColor">@android:color/white</item>
    <item name="android:textSize">18dp</item>
    <item name="android:foreground">@drawable/key_foreground</item>
</style>

<style name="MyLockScreenFingerprintButtonStyle">
    <item name="android:src">@drawable/fingerprint_icon</item>
</style>

<style name="MyLockScreenDeleteButtonStyle">
    <item name="android:src">@drawable/delete_lockscreen</item>
</style>

<style name="MyLockScreenCodeStyle">
    <item name="android:button">@drawable/code_selector</item>
</style>

<style name="MyLockNextButtonStyle">
    <item name="android:textColor">#9FFF</item>
    <item name="android:textSize">18dp</item>
    <item name="android:background">@null</item>
    <item name="android:layout_margin">20dp</item>
</style>

<style name="MyLockTitleStyle">
    <item name="android:textColor">#FFF</item>
</style>

<style name="MyLockHintStyle">
    <item name="android:textColor">#FFF</item>
</style>

If you want just a bit correct an existing styles you can override:

PFLockScreenStyle
PFLockScreenButtonStyle
PFLockScreenFingerPrintButtonStyle
PFLockScreenDeleteButtonStyle
PFCheckBox
PFLockScreenCodeStyle
PFLockScreenNextTextStyle
PFLockScreenHintTextStyle
PFLockScreenTitleTextStyle

The only important thing you can't change right now is the size of keys. But it's coming.

Feel free to ask questions add issues. If I don't respond to an issue or PR, feel free to ping me or send me DM on twitter @thealeksandr. If you create issue it would be nice if you subscribe for updates. So we can discuss it.