diff --git a/packages/uni-api/src/index.ts b/packages/uni-api/src/index.ts index f32a721a4c70f6c8066feb12d9e5d8346ffa3981..ce2ae1d39934a3e1c24459372366bbce39a78d68 100644 --- a/packages/uni-api/src/index.ts +++ b/packages/uni-api/src/index.ts @@ -31,6 +31,7 @@ export * from './protocols/device/vibrate' export * from './protocols/device/bluetooth' export * from './protocols/device/ibeacon' export * from './protocols/device/brightness' +export * from './protocols/device/soterAuthentication' export * from './protocols/storage/storage' diff --git a/packages/uni-api/src/protocols/device/soterAuthentication.ts b/packages/uni-api/src/protocols/device/soterAuthentication.ts new file mode 100644 index 0000000000000000000000000000000000000000..9f055df6bae2625981e755b2b047f9e2aef4276d --- /dev/null +++ b/packages/uni-api/src/protocols/device/soterAuthentication.ts @@ -0,0 +1,50 @@ +export const API_CHECK_IS_SUPPORT_SOTER_AUTHENTICATION = 'soterAuthentication' +export type API_TYPE_CHECK_IS_SUPPORT_SOTER_AUTHENTICATION = + typeof uni.checkIsSupportSoterAuthentication + +export const API_CHECK_IS_SOTER_ENROLLED_IN_DEVICE = + 'checkIsSoterEnrolledInDevice' +export type API_TYPE_CHECK_IS_SOTER_ENROLLED_IN_DEVICE = + typeof uni.checkIsSoterEnrolledInDevice +export type CheckIsSoterEnrolledInDeviceCheckAuthMode = + Parameters[0]['checkAuthMode'] +const CheckAuthModes: CheckIsSoterEnrolledInDeviceCheckAuthMode[] = [ + 'fingerPrint', + 'facial', + 'speech', +] +export const CheckIsSoterEnrolledInDeviceOptions: ApiOptions = + { + formatArgs: { + checkAuthMode(value, params) { + if (!value || !CheckAuthModes.includes(value)) + return 'checkAuthMode 填写错误' + }, + }, + } +export const CheckIsSoterEnrolledInDeviceProtocols: ApiProtocol = + { + checkAuthMode: String as any, + } + +export const API_START_SOTER_AUTHENTICATION = 'checkIsSoterEnrolledInDevice' +export type API_TYPE_START_SOTER_AUTHENTICATION = + typeof uni.startSoterAuthentication +export const StartSoterAuthenticationOptions: ApiOptions = + { + formatArgs: { + requestAuthModes(value, params) { + if (!value.includes('fingerPrint') && !value.includes('facial')) + return 'requestAuthModes 填写错误' + }, + }, + } +export const StartSoterAuthenticationProtocols: ApiProtocol = + { + requestAuthModes: { + type: Array, + required: true, + }, + challenge: String, + authContent: String, + } diff --git a/packages/uni-app-plus/src/service/api/device/soterAuthentication.ts b/packages/uni-app-plus/src/service/api/device/soterAuthentication.ts new file mode 100644 index 0000000000000000000000000000000000000000..f192e1bfefb548315dd8ea5c01cddccd7cf1538a --- /dev/null +++ b/packages/uni-app-plus/src/service/api/device/soterAuthentication.ts @@ -0,0 +1,308 @@ +import { extend } from '@vue/shared' +import { requireNativePlugin } from '../../api/base/requireNativePlugin' +import { + useI18n, + initI18nStartSoterAuthenticationMsgsOnce, +} from '@dcloudio/uni-core' +import { + defineAsyncApi, + API_CHECK_IS_SUPPORT_SOTER_AUTHENTICATION, + API_TYPE_CHECK_IS_SUPPORT_SOTER_AUTHENTICATION, + CheckIsSoterEnrolledInDeviceCheckAuthMode, + API_CHECK_IS_SOTER_ENROLLED_IN_DEVICE, + API_TYPE_CHECK_IS_SOTER_ENROLLED_IN_DEVICE, + CheckIsSoterEnrolledInDeviceOptions, + CheckIsSoterEnrolledInDeviceProtocols, + API_START_SOTER_AUTHENTICATION, + API_TYPE_START_SOTER_AUTHENTICATION, + StartSoterAuthenticationOptions, + StartSoterAuthenticationProtocols, +} from '@dcloudio/uni-api' + +function checkIsSupportFaceID() { + const platform = plus.os.name!.toLowerCase() + if (platform !== 'ios') { + return false + } + const faceID = requireNativePlugin('faceID') + return !!(faceID && faceID.isSupport()) +} + +function checkIsSupportFingerPrint() { + return !!(plus.fingerprint && plus.fingerprint.isSupport()) +} + +const baseCheckIsSupportSoterAuthentication = ( + resolve?: (...args: any) => void +) => { + const supportMode: UniApp.SoterAuthModes[] = [] + if (checkIsSupportFingerPrint()) { + supportMode.push('fingerPrint') + } + if (checkIsSupportFaceID()) { + supportMode.push('facial') + } + resolve && + resolve({ + supportMode, + }) + return { + supportMode, + errMsg: 'checkIsSupportSoterAuthentication:ok', + } +} +export const checkIsSupportSoterAuthentication = + defineAsyncApi( + API_CHECK_IS_SUPPORT_SOTER_AUTHENTICATION, + (_, { resolve, reject }) => { + baseCheckIsSupportSoterAuthentication(resolve) + } + ) + +const basecheckIsSoterEnrolledInDevice = ({ + checkAuthMode, + resolve, + reject, +}: { + checkAuthMode: CheckIsSoterEnrolledInDeviceCheckAuthMode + resolve?: (...args: any) => void + reject?: (errMsg: string, errRes?: any) => void +}) => { + const wrapReject = (errMsg: string, errRes?: any) => + reject && reject(errMsg, ...errRes) + const wrapResolve = (res?: any) => resolve && resolve(res) + if (checkAuthMode === 'fingerPrint') { + if (checkIsSupportFingerPrint()) { + const isEnrolled = + plus.fingerprint.isKeyguardSecure() && + plus.fingerprint.isEnrolledFingerprints() + wrapResolve({ isEnrolled }) + return { + isEnrolled, + errMsg: 'checkIsSoterEnrolledInDevice:ok', + } + } + wrapReject('not support', { isEnrolled: false }) + return { + isEnrolled: false, + errMsg: 'checkIsSoterEnrolledInDevice:fail not support', + } + } else if (checkAuthMode === 'facial') { + if (checkIsSupportFaceID()) { + const faceID = requireNativePlugin('faceID') + const isEnrolled = + faceID && faceID.isKeyguardSecure() && faceID.isEnrolledFaceID() + wrapResolve({ isEnrolled }) + return { + isEnrolled, + errMsg: 'checkIsSoterEnrolledInDevice:ok', + } + } + wrapReject('not support', { isEnrolled: false }) + return { + isEnrolled: false, + errMsg: 'checkIsSoterEnrolledInDevice:fail not support', + } + } + wrapReject('not support', { isEnrolled: false }) + return { + isEnrolled: false, + errMsg: 'checkIsSoterEnrolledInDevice:fail not support', + } +} +export const checkIsSoterEnrolledInDevice = + defineAsyncApi( + API_CHECK_IS_SOTER_ENROLLED_IN_DEVICE, + ({ checkAuthMode }, { resolve, reject }) => { + basecheckIsSoterEnrolledInDevice({ checkAuthMode, resolve, reject }) + }, + CheckIsSoterEnrolledInDeviceProtocols, + CheckIsSoterEnrolledInDeviceOptions + ) + +export const startSoterAuthentication = + defineAsyncApi( + API_START_SOTER_AUTHENTICATION, + ( + { requestAuthModes, challenge = false, authContent }, + { resolve, reject } + ) => { + /* + 以手机不支持facial未录入fingerPrint为例 + requestAuthModes:['facial','fingerPrint']时，微信小程序返回值里的authMode为"fingerPrint" + requestAuthModes:['fingerPrint','facial']时，微信小程序返回值里的authMode为"fingerPrint" + 即先过滤不支持的方式之后再判断是否录入 + 微信小程序errCode（从企业号开发者中心查到如下文档）： + 0：识别成功 'startSoterAuthentication:ok' + 90001：本设备不支持SOTER 'startSoterAuthentication:fail not support soter' + 90002：用户未授权微信使用该生物认证接口 注：APP端暂不支持 + 90003：请求使用的生物认证方式不支持 'startSoterAuthentication:fail no corresponding mode' + 90004：未传入challenge或challenge长度过长（最长512字符）注：APP端暂不支持 + 90005：auth_content长度超过限制（最长42个字符）注：微信小程序auth_content指纹识别时无效果，faceID暂未测试 + 90007：内部错误 'startSoterAuthentication:fail auth key update error' + 90008：用户取消授权 'startSoterAuthentication:fail cancel' + 90009：识别失败 'startSoterAuthentication:fail' + 90010：重试次数过多被冻结 'startSoterAuthentication:fail authenticate freeze. please try again later' + 90011：用户未录入所选识别方式 'startSoterAuthentication:fail no fingerprint enrolled' + */ + initI18nStartSoterAuthenticationMsgsOnce() + const { t } = useI18n() + const supportMode = baseCheckIsSupportSoterAuthentication().supportMode + if (supportMode.length === 0) { + return { + authMode: 'fingerPrint', + errCode: 90001, + errMsg: 'startSoterAuthentication:fail', + } + } + const supportRequestAuthMode: UniApp.SoterAuthModes[] = [] + requestAuthModes.map((item, index) => { + if (supportMode.indexOf(item) > -1) { + supportRequestAuthMode.push(item) + } + }) + if (supportRequestAuthMode.length === 0) { + return { + authMode: 'fingerPrint', + errCode: 90003, + errMsg: 'startSoterAuthentication:fail no corresponding mode', + } + } + const enrolledRequestAuthMode: UniApp.SoterAuthModes[] = [] + supportRequestAuthMode.map((item, index) => { + const checked = basecheckIsSoterEnrolledInDevice({ + checkAuthMode: item, + }).isEnrolled + if (checked) { + enrolledRequestAuthMode.push(item) + } + }) + if (enrolledRequestAuthMode.length === 0) { + return { + authMode: supportRequestAuthMode[0], + errCode: 90011, + errMsg: `startSoterAuthentication:fail no ${supportRequestAuthMode[0]} enrolled`, + } + } + const realAuthMode = enrolledRequestAuthMode[0] + if (realAuthMode === 'fingerPrint') { + if (plus.os.name!.toLowerCase() === 'android') { + plus.nativeUI.showWaiting( + authContent || t('uni.startSoterAuthentication.authContent') + ).onclose = function () { + plus.fingerprint.cancel() + } + } + plus.fingerprint.authenticate( + () => { + plus.nativeUI.closeWaiting() + resolve({ + authMode: realAuthMode, + errCode: 0, + }) + }, + (e) => { + const res = { + authMode: realAuthMode, + } + switch (e.code) { + case e.AUTHENTICATE_MISMATCH: + // 微信小程序没有这个回调，如果要实现此处回调需要多次触发需要用事件publish实现 + // invoke(callbackId, { + // authMode: realAuthMode, + // errCode: 90009, + // errMsg: 'startSoterAuthentication:fail' + // }) + break + case e.AUTHENTICATE_OVERLIMIT: + // 微信小程序在第一次重试次数超限时安卓IOS返回不一致，安卓端会返回次数超过限制（errCode: 90010），IOS端会返回认证失败（errCode: 90009）。APP-IOS实际运行时不会次数超限，超过指定次数之后会弹出输入密码的界面 + plus.nativeUI.closeWaiting() + reject( + 'authenticate freeze. please try again later', + extend(res, { + errCode: 90010, + }) + ) + break + case e.CANCEL: + plus.nativeUI.closeWaiting() + reject( + 'cancel', + extend(res, { + errCode: 90008, + }) + ) + break + default: + plus.nativeUI.closeWaiting() + reject( + '', + extend(res, { + errCode: 90007, + }) + ) + break + } + }, + { + message: authContent, + } + ) + } else if (realAuthMode === 'facial') { + const faceID = requireNativePlugin('faceID') + faceID.authenticate( + { + message: authContent, + }, + (e: Data) => { + const res = { + authMode: realAuthMode, + } + if (e.type === 'success' && e.code === 0) { + resolve({ + authMode: realAuthMode, + errCode: 0, + }) + } else { + switch (e.code) { + case 4: + reject( + '', + extend(res, { + errCode: 90009, + }) + ) + break + case 5: + reject( + 'authenticate freeze. please try again later', + extend(res, { + errCode: 90010, + }) + ) + break + case 6: + reject( + '', + extend(res, { + errCode: 90008, + }) + ) + break + default: + reject( + '', + extend(res, { + errCode: 90007, + }) + ) + break + } + } + } + ) + } + }, + StartSoterAuthenticationProtocols, + StartSoterAuthenticationOptions + ) diff --git a/packages/uni-app-plus/src/service/api/index.ts b/packages/uni-app-plus/src/service/api/index.ts index 625843738449c62f4d25cf2a2313850904b4bc21..e28e338327d9d4ec61d0f9a23595d064aaf9e84b 100644 --- a/packages/uni-app-plus/src/service/api/index.ts +++ b/packages/uni-app-plus/src/service/api/index.ts @@ -10,6 +10,7 @@ export * from './device/ibeacon' export * from './device/makePhoneCall' export * from './device/clipboard' export * from './device/network' +export * from './device/soterAuthentication' export * from './media/getImageInfo' export * from './media/getVideoInfo' diff --git a/packages/uni-components/src/components/radio/index.tsx b/packages/uni-components/src/components/radio/index.tsx index 1bf3b2279d5a02a2d22dc54560e6c8f8f698de22..3066bde2d32d47112881dcd559364508075edba4 100644 --- a/packages/uni-components/src/components/radio/index.tsx +++ b/packages/uni-components/src/components/radio/index.tsx @@ -87,6 +87,7 @@ export default /*#__PURE__*/ defineBuiltInComponent({