FingerprintAuthHelper - GitLite

KO | EN

gitlite — search

#hacktoberfest #ai #llm #android #rust #linux #docker #macos #java #cli #vue #awesome-list #openai #open-source

FingerprintAuthHelper

(★ 443)

A small library that allows You to easily manage fingererprint authentication inside your Activity or Fragment on devices with fingerprint scanner and Android M and higher. Min sdk 14

파일 탐색기

최종 버전 다운로드 (.zip)

- .gitignore
- build.gradle
- proguard-rules.pro
- - gradle-wrapper.jar
  - gradle-wrapper.properties
- - workspace.xml
- .gitignore
- build.gradle
- proguard-rules.pro
- sample-release.apk
- sc_0.png
- sc_1.png
.gitignore
build.gradle
Docs.md
gradle.properties
gradlew
gradlew.bat
README.md
settings.gradle

# 설치 가이드

1. 코드 내려받기

git clone https://github.com/pro100svitlo/FingerprintAuthHelper

깃허브에서 프로젝트 코드 전체를 내 컴퓨터로 내려받습니다.

cd FingerprintAuthHelper

방금 내려받은 프로젝트 폴더 안으로 이동합니다.

2. Gradle (Java/Kotlin)

보통 추천

사전 준비물

Git GitHub에서 프로젝트 코드를 내려받으려면 필요합니다.
JDK (Java) Java/Kotlin 프로젝트를 빌드/실행하려면 필요합니다.
Gradle 레포에 포함된 gradlew(Gradle Wrapper)를 쓰면 Gradle을 따로 설치할 필요가 없습니다.

1. updated gradle version, Android SDK, .gitignore, kotlin version

Gradle로 빌드를 진행합니다.

✅ BUILD SUCCESSFUL 메시지가 뜨면 성공입니다. build/ 폴더에 결과물이 생성됩니다.

이 레포의 README에 적힌 실제 명령어를 그대로 가져왔습니다.

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# FingerprintAuthHelper
A small library that allows You to easily manage fingererprint authentication inside your Activity or Fragment on devices with fingerprint scanner and Android M and higher.
Min sdk version 14.

1. [Demo app](https://play.google.com/store/apps/details?id=com.pro100svitlo.fingerprintauthdemo)
2. [Usage](#usage)
3. [Documentation](Docs.md)
4. [ChangeLog](#changelog)
5. [Questions and help](#questions-and-help)
6. [License](#license)

![alt text](https://raw.githubusercontent.com/pro100svitlo/FingerprintAuthHelper/master/screenshots/sc_0.png "Touch sensor")
![alt text](https://raw.githubusercontent.com/pro100svitlo/FingerprintAuthHelper/master/screenshots/sc_1.png "Try in")

# Usage
##### Add the dependencies to your gradle file:
```sh
    dependencies {
        compile 'com.github.pro100svitlo:fingerprintAuthHelper:1.3.0'
    }
```

##### Inside your activity or fragment:

```sh

private FingerprintAuthHelper mFAH;

@Override
    protected void onCreate(Bundle savedInstanceState) {
    ...
        mFAH = new FingerprintAuthHelper
                .Builder(this, this) //(Context inscance of Activity, FahListener)
                .build();

if (mFAH.isHardwareEnable()){
            //do some stuff here
        } else {
            //otherwise do
        }
    }

...

@Override
    protected void onResume() {
        super.onResume();
        mFAH.startListening();
    }

...

@Override
    protected void onStop() {
        super.onStop();
        mFAH.stopListening();
    }

...

@Override
    protected void onDestroy() {
        super.onDestroy();
        mFAH.onDestroy();
    }

@Override
    public void onFingerprintStatus(boolean authSuccessful, int errorType, CharSequence errorMess) {
        // authSuccessful - boolean that shows auth status
        // errorType - if auth was failed, you can catch error type
        // errorMess - if auth was failed, errorMess will tell you (and user) the reason

if (authSuccessful){
            // do some stuff here in case auth was successful
        } else if (mFAH != null){
          // do some stuff here in case auth failed
            switch (errorType){
                case FahErrorType.General.LOCK_SCREEN_DISABLED:
                case FahErrorType.General.NO_FINGERPRINTS:
                    mFAH.showSecuritySettingsDialog();
                    break;
                case FahErrorType.Auth.AUTH_NOT_RECOGNIZED:
                    //do some stuff here
                    break;
                case FahErrorType.Auth.AUTH_TO_MANY_TRIES:
                    //do some stuff here
                    break;
            }
        }
    }

@Override
    public void onFingerprintListening(boolean listening, long milliseconds) {
        // listening - status of fingerprint listen process
        // milliseconds - timeout value, will be > 0, if listening = false & errorType = AUTH_TO_MANY_TRIES

if (listening){
            //add some code here
        } else {
            //add some code here
        }
        if (milliseconds > 0) {
            //if u need, u can show timeout for user
        }
    }
```
That's pretty much all what you need to start the work!
Full documentation and all options descriptions you can find [here](Docs.md).

---

### ChangeLog
* v.1.3.0 //great thanks [Boris Rosenow](https://github.com/Bombo) for helping with this release!
    1. kotlin style refactoring
    2. fix bug with multiple calling tryToStopMe()
    3. some library API updates (add few new and few deprecated methods)
* v.1.2.2
    1. updated gradle version, Android SDK, .gitignore, kotlin version
    1. fixed known issue with Samsung firmware
* v.1.2.1
    1. refactoring
* v.1.2.0
    1. stability improvements
* v.1.1.7
    1. new function cleanTimeOut() - in case you authinticate with other method. More details in [docs](Docs.md).
    2. remove possibility to set max try count (becouse Fingerprint API update :)
    3. now on Kotlin :)
    4. refactoring
* v.1.1.5
    1. refactoring
    2. small bugfix
* v.1.1.4
    1. fix crashes on Sumsung devices
    2. add method isFingerprintEnrolled() to FingerprintAuthHelper
    3. small bugfix
* v.1.1.3
    1. init context must be instance of Activity
    2. add method showSecuritySettingsDialog() to FingerprintAuthHelper
    3. add help error
* v.1.1.2
    1. add possibility to set max count of tries

### Questions and help
If you have some problems with using this library or something doesn't work correctly - just write me an email and describe your question or problem. I will try to do my best to help you and fix the problem if it exists. Here is my email: pro100svitlo@gmail.com. Or you also can leave an [issue here](https://github.com/pro100svitlo/FingerprintAuthHelper/issues).

### License
The MIT License (MIT)

Copyright (c) 2016 FingerprintAuthHelper

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.