# tencent-soter
**Repository Path**: geekcheng/tencent-soter
## Basic Information
- **Project Name**: tencent-soter
- **Description**: TENCENT SOTER是腾讯于2015年开始制定的生物认证平台与标准，通过与厂商合作，目前已经在一百余款、2.3亿部Android设备上得到支持，并且这个数字还在快速增长
- **Primary Language**: Java
- **License**: BSD-3-Clause
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 0
- **Forks**: 7
- **Created**: 2017-08-08
- **Last Updated**: 2024-06-14
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
# Hello TENCENT SOTER
[](https://github.com/Tencent/soter/blob/master/LICENSE)
[](https://github.com/Tencent/soter/releases)
[](https://github.com/Tencent/soter/pulls)
For English version, please click [here](#a-quick-look-at-tencent-soter).
## TENCENT SOTER简介
TENCENT SOTER是腾讯于2015年开始制定的生物认证平台与标准，通过与厂商合作，目前已经在一百余款、数亿部Android设备上得到支持，并且这个数字还在快速增长。
目前，TENCENT SOTER已经在微信指纹支付、微信公众号/小程序指纹授权接口等场景使用，并得到了验证。
接入TENCENT SOTER，你可以在**不获取用户指纹图案的前提下**，在Android设备上实现可信的指纹认证，获得与微信指纹支付一致的安全快捷认证体验。
## 快速接入
可以在几行代码之内快速体验TENCENT SOTER完成指纹授权接口。
在使用之前，请确保所使用的测试机在[支持机型列表](http://mp.weixin.qq.com/s/IRI-RCGsVB2WiPwUCGcytA)中。
### 添加gradle依赖
在项目的`build.gradle`中，添加TENCENT SOTER依赖
```groovy
dependencies {
...
compile 'com.tencent.soter:soter-wrapper:1.3.2'
...
}
```
### 声明权限
在 `AndroidManifest.xml`中添加使用指纹权限
```xml
```
### 初始化
初始化过程整个应用声明周期内只需要进行一次，用于生成基本配置和检查设备支持情况。你可以选择在`Application`的onCreate()中，或者在使用TENCENT SOTER之前进行初始化。
```java
InitializeParam param = new InitializeParam.InitializeParamBuilder()
.setScenes(0) // 场景值常量，后续使用该常量进行密钥生成或指纹认证
.build();
SoterWrapperApi.init(context,
new SoterProcessCallback() {...},
param);
```
### 准备密钥
需要在使用指纹认证之前生成相关密钥
```java
SoterWrapperApi.prepareAuthKey(new SoterProcessCallback() {...},false, true, 0, null, null);
```
### 进行指纹认证
密钥生成完毕之后，可以使用封装接口调用指纹传感器进行认证。
```java
AuthenticationParam param = new AuthenticationParam.AuthenticationParamBuilder()
.setScene(0)
.setContext(MainActivity.this)
.setFingerprintCanceller(mSoterFingerprintCanceller)
.setPrefilledChallenge("test challenge")
.setSoterFingerprintStateCallback(new SoterFingerprintStateCallback() {...}).build();
SoterWrapperApi.requestAuthorizeAndSign(new SoterProcessCallback() {...}, param);
```
### 释放
当你不再使用TENCENT SOTER时，可以选择释放所有资源，用于停止所有生成、上传任务以及支持状态等。释放之后再次使用时，需要重新进行初始化。 实际上，TENCENT SOTER本身不会占据过多资源，只需要在确认不会再次使用的前提下（如切换账户之前）释放一次即可。
```java
SoterWrapperApi.release();
```
## 更多文档
* 想了解TENCENT SOTER更多信息与原理？看[这里](https://github.com/Tencent/soter/wiki)。
* 想要更高的安全性，用于登录甚至支付场景中？看[这里](https://github.com/Tencent/soter/wiki/%E5%AE%89%E5%85%A8%E6%8E%A5%E5%85%A5)。
## 贡献代码
我们欢迎开发者贡献代码丰富TENCENT SOTER应用，请参考[这个文档](./CONTRIBUTING.md)。
## 协议
TENCENT SOTER基于BSD协议。请参考[协议文档](./LICENSE)。
## A Quick Look at TENCENT SOTER
TENCENT SOTER is a biometric standard as well as a platform held by Tencent.
There are more than 100 models, hundreds of millions Android devices supporting TENCENT SOTER, and the number is still increasing fast.
TENCENT SOTER has been already used in scenarios like WeChat fingerprint payment, fingerprint authentication in Official Account Webpages and Mini Programs.
You can get a consistent experience in fingerprint authenticating in your application, like what it is like in WeChat Payment, by getting access to TENCENT SOTER.
## Quick Start
You can get access to TENCENT SOTER in few lines of code to quick experience.
You should make sure your device for testing is in [support list](http://mp.weixin.qq.com/s/IRI-RCGsVB2WiPwUCGcytA).
### Add Gradle Dependency
Add TENCENT SOTER dependency in your project's `build.gradle`
```groovy
dependencies {
...
compile 'com.tencent.soter:soter-wrapper:1.3.2'
...
}
```
### Declare Permission
Add fingerprint permission declaration in `AndroidManifest.xml`
```xml
```
### Initialize
You need to initialize only once in application's lifecycle. You can either do it in `Application`'s `onCreate()`, or anywhere before you need to use TENCENT SOTER.
```java
InitializeParam param = new InitializeParam.InitializeParamBuilder()
.setScenes(0) // The senary constant for business index
.build();
SoterWrapperApi.init(context,
new SoterProcessCallback() {...},
param);
```
### Prepare Keys
You need to prepare keys before authentication process.
```java
SoterWrapperApi.prepareAuthKey(new SoterProcessCallback() {...},false, true, 0, null, null);
```
### Authenticate With Fingerprint
You can use wrapped interface to authenticate when fingerprint.
```java
AuthenticationParam param = new AuthenticationParam.AuthenticationParamBuilder()
.setScene(0)
.setContext(MainActivity.this)
.setFingerprintCanceller(mSoterFingerprintCanceller)
.setPrefilledChallenge("test challenge")
.setSoterFingerprintStateCallback(new SoterFingerprintStateCallback() {...}).build();
SoterWrapperApi.requestAuthorizeAndSign(new SoterProcessCallback() {...}, param);
```
### Release
You can release all the resource when you do not use TENCENT SOTER again by calling release. It will abort on-going tasks and remove support status. TENCENT SOTER will not occupy too much room actually. You can only do it when you confirm that you did not need to use it, like switch an account.
```java
SoterWrapperApi.release();
```
## More Document
- Want to know more about TENCENT SOTER's mechanism? Check [this](https://github.com/Tencent/soter/wiki).
- Want to use TENCENT SOTER in more sensitive business scenarios like login, or even payment? Check [this](https://github.com/Tencent/soter/wiki).
## Contributing
For more information about contributing issues or pull requests, check our [CONTRIBUTING document](./CONTRIBUTING.md).
## License
TENCENT SOTER is based on BSD license. Please check our [LICENSE document](./LICENSE).