React Secure Biometric Interface Integrator

A standalone library component for interacting with SBI devices and auth capture Face, Finger & Iris detail.

Build

To build up the library

npm run rollup

To generate a package from it

npm pack

For publishing the package

npm publish

Component

<SecureBiometricInterfaceIntegrator 
    transactionId="your_transaction_id"
    buttonLabel="button_label"
    langCode="en"
    sbiEnv={sbiEnv}
    onCapture={myChange}
    onErrored={myError} />

Props

Common props you may want to specify include:

| prop | type | default value | note | | -------------- | -------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | buttonLabel | string | Scan and Verify | Capture button label | | transactionId| string | | Transaction id of the current biometric authorization | | onCapture | func | | The function to be called on a successful capture with Biometric response. | | onErrored | func | | optional callback function on capture failure with error msg string. | | customStyle | Object | See below | Json object for customize the css of the component | | sbiEnv | Object | See below | Biometric environment detail | | disable | boolean | false | To disable scan_and_verify button. | | langCode | string | en | Language code. Valid values en, ar, hi, kn, ta, eng, hin, kan, tam, ara

Prop customStyle

| field | type | Default value | note | | -------------- | -------- | ------------- | ----------------------------- | | selectBoxStyle | {borderColor: string; borderColorActive: string;borderColorHover: string;panelBgColor: string;panelBgColorHover: string;panelBgColorActive: string;} | {borderColor: "#cccccc";borderColorActive: "#2684ff";borderColorHover: "#b3b3b3";panelBgColor: "#fff";panelBgColorHover: "#deebff";panelBgColorActive: "#2684ff";} | Css for select dropdown | | refreshButtonStyle | {iconUniCode: string;} | {iconUniCode: "\u21bb";} | Css for refresh button | | verifyButtonStyle | {background: string;color: string;} | {background: linear-gradient(to top, #06b6d4, #3b82f6);color: rgb(255, 255, 255, 1);} | Css for verify button |

Prop sbiEnv

For more information check MDS Specification

| field | type | valid values | default value | note | | -------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- | -------------------------------------------------------------------------------- | | env | string | ("Staging", "Developer", "Pre-Production", "Production") | "Staging" | The target environment. | | captureTimeout | number | | 30 | Max time the app will wait for the capture api call. | | discTimeout | number | | 30 | The time during which app will keep scanning for the devices at a regular interval of 2 seconds. | | dinfoTimeout | number | | 30 | Max time the app will wait for the device info api call. | | domainUri | string | | window.origin | URI of the authentication server. | | faceCaptureCount | number | Always set to 1 | 1 | Number of biometric data that is collected for face. | | faceCaptureScore | number | Floating point number ranges from 0-100. | 70 | Expected quality score that should match to complete a successful face capture | | fingerBioSubtypes | string | ["Left IndexFinger", "Left MiddleFinger", "Left RingFinger", "Left LittleFinger", "Left Thumb", "Right IndexFinger", "Right MiddleFinger", "Right RingFinger", "Right LittleFinger", "Right Thumb", "UNKNOWN"] | "UNKNOWN" | Array of bioSubType for finger. | | fingerCaptureCount | number | Ranges from 1 to 10 | 1 | Number of biometric data that is collected for finger. | | fingerCaptureScore | number | Floating point number ranges from 0-100. | 70 | Expected quality score that should match to complete a successful finger capture | | irisBioSubtypes | string | ["Left", "Right", "UNKNOWN"] | "UNKNOWN" | Array of bioSubType for iris | | irisCaptureCount | number | Ranges from 1 to 2 | 1 | Number of biometric data that is collected for Iris. | | irisCaptureScore | number | Floating point number ranges from 0-100. | 70 | Expected quality score that should match to complete a successful iris capture | | portRange | string | Port should be under that range of 4501 - 4600. | "4501-4600" | Range of port that will be scanned for available devices |

License

• react-select - a third party dropdown component, licensed under MIT
• react-jss - use to apply css in DOM through JSON object, licensed under MIT
• axios - is a promised-based HTTP client for JavaScript licensed under MIT
• rollup - is a module bundler for JavaScript which compiles small pieces of code into something larger and more complex, such as a library or application, licensed under MIT
• rollup-plugin-dts - a plugin that lets you roll-up your .d.ts definition files, licensed under LGPL-3.0
• rollup-plugin-peer-deps-external - Automatically externalize peerDependencies in a rollup bundle, licensed under MIT
• rollup-plugin-postcss - used for seamless integration between rollup & postcss , licensed under MIT
• @rollup/plugin-commonjs - a Rollup plugin to convert CommonJS modules to ES6, so they can be included in a Rollup bundle, licensed under MIT
• @rollup/plugin-image - A Rollup plugin which imports JPG, PNG, GIF, SVG, and WebP files, licensed under MIT
• @rollup/plugin-json - A Rollup plugin which Converts .json files to ES6 modules, licensed under MIT
• @rollup/plugin-node-resolve - a Rollup plugin which locates modules using the Node resolution algorithm, for using third party modules in node_modules, licensed under MIT
• @rollup/plugin-typescript - a Rollup plugin for seamless integration between Rollup and Typescript, licensed under MIT
• jose - a JavaScript module for JSON Object Signing and Encryption, providing support for JSON Web Tokens (JWT), JSON Web Signature (JWS), JSON Web Encryption (JWE), JSON Web Key (JWK), JSON Web Key Set (JWKS), licensed under MIT