├── .github ├── CODEOWNERS ├── ISSUE_TEMPLATE │ ├── Bug Report.yml │ ├── Feature Request.yml │ └── config.yml ├── PULL_REQUEST_TEMPLATE.md └── workflows │ └── semgrep.yml ├── .gitignore ├── CHANGELOG.md ├── CODE-OF-CONDUCT.md ├── CONTRIBUTING.md ├── GENERAL-CONTRIBUTING.md ├── LICENSE ├── README-sample.md ├── README.md ├── codecov.yml ├── example.env ├── javascript ├── .npmignore ├── BADGES.md └── package.json ├── opslevel.yml ├── python └── BADGES.md └── ruby └── BADGES.md /.github/CODEOWNERS: -------------------------------------------------------------------------------- 1 | * @auth0/project-dx-sdks-engineer-codeowner 2 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/Bug Report.yml: -------------------------------------------------------------------------------- 1 | name: 🐞 Report a bug 2 | description: Have you found a bug or issue? Create a bug report for this library 3 | labels: ["bug"] 4 | 5 | body: 6 | - type: markdown 7 | attributes: 8 | value: | 9 | **Please do not report security vulnerabilities here**. The [Responsible Disclosure Program](https://auth0.com/responsible-disclosure-policy) details the procedure for disclosing security issues. 10 | 11 | - type: checkboxes 12 | id: checklist 13 | attributes: 14 | label: Checklist 15 | options: 16 | - label: I have searched the [Auth0 Community](https://community.auth0.com) forums and have not found a suitable solution or answer. 17 | required: true 18 | - label: I agree to the terms within the [Auth0 Code of Conduct](https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md). 19 | required: true 20 | 21 | - type: textarea 22 | id: description 23 | attributes: 24 | label: Description 25 | description: Provide a clear and concise description of the issue, including what you expected to happen. 26 | validations: 27 | required: true 28 | 29 | - type: textarea 30 | id: reproduction 31 | attributes: 32 | label: Reproduction 33 | description: Detail the steps taken to reproduce this error, and whether this issue can be reproduced consistently or if it is intermittent. 34 | placeholder: | 35 | 1. Step 1... 36 | 2. Step 2... 37 | 3. ... 38 | validations: 39 | required: true 40 | 41 | - type: textarea 42 | id: additional-context 43 | attributes: 44 | label: Additional context 45 | description: Other libraries that might be involved, or any other relevant information you think would be useful. 46 | validations: 47 | required: false 48 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/Feature Request.yml: -------------------------------------------------------------------------------- 1 | name: 🧩 Feature request 2 | description: Suggest an idea or a feature for this library 3 | labels: ["feature request"] 4 | 5 | body: 6 | - type: checkboxes 7 | id: checklist 8 | attributes: 9 | label: Checklist 10 | options: 11 | - label: I have searched the [Auth0 Community](https://community.auth0.com) forums and have not found a suitable solution or answer. 12 | required: true 13 | - label: I agree to the terms within the [Auth0 Code of Conduct](https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md). 14 | required: true 15 | 16 | - type: textarea 17 | id: description 18 | attributes: 19 | label: Describe the problem you'd like to have solved 20 | description: A clear and concise description of what the problem is. 21 | placeholder: I'm always frustrated when... 22 | validations: 23 | required: true 24 | 25 | - type: textarea 26 | id: ideal-solution 27 | attributes: 28 | label: Describe the ideal solution 29 | description: A clear and concise description of what you want to happen. 30 | validations: 31 | required: true 32 | 33 | - type: textarea 34 | id: alternatives-and-workarounds 35 | attributes: 36 | label: Alternatives and current workarounds 37 | description: A clear and concise description of any alternatives you've considered or any workarounds that are currently in place. 38 | validations: 39 | required: false 40 | 41 | - type: textarea 42 | id: additional-context 43 | attributes: 44 | label: Additional context 45 | description: Add any other context or screenshots about the feature request here. 46 | validations: 47 | required: false 48 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/config.yml: -------------------------------------------------------------------------------- 1 | blank_issues_enabled: false 2 | contact_links: 3 | - name: 🤔 Help & Questions 4 | url: https://community.auth0.com 5 | about: Ask general support or usage questions in the Auth0 Community forums 6 | -------------------------------------------------------------------------------- /.github/PULL_REQUEST_TEMPLATE.md: -------------------------------------------------------------------------------- 1 | By submitting a PR to this repository, you agree to the terms within the [Auth0 Code of Conduct](https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md). Please see the [contributing guidelines](https://github.com/auth0/open-source-template/blob/master/CONTRIBUTING.md) for how to create and submit a high-quality PR for this repo. 2 | 3 | ### Description 4 | 5 | > Describe the purpose of this PR along with any background information and the impacts of the proposed change. For the benefit of the community, please do not assume prior context. 6 | > 7 | > Provide details that support your chosen implementation, including: breaking changes, alternatives considered, changes to the API, etc. 8 | > 9 | > If the UI is being changed, please provide screenshots. 10 | 11 | 12 | ### References 13 | 14 | > Include any links supporting this change such as a: 15 | > 16 | > - GitHub Issue/PR number addressed or fixed 17 | > - Auth0 Community post 18 | > - StackOverflow post 19 | > - Support forum thread 20 | > - Related pull requests/issues from other repos 21 | > 22 | > If there are no references, simply delete this section. 23 | 24 | ### Testing 25 | 26 | > Describe how this can be tested by reviewers. Be specific about anything not tested and reasons why. If this library has unit and/or integration testing, tests should be added for new functionality and existing tests should complete without errors. 27 | > 28 | > Please include any manual steps for testing end-to-end or functionality not covered by unit/integration tests. 29 | > 30 | > Also include details of the environment this PR was developed in (language/platform/browser version). 31 | 32 | - [ ] This change adds test coverage for new/changed/fixed functionality 33 | 34 | ### Checklist 35 | 36 | - [ ] I have added documentation for new/changed functionality in this PR or in auth0.com/docs 37 | - [ ] All active GitHub checks for tests, formatting, and security are passing 38 | - [ ] The correct base branch is being used, if not `master` 39 | -------------------------------------------------------------------------------- /.github/workflows/semgrep.yml: -------------------------------------------------------------------------------- 1 | name: "Semgrep" 2 | 3 | on: 4 | merge_group: 5 | push: 6 | branches: 7 | - master 8 | pull_request: 9 | types: 10 | - opened 11 | - synchronize 12 | schedule: 13 | - cron: "30 0 1,15 * *" 14 | 15 | jobs: 16 | run: 17 | if: github.actor != 'dependabot[bot]' 18 | 19 | name: "Run" 20 | runs-on: ubuntu-latest 21 | 22 | container: 23 | image: returntocorp/semgrep 24 | 25 | steps: 26 | - uses: actions/checkout@v3 27 | 28 | - run: semgrep ci 29 | env: 30 | SEMGREP_APP_TOKEN: ${{ secrets.SEMGREP_APP_TOKEN }} 31 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | # .gitignore docs - https://git-scm.com/docs/gitignore 2 | # Useful .gitignore templates - https://github.com/github/gitignore 3 | # Other common .gitignore directives - https://gist.github.com/octocat/9257657 4 | # Consider adding software-specific ignores to ~/.gitignore_global 5 | # 6 | # Commonly-used directives: 7 | # 8 | # .DS_Store 9 | # .DS_Store? 10 | # ._* 11 | # .Spotlight-V100 12 | # .Trashes 13 | # ehthumbs.db 14 | # Thumbs.db 15 | # npm-debug.log 16 | # .env 17 | # 18 | # .idea/ 19 | # node_modules/ 20 | # vendor/ 21 | # build/ 22 | # dist/ 23 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # Change Log 2 | 3 | Resources for generating a changelog: 4 | 5 | [skywinder/Github-Changelog-Generator](https://github.com/skywinder/Github-Changelog-Generator) - generates a full changelog that overwrites the existing CHANGELOG.md. 6 | 7 | [hzalaz/wt-oss-milestone-changelog](https://github.com/hzalaz/wt-oss-milestone-changelog) - generates a snippet of Markdown that can be added to a CHANGELOG.md. 8 | 9 | [conventional-changelog/conventional-changelog](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-cli) - generates a full changelog based on commit history with the option to append to an existing changelog. 10 | -------------------------------------------------------------------------------- /CODE-OF-CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Code of Conduct 2 | 3 | Our [company values](https://auth0.com/careers/culture) guide us in our day-to-day interactions and decision-making. Our open source projects are no exception. Trust, respect, collaboration and transparency are core values we believe should live and breathe within our projects. Our community welcomes participants from around the world with different experiences, unique perspectives, and great ideas to share. 4 | 5 | ## Our Pledge 6 | 7 | In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation. 8 | 9 | ## Our Standards 10 | 11 | Examples of behavior that contributes to creating a positive environment include: 12 | 13 | - Using welcoming and inclusive language 14 | - Being respectful of differing viewpoints and experiences 15 | - Gracefully accepting constructive criticism 16 | - Attempting collaboration before conflict 17 | - Focusing on what is best for the community 18 | - Showing empathy towards other community members 19 | 20 | Examples of unacceptable behavior by participants include: 21 | 22 | - Violence, threats of violence, or inciting others to commit self-harm 23 | - The use of sexualized language or imagery and unwelcome sexual attention or advances 24 | - Trolling, intentionally spreading misinformation, insulting/derogatory comments, and personal or political attacks 25 | - Public or private harassment 26 | - Publishing others' private information, such as a physical or electronic address, without explicit permission 27 | - Abuse of the reporting process to intentionally harass or exclude others 28 | - Advocating for, or encouraging, any of the above behavior 29 | - Other conduct which could reasonably be considered inappropriate in a professional setting 30 | 31 | ## Our Responsibilities 32 | 33 | Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior. 34 | 35 | Project maintainers 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, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful. 36 | 37 | ## Scope 38 | 39 | This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers. 40 | 41 | ## Enforcement 42 | 43 | Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting us anonymously through [this form](https://goo.gl/forms/chVYUnA4bP70WGsL2). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. 44 | 45 | Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership. 46 | 47 | If you are unsure whether an incident is a violation, or whether the space where the incident took place is covered by our Code of Conduct, **we encourage you to still report it**. We would prefer to have a few extra reports where we decide to take no action, than to leave an incident go unnoticed and unresolved that may result in an individual or group to feel like they can no longer participate in the community. Reports deemed as not a violation will also allow us to improve our Code of Conduct and processes surrounding it. If you witness a dangerous situation or someone in distress, we encourage you to report even if you are only an observer. 48 | 49 | ## Attribution 50 | 51 | This Code of Conduct is adapted from the [Contributor Covenant](https://www.contributor-covenant.org/), [version 1.4](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html). 52 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contribution 2 | 3 | Please read [Auth0's contribution guidelines](https://github.com/auth0/open-source-template/blob/master/GENERAL-CONTRIBUTING.md). 4 | 5 | ## Documentation 6 | 7 | - PR for docs site update, if needed 8 | - Code-level documentation expectations 9 | - 100% documentation coverage for PRs 10 | - Include links to relevant Auth0 doc pages 11 | 12 | ## Assets compilation 13 | 14 | Information about compiling CSS, JS, SVG, etc. 15 | 16 | ## Environment setup 17 | 18 | Link to [README installation](README.md#installation) steps and include anything additional needed to contribute to the project. 19 | 20 | ## Testing 21 | 22 | 23 | ### Adding tests 24 | 25 | General information about the test suite and how to format and structure tests. 26 | 27 | ### Running tests 28 | 29 | Any additional information needed to run the test suite. Include `bash`-formatted commands like: 30 | 31 | ```bash 32 | composer test 33 | bundle exec rake test 34 | ``` 35 | 36 | Also include any information about essential manual tests. 37 | 38 | ## Code quality tools 39 | 40 | Information about scripts to run before committing. 41 | 42 | ## CI Information 43 | 44 | What CI checks for and how to pass. 45 | 46 | ## Repo-specific PR guidelines 47 | 48 | Anything not covered in the general guidelines linked above. 49 | -------------------------------------------------------------------------------- /GENERAL-CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing to Auth0 projects 2 | 3 | A big welcome and thank you for considering contributing to Auth0 open source projects! It’s people like you that make it a reality for users in our community. 4 | 5 | Reading and following these guidelines will help us make the contribution process easy and effective for everyone involved. It also communicates that you agree to respect the time of the developers managing and developing these open source projects. In return, we will reciprocate that respect by addressing your issue, assessing changes, and helping you finalize your pull requests. 6 | 7 | ## Quicklinks 8 | 9 | * [Code of Conduct](#code-of-conduct) 10 | * [Getting Started](#getting-started) 11 | * [Issues](#issues) 12 | * [Pull Requests](#pull-requests) 13 | * [Getting Help](#getting-help) 14 | 15 | ## Code of Conduct 16 | 17 | We take our open source community seriously and hold ourselves and other contributors to high standards of communication. By participating and contributing to this project, you agree to uphold our [Code of Conduct](https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md). 18 | 19 | ## Getting Started 20 | 21 | Contributions are made to this repo via Issues and Pull Requests (PRs). A few general guidelines that cover both: 22 | 23 | - To report security vulnerabilities, please use our [Responsible Disclosure Program](https://auth0.com/whitehat) which is monitored by our security team. 24 | - Search for existing Issues and PRs before creating your own. 25 | - We work hard to makes sure issues are handled in a timely manner but, depending on the impact, it could take a while to investigate the root cause. A friendly ping in the comment thread to the submitter or a contributor can help draw attention if your issue is blocking. 26 | - If you've never contributed before, see [the first timer's guide on our blog](https://auth0.com/blog/a-first-timers-guide-to-an-open-source-project/) for resources and tips on how to get started. 27 | 28 | ### Issues 29 | 30 | Issues should be used to report problems with the library, request a new feature, or to discuss potential changes before a PR is created. When you create a new Issue, a template will be loaded that will guide you through collecting and providing the information we need to investigate. 31 | 32 | If you find an Issue that addresses the problem you're having, please add your own reproduction information to the existing issue rather than creating a new one. Adding a [reaction](https://github.blog/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) can also help be indicating to our maintainers that a particular problem is affecting more than just the reporter. 33 | 34 | ### Pull Requests 35 | 36 | PRs to our libraries are always welcome and can be a quick way to get your fix or improvement slated for the next release. In general, PRs should: 37 | 38 | - Only fix/add the functionality in question **OR** address wide-spread whitespace/style issues, not both. 39 | - Add unit or integration tests for fixed or changed functionality (if a test suite already exists). 40 | - Address a single concern in the least number of changed lines as possible. 41 | - Include documentation in the repo or on our [docs site](https://auth0.com/docs). 42 | - Be accompanied by a complete Pull Request template (loaded automatically when a PR is created). 43 | 44 | For changes that address core functionality or would require breaking changes (e.g. a major release), it's best to open an Issue to discuss your proposal first. This is not required but can save time creating and reviewing changes. 45 | 46 | In general, we follow the ["fork-and-pull" Git workflow](https://github.com/susam/gitpr) 47 | 48 | 1. Fork the repository to your own Github account 49 | 2. Clone the project to your machine 50 | 3. Create a branch locally with a succinct but descriptive name 51 | 4. Commit changes to the branch 52 | 5. Following any formatting and testing guidelines specific to this repo 53 | 6. Push changes to your fork 54 | 7. Open a PR in our repository and follow the PR template so that we can efficiently review the changes. 55 | 56 | ## Getting Help 57 | 58 | Join us in the [Auth0 Community](https://community.auth0.com) and post your question there in the correct category with a descriptive tag. 59 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Copyright 2018 Auth0 2 | 3 | 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: 4 | 5 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. 6 | 7 | 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. 8 | -------------------------------------------------------------------------------- /README-sample.md: -------------------------------------------------------------------------------- 1 | # Project Name 2 | 3 | The section after the title is where we say what this library, sample, or SDK does in a few sentences. Consider adding: 4 | 5 | - Short description of use case + problem(s) solved. Consider the following ([from here](https://threadreaderapp.com/thread/921921604140937216.html )): 6 | - Have you described what it is and what the benefits are in a way a non-developer can understand? 7 | - If someone Googles to try to learn more about it, is this description easy to find? 8 | - Is this description easily skimmable? If someone looks at it for 6 seconds can they be convinced? 9 | - Do you compare your tool to other similar tools so people feel educated about pros/cons of yours? 10 | - If performance matters, do you have easy-to-skim benchmarks that include comparing it to other tools? 11 | - Do you have a demo? If it’s open source, are there well documented and easy to build samples/demos? 12 | Have you talked with developers who may be interested to learn about why they haven’t tried it or don’t use it? 13 | - Platform/language version supported 14 | - Links to the project in other repos (npm, packagist, etc) 15 | - Information about maintained and deprecated branches 16 | - Repo status - maintained, deprecated, etc. 17 | - Other resources: 18 | - https://github.com/coreinfrastructure/best-practices-badge/blob/master/doc/criteria.md 19 | - https://gist.github.com/PurpleBooth/109311bb0361f32d87a2 20 | - https://gist.github.com/fvcproductions/1bfc2d4aecb01a834b46 21 | 22 | Search-replace the org/repo in the badge images and links below. 23 | 24 | **Note:** See individual language directories in this repo for technology-specific badges. 25 | 26 | [![CircleCI](https://img.shields.io/circleci/project/github/auth0/open-source-template.svg?style=flat-square)](https://circleci.com/gh/auth0/open-source-template/tree/master) 27 | [![TravisCI](https://travis-ci.org/auth0/open-source-template.png)](https://travis-ci.org/auth0/open-source-template) 28 | [![CodeCov](https://img.shields.io/codecov/c/github/auth0/open-source-template/v3.svg?style=flat-square)](https://codecov.io/github/auth0/open-source-template) 29 | [![Coveralls](https://coveralls.io/repos/auth0/open-source-template/badge.svg?branch=master)](https://coveralls.io/r/auth0/open-source-template?branch=master) 30 | [![Code Climate](https://img.shields.io/codeclimate/maintainability/auth0/open-source-template.svg)](https://codeclimate.com/github/auth0/open-source-template) 31 | [![License](http://img.shields.io/:license-mit-blue.svg?style=flat)](https://opensource.org/licenses/MIT) 32 | 33 | ## Table of Contents 34 | 35 | Make sure this is updated based on the sections included: 36 | 37 | - [Documentation](#documentation) 38 | - [Installation](#installation) 39 | - [Getting Started](#getting-started) 40 | - [Contributing](#contributing) 41 | - [Support + Feedback](#support--feedback) 42 | - [Vulnerability Reporting](#vulnerability-reporting) 43 | - [Thank You](#thank-you) 44 | - [What is Auth0](#what-is-auth0) 45 | - [License](#license) 46 | 47 | ## Documentation 48 | 49 | This section should describe the documentation contained within this repo as well as links to other helpful pages. Full documentation for the library should not, ideally, be located in the repo README and must not be duplicated from somewhere else. If the README is being updated to adhere to these guidelines and the documentation only exists in the readme, consider moving it to a docs page or a Quickstart. 50 | 51 | Consider adding: 52 | 53 | - How to generate documentation in the project (if applicable) 54 | - Links to Quickstarts and sample projects 55 | - Links to any specific `.md` files in the repo 56 | - Links to [auth0/docs](https://auth0.com/docs/) 57 | - Links to [Auth0 blog posts](https://auth0.com/blog/tech/) 58 | - Links to any helpful supporting information about the project 59 | - Links to relevant Community posts (consider parsing and adding somewhere more easily accessible) 60 | 61 | ## Installation 62 | 63 | This section should outline what is required to install and configure this project. Consider adding: 64 | 65 | - Prerequisites for use 66 | - Command line instructions using `bash` syntax: 67 | 68 | ```bash 69 | npm install 70 | composer install 71 | ``` 72 | 73 | - Links to information about package manager used 74 | - Information about `.env` values needed (include an `example.env` file) 75 | - Include different ways to install, indicate preferred method 76 | - Include instructions on how to install older versions 77 | 78 | ## Getting Started 79 | 80 | This section should include basic usage instructions that can be successfully completed after [Installation](#installation) above. This section should be a short introduction to how this library can be used, not a duplication of existing Quickstarts. 81 | 82 | Consider adding: 83 | 84 | - Working with the Authentication API 85 | - Basic login 86 | - Basic code exchange 87 | - Authorize redirect 88 | - Logout 89 | - Working with the Management API 90 | - Perform a Client Credentials grant 91 | - Get Users by page 92 | - Get Clients by page 93 | - Get Connections by page 94 | - Other common tasks 95 | - Security recommendations 96 | - State validation 97 | - ID token verification 98 | 99 | ## Contributing 100 | 101 | We appreciate feedback and contribution to this repo! Before you get started, please see the following: 102 | 103 | - [Auth0's general contribution guidelines](https://github.com/auth0/open-source-template/blob/master/GENERAL-CONTRIBUTING.md) 104 | - [Auth0's code of conduct guidelines](https://github.com/auth0/open-source-template/blob/master/CODE-OF-CONDUCT.md) 105 | - [This repo's contribution guide](CONTRIBUTING.md) 106 | 107 | ## Support + Feedback 108 | 109 | Include information on how to get support. Consider adding: 110 | 111 | - Use [Issues](https://github.com/auth0/open-source-template/issues) for code-level support 112 | - Use [Community](https://community.auth0.com/) for usage, questions, specific cases 113 | - Link to other support forums and FAQs 114 | 115 | ## Vulnerability Reporting 116 | 117 | Please do not report security vulnerabilities on the public GitHub issue tracker. The [Responsible Disclosure Program](https://auth0.com/whitehat) details the procedure for disclosing security issues. 118 | 119 | ## What is Auth0? 120 | 121 | Auth0 helps you to easily: 122 | 123 | - implement authentication with multiple identity providers, including social (e.g., Google, Facebook, Microsoft, LinkedIn, GitHub, Twitter, etc), or enterprise (e.g., Windows Azure AD, Google Apps, Active Directory, ADFS, SAML, etc.) 124 | - log in users with username/password databases, passwordless, or multi-factor authentication 125 | - link multiple user accounts together 126 | - generate signed JSON Web Tokens to authorize your API calls and flow the user identity securely 127 | - access demographics and analytics detailing how, when, and where users are logging in 128 | - enrich user profiles from other data sources using customizable JavaScript rules 129 | 130 | [Why Auth0?](https://auth0.com/why-auth0) 131 | 132 | ## Thank You! (optional) 133 | 134 | Information on the dependencies used, if desired. 135 | 136 | ## License 137 | 138 | Link to [LICENSE](LICENSE) doc. Typically MIT but can be different for a specific platform. 139 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Auth0 Open Source Template 2 | 3 | This repo contains sample files to be used in Auth0 open source software repositories. These files are guidelines that can be used in an Auth0 or any open source project to ensure that the project is described properly, the contribution process is clear, and additional tools like CI, coverage monitors, and quality checkers are configured properly. 4 | 5 | ## Table of Contents 6 | 7 | - [Getting Started](#getting-started) 8 | - [Contribution](#contribution) 9 | - [Thank You](#thank-you) 10 | - [License](#license) 11 | 12 | ## Getting Started 13 | 14 | This repo can be cloned, modified, then re-purposed for new open source projects. It can also be used piecemeal to improve existing repos. 15 | 16 | ### Copy README-sample.md to README.md 17 | 18 | The core of open source repo quality is the `README.md` file that's displayed on the repo's homepage in Github. The `README-sample.md` included here was collaboratively created by Auth0's SDK engineering team and community engineering team based on samples of high-quality README files around the web. 19 | 20 | Most sections within this file should be considered required, even if that section contains a link to a more relevant page. Certain sections will contain repo-specific information and should be modified as needed: 21 | 22 | - Description (below the title) 23 | - Badges 24 | - Documentation 25 | - Installation 26 | - Getting Started 27 | - Thank you 28 | - License 29 | 30 | Other sections should be used as-is with minimal changes: 31 | 32 | - Table of Contents 33 | - Contribution 34 | - Support + Feedback 35 | - Vulnerability Reporting 36 | - What is Auth0? 37 | 38 | ### Modify templates in `.github` 39 | 40 | The issue and PR templates contained in this repo are general guidelines for what to include. What is being asked for is entirely up to the repo maintainer but a template of some kind should be included. 41 | 42 | ### Update LICENSE 43 | 44 | See `README-sample.md` for guidelines. 45 | 46 | ### Modify .gitignore 47 | 48 | This file contains files that will be excluded from git. Modify as needed based on the technology being used. 49 | 50 | ### Modify/remove platform-specific files 51 | 52 | Additional template files have been included here for the specific technology that we work with. These should be considered as guidelines and not enforced in any way. 53 | 54 | ## Contribution 55 | 56 | We appreciate feedback and contribution to this template! Before you get started, please see the following: 57 | 58 | - [Auth0's general contribution guidelines](GENERAL-CONTRIBUTING.md) 59 | - [Auth0's code of conduct guidelines](CODE-OF-CONDUCT.md) 60 | 61 | ## Thank You! 62 | 63 | A big thank you to all of our sources of inspiration! 64 | 65 | - [First Contributions by @Roshanjossey](https://github.com/Roshanjossey/first-contributions) 66 | - [First Timers Only](https://www.firsttimersonly.com/) 67 | - [Sane Github Labels](https://medium.com/@dave_lunny/sane-github-labels-c5d2e6004b63) 68 | - [Awesome README by @matiassingers](https://github.com/matiassingers/awesome-readme) 69 | 70 | ... and many more! 71 | 72 | ## License 73 | 74 | This repo is covered under [The MIT License](LICENSE). 75 | -------------------------------------------------------------------------------- /codecov.yml: -------------------------------------------------------------------------------- 1 | coverage: 2 | precision: 2 3 | round: down 4 | range: "70...100" 5 | status: 6 | project: 7 | default: 8 | enabled: true 9 | target: auto 10 | threshold: 1% 11 | if_no_uploads: error 12 | patch: 13 | default: 14 | enabled: true 15 | target: 90% 16 | threshold: 50% 17 | if_no_uploads: error 18 | changes: 19 | default: 20 | enabled: true 21 | if_no_uploads: error 22 | comment: false 23 | -------------------------------------------------------------------------------- /example.env: -------------------------------------------------------------------------------- 1 | # 2 | # Auth0 environment variables 3 | # Copy this file to a .env file and replace the placeholders below 4 | # These can also be stored in a global .env file 5 | # DO NOT check this file into version control! 6 | # 7 | 8 | # Auth0 tenant domain, found in your Application settings 9 | AUTH0_DOMAIN=YOUR_TENANT_DOMAIN_HERE 10 | 11 | # Auth0 Client ID, found in your Application settings 12 | AUTH0_CLIENT_ID=YOUR_CLIENT_ID_HERE 13 | 14 | # Auth0 Client Secret, found in your Application settings 15 | AUTH0_CLIENT_SECRET=YOUR_CLIENT_SECRET_HERE 16 | 17 | # URL to handle the authentication callback 18 | # Must be saved in "Allowed Callback URLs" in your Application settings 19 | AUTH0_CALLBACK_URL=YOUR_CALLBACK_URL_HERE 20 | 21 | # URL to handle the logout callback 22 | # Must be saved in "Allowed Logout URLs" in your Application settings 23 | AUTH0_LOGOUT_RETURN_URL=YOUR_LOGOUT_URL_HERE 24 | 25 | # Audience for Authentication API calls 26 | AUTH0_AUTH_AUDIENCE=YOUR_AUTHENTICATION_API_AUDIENCE_HERE 27 | 28 | # Audience for Management API calls 29 | AUTH0_MANAGEMENT_AUDIENCE=YOUR_MANAGEMENT_API_AUDIENCE_HERE 30 | 31 | # joshc-test.auth0.com 32 | AUTH0_MANAGEMENT_API_TOKEN=YOUR_SCOPED_MANAGEMENT_API_TOKEN_HERE 33 | -------------------------------------------------------------------------------- /javascript/.npmignore: -------------------------------------------------------------------------------- 1 | # Docs = https://docs.npmjs.com/misc/developers#keeping-files-out-of-your-package 2 | # 3 | # Commonly-used directives: 4 | # 5 | # .vscode/ 6 | # bin/ 7 | # build/ 8 | # css/ 9 | # coverage/ 10 | # examples/ 11 | # release/ 12 | # scripts/ 13 | # src/ 14 | # support/ 15 | # test/ 16 | # bower.json 17 | # Gruntfile.js 18 | # .css.map 19 | # *~ 20 | # .babelrc 21 | -------------------------------------------------------------------------------- /javascript/BADGES.md: -------------------------------------------------------------------------------- 1 | # JavaScript repo badges 2 | 3 | [![NPM version](https://img.shields.io/npm/v/open-source-template.svg?style=flat-square)](https://npmjs.org/package/open-source-template) 4 | 5 | [![Dependency Status](https://david-dm.org/auth0/open-source-template/status.svg?style=flat-square)](https://david-dm.org/auth0/open-source-template) 6 | 7 | [![Downloads](https://img.shields.io/npm/dm/auth0-open-source-template.svg?style=flat-square)](https://npmjs.org/package/auth0-open-source-template) -------------------------------------------------------------------------------- /javascript/package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "auth0-open-source-template", 3 | "version": "0.0.1", 4 | "description": "A template for open source projects at Auth0", 5 | "author": "Auth0 (https://auth0.com)", 6 | "license": "MIT", 7 | "keywords": ["auth0"], 8 | "repository": { 9 | "type": "git", 10 | "url": "git://github.com/auth0/open-source-template" 11 | }, 12 | "main": "index.js", 13 | "scripts": {}, 14 | "devDependencies": {}, 15 | "dependencies": {} 16 | } 17 | -------------------------------------------------------------------------------- /opslevel.yml: -------------------------------------------------------------------------------- 1 | --- 2 | version: 1 3 | repository: 4 | owner: dx_sdks 5 | tier: 6 | tags: 7 | -------------------------------------------------------------------------------- /python/BADGES.md: -------------------------------------------------------------------------------- 1 | # Python Badges 2 | 3 | [![PyPI](https://img.shields.io/pypi/v/auth0-open-source-template.svg)](https://pypi.org/project/auth0-open-source-template/) -------------------------------------------------------------------------------- /ruby/BADGES.md: -------------------------------------------------------------------------------- 1 | # Ruby and Rails Badges 2 | 3 | [![Gem Version](https://badge.fury.io/rb/auth0-open-source-template.svg)](http://badge.fury.io/rb/auth0-open-source-template) 4 | 5 | [![Yard Docs](http://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/github/auth0/open-source-template/master/frames) --------------------------------------------------------------------------------