Overview

This at_onboarding_flutter package handles secure management of secret keys for authenticating an atsign as cryptographically secure replacement for usernames and passwords.

This open source package is written in Dart, supports Flutter and follows the atPlatform's decentralized, edge computing model with the following features:

• Takes away the difficulty in implementing atsign authentication.
• Generate and Supports free atsigns.
• Supports multiple atSign onboarding.
• Flexibility of either pair atSign with QRCode or Atkey file.
• Reset/Sign out button.

We call giving people control of access to their data “flipping the internet” and you can learn more about how it works by reading this overview.

Get Started

There are two options to get started using this package.

1. Clone it from GitHub

Feel free to fork a copy the source from the GitHub repo. The example code contained there demonstrates the onboarding flow of an atSign.

git clone https://github.com/atsign-foundation/at_widgets

2. Manually add the package to a project

Instructions on how to manually add this package to you project can be found on pub.dev here.

Setup

    <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE"/>
    <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE"/>
    <uses-permission android:name="android.permission.INTERNET"/>
    <uses-permission android:name="android.permission.USE_FULL_SCREEN_INTENT" />
    <uses-permission android:name="android.permission.CAMERA" />
    <uses-feature android:name="android.hardware.camera" />
    <uses-feature android:name="android.hardware.camera.autofocus" />
    <uses-feature android:name="android.hardware.camera.flash" />

compileSdkVersion 32

minSdkVersion 24
targetSdkVersion 29

  <key>NSCameraUsageDescription</key>
  <string>The camera is used to scan QR code to pair your device with your atSign</string>

post_install do |installer|
  installer.pods_project.targets.each do |target|
    flutter_additional_ios_build_settings(target)
    target.build_configurations.each do |config|
      config.build_settings['GCC_PREPROCESSOR_DEFINITIONS'] ||= [
        '$(inherited)',
        ## dart: PermissionGroup.calendar
        'PERMISSION_EVENTS=0',

        ## dart: PermissionGroup.reminders
        'PERMISSION_REMINDERS=0',

        ## dart: PermissionGroup.contacts
        'PERMISSION_CONTACTS=0',

        ## dart: PermissionGroup.microphone
        'PERMISSION_MICROPHONE=0',

        ## dart: PermissionGroup.speech
        'PERMISSION_SPEECH_RECOGNIZER=0',

        ## dart: [PermissionGroup.location, PermissionGroup.locationAlways, PermissionGroup.locationWhenInUse]
        'PERMISSION_LOCATION=0',

        ## dart: PermissionGroup.notification
        'PERMISSION_NOTIFICATIONS=0',

        ## dart: PermissionGroup.sensors
        'PERMISSION_SENSORS=0'
      ]
    end
  end
end

<key>com.apple.security.files.downloads.read-write</key>
<true/>
<key>com.apple.security.network.client</key>
<true/>

3. Migration guide

Usage

TextButton
(
onPressed: () async {
final result = await AtOnboarding.onboard(
context: context,
config: AtOnboardingConfig(
atClientPreference: atClientPreference,
domain: AtEnv.rootDomain,
rootEnvironment: AtEnv.rootEnvironment,
appAPIKey: AtEnv.appApiKey,
),
);
switch (result.status) {
case AtOnboardingResultStatus.success:
final atsign = result.atsign;
// TODO: handle onboard successfully
break;
case AtOnboardingResultStatus.error:
// TODO: handle onboard failure
break;
case AtOnboardingResultStatus.cancel:
// TODO: handle user canceled onboard
break;
}
},
child: Text('Onboard my atSign'),
);

• If your app supports windows platform then add biometric_storage in app's dependencies

dependencies:
 biometric_storage: ^4.1.3

Steps to generate API key :

1. Open URL https://my.atsign.com/login
2. Login with valid credentials
3. Click on My atSign on the dashboard
4. Click on atSign for which you want to generate an API key
5. Click on the manage button
6. Click on Advance settings
7. Click on "Generate New API key"

Language localization

The strings displayed in at_onboarding_flutter are already localized in 2 languages. New languages will be supported in the future with minor updates.

Languages supported:

• English ('en')
• French ('fr')

The at_onboarding_flutter package can be supplied with additional languages in your code by setting the locale property in MaterialApp class to provide custom values.

Open source usage and contributions

This is open source code, so feel free to use it as is, suggest changes or enhancements or create your own version. See Contribution Guideline for detailed guidance on how to setup tools, tests and make a pull request.