[improvement] move the new pet care android application to sample-is

petcare-sample/b2c/mobile-app/petcare-with-sdk/.gitignore

@@ -0,0 +1,16 @@
+*.iml
+.gradle
+/local.properties
+/.idea/caches
+/.idea/libraries
+/.idea/modules.xml
+/.idea/workspace.xml
+/.idea/navEditor.xml
+/.idea/assetWizardSettings.xml
+.DS_Store
+/build
+/captures
+.externalNativeBuild
+.cxx
+local.properties
+*.aab

petcare-sample/b2c/mobile-app/petcare-with-sdk/README.md

@@ -0,0 +1,264 @@
+# API Authentication Android Sample - WSO2 Identity Server
+
+## ⚠️ Read this first
+
+1. Required versions
+ ```
+ Java version >= 17
+ ```
+ ```
+ Android Studio version >= Giraffe
+ ```
+
+#### 1. Setup steps Identity Server
+1.1 Setup the latest version of WSO2 Identity Sever.
+
+1.2 [Create a mobile application](https://is.docs.wso2.com/en/next/guides/applications/register-mobile-app/) (Un tick the PKCE `Mandayory` checkbox)
+
+#### 2. Import the configurations
+2.1 Create `config.xml` file in `res/values`
+
+```
+<resources>
+    <string name="oauth_client_base_url"> <BASE_URL> </string>
+    <string name="oauth_client_client_id"> <CLIENT_ID> </string>
+    <string name="oauth_client_redirect_uri">https://example-app.com/redirect</string>
+    <string name="oauth_client_scope">openid internal_login</string>
+    <string name="oauth_client_response_type">code</string>
+    <string name="oauth_client_response_mode">direct</string>
+    <string name="oauth_client_google_web_client_id"> <WSO2_CLIENT_ID_OF_GOOGLE> </string>
+    <string name="oauth_client_google_web_client_secret"> <WSO2_CLIENT_SECRET_OF_GOOGLE> </string>
+    <string name="data_source_resource_server_url"> <PET_RESOURCE_SERVER_URL> </string>
+</resources>
+```
+
+>| Property                    |                                    Value/s                                     |
+>|--------------------------|:------------------------------------------------------------------------------:|
+>| oauth_client_base_url      |            Enter the base URL of the IS server here. If you are using an emulator to try with a locally hosted IS instance, <b>make sure to replace `localhost` with `10.0.2.2` !</b>          |
+>| oauth_client_client_id |  Client ID of the created mobile application in the identity server  |
+>| oauth_client_redirect_uri           |            This does not affect the API authentication flow, but is required since we are using `Authorization Code` grant flow. Hence use a random URL, better to keep the value as it is. Also make sure to use the same URL in the crated application as well.             |
+>| oauth_client_scope      |            `openid internal_login`             |
+>| oauth_client_response_mode |  `direct` is the header value where we force the API authenitcation flow.  |
+>| oauth_client_google_web_client_id           |            Enter the client id of the Google credential that will be used to create the Google connection in the IS. Since we are using the IS to authenticate the user we need to identify the currently signed-in user on the server. To do so securely, after a user successfully signs in, we need to send the user's ID token to the IS using HTTPS. Then, on the server, we are verifing the integrity of the ID token and use the user information contained in the token to establish the session. To generate the user's ID token for the IS, we will require the client id that is used to create the Google connection in the IS. For more details, https://developers.google.com/identity/sign-in/android/backend-auth         |
+>| oauth_client_google_web_client_secret           |            Enter the client secret of the Google credential that will be used to create the Google connection in the IS.         |
+>| data_source_resource_server_url |  This is the url where we have hosted the pet care service. If you do not have that setup enter a random URL, the app is developed to show a dummy data if the resource server is not available. <b>This should be a URL!</b>  |
+
+#### 3. Setup Google Login
+3.1 Go to `https://console.cloud.google.com/` and create a new project.
+
+3.2 In the `credentials` section create two `Oauth Client IDs` one for `android app(Select Android)` and one for `WSO2 identity server(Select Web Application)`.
+> Follow the steps to get the SHA-1 key to create Oauth Client ID for our Android app
+> https://stackoverflow.com/a/67983215/10601286.
+>
+> After that make sure to sync the gradle of the project. This can be done using the `Sync project with Gradle files` icon in the top right hand corner of the IDE (or in Apple `Shift + Command + O`).
+> ![image](https://github.com/wso2/samples-is/assets/46097917/dbd6738c-384d-495c-bc57-03bfd8dd7105)
+
+> `WSO2_CLIENT_ID_OF_GOOGLE` is the client ID of the client ID crated for the WSO2 identity server.
+
+3.3 Create a Google connection as a Trusted Token Issuer using the following curl command.
+```
+curl --location 'https://localhost:9443/api/server/v1/identity-providers' \
+--header 'User-Agent: Mozilla/5.0 (Macintosh; Intel Mac OS X 10.15; rv:109.0) Gecko/20100101 Firefox/118.0' \
+--header 'Accept: application/json' \
+--header 'Accept-Language: en-US,en;q=0.5' \
+--header 'Accept-Encoding: gzip, deflate, br' \
+--header 'Content-Type: application/json' \
+--header 'Authorization: Basic YWRtaW46YWRtaW4=' \
+--data '{
+    "image": "assets/images/logos/google.svg",
+    "isPrimary": false,
+    "roles": {
+        "mappings": [],
+        "outboundProvisioningRoles": []
+    },
+    "name": "Google-TTI-IDP",
+    "certificate": {
+        "certificates": [],
+        "jwksUri": "https://www.googleapis.com/oauth2/v3/certs"
+    },
+    "claims": {
+        "userIdClaim": {
+            "uri": "http://wso2.org/claims/username"
+        },
+        "roleClaim": {
+            "uri": "http://wso2.org/claims/role"
+        },
+        "provisioningClaims": []
+    },
+    "description": "Login users with existing Google accounts.",
+    "alias": <WSO2_CLIENT_ID_OF_GOOGLE>,
+    "homeRealmIdentifier": "",
+    "provisioning": {
+        "jit": {
+            "userstore": "PRIMARY",
+            "scheme": "PROVISION_SILENTLY",
+            "isEnabled": true
+        }
+    },
+    "federatedAuthenticators": {
+        "defaultAuthenticatorId": "R29vZ2xlT0lEQ0F1dGhlbnRpY2F0b3I",
+        "authenticators": [
+            {
+                "isEnabled": true,
+                "authenticatorId": "R29vZ2xlT0lEQ0F1dGhlbnRpY2F0b3I",
+                "properties": [
+                    {
+                        "value": <WSO2_CLIENT_ID_OF_GOOGLE>,
+                        "key": "ClientId"
+                    },
+                    {
+                        "value": <WSO2_CLIENT_SECRET_OF_GOOGLE>,
+                        "key": "ClientSecret"
+                    },
+                    {
+                        "value": "https://localhost:9443/commonauth",
+                        "key": "callbackUrl"
+                    },
+                    {
+                        "value": "scope=email openid profile",
+                        "key": "AdditionalQueryParameters"
+                    }
+                ]
+            }
+        ]
+    },
+    "idpIssuerName": "https://accounts.google.com",
+    "isFederationHub": false,
+    "templateId": "google-idp"
+}'
+```
+3.4 Add the created Google connection to the created application (in step 2) as a level 1 sign-in option.
+
+#### 4. Supported authenticators
+Currently this sample application supports the following authenticators.
+
+- Basic authenticatator
+- Google authenticator
+- TOTP
+- Passkey authenticator
+    - NOTE
+        - This authenticator is only supported from `Android 13` and above.
+    - For this, we have to enrol a passkey in my account for the user's account. Also, you may the face a difficulty when accessing the registred passkey in your device, to overcome this you can register a passkey from another device. <b>We are working on mitigating this issue.</b>
+
+#### 5. Run the application
+
+5.1 To run the application you need to open the application from the Android Studio IDE, and select the project to open with an `Android` view from the project view selection.
+![image](https://github.com/wso2/samples-is/assets/46097917/c5ebb28f-335e-4a0f-a560-5504f5402f55)
+
+5.2 You may require to sync the gradle files again. This can be done using the `Sync project with Gradle files` icon in the top right hand corner of the IDE (or in Apple `Shift + Command + O`).
+![image](https://github.com/wso2/samples-is/assets/46097917/f4548481-9eda-425b-8535-eed610012723)
+
+###### Optional
+> This project is recommended to run on an emulator version `Pixel 7` or above, becuase some authenticators like `Passkey` are not supported for older version of Andriod.  To download the new emulator you can refer the following documentation. When selecting the device make sure to select `Pixel 7` or above version.
+https://developer.android.com/studio/run/managing-avds
+
+5.3 After the gradle files are synced you can run the app from the `Run `app`` button on the top bar (or in Apple `Command + R`)
+![image](https://github.com/wso2/samples-is/assets/46097917/2ec180e4-4aec-4c0c-83b7-258118bfd988)
+
+#### 6. Client attestation
+
+6.1 To test the client attestation you need to test the application from a real device, where the app downloaded from the playstore, for this <b>you will require a Google play account</b>.
+This application is bound to one of my Google cloud projects, hence you need to change the package name of the application and associate the project with a new Google Project, for this you can use the Google project that you created for the step 3.
+> Changing the package name of an Android application involves several steps. It's a common task, but it requires careful attention to detail to ensure that all components of the app work correctly after the change. Here are the general steps:
+>
+> #### Step 1: Backup Your Project
+>
+> Before making any changes, it's always a good idea to create a backup of your entire project to avoid potential data loss.
+>
+> #### Step 2: Update the Package Name in the Manifest
+>
+> 1. Open the `AndroidManifest.xml` file in your Android Studio.
+> 2. Locate the `package` attribute in the `<manifest>` element and change the package name to your desired name.
+     >
+     >    ```xml
+>    <manifest xmlns:android="http://schemas.android.com/apk/res/android"
+>        package="com.your.old.packagename">
+>    ```
+     >
+     >    Change it to:
+     >
+     >    ```xml
+>    <manifest xmlns:android="http://schemas.android.com/apk/res/android"
+>        package="com.your.new.packagename">
+>    ```
+>
+> #### Step 3: Refactor the Package Name
+>
+> 1. Right-click on the old package name in the project explorer.
+> 2. Select "Refactor" > "Rename" (or just press `Shift` + `F6`).
+> 3. Enter the new package name and click "Refactor."
+>
+> #### Step 4: Update Gradle Files
+>
+> 1. Open the `build.gradle` file (Module: app).
+> 2. Update the `applicationId` to the new package name.
+     >
+     >    ```gradle
+>    android {
+>        ...
+>        defaultConfig {
+>          ...
+>            applicationId "com.your.new.packagename"
+>        }
+>    }
+>    ```
+>
+> 3. Sync your project with Gradle by clicking on the "Sync Now" prompt that appears in the bar at the top.
+>
+> #### Step 5: Rename Source Code Directories
+>
+> 1. Right-click on the old package name directory and choose "Refactor" > "Rename."
+> 2. Enter the new package name and click "Refactor."
+>
+> #### Step 6: Update References
+>
+> 1. Android Studio will update most references automatically, but double-check for any manual references in your code or resources.
+> 2. Look for occurrences of the old package name and update them to the new one.
+>
+> #### Step 7: Clean and Rebuild
+>
+> 1. Clean your project by selecting "Build" > "Clean Project" from the menu.
+> 2. Rebuild your project by selecting "Build" > "Rebuild Project."
+>
+> #### Step 8: Test Your App
+>
+> 1. Run your app on an emulator or a physical device to ensure that everything is working as expected.
+> 2. Check for any errors or warnings in the logcat.
+
+Also make sure to subscribe to Google Play Integrity API from the project, you can do this from `Enabled API's & Services` in the Google cloud project.
+
+6.2 After that you need to create a new service account in the google project.
+You can create a Service Account for yourself with the following scopes.
+- Go to IAM& Admin -> Service Accounts
+- Click Create Service Account
+- Fill the name and click create and continue.
+- You need to grant your service account the roles of Service Account User and Service Usage Consumer.
+- Click continue and then Done
+- You can see the service account added without keys, click : Actions -> Manage Keys for the service account.
+- Click Add key and Select JSON.
+- Save the JSON in secure place (We need this for Android Attestation Credentials for application metadata)
+
+6.3 After that, Update Application Advanced properties.
+The application you created requires 2 properties to perform android attestation.
+- Android package name
+- androidAttestationServiceCredentials
+    - The JSON secret of Service Account downloaded. Note that this attribute is defined as a JSON object hence use the JSON key as it is.
+
+6.4 Go to the Google play console and create a new application for this application, after that you need to associate your cloud project for the app integrity. To do this,
+- Navigate to Release > App integrity. Under Play Integrity API select **Link a Cloud project**.
+- Choose the Cloud project you want to link to your app and this will enable Play Integrity API responses.
+- You can now integrate the Play Integrity API into your app.
+- Create a new release.
+    - For this we need a signed app bundle. To create a signed app bundle,
+        - In the Android Studio, go to **Build** > **Generate Signed App Bundle**, and select app bundle.
+        - Then create a new keystore (make sure to store the credentials of the keystore in a secure location), then upload the released bundle to the play console internal testing release section.
+- In the testers section, add yourself as a tester in a new list of testers and select that list only for the testing.
+- Then copy the web link and download the application from there.
+- Download the application from that link, and you can test the client attestation from that application
+> NOTE:
+> When you have released multiple versions of the application, you may face a problem that the application you download from the link are still giving the old version, to mitigate this you can change the device and open the link or wait a few minutes.
+
+###### App Screens
+![image](https://github.com/wso2/samples-is/assets/46097917/5a31af56-b3ae-4b37-992d-aae42046ab31)
+![image](https://github.com/wso2/samples-is/assets/46097917/cc67d9da-2f47-408b-8b75-77499f03802f)
+![image](https://github.com/wso2/samples-is/assets/46097917/65f04443-e43a-4c28-a68a-436f890deb7e)

petcare-sample/b2c/mobile-app/petcare-with-sdk/app/.gitignore

@@ -0,0 +1 @@
+/build

petcare-sample/b2c/mobile-app/petcare-with-sdk/app/build.gradle.kts

@@ -0,0 +1,107 @@
+/*
+ *  Copyright (c) 2024, WSO2 LLC. (https://www.wso2.com).
+ *
+ *  WSO2 LLC. licenses this file to you under the Apache License,
+ *  Version 2.0 (the "License"); you may not use this file except
+ *  in compliance with the License.
+ *  You may obtain a copy of the License at
+ *
+ *         http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *  Unless required by applicable law or agreed to in writing,
+ *  software distributed under the License is distributed on an
+ *  "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ *  KIND, either express or implied. See the License for the
+ *  specific language governing permissions and limitations
+ *  under the License.
+ */
+
+plugins {
+    alias(libs.plugins.androidApplication)
+    alias(libs.plugins.jetbrainsKotlinAndroid)
+    id("kotlin-android")
+    id("kotlin-kapt")
+    id("com.google.dagger.hilt.android")
+}
+
+android {
+    namespace = "com.wso2_sample.api_auth_sample"
+    compileSdk = 34
+
+    defaultConfig {
+        applicationId = "com.wso2_sample.api_auth_sample"
+        minSdk = 26
+        targetSdk = 34
+        versionCode = 1
+        versionName = "1.0"
+
+        testInstrumentationRunner = "androidx.test.runner.AndroidJUnitRunner"
+
+        manifestPlaceholders.putAll(
+            mapOf(
+                "appAuthRedirectScheme" to "wso2.apiauth.sample.android://login-callback",
+                "callbackUriHost" to "login-callback",
+                "callbackUriScheme" to "wso2.apiauth.sample.android"
+            )
+        )
+    }
+
+    buildTypes {
+        release {
+            isMinifyEnabled = false
+            proguardFiles(
+                getDefaultProguardFile("proguard-android-optimize.txt"),
+                "proguard-rules.pro"
+            )
+        }
+    }
+    buildFeatures {
+        compose = true
+    }
+    composeOptions {
+        kotlinCompilerExtensionVersion = "1.5.10"
+    }
+    compileOptions {
+        sourceCompatibility = JavaVersion.VERSION_1_8
+        targetCompatibility = JavaVersion.VERSION_1_8
+    }
+    kotlinOptions {
+        jvmTarget = "1.8"
+    }
+}
+
+dependencies {
+
+    implementation(libs.androidx.core.ktx)
+    implementation(libs.androidx.lifecycle.runtime.ktx)
+    implementation(libs.androidx.activity.compose)
+    implementation(libs.androidx.appcompat)
+    implementation(platform(libs.androidx.compose.bom))
+    implementation(libs.androidx.material3.android)
+    implementation(libs.androidx.ui.tooling.preview.android)
+    implementation(libs.integrity)
+    implementation(libs.play.services.tasks)
+    testImplementation(libs.junit)
+    androidTestImplementation(libs.androidx.junit)
+    androidTestImplementation(libs.androidx.espresso.core)
+    androidTestImplementation(platform(libs.androidx.compose.bom.v20240400))
+
+    // Arrow
+    implementation(libs.arrow.core)
+    implementation(libs.arrow.fx.coroutines)
+    // Coil
+    implementation(libs.coil.compose)
+    // Dagger hilt
+    implementation(libs.hilt.android)
+    debugImplementation(libs.androidx.ui.tooling)
+    kapt(libs.hilt.android.compiler)
+    implementation(libs.androidx.hilt.navigation.compose)
+
+    implementation(libs.androidx.lifecycle.runtime.compose)
+
+    // Asgardeo android SDK
+    implementation(libs.asgardeo.android.ui)
+
+    implementation(libs.okhttp)
+    implementation(libs.jackson.module.kotlin)
+}