Bitwarden 贡献文档
⮐ Bitwarden Contributing Documentation我的博客联系我
  • 关于
  • 入门
    • 概述
    • 工具
    • 服务器
      • 设置指南
      • 高级服务器设置
      • 数据库
        • MSSQL
        • 实体框架
      • 事件日志
      • Ingress 隧道
      • SCIM
      • 自托管指南
      • 系统管理门户
      • 单点登录 (SSO)
        • 本地 IdP
        • Okta
      • 故障排除
      • 用户机密
      • 公共 API
    • 网页客户端
      • 网页密码库
        • WebAuthn
      • 浏览器端
        • 生物识别解锁
        • Firefox 隐私模式
      • 桌面端
        • Mac App Store Dev
        • Microsoft Store
        • Native Messaging Test Runner
        • 更新测试
      • CLI
      • 故障排除
    • 移动端
      • Android
        • F-Droid
      • iOS
      • .NET MAUI (legacy)
        • Android
        • iOS
        • watchOS
    • SDK
      • 内部 SDK
      • Secrets Manager
        • Integrations
          • Kubernetes
    • 业务 App
      • 目录连接器
        • JumpCloud
        • OpenLDAP Docker 服务器
      • Key Connector
      • Splunk App
  • 贡献
    • 贡献
    • 代码样式
      • =Android & Kotlin
      • Angular & TypeScript
      • C#
      • =Rust
      • T-SQL
      • =Swift
      • Tailwind
    • 数据库迁移
      • 进化数据库设计
    • 提交签名
    • 拉取请求
      • =贡献审查程序
      • 分支
      • 代码审查
      • UI 审查 - Chromatic
    • 无障碍
    • 依赖管理
    • 功能标记
    • 模板存储库
    • 测试
      • =数据库集成测试
      • 负载测试
      • 单元测试
        • 命名约定
        • 测试结构
    • 修改用户机密
  • 架构
    • 架构
    • 架构决策记录 (ADR)
      • 0001 - Angular Reactive Forms
      • 0002 - Public API for modules
      • 0003 - Adopt Observable Data Services for Angular
      • 0004 - Refactor State Service
      • 0005 - Refactor Api Service
      • 0006 - Clients: Use Jest Mocks
      • 0007 - Manifest V3 sync Observables
      • 0008 - Server: Adopt CQRS
      • 0009 - Composition over inheritance
      • 0010 - Angular Modules
      • 0011 - Scalable Angular Clients folder structure
      • 0012 - Angular Filename convention
      • 0013 - Avoid layered folder structure for request/response models
      • 0014 - Adopt Typescript Strict flag
      • 0015 - Short Lived Browser Services
      • 0016 - Move Decryption and Encryption to Views
      • 0017 - Use Swift to build watchOS app
      • 0018 - Feature management
      • 0019 - Adoption of Web Push
      • 0020 - Observability with OpenTelemetry
      • 0021 - Logging to Standard Output
      • =0022 - Authorization
      • =0023 - Identifying Integrated Clients
    • 移动客户端架构
      • =Android
      • =iOS
        • =推送通知故障排除提示
      • =.NET MAUI (legacy)
        • =概述
        • watchOS
    • =SDK 架构
      • =数据模型
      • =依赖
      • Password Manager
        • Web
          • =互操作性
      • =Secrets Manager
      • =服务器绑定
      • =版本控制和破坏性更改
    • 网络客户端架构
      • 概述
      • 数据模型
      • 表示层
        • Angular
        • CLI
      • =依赖注入
      • 服务层
        • Vision
        • 实现
    • 服务器架构
    • 深度剖析
      • 身份验证
        • 双重身份验证
      • =授权
      • =浏览器自动填充
        • 收集页面详细信息
        • 生成并执行填充脚本
        • 表单提交检测
        • Shadow DOM
        • =内联自动填充菜单
      • Captcha
      • =只读数据库副本
      • 事件日志
      • =FIDO2 和通行密钥
        • =凭据
        • =操作
        • =命名惯例
        • =实现
          • =提供程序
            • =浏览器扩展
          • =依赖方
            • =用于解密的通行密钥
        • =术语表
      • 推送通知
        • 移动端推送通知
        • 其他客户端推送通知
      • =SSH 密钥和代理
        • =SSH 代理
      • =状态提供程序框架
        • =派生状态
    • =安全
      • =定义
      • =原则
        • =P01 - 锁定的密码库是安全的
        • =P02 - 半受损设备密码库的有限安全性
        • =P03 - 完全损坏的系统没有安全性
        • =P04 - 控制密码库数据的访问权限
        • =P05 - 将安全漏洞的影响降至最低
      • =要求
由 GitBook 提供支持
在本页
  • 概述​
  • 设置​
  • Go
  • F-Droid 服务器和存储库工具​
  • 安卓 SDK​
  • 文件结构​
  • repos.yml​
  • metascoop/​
  • fdroid/​
  • 测试​
  • 安全​
  1. 入门
  2. 移动端
  3. Android

F-Droid

上一页Android下一页iOS

最后更新于1个月前

对应的

概述

Bitwarden F-Droid 存储库托管在 上。它包含所有在 F-Droid 上可用的 Bitwarden App。

Bitwarden F-Droid 存储库会定期自动更新,以确保存储库中托管的 App 与 Google Play Store 发布的最新版本保持同步。

设置

Go

构建和运行 metascoop 应用程序需要 Go 语言。

使用 Homebrew 下载和安装 Go 的命令如下:

brew install go

其他下载和安装选项请参阅 。

F-Droid 服务器和存储库工具

要手动更新 F-Droid 存储库,需要使用 F-Droid 服务器和存储库工具。安装说明请参阅。

