diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 559069b..0000000 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,41 +0,0 @@ -# Pull Request Template - -## What's New? - -Please include a summary of the changes and the related feature/issue. Please also include relevant motivation and context. List any dependencies that are required for this change. - - -## Screenshots (if appropriate): - -Please attach any screenshots that would help illustrate the changes. - - -## Type of change - -- [ ] Bug fix (non-breaking change which fixes an issue) -- [ ] New feature (non-breaking change which adds functionality) -- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected) -- [ ] Documentation update - -## Checklist: - -- [ ] My code follows the style guidelines of this project -- [ ] I have performed a self-review of my own code -- [ ] I have manually tested my code thoroughly -- [ ] I have added/updated inline documentation for public facing interfaces if relevant -- [ ] My changes generate no new warnings -- [ ] I have added tests that prove my fix is effective or that my feature works -- [ ] New and existing integration and unit tests pass locally with my changes -- [ ] Any dependent changes have been merged and published in downstream modules - - -## Jira Ticket - -Please add the Jira ticket number and link. - -- [ ] Jira Ticket: [PSG-XXXX](https://passage-identity.atlassian.net/browse/PSG-XXXX) - - -## Additional context - -Add any other context or screenshots about the pull request here. diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md deleted file mode 100644 index 4dc250c..0000000 --- a/CODE_OF_CONDUCT.md +++ /dev/null @@ -1,133 +0,0 @@ - -# Contributor Covenant Code of Conduct - -## Our Pledge - -We as members, contributors, and leaders pledge to make participation in our -community a harassment-free experience for everyone, regardless of age, body -size, visible or invisible disability, ethnicity, sex characteristics, gender -identity and expression, level of experience, education, socio-economic status, -nationality, personal appearance, race, caste, color, religion, or sexual -identity and orientation. - -We pledge to act and interact in ways that contribute to an open, welcoming, -diverse, inclusive, and healthy community. - -## Our Standards - -Examples of behavior that contributes to a positive environment for our -community include: - -* Demonstrating empathy and kindness toward other people -* Being respectful of differing opinions, viewpoints, and experiences -* Giving and gracefully accepting constructive feedback -* Accepting responsibility and apologizing to those affected by our mistakes, - and learning from the experience -* Focusing on what is best not just for us as individuals, but for the overall - community - -Examples of unacceptable behavior include: - -* The use of sexualized language or imagery, and sexual attention or advances of - any kind -* Trolling, insulting or derogatory comments, and personal or political attacks -* Public or private harassment -* Publishing others' private information, such as a physical or email address, - without their explicit permission -* Other conduct which could reasonably be considered inappropriate in a - professional setting - -## Enforcement Responsibilities - -Community leaders are responsible for clarifying and enforcing our standards of -acceptable behavior and will take appropriate and fair corrective action in -response to any behavior that they deem inappropriate, threatening, offensive, -or harmful. - -Community leaders have the right and responsibility to remove, edit, or reject -comments, commits, code, wiki edits, issues, and other contributions that are -not aligned to this Code of Conduct, and will communicate reasons for moderation -decisions when appropriate. - -## Scope - -This Code of Conduct applies within all community spaces, and also applies when -an individual is officially representing the community in public spaces. -Examples of representing our community include using an official email address, -posting via an official social media account, or acting as an appointed -representative at an online or offline event. - -## Enforcement - -Instances of abusive, harassing, or otherwise unacceptable behavior may be -reported to the community leaders responsible for enforcement at -hello@passage.id. -All complaints will be reviewed and investigated promptly and fairly. - -All community leaders are obligated to respect the privacy and security of the -reporter of any incident. - -## Enforcement Guidelines - -Community leaders will follow these Community Impact Guidelines in determining -the consequences for any action they deem in violation of this Code of Conduct: - -### 1. Correction - -**Community Impact**: Use of inappropriate language or other behavior deemed -unprofessional or unwelcome in the community. - -**Consequence**: A private, written warning from community leaders, providing -clarity around the nature of the violation and an explanation of why the -behavior was inappropriate. A public apology may be requested. - -### 2. Warning - -**Community Impact**: A violation through a single incident or series of -actions. - -**Consequence**: A warning with consequences for continued behavior. No -interaction with the people involved, including unsolicited interaction with -those enforcing the Code of Conduct, for a specified period of time. This -includes avoiding interactions in community spaces as well as external channels -like social media. Violating these terms may lead to a temporary or permanent -ban. - -### 3. Temporary Ban - -**Community Impact**: A serious violation of community standards, including -sustained inappropriate behavior. - -**Consequence**: A temporary ban from any sort of interaction or public -communication with the community for a specified period of time. No public or -private interaction with the people involved, including unsolicited interaction -with those enforcing the Code of Conduct, is allowed during this period. -Violating these terms may lead to a permanent ban. - -### 4. Permanent Ban - -**Community Impact**: Demonstrating a pattern of violation of community -standards, including sustained inappropriate behavior, harassment of an -individual, or aggression toward or disparagement of classes of individuals. - -**Consequence**: A permanent ban from any sort of public interaction within the -community. - -## Attribution - -This Code of Conduct is adapted from the [Contributor Covenant][homepage], -version 2.1, available at -[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1]. - -Community Impact Guidelines were inspired by -[Mozilla's code of conduct enforcement ladder][Mozilla CoC]. - -For answers to common questions about this code of conduct, see the FAQ at -[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at -[https://www.contributor-covenant.org/translations][translations]. - -[homepage]: https://www.contributor-covenant.org -[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html -[Mozilla CoC]: https://github.com/mozilla/diversity -[FAQ]: https://www.contributor-covenant.org/faq -[translations]: https://www.contributor-covenant.org/translations diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 4f6e102..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,49 +0,0 @@ -# Contributing to Passage Flutter - -Thank you for considering contributing to Passage Flutter! Here are some guidelines and instructions to help you get started. - -## Table of Contents - -1. [Code of Conduct](#code-of-conduct) -2. [Getting Started](#getting-started) -3. [Code Style](#code-style) -4. [Code Generation](#code-generation) -5. [Testing](#testing) -6. [Submitting Changes](#submitting-changes) -7. [Community](#community) - -## Code of Conduct - -Please read our [Code of Conduct](CODE-OF-CONDUCT.md) to understand the behavior we expect from all contributors. - -## Getting Started - -1. Fork the repository and clone your fork. -2. Create a new branch for your changes: `git checkout -b my-feature-branch`. -3. Install the necessary dependencies. - -## Code Style - -Please follow these guidelines to ensure a consistent code style: - -- Use FlutterLinkt to enforce Flutter style and conventions. -- Write clear, concise commit messages. -- Comment your code, especially complex or non-obvious sections. - -## Submitting Changes - -1. Ensure all tests pass and there are no linting errors. -2. Commit your changes to your branch with a clear commit message. -3. Push your branch to your forked repository: `git push origin my-feature-branch`. -4. Create a pull request against the `main` repository. -5. Ensure your pull request includes: - - A reference to the related Jira ticket (internal use only). - - A detailed description of the changes. - - Any additional context or screenshots. - -## Community - -- Join our discussions on [Discord](https://discord.com/invite/445QpyEDXh) to ask questions and interact with our developers other contributors. -- Check out the [issue tracker](https://github.com/passageidentity/passage-flutter/issues) for ways to contribute. - -Thank you for contributing to [Your Project Name]! Your efforts help make this project better for everyone. diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md deleted file mode 100644 index 1d8f5fe..0000000 --- a/ISSUE_TEMPLATE.md +++ /dev/null @@ -1,36 +0,0 @@ -# Passage Swift Issue Template - -## Description - -Please describe the issue or feature request in detail. - -## Steps to Reproduce (for bugs) - -1. Step 1 -2. Step 2 -3. Step 3 - -## Expected Behavior - -Please describe the behavior you expected. - -## Actual Behavior - -Please describe what actually happened. - -## Possible Solution - -(Optional) Suggest a fix or reason for the bug. - -## Environment - -- Package version: -- Android version: -- Ios Version: -- Web Broswer version: -- Device: -- Additional details: - -## Additional Context - -Add any other context or screenshots about the issue here. diff --git a/LICENSE b/LICENSE index aa75df4..3442d75 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,7 @@ MIT License -Copyright (c) 2023 Passage Identity, Inc +Copyright (c) 2024 Passage by 1Password + 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 @@ -17,4 +18,4 @@ 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. \ No newline at end of file +SOFTWARE. diff --git a/README.md b/README.md index b05b161..e653c05 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,77 @@ -Passage logo +![passage-flutter](https://storage.googleapis.com/passage-docs/github-md-assets/passage-flutter.png) -[![Pub](https://img.shields.io/pub/v/passage_flutter.svg)](https://pub.dartlang.org/packages/passage_flutter) +[![Pub](https://img.shields.io/pub/v/passage_flutter.svg)](https://pub.dartlang.org/packages/passage_flutter) ![GitHub License](https://img.shields.io/github/license/passageidentity/passage-flutter) [![Flutter](https://img.shields.io/badge/Flutter-02569B?logo=flutter&logoColor=fff)](#) [![Dart](https://img.shields.io/badge/Dart-%230175C2.svg?logo=dart&logoColor=white)](#) ![Static Badge](https://img.shields.io/badge/Built_by_1Password-grey?logo=1password) -### Native passkey authentication for your Flutter app -## Welcome! -Integrating passkey technology can be really hard. That's why we built the Passage Flutter SDK - to make passkey authentication easy for you and your users - across native iOS, native Android, and web. +## About -Passage Flutter +[Passage by 1Password](https://1password.com/product/passage) unlocks the passwordless future with a simpler, more secure passkey authentication experience. Passage handles the complexities of the [WebAuthn API](https://blog.1password.com/what-is-webauthn/), and allows you to implement passkeys with ease. -
+Use [Passkey Flex](https://docs.passage.id/flex) to add passkeys to an existing authentication experience. -## Installation +Use [Passkey Complete](https://docs.passage.id/complete) as a standalone passwordless auth solution. -```sh +Use [Passkey Ready](https://docs.passage.id/passkey-ready) to determine if your users are ready for passkeys. + +### In passage-flutter + +Use passage-flutter to implement Passkey Complete in your Flutter application to authenticate requests and manage users. + +| Product | Compatible | +| ---------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| ![Passkey Flex](https://storage.googleapis.com/passage-docs/github-md-assets/passage-passkey-flex-icon.png) Passkey **Flex** | ✖️ For Passkey Flex, check out the [Passkey Flex for Android](https://github.com/passageidentity/passage-android/tree/main/passageflex) and [Passkey Flex for iOS](https://github.com/passageidentity/passage-flex-ios) | +| ![Passkey Complete](https://storage.googleapis.com/passage-docs/github-md-assets/passage-passkey-complete-icon.png) Passkey **Complete** | ✅ | +| ![Passkey Ready](https://storage.googleapis.com/passage-docs/github-md-assets/passage-passkey-ready-icon.png) Passkey **Ready** | ✖️ For Passkey Ready, check out [Authentikit for Android](https://github.com/passageidentity/passage-android/tree/main/authentikit) and [Authentikit for iOS](https://github.com/passageidentity/passage-authentikit-ios) | + +
+ +## Getting Started + +### Check Prerequisites + +

+ You'll need a free Passage account and a Passkey Complete app set up in Passage Console to get started.
+ Learn more about Passage Console → +

+ +### Install + +```shell flutter pub add passage_flutter ``` -
-## Example Usage +### Import ```dart import 'package:passage_flutter/passage_flutter.dart'; +``` + +### Initialize +```dart final passage = PassageFlutter('YOUR_PASSAGE_APP_ID'); +``` -// Register a new user with a passkey -await passage.passkey.register('name@email.com'); +### Go Passwordless -// Get authenticated user info -final user = await passage.currentUser.userInfo(); -``` +Find all core functions, user management details, and more implementation guidance on our [Passkey Complete Flutter Documentation](https://docs.passage.id/complete/flutter/add-passage) page. + +## Support & Feedback + +We are here to help! Find additional docs, the best ways to get in touch with our team, and more within our [support resources](https://github.com/passageidentity/.github/blob/main/SUPPORT.md). + +
+ +--- -To see a full example, check out our [Flutter Example App](https://github.com/passageidentity/example-flutter). -
+

+ + + + Passage by 1Password Logo + +

-## Documentation -To get started using Passage in your Flutter app, please visit our [Passage Docs](https://docs.passage.id/mobile/cross-platform/flutter). +

+ Passage is a product by 1Password, the global leader in access management solutions with nearly 150k business customers.
+ This project is licensed under the MIT license. See the LICENSE file for more info. +

diff --git a/SECURITY.md b/SECURITY.md deleted file mode 100644 index e9ab59f..0000000 --- a/SECURITY.md +++ /dev/null @@ -1,13 +0,0 @@ -# Security Policy - -## Supported Versions - -The following table lists the versions of the project that are currently supported with security updates: - -| Version | Supported | -| ------- | ------------------ | -| 1.x | :white_check_mark: | - -## Reporting a Vulnerability - -Please report security vulnerabilities to [security@passage.id](mailto:security@passage.id). You will receive a response within 48 hours. \ No newline at end of file diff --git a/ios/passage_flutter.podspec b/ios/passage_flutter.podspec index d2b962c..55ca735 100644 --- a/ios/passage_flutter.podspec +++ b/ios/passage_flutter.podspec @@ -1,13 +1,13 @@ Pod::Spec.new do |s| s.name = 'passage_flutter' s.version = '1.0.0' - s.summary = 'Passkey authentication for your Flutter app' + s.summary = 'Passkey Complete for Flutter - Go completely passwordless with a standalone auth solution in your Flutter app with Passage by 1Password' s.description = <<-DESC - Passkey authentication for your Flutter app +Passkey Complete for Flutter - Go completely passwordless with a standalone auth solution in your Flutter app with Passage by 1Password DESC - s.homepage = 'http://passage.id' + s.homepage = 'https://docs.passage.id/complete' s.license = { :file => '../LICENSE' } - s.author = { 'Passage' => 'hello@passage.id' } + s.author = { 'Passage by 1Password' => 'support@passage.id' } s.source = { :path => '.' } s.source_files = 'Classes/**/*' s.dependency 'Flutter' diff --git a/pubspec.yaml b/pubspec.yaml index 7a5486e..5237e2c 100644 --- a/pubspec.yaml +++ b/pubspec.yaml @@ -1,11 +1,11 @@ name: passage_flutter -description: Native passkey authentication for your Flutter app +description: Passkey Complete for Flutter - Go completely passwordless with a standalone auth solution in your Flutter app with Passage by 1Password version: 1.0.0 -homepage: https://github.com/passageidentity/passage-flutter +homepage: https://docs.passage.id/complete environment: sdk: '>=3.0.3 <4.0.0' - flutter: ">=3.3.0" + flutter: '>=3.3.0' dependencies: flutter: