Fetch upstream

.crowdin/config.example.yml

@@ -0,0 +1,10 @@
+project_id: "372633"
+api_token: "<api-token-here>"
+base_path: "../app/src/main"
+base_url: "https://api.crowdin.com"
+preserve_hierarchy: true
+
+files:
+- source: "res/values/strings.xml"
+  dest: "strings.xml"
+  translation: "res/values-%android_code%/%original_file_name%"

.github/FUNDING.yml

@@ -1 +1,4 @@
-custom: ['https://www.buymeacoffee.com/beemdevelopment']
+buy_me_a_coffee: beemdevelopment
+custom:
+  - "https://www.blockchain.com/btc/address/bc1q26kyxqjkc6tu477pzy0whagwhs4ypv93qls22n"
+  - "https://nanocrawler.cc/explorer/account/nano_1aegisc559b1x4p3839egnu579jkd4htpidy14eo9e31gzqmwuafypnj4q94"

.github/ISSUE_TEMPLATE/bug.yml

@@ -0,0 +1,89 @@
+name: Bug Report
+description: Create a report to help us fix a bug
+labels: ["bug"]
+body:
+  - type: markdown
+    attributes:
+      value: |
+        Please read the [bug reports section of the contribution guidelines](https://github.com/beemdevelopment/Aegis/blob/master/CONTRIBUTING.md#bug-reports) before submitting an issue.
+  - type: input
+    id: version
+    attributes:
+      label: Version
+      description: Which version of Aegis are you using?
+      placeholder: "Example: v2.1"
+    validations:
+      required: true
+  - type: dropdown
+    id: source
+    attributes:
+      label: Source
+      description: Where did you get Aegis from?
+      options:
+        - Google Play
+        - F-Droid
+        - GitHub
+        - Other
+    validations:
+      required: true
+  - type: dropdown
+    id: encryption
+    attributes:
+      label: Vault encryption
+      description: Do you have encryption enabled for your Aegis vault?
+      options:
+        - "Yes (with biometric unlock)"
+        - "Yes"
+        - "No"
+    validations:
+      required: true
+  - type: input
+    id: device
+    attributes:
+      label: Device
+      description: Which device are you using Aegis on?
+      placeholder: "Example: Pixel 5"
+    validations:
+      required: true
+  - type: input
+    id: android_version
+    attributes:
+      label: Android version
+      description: Which Android version is running on your device?
+      placeholder: "Example: Android 13"
+    validations:
+      required: true
+  - type: input
+    id: rom
+    attributes:
+      label: ROM
+      description: Are you using a custom ROM? If so, which one and which version? If you're using the stock OS that came with your device, you can leave this field empty.
+      placeholder: "Example: GrapheneOS"
+    validations:
+      required: false
+  - type: textarea
+    id: reproduction_steps
+    attributes:
+      label: Steps to reproduce
+      description: A detailed list of reproduction steps.
+    validations:
+      required: true
+  - type: textarea
+    id: expectations
+    attributes:
+      label: What do you expect to happen?
+    validations:
+      required: true
+  - type: textarea
+    id: reality
+    attributes:
+      label: What happens instead?
+    validations:
+      required: true
+  - type: textarea
+    id: log
+    attributes:
+      label: Log
+      description: If applicable, paste the debug log that you captured using ADB here.
+    validations:
+      required: false

.github/workflows/build-app-workflow.yaml

@@ -5,8 +5,59 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout the code
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Validate Gradle wrapper
-        uses: gradle/wrapper-validation-action@e2c57acffb2c9aa5a8dc6eda2bbae0b6e495bd4c
+        uses: gradle/wrapper-validation-action@699bb18358f12c5b78b37bb0111d3a0e2276e0e2
+      - uses: actions/setup-java@v4
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+          cache: 'gradle'
       - name: Build the app
         run: ./gradlew build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: apk
+          path: app/build/outputs/apk/debug/app-debug.apk
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - uses: actions/setup-java@v4
+        with:
+          java-version: '17'
+          distribution: 'temurin'
+          cache: 'gradle'
+      - name: Enable KVM group perms
+        run: |
+          echo 'KERNEL=="kvm", GROUP="kvm", MODE="0666", OPTIONS+="static_node=kvm"' | sudo tee /etc/udev/rules.d/99-kvm4all.rules
+          sudo udevadm control --reload-rules
+          sudo udevadm trigger --name-match=kvm
+      - name: Tests
+        uses: reactivecircus/android-emulator-runner@62dbb605bba737720e10b196cb4220d374026a6d
+        with:
+          api-level: 31
+          arch: x86_64
+          profile: pixel_3a
+          heap-size: 512M
+          ram-size: 4096M
+          emulator-options: -memory 4096 -no-window -gpu swiftshader_indirect -noaudio -no-boot-anim -camera-back none
+          disable-animations: true
+          disk-size: 8G
+          script: |
+            mkdir -p artifacts/report
+            adb logcat -c
+            adb logcat -G 16M && adb logcat -g
+            ./gradlew connectedCheck || touch tests_failing
+            adb logcat -d > artifacts/logcat.txt
+            cp -r app/build/reports/androidTests/connected/* artifacts/report/
+            if adb shell '[ -e /sdcard/Pictures/screenshots ]'; then adb pull /sdcard/Pictures/screenshots artifacts/; fi
+            test ! -f tests_failing
+      - uses: actions/upload-artifact@v4
+        if: always()
+        with:
+          name: instrumented-test-report
+          path: |
+            artifacts/*
+          if-no-files-found: ignore

.github/workflows/codeql-analysis.yml

@@ -0,0 +1,42 @@
+name: codeql
+on:
+  push:
+    branches: [ "master" ]
+  pull_request:
+    branches: [ "master" ]
+  schedule:
+    - cron: '25 16 * * 2'
+jobs:
+  analyze:
+    name: analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+    if: github.event_name != 'schedule' || github.repository == 'beemdevelopment/Aegis'
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+    - name: Exclude paths
+      # The importers are excluded from analysis, because some of the apps Aegis
+      # can import from don't have such great crypto, which will cause false
+      # positive security alerts.
+      run: |
+        find app/src/main/java/com/beemdevelopment/aegis/importers ! \( -name AegisImporter.java -o -name "DatabaseImporter*" \) -type f -exec rm -f {} +
+        sed -i '/Importer.class/d' app/src/main/java/com/beemdevelopment/aegis/importers/DatabaseImporter.java
+    - uses: actions/setup-java@v4
+      with:
+        java-version: '17'
+        distribution: 'temurin'
+        cache: 'gradle'
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v3
+      with:
+        languages: java
+    - name: Build
+      run: ./gradlew assembleDebug
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v3
+      with:
+        category: "/language:${{matrix.language}}"

.github/workflows/crowdin.yml

@@ -0,0 +1,31 @@
+name: crowdin
+on:
+  push:
+    branches:
+      - master
+# run sequentially (per branch)
+concurrency: "crowdin-upload-${{ github.ref }}"
+jobs:
+  upload-sources:
+    runs-on: ubuntu-latest
+    if: github.repository == 'beemdevelopment/Aegis'
+    steps:
+      - uses: actions/checkout@v4
+      - name: Install crowdin-cli
+        run: |
+          wget https://github.com/crowdin/crowdin-cli/releases/download/3.7.2/crowdin-cli.zip
+          echo "ee9f838b819ccedc33c9b2537055e5ba7d7934561b24df1e1a6274cbd6e27f2d  crowdin-cli.zip" | sha256sum -c
+          unzip crowdin-cli.zip -d crowdin-cli
+      - name: Upload to Crowdin
+        env:
+          CROWDIN_TOKEN: "${{ secrets.CROWDIN_TOKEN }}"
+        run: |
+          java -jar ./crowdin-cli/3.7.2/crowdin-cli.jar upload sources \
+            --no-progress \
+            --token "$CROWDIN_TOKEN" \
+            --project-id 372633 \
+            --base-path app/src/main \
+            --source res/values/strings.xml \
+            --translation "res/values-%android_code%/%original_file_name%" \
+            --dest strings.xml \
+            --branch master

.gitignore

@@ -40,3 +40,4 @@ captures/
 # Keystore files
 *.jks
 crowdin.properties
+.crowdin/config.yml

CONTRIBUTING.md

@@ -4,6 +4,9 @@ Looking to contribute to Aegis? That's great! There are a couple of ways to help
 out. This document contains some general guidelines for each type of
 contribution.
 
+Please review [the FAQ](FAQ.md) before reporting a bug, asking a question or
+requesting a feature.
+
 ## Translations
 
 We use [Crowdin](https://crowdin.com/project/aegis-authenticator) to crowdsource
@@ -27,10 +30,9 @@ requests.
 ## Bug reports
 
 We use GitHub's issue tracker to track bugs. To make bug reports easier to
-follow up on for us, they must follow [the
-template](.github/ISSUE_TEMPLATE/bug.md). If a bug report does not follow the
-template and does not contain enough information, it will be closed. Duplicate
-bug reports receive the same treatment.
+follow up on for us, please fill out the form as accurately as possible. If a
+bug report does not contain enough information, it will be closed. Duplicate bug
+reports receive the same treatment.
 
 Please consider trying to find the root cause yourself first and include your
 analysis of the issue in your report. Perhaps even send us a patch that fixes