Repository containing the source of WSO2 IS QR Authentication SDK.
WSO2 auth-qr-react-native is a package that can be used for developing a qrcode-based authentication app with React Native, that can be used for authenticating with WSO2 Identity Server.
For npm
$ npm install @wso2/auth-qr-react-native
For yarn
$ yarn add @wso2/auth-qr-react-native
For installing on iOS
$ cd ios && pod install
If you wish to build the SDK on your own and install the packages, the following steps should be followed.
Step 1: Clone the project
Step 2: Go to the samples/sample-mobile-app/sdk directory from the terminal
Step 3: Run the command npm run build
Step 4: Create a new directory in the app project for saving the package (eg: packages)
Step 5: Copy the lib directory from the sdk and paste in the new packages directory in the app project.
The src directory may be removed as it is not required for using the SDK once built.
Step 6: Open a terminal at the app project root
Step 7: Run npm install <path-to-package>
example: npm install packages/lib |
|---|
Step 8: Run cd ios && pod install for iOS
**Note: Step 7 will auto-link the package. Any changes made in the lib directory will take effect within the project
installing the package.
The following methods can be used for implementing qrcode-based authentication on a mobile app.
| Method | Return Type | Description |
|---|---|---|
| processAuthRequest(request) | AuthRequestInterface |
Convert the authentication request data received from the qrcode to AuthRequestInterface |
| sendAuthRequest( authRequest, token, response ) |
Promise<object> |
Send the authentication response to the server once the user has authorized or denied the request |
Process the data received from the qrcode as an AuthRequestInterface object.
import { AuthorizationService } from "@wso2/auth-qr-react-native";
...
let authData = AuthorizationService.processAuthRequest(data);sendAuthRequest(authRequest: AuthRequestInterface, token: string, response: string)
Send the authentication response to WSO2 IS once the user authorizes or denies the request.
import { AuthorizationService } from "@wso2/auth-qr-react-native";
...
AuthorizationService.sendAuthRequest(authData, token, response)
.then((res) => {
if (response == "SUCCESSFUL") {
// Do positive action
} else if (response == "DENIED") {
// Do negative action
}
})
.catch((err) => {
// Handle error
});sessionDataKey: string
tenantDomain: string
host: string
expiryTime: string
authenticationStatus: string
requestTime: DateTimeInterface
- For testing out the use of the SDK in a React Native application, the following steps should be followed. As the IS running locally will not have a valid CA certificate, any request sent from an Android device will get blocked.
- Changing the keystore of the IS with the required credentials enables the possibility of getting the requests to work.
- As a physical device will be required for scanning QR code, the DNS and the IP address of the host machine should be included in the certificate.
- Follow this article to generate a new keystore according to the above requirements.
Please read Contributing to the Code Base for details on our code of conduct, and the process for submitting pull requests to us.
We encourage you to report issues, improvements, and feature requests creating Github Issues.
Important: And please be advised that security issues must be reported to [email protected], not as GitHub issues, in order to reach the proper audience. We strongly advise following the WSO2 Security Vulnerability Reporting Guidelines when reporting the security issues.
This project is licensed under the Apache License 2.0. See the LICENSE file for details.