安卓 SDK

F-Droid 服务器和存储库工具需要 apksigner,它是安卓 SDK 的一部分。

要使用 Homebrew 安装所需的安卓 SDK 工具,请运行以下命令:

brew install android-sdk
android update sdk --no-ui --all --filter tools,platform-tools,build-tools-25.0.0

该存储库的结构如下:

  • fdroid/:存放应用程序的 F-Droid 存储库。

  • metascoop/:用于在 Bitwarden App 发布新版本时更新 F-Droid 存储库的 Go App。

  • repos.yml:定义源存储库和可托管 F-Droid App 的文件。

此文件包含有关 MetasCoop 将搜索新的 F-Droid 版本的源存储库的详细信息。它使用以下结构来声明存储库及其应用程序:

my-repository:
  git: "https://github.com/bitwarden/android"
  applications:
    - filename: "com.x8bit.bitwarden-fdroid.apk"
      id: "bitwarden"
      name: "Bitwarden"
      categories:
        - Security
      description: |
        My awesome app description.
  • my-repository:存储库的名称。用于在索引中识别存储库。

  • git:源存储库的 URL。

  • applications:存储库中可用的应用程序。可以通过向 applications 列表中添加新条目来向存储库添加多个应用程序。

    • filename:将要从源存储库下载的 APK 文件的名称。

    • id:应用程序 ID。这必须是唯一的,用于在 F-Droid 存储库中识别应用程序。

    • name:在 F-Droid 中查看应用程序时显示给用户的名称。

    • categories:应用程序所属的分类。用于在 F-Droid 中对应用程序进行分类。

    • description:在 F-Droid 中查看应用程序时显示给用户的描述。

Bitwarden 的 F-Droid 存储库配置为在源仓库中检测到新版本时自动更新应用程序,这些源存储库在 repos.yml 中定义。

这通过使用 metascoop 应用程序来获取源存储库的最新版本,然后更新存储库索引来完成。

metascoop 应用程序由 CI/CD 管道定期运行,以确保存储库索引保持最新。

当检测到源存储库中的更改时,任何新的发布都将添加到 F-Droid 存储库中,并执行 fdroid update 命令以更新 F-Droid 服务器和存储库元数据。CI/CD 管道将自动创建一个拉取请求以更新存储库中的这些更改。

此目录中的大多数文件由 metascoop App 和 fdroid 工具生成。一些文件无法自动生成,必须手动编辑。

F-Droid 存储库配置在 config.yml 文件中。这包括名称、描述和存档设置等详细信息。出于安全考虑,此文件不会被跟踪。

F-Droid 存储库图标存储在 fdroid/icon.png 中。

一些应用程序元数据,如应用程序图标、功能图形和截图,未在 repos.yml 文件中定义,必须放置在 F-Droid 存储库的正确位置。

以下目录结构用于存储应用程序图像:

  • fdroid/repo/<app-id>/<locale>/icon.png :应用程序图标。

  • fdroid/repo/<app-id>/<locale>/feature-graphic.png :功能图形。

  • 各种设备的截图。例如 fdroid/repo/com.x8bit.bitwarden/en-US/phoneScreenshots/login-screenshot.png 。

运行 run_metascoop.sh 和 update_repo.sh 脚本可以手动检查新发布并更新 F-Droid 存储库。这在进行测试时特别有帮助。

当在本地执行 run_metascoop.sh 时,需要存储库密钥库,因为 fdroid update 作为过程的一部分被执行。

可以通过在 fdroid 目录下运行 fdroid init 命令并按照提示操作来生成一个临时密钥库。这将生成具有默认值的 config.yml 和 keystore.p12 文件。

运行以下命令以生成新的密钥库和配置:

cd fdroid
fdroid init

如果您需要访问生产环境的 F-Droid 密钥库和配置,请联系您的管理员。

请勿推送由本地生成的密钥库或配置签名的更改。

使用本地生成的密钥库或配置将强制重新生成所有元数据和重新签名仓库。这些更改仅应用于本地测试。

要从 Android 模拟器连接到您的本地存储库,请使用 10.0.2.2 而不是 localhost。

对于 macOS 用户

如果使用 nginx 作为 Web 服务器,并且使用 Homebrew 安装,Web 根目录位于 /opt/homebrew/var/www/。

要启动/停止 nginx,请运行:

brew services start nginx
brew services stop nginx

默认情况下,从 homebrew 启动时,nginx 将监听端口 8080。从模拟器进入时,本地服务器 URL 的示例应如下所示: http://10.0.2.2:8080/fdroid/repo

可以从 GitHub Actions 标签页触发 fdroid.yml 工作流。勾选「Dry run」复选框可以在不发布更改的情况下运行工作流。默认情况下,工作流会将更改发布到 F-Droid 存储库。

F-Droid 存储库使用 Bitwarden 拥有的证书进行签名。用户可将签名与 README.md 文件中提供的指纹进行比较,以验证存储库的有效性。

可以在找到下载和安装所需 Android SDK 工具的替代说明。

文件结构

repos.yml

metascoop/

fdroid/

F-Droid 存储库配置

存储库图标

应用程序图片

元数据文件结构详细信息请参阅。

测试

本地测试

可以运行本地 F-Droid 服务器进行端到端测试。此类测试需要将您的计算机设置为 Web 服务器,并将整个存储库复制到 Web 根目录中。有关设置本地演示存储库的说明,请参阅。

远程测试

安全

官方页面地址
​
GitHub
​
Go 安装文档
​
官方 F-Droid 服务器和存储库工具文档
​
此处
​
​
​
​
​
​
​
官方 F-Droid 文档
​
​
官方 F-Droid 文档
​
​