at_onboarding_flutter

Description:

at onboarding flutter

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
copied to clipboard
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

Android
Add the following permissions to AndroidManifest.xml
<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" />
copied to clipboard
Also, the Android version support in app/build.gradle
compileSdkVersion 32

minSdkVersion 24
targetSdkVersion 29
copied to clipboard


IOS
Add the following permission string to info.plist
<key>NSCameraUsageDescription</key>
<string>The camera is used to scan QR code to pair your device with your atSign</string>
copied to clipboard
Also, update the Podfile with the following lines of code:
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
copied to clipboard


macOS
Go to your project folder, macOS/Runner/DebugProfile.entitlements
For release you need to open macOS/Runner/Release.entitlements
and add the following keys:
<key>com.apple.security.files.downloads.read-write</key>
<true/>
<key>com.apple.security.network.client</key>
<true/>
copied to clipboard

3. Migration guide #

From 4.x.x to 5.x.x

Replace Onboarding(...) with AtOnboarding.onboard(...)
Move all config params (domain, atClientPreference, rootEnviroment, ...)
into AtOnboardingConfig(...)
The nextScreen and fistTimeAuthNextScreen has been removed and should be
using AtOnboardingResult to determine which screen will be opened


Usage #



Parameters
Description




domain
Domain can differ based on the environment you are using.Default the plugin connects to 'root.atsign.org' to perform onboarding.


atClientPreference
The atClientPreference to continue with the onboarding.


rootEnvironment
Permission to access the device's location is allowed even when the App is running in the background.


appAPIKey
API authentication key for getting free atsigns.


isSwitchingAtsign
Param specifies whether this action is switching atsign or not. Default is false


atsign
The atsign name when change the primary atsign. Default is null



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'),
);
copied to clipboard

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

dependencies:
biometric_storage: ^4.1.3
copied to clipboard
Steps to generate API key : #

Open URL https://my.atsign.com/login
Login with valid credentials
Click on My atSign on the dashboard
Click on atSign for which you want to generate an API key
Click on the manage button
Click on Advance settings
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.