react-native-credentials-manager 0.2.0

package/LICENSE

@@ -0,0 +1,20 @@
+MIT License
+
+Copyright (c) 2025 Benjamin
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,258 @@
+# react-native-credentials-manager
+
+A React Native library that implements the [Credential Manager API](https://developer.android.com/training/sign-in/credential-manager) for Android. This library allows you to manage passwords and passkeys in your React Native applications.
+
+> ⚠️ **Note**: This library is actively under development. iOS support using Authentication Services is coming soon. Support for the old React Native architecture is also in progress. Google Sign-In integration with Credential Manager will be added shortly.
+
+## Features
+
+- ✨ Passkey Authentication
+- 🔐 Password Credential Management
+- 📱 Google Signing (coming soon)
+- 🤖 [iOS Authentication Services](https://developer.apple.com/documentation/authenticationservices?language=objc) (coming soon)
+
+## Installation
+
+```bash
+npm install react-native-credentials-manager
+
+# or if you prefer yarn
+
+yarn add react-native-credentials-manager
+```
+
+## Requirements
+
+- React Native >= 0.71.0
+- New Architecture enabled
+
+## Android Setup
+
+For complete setup instructions, see the [official Credential Manager documentation](https://developer.android.com/identity/sign-in/credential-manager#add-support-dal).
+
+1. Add support for Digital Asset Links
+
+To enable passkey support, you need to associate your Android app with your website by creating and hosting a Digital Asset Links JSON file.
+
+Create a file named `assetlinks.json` with the following content:
+
+```json
+[
+  {
+    "relation": [
+      "delegate_permission/common.handle_all_urls",
+      "delegate_permission/common.get_login_creds"
+    ],
+    "target": {
+      "namespace": "android_app",
+      "package_name": "your.package.name",
+      "sha256_cert_fingerprints": [
+        "YOUR_APP_SIGNING_CERTIFICATE_SHA256_FINGERPRINT"
+      ]
+    }
+  }
+]
+```
+
+Host this file at:
+
+```
+https://your-domain.com/.well-known/assetlinks.json
+```
+
+Important requirements:
+
+- The MIME type must be `application/json`
+- If you have a `robots.txt`, ensure it allows access to `/.well-known/assetlinks.json`:
+  ```
+  User-agent: \*
+  Allow: /.well-known/
+  ```
+- The domain must be fully-qualified
+- Don't include trailing slashes or paths in the domain
+- Subdomains are not automatically included in the association
+
+### ProGuard Rules
+
+If you're using ProGuard, add these rules to your `android/app/proguard-rules.pro`:
+
+```pro
+-if class androidx.credentials.CredentialManager
+-keep class androidx.credentials.playservices.** {
+  *;
+}
+```
+
+## Usage
+
+### High-Level Authentication Flow
+
+The library provides three primary functions for managing user authentication:
+
+1. **signUpWithPasskeys**: Registers a new user using passkeys.
+2. **signUpWithPassword**: Registers a new user using a traditional username and password.
+3. **signInWithSavedCredentials**: Authenticates a user using previously saved credentials.
+
+### 1. Sign Up with Passkeys
+
+**Function**: `signUpWithPasskeys(requestJson)`
+
+**Description**: Registers a new user using passkeys, enhancing security and user experience.
+
+**Backend Requirements**:
+
+- **Challenge Generation**: Your backend must generate a unique, base64-encoded challenge to prevent replay attacks.
+- **User Information**: Provide user details such as a unique identifier, username, and display name.
+
+**When to Use**: Opt for passkey registration to offer users a passwordless and secure authentication method.
+
+**Example**:
+
+```typescript
+import { signUpWithPasskeys } from 'react-native-credentials-manager';
+
+// From your backend
+const requestJson = {
+  challenge: 'base64EncodedChallengeFromBackend',
+  rp: {
+    name: 'Your App Name',
+    id: 'your-domain.com',
+  },
+  user: {
+    id: 'base64EncodedUserIdFromBackend',
+    name: 'username',
+    displayName: 'User Display Name',
+  },
+  pubKeyCredParams: [
+    {
+      type: 'public-key',
+      alg: -7, // ES256
+    },
+  ],
+  authenticatorSelection: {
+    authenticatorAttachment: 'platform',
+    requireResidentKey: true,
+    residentKey: 'required',
+    userVerification: 'required',
+  },
+};
+
+try {
+  const response = await signUpWithPasskeys(requestJson);
+  console.log('Passkey registration successful:', response);
+} catch (error) {
+  console.error('Passkey registration failed:', error);
+}
+```
+
+**Parameters**:
+
+| Parameter                                        | Type      | Description                                                                                    |
+| ------------------------------------------------ | --------- | ---------------------------------------------------------------------------------------------- |
+| `challenge`                                      | `string`  | A base64-encoded challenge provided by your server to prevent replay attacks.                  |
+| `rp`                                             | `object`  | Information about your app (Relying Party).                                                    |
+| `rp.name`                                        | `string`  | The name of your app.                                                                          |
+| `rp.id`                                          | `string`  | The domain of your app.                                                                        |
+| `user`                                           | `object`  | Information about the user registering.                                                        |
+| `user.id`                                        | `string`  | A base64-encoded unique identifier for the user.                                               |
+| `user.name`                                      | `string`  | The username of the user.                                                                      |
+| `user.displayName`                               | `string`  | The display name of the user.                                                                  |
+| `pubKeyCredParams`                               | `array`   | An array of objects indicating acceptable public key algorithms.                               |
+| `authenticatorSelection`                         | `object`  | Criteria for selecting the appropriate authenticator.                                          |
+| `authenticatorSelection.authenticatorAttachment` | `string`  | Indicates the desired authenticator attachment modality (`"platform"` or `"cross-platform"`).  |
+| `authenticatorSelection.requireResidentKey`      | `boolean` | Indicates whether resident keys are required.                                                  |
+| `authenticatorSelection.residentKey`             | `string`  | Specifies the resident key requirement (`"required"`, `"preferred"`, or `"discouraged"`).      |
+| `authenticatorSelection.userVerification`        | `string`  | Specifies the user verification requirement (`"required"`, `"preferred"`, or `"discouraged"`). |
+
+**Note**: Parameters such as `challenge`, `user.id`, and other user-specific information should be securely generated and provided by your backend server.
+
+### 2. Sign Up with Password
+
+**Function**: `signUpWithPassword(credentials)`
+
+**Description**: Registers a new user using a traditional username and password combination.
+
+**Backend Requirements**:
+
+- **User Registration**: Your backend should handle the storage and management of user credentials securely.
+
+**When to Use**: Use this method when you want to support traditional password-based authentication.
+
+**Example**:
+
+```typescript
+import { signUpWithPassword } from 'react-native-credentials-manager';
+
+const credentials = {
+  username: 'user@example.com',
+  password: 'securePassword123!',
+};
+
+try {
+  await signUpWithPassword(credentials);
+  console.log('User registered successfully with password.');
+} catch (error) {
+  console.error('Password registration failed:', error);
+}
+```
+
+### Sign In with Saved Credentials
+
+```typescript
+import { signInWithSavedCredentials } from 'react-native-credentials-manager';
+
+// From your backend
+const signinRequestJson = {
+  challenge: 'base64EncodedChallenge',
+  timeout: 1800000,
+  userVerification: 'required',
+  rpId: 'your-domain.com',
+};
+
+try {
+  const credential = await signInWithSavedCredentials(signinRequestJson);
+
+  if (credential.type === 'passkey') {
+    console.log('Passkey:', credential.authenticationResponseJson);
+  } else if (credential.type === 'password') {
+    console.log('Password credentials:', {
+      username: credential.username,
+      password: credential.password,
+    });
+  }
+} catch (error) {
+  console.error('Sign in failed:', error);
+}
+```
+
+## Documentation
+
+For more detailed information about the underlying APIs, refer to:
+
+- [Android Credential Manager Overview](https://developer.android.com/identity/sign-in/credential-manager)
+- [Android Credential Manager API Reference](https://developer.android.com/reference/androidx/credentials/package-summary)
+- [WebAuthn Developer Guide](https://webauthn.guide)
+- [Passkeys Overview](https://developers.google.com/identity/passkeys)
+
+## Roadmap
+
+- Old Architecture Support
+- iOS Support using [Authentication Services](https://developer.apple.com/documentation/authenticationservices?language=objc)
+- Additional Authentication Methods
+- Comprehensive Documentation
+
+## Contributing
+
+See the [contributing guide](CONTRIBUTING.md) to learn how to contribute to the repository and the development workflow.
+
+## License
+
+MIT
+
+---
+
+Made with [create-react-native-library](https://github.com/callstack/react-native-builder-bob)
+
+```
+
+```

package/android/build.gradle

@@ -0,0 +1,116 @@
+buildscript {
+  ext.getExtOrDefault = {name ->
+    return rootProject.ext.has(name) ? rootProject.ext.get(name) : project.properties['CredentialsManager_' + name]
+  }
+
+  repositories {
+    google()
+    mavenCentral()
+  }
+
+  dependencies {
+    classpath "com.android.tools.build:gradle:8.7.2"
+    // noinspection DifferentKotlinGradleVersion
+    classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:${getExtOrDefault('kotlinVersion')}"
+ }
+}
+
+
+def isNewArchitectureEnabled() {
+  return rootProject.hasProperty("newArchEnabled") && rootProject.getProperty("newArchEnabled") == "true"
+}
+
+apply plugin: "com.android.library"
+apply plugin: "kotlin-android"
+
+if (isNewArchitectureEnabled()) {
+  apply plugin: "com.facebook.react"
+}
+
+def getExtOrIntegerDefault(name) {
+  return rootProject.ext.has(name) ? rootProject.ext.get(name) : (project.properties["CredentialsManager_" + name]).toInteger()
+}
+
+def supportsNamespace() {
+  def parsed = com.android.Version.ANDROID_GRADLE_PLUGIN_VERSION.tokenize('.')
+  def major = parsed[0].toInteger()
+  def minor = parsed[1].toInteger()
+
+  // Namespace support was added in 7.3.0
+  return (major == 7 && minor >= 3) || major >= 8
+}
+
+android {
+  if (supportsNamespace()) {
+    namespace "com.credentialsmanager"
+
+    sourceSets {
+      main {
+        manifest.srcFile "src/main/AndroidManifestNew.xml"
+      }
+    }
+  }
+
+  compileSdkVersion getExtOrIntegerDefault("compileSdkVersion")
+
+  defaultConfig {
+    minSdkVersion getExtOrIntegerDefault("minSdkVersion")
+    targetSdkVersion getExtOrIntegerDefault("targetSdkVersion")
+    buildConfigField "boolean", "IS_NEW_ARCHITECTURE_ENABLED", isNewArchitectureEnabled().toString()
+
+  }
+
+  buildFeatures {
+    buildConfig true
+  }
+
+  buildTypes {
+    release {
+      minifyEnabled false
+    }
+  }
+
+  lintOptions {
+    disable "GradleCompatible"
+  }
+
+  compileOptions {
+    sourceCompatibility JavaVersion.VERSION_1_8
+    targetCompatibility JavaVersion.VERSION_1_8
+  }
+
+  sourceSets {
+    main {
+      if (isNewArchitectureEnabled()) {
+          java.srcDirs += [
+            "generated/java",
+            "generated/jni"
+          ]
+      }
+    }
+  }
+}
+
+repositories {
+  mavenCentral()
+  google()
+}
+
+def kotlin_version = getExtOrDefault("kotlinVersion")
+
+dependencies {
+  implementation "com.facebook.react:react-android"
+  implementation "org.jetbrains.kotlin:kotlin-stdlib:$kotlin_version"
+     implementation "androidx.credentials:credentials:1.5.0-rc01"
+    implementation "androidx.credentials:credentials-play-services-auth:1.5.0-rc01"
+    implementation "org.jetbrains.kotlinx:kotlinx-coroutines-core:1.6.4"
+    implementation "org.jetbrains.kotlinx:kotlinx-coroutines-android:1.6.4"
+}
+
+if (isNewArchitectureEnabled()) {
+  react {
+    jsRootDir = file("../src/")
+    libraryName = "CredentialsManager"
+    codegenJavaPackageName = "com.credentialsmanager"
+  }
+}

package/android/generated/RCTAppDependencyProvider.h

@@ -0,0 +1,25 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+
+#import <Foundation/Foundation.h>
+
+#if __has_include(<React-RCTAppDelegate/RCTDependencyProvider.h>)
+#import <React-RCTAppDelegate/RCTDependencyProvider.h>
+#elif __has_include(<React_RCTAppDelegate/RCTDependencyProvider.h>)
+#import <React_RCTAppDelegate/RCTDependencyProvider.h>
+#else
+#import "RCTDependencyProvider.h"
+#endif
+
+NS_ASSUME_NONNULL_BEGIN
+
+@interface RCTAppDependencyProvider : NSObject <RCTDependencyProvider>
+
+@end
+
+NS_ASSUME_NONNULL_END

package/android/generated/RCTAppDependencyProvider.mm

@@ -0,0 +1,55 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+#import "RCTAppDependencyProvider.h"
+#import <ReactCodegen/RCTModulesConformingToProtocolsProvider.h>
+#import <ReactCodegen/RCTThirdPartyComponentsProvider.h>
+
+@implementation RCTAppDependencyProvider {
+  NSArray<NSString *> * _URLRequestHandlerClassNames;
+  NSArray<NSString *> * _imageDataDecoderClassNames;
+  NSArray<NSString *> * _imageURLLoaderClassNames;
+  NSDictionary<NSString *,Class<RCTComponentViewProtocol>> * _thirdPartyFabricComponents;
+}
+
+- (nonnull NSArray<NSString *> *)URLRequestHandlerClassNames {
+  static dispatch_once_t requestUrlToken;
+  dispatch_once(&requestUrlToken, ^{
+    self->_URLRequestHandlerClassNames = RCTModulesConformingToProtocolsProvider.URLRequestHandlerClassNames;
+  });
+
+  return _URLRequestHandlerClassNames;
+}
+
+- (nonnull NSArray<NSString *> *)imageDataDecoderClassNames {
+  static dispatch_once_t dataDecoderToken;
+  dispatch_once(&dataDecoderToken, ^{
+    _imageDataDecoderClassNames = RCTModulesConformingToProtocolsProvider.imageDataDecoderClassNames;
+  });
+
+  return _imageDataDecoderClassNames;
+}
+
+- (nonnull NSArray<NSString *> *)imageURLLoaderClassNames {
+  static dispatch_once_t urlLoaderToken;
+  dispatch_once(&urlLoaderToken, ^{
+    _imageURLLoaderClassNames = RCTModulesConformingToProtocolsProvider.imageURLLoaderClassNames;
+  });
+
+  return _imageURLLoaderClassNames;
+}
+
+- (nonnull NSDictionary<NSString *,Class<RCTComponentViewProtocol>> *)thirdPartyFabricComponents {
+  static dispatch_once_t nativeComponentsToken;
+  dispatch_once(&nativeComponentsToken, ^{
+    _thirdPartyFabricComponents = RCTThirdPartyComponentsProvider.thirdPartyFabricComponents;
+  });
+
+  return _thirdPartyFabricComponents;
+}
+
+@end

package/android/generated/RCTModulesConformingToProtocolsProvider.h

@@ -0,0 +1,18 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+#import <Foundation/Foundation.h>
+
+@interface RCTModulesConformingToProtocolsProvider: NSObject
+
++(NSArray<NSString *> *)imageURLLoaderClassNames;
+
++(NSArray<NSString *> *)imageDataDecoderClassNames;
+
++(NSArray<NSString *> *)URLRequestHandlerClassNames;
+
+@end

package/android/generated/RCTModulesConformingToProtocolsProvider.mm

@@ -0,0 +1,33 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+#import "RCTModulesConformingToProtocolsProvider.h"
+
+@implementation RCTModulesConformingToProtocolsProvider
+
++(NSArray<NSString *> *)imageURLLoaderClassNames
+{
+  return @[
+    
+  ];
+}
+
++(NSArray<NSString *> *)imageDataDecoderClassNames
+{
+  return @[
+    
+  ];
+}
+
++(NSArray<NSString *> *)URLRequestHandlerClassNames
+{
+  return @[
+    
+  ];
+}
+
+@end

package/android/generated/RCTThirdPartyComponentsProvider.h

@@ -0,0 +1,16 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+#import <Foundation/Foundation.h>
+
+@protocol RCTComponentViewProtocol;
+
+@interface RCTThirdPartyComponentsProvider: NSObject
+
++ (NSDictionary<NSString *, Class<RCTComponentViewProtocol>> *)thirdPartyFabricComponents;
+
+@end

package/android/generated/RCTThirdPartyComponentsProvider.mm

@@ -0,0 +1,23 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+
+#import <Foundation/Foundation.h>
+
+#import "RCTThirdPartyComponentsProvider.h"
+#import <React/RCTComponentViewProtocol.h>
+
+@implementation RCTThirdPartyComponentsProvider
+
++ (NSDictionary<NSString *, Class<RCTComponentViewProtocol>> *)thirdPartyFabricComponents
+{
+  return @{
+
+  };
+}
+
+@end

package/android/generated/ReactAppDependencyProvider.podspec

@@ -0,0 +1,34 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+
+version = "0.77.0"
+source = { :git => 'https://github.com/facebook/react-native.git' }
+if version == '1000.0.0'
+  # This is an unpublished version, use the latest commit hash of the react-native repo, which we’re presumably in.
+  source[:commit] = `git rev-parse HEAD`.strip if system("git rev-parse --git-dir > /dev/null 2>&1")
+else
+  source[:tag] = "v#{version}"
+end
+
+Pod::Spec.new do |s|
+  s.name                   = "ReactAppDependencyProvider"
+  s.version                = version
+  s.summary                = "The third party dependency provider for the app"
+  s.homepage               = "https://reactnative.dev/"
+  s.documentation_url      = "https://reactnative.dev/"
+  s.license                = "MIT"
+  s.author                 = "Meta Platforms, Inc. and its affiliates"
+  s.platforms              = min_supported_versions
+  s.source                 = source
+  s.source_files           = "**/RCTAppDependencyProvider.{h,mm}"
+
+  # This guard prevent to install the dependencies when we run `pod install` in the old architecture.
+  s.pod_target_xcconfig    = {
+    "CLANG_CXX_LANGUAGE_STANDARD" => rct_cxx_language_standard(),
+    "DEFINES_MODULE" => "YES"
+  }
+
+  s.dependency "ReactCodegen"
+end

package/android/generated/java/com/credentialsmanager/NativeCredentialsManagerSpec.java

@@ -0,0 +1,47 @@
+
+/**
+ * This code was generated by [react-native-codegen](https://www.npmjs.com/package/react-native-codegen).
+ *
+ * Do not edit this file as changes may cause incorrect behavior and will be lost
+ * once the code is regenerated.
+ *
+ * @generated by codegen project: GenerateModuleJavaSpec.js
+ *
+ * @nolint
+ */
+
+package com.credentialsmanager;
+
+import com.facebook.proguard.annotations.DoNotStrip;
+import com.facebook.react.bridge.Promise;
+import com.facebook.react.bridge.ReactApplicationContext;
+import com.facebook.react.bridge.ReactContextBaseJavaModule;
+import com.facebook.react.bridge.ReactMethod;
+import com.facebook.react.bridge.ReadableMap;
+import com.facebook.react.turbomodule.core.interfaces.TurboModule;
+import javax.annotation.Nonnull;
+
+public abstract class NativeCredentialsManagerSpec extends ReactContextBaseJavaModule implements TurboModule {
+  public static final String NAME = "CredentialsManager";
+
+  public NativeCredentialsManagerSpec(ReactApplicationContext reactContext) {
+    super(reactContext);
+  }
+
+  @Override
+  public @Nonnull String getName() {
+    return NAME;
+  }
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void signUpWithPasskeys(ReadableMap requestJson, boolean preferImmediatelyAvailableCredentials, Promise promise);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void signUpWithPassword(ReadableMap credObject);
+
+  @ReactMethod
+  @DoNotStrip
+  public abstract void signInWithSavedCredentials(ReadableMap requestJson, Promise promise);
+}

package/android/generated/jni/CMakeLists.txt

@@ -0,0 +1,36 @@
+# Copyright (c) Meta Platforms, Inc. and affiliates.
+#
+# This source code is licensed under the MIT license found in the
+# LICENSE file in the root directory of this source tree.
+
+cmake_minimum_required(VERSION 3.13)
+set(CMAKE_VERBOSE_MAKEFILE on)
+
+file(GLOB react_codegen_SRCS CONFIGURE_DEPENDS *.cpp react/renderer/components/RNCredentialsManagerSpec/*.cpp)
+
+add_library(
+  react_codegen_RNCredentialsManagerSpec
+  OBJECT
+  ${react_codegen_SRCS}
+)
+
+target_include_directories(react_codegen_RNCredentialsManagerSpec PUBLIC . react/renderer/components/RNCredentialsManagerSpec)
+
+target_link_libraries(
+  react_codegen_RNCredentialsManagerSpec
+  fbjni
+  jsi
+  # We need to link different libraries based on whether we are building rncore or not, that's necessary
+  # because we want to break a circular dependency between react_codegen_rncore and reactnative
+  reactnative
+)
+
+target_compile_options(
+  react_codegen_RNCredentialsManagerSpec
+  PRIVATE
+  -DLOG_TAG=\"ReactNative\"
+  -fexceptions
+  -frtti
+  -std=c++20
+  -Wall
+)