Fingerprint Dart Auth SDK

Fingerprint Dart Auth SDK is designed to provide select out of the box features of Fingerprint in Dart. Both low level and high level abstractions are provided.

Features

This implementation does not yet support all functionalities of the Fingerprint authentication service. Here is a list of functionalities with the current support status:

#	Method	Supported
1	AuthenticationMode Enum	✅
2	DecryptionAlgorithm Enum	✅
3	Region Enum	✅
4	FingerprintJsServerApiClient Class	✅
5	RequestError Class	✅
6	SdkError Class	✅
7	TooManyRequestsError Class	✅
8	UnsealAggregateError Class	✅
9	UnsealError Class	✅
10	DecryptionKey Interface	✅
11	IsValidWebhookSignatureParams Interface	✅
12	Options Interface	✅
13	ErrorPlainResponse Type	✅
14	ErrorResponse Type	✅
15	EventsGetResponse Type	✅
16	EventsUpdateRequest Type	✅
17	ExtractQueryParams Type	✅
18	FingerprintApi Type	✅
19	RelatedVisitorsFilter Type	✅
20	RelatedVisitorsResponse Type	✅
21	SearchEventsFilter Type	✅
22	SearchEventsResponse Type	✅
23	VisitorHistoryFilter Type	✅
24	VisitorsResponse Type	✅
25	Webhook Type	✅
26	getIntegrationInfo Function	✅
27	getRequestPath Function	✅
28	getRetryAfter Function	✅
29	isValidWebhookSignature Function	✅

Available Versions

Fingerprint Dart Auth SDK is available in two versions to cater to different needs:

1. Main - Stable Version: Usually one release a month. This version attempts to keep stability without introducing breaking changes.
2. Sample Apps - FrontEnd Version: The sample apps are provided in various frontend languages in order to allow maximum flexibility with your frontend implementation with the Dart backend. Note that new features are first tested in the sample apps before being released in the mainline branch. Use only as a guide for your frontend/backend implementation of Dart.

Documentation

For detailed guides, API references, and example projects, visit our Fingerprint Dart Auth SDK Documentation. Start building with Fingerprint Dart Auth SDK today and take advantage of its robust features and elegant syntax.

Examples

Explore the /example directory in this repository to find sample applications demonstrating Fingerprint Dart Auth SDK's capabilities in real-world scenarios.

Contributing

We welcome contributions of all forms from the community! If you're interested in helping improve Fingerprint Dart Auth SDK, please fork the repository and submit your pull requests. For more details, check out our CONTRIBUTING.md guide. Our team will review your pull request. Once approved, we will integrate your changes into our primary repository and push the mirrored changes on the main github branch.

Support

For support across all Aortem open-source products, including this SDK, visit our Support Page.

Licensing

The Fingerprint Dart Auth SDK is licensed under a dual-license approach:

1. BSD-3 License:

   • Applies to all packages and libraries in the SDK.
   • Allows use, modification, and redistribution, provided that credit is given and compliance with the BSD-3 terms is maintained.
   • Permits usage in open-source projects, applications, and private deployments.

2. Enhanced License Version 2 (ELv2):

   • Applies to all use cases where the SDK or its derivatives are offered as part of a cloud service.
   • This ensures that the SDK cannot be directly used by cloud providers to offer competing services without explicit permission.
   • Example restricted use cases:
     • Including the SDK in a hosted SaaS authentication platform.
     • Offering the SDK as a component of a managed cloud service.

Summary

• You are free to use the SDK in your applications, including open-source and commercial projects, as long as the SDK is not directly offered as part of a third-party cloud service.
• For details, refer to the LICENSE file.

Enhance with Fingerprint Dart Auth SDK

We hope the Fingerprint Dart Auth SDK helps you to efficiently build and scale your server-side applications. Join our growing community and start contributing to the ecosystem today!