diff --git a/.editorconfig b/.editorconfig new file mode 100644 index 0000000..1895dae --- /dev/null +++ b/.editorconfig @@ -0,0 +1,18 @@ +# EditorConfig is awesome: http://EditorConfig.org + +# top-most EditorConfig file +root = true + +# Don't use tabs for indentation. +[*] +indent_size = 4 +indent_style = space +tab_width = 4 +end_of_line = lf +charset = utf-8 +trim_trailing_whitespace = true +insert_final_newline = true +guidelines = 120 + +[*.{json,yml}] +indent_size = 2 diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..6313b56 --- /dev/null +++ b/.gitattributes @@ -0,0 +1 @@ +* text=auto eol=lf diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml new file mode 100644 index 0000000..94332c8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug.yml @@ -0,0 +1,92 @@ +name: Self-host Release Bug Report +description: File a bug report +labels: [bug] +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + + > [!WARNING] + > This repository only tracks installation scripts for our self-host project. For any other Bitwarden Server issues including Bitwarden Unified, please submit your report in [bitwarden/server](https://github.com/bitwarden/server) + + Please do not submit feature requests. The [Community Forums](https://community.bitwarden.com) has a section for submitting, voting for, and discussing product feature requests. + - type: checkboxes + id: self-host-scripts + attributes: + label: Self-host installation scripts issue + description: "This repository only tracks installation scripts for our self-host project, any other Bitwarden Server issues including Bitwarden Unified should be reported in [bitwarden/server](https://github.com/bitwarden/server)" + options: + - label: "I understand this repository only tracks self-host installation scripts and any other issues should be reported in bitwarden/server" + required: true + - type: textarea + id: reproduce + attributes: + label: Steps To Reproduce + description: How can we reproduce the behavior. + value: | + 1. Go to '...' + 2. Click on '....' + 3. Scroll down to '....' + 4. Click on '...' + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected Result + description: A clear and concise description of what you expected to happen. + validations: + required: true + - type: textarea + id: actual + attributes: + label: Actual Result + description: A clear and concise description of what is happening. + validations: + required: true + - type: textarea + id: screenshots + attributes: + label: Screenshots or Videos + description: If applicable, add screenshots and/or a short video to help explain your problem. + - type: textarea + id: additional-context + attributes: + label: Additional Context + description: Add any other context about the problem here. + - type: input + id: version + attributes: + label: Build Version + description: What version of our software are you running? + validations: + required: true + - type: dropdown + id: environment + attributes: + label: Environment + description: Which environment (Cloud / Self-Hosted) are you using? + multiple: true + options: + - Cloud (bitwarden.com) + - Self-Hosted + validations: + required: true + - type: textarea + id: environment-details + attributes: + label: Environment Details + description: If Self-Hosted please provide some additional environment details. + placeholder: | + - Operating system: [e.g. Windows 10, Mac OS Catalina] + - Environment: [e.g. Docker, EKS, ECS, K8S] + - Hardware: [e.g. Intel 6-core, 8GB RAM] + - type: checkboxes + id: issue-tracking-info + attributes: + label: Issue Tracking Info + description: | + Issue tracking information + options: + - label: I understand that work is tracked outside of Github. A PR will be linked to this issue should one be opened to address it, but Bitwarden doesn't use fields like "assigned", "milestone", or "project" to track progress. diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..61d7e2b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,14 @@ +blank_issues_enabled: false +contact_links: + - name: Feature Requests + url: https://community.bitwarden.com/c/feature-requests/ + about: Request new features using the Community Forums. Please search existing feature requests before making a new one. + - name: Bitwarden Community Forums + url: https://community.bitwarden.com + about: Please visit the community forums for general community discussion, support and the development roadmap. + - name: Customer Support + url: https://bitwarden.com/contact/ + about: Please contact our customer support for account issues and general customer support. + - name: Security Issues + url: https://hackerone.com/bitwarden + about: We use HackerOne to manage security disclosures. diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..edbc9d9 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,35 @@ +## đŸŽŸī¸ Tracking + + + +## 📔 Objective + + + +## 📸 Screenshots + + + +## ⏰ Reminders before review + +- Contributor guidelines followed +- All formatters and local linters executed and passed +- Written new unit and / or integration tests where applicable +- Protected functional changes with optionality (feature flags) +- Used internationalization (i18n) for all UI strings +- CI builds passed +- Communicated to DevOps any deployment requirements +- Updated any necessary documentation (Confluence, contributing docs) or informed the documentation team + +## đŸĻŽ Reviewer guidelines + + + +- 👍 (`:+1:`) or similar for great changes +- 📝 (`:memo:`) or â„šī¸ (`:information_source:`) for notes or general info +- ❓ (`:question:`) for questions +- 🤔 (`:thinking:`) or 💭 (`:thought_balloon:`) for more open inquiry that's not quite a confirmed issue and could potentially benefit from discussion +- 🎨 (`:art:`) for suggestions / improvements +- ❌ (`:x:`) or âš ī¸ (`:warning:`) for more significant problems or concerns needing attention +- 🌱 (`:seedling:`) or â™ģī¸ (`:recycle:`) for future improvements or indications of technical debt +- ⛏ (`:pick:`) for minor or nitpick changes diff --git a/.gitignore b/.gitignore index 05f4ccb..c85177c 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,23 @@ +# General +.DS_Store +Thumbs.db + +# IDEs and editors +.idea/ +.project +.classpath +.c9/ +*.launch +.settings/ +*.sublime-workspace + +# Visual Studio Code +.vscode/* +!.vscode/settings.json +!.vscode/tasks.json +!.vscode/launch.json +!.vscode/extensions.json +.history/* + # Secrets file for act (gh actions local run tool) -.secrets \ No newline at end of file +.secrets diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..2833057 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,3 @@ +# How to Contribute + +Our [Contributing Guidelines](https://contributing.bitwarden.com/contributing/) are located in our [Contributing Documentation](https://contributing.bitwarden.com/). The documentation also includes recommended tooling, code style tips, and lots of other great information to get you started. diff --git a/SECURITY.md b/SECURITY.md new file mode 100644 index 0000000..b2a37f6 --- /dev/null +++ b/SECURITY.md @@ -0,0 +1,32 @@ +Bitwarden believes that working with security researchers across the globe is crucial to keeping our +users safe. If you believe you've found a security issue in our product or service, we encourage you +to please submit a report through our [HackerOne Program](https://hackerone.com/bitwarden/). We +welcome working with you to resolve the issue promptly. Thanks in advance! + +# Disclosure Policy + +- Let us know as soon as possible upon discovery of a potential security issue, and we'll make every + effort to quickly resolve the issue. +- Provide us a reasonable amount of time to resolve the issue before any disclosure to the public or + a third-party. We may publicly disclose the issue before resolving it, if appropriate. +- Make a good faith effort to avoid privacy violations, destruction of data, and interruption or + degradation of our service. Only interact with accounts you own or with explicit permission of the + account holder. +- If you would like to encrypt your report, please use the PGP key with long ID + `0xDE6887086F892325FEC04CC0D847525B6931381F` (available in the public keyserver pool). + +While researching, we'd like to ask you to refrain from: + +- Denial of service +- Spamming +- Social engineering (including phishing) of Bitwarden staff or contractors +- Any physical attempts against Bitwarden property or data centers + +# We want to help you! + +If you have something that you feel is close to exploitation, or if you'd like some information +regarding the internal API, or generally have any questions regarding the app that would help in +your efforts, please email us at https://bitwarden.com/contact and ask for that information. As +stated above, Bitwarden wants to help you find issues, and is more than willing to help. + +Thank you for helping keep Bitwarden and our users safe!