Repository files navigation

Bitwarden Authenticator allows you easily store and generate two-factor authentication codes on your device. The Bitwarden Authenticator Android application is written in Kotlin.

• Minimum SDK: 28
• Target SDK: 34
• Device Types Supported: Phone and Tablet
• Orientations Supported: Portrait and Landscape

1. Clone the repository:

   $ git clone https://github.com/bitwarden/authenticator-android

2. Create auser.properties file in the root directory of the project and add the following properties:

   • gitHubToken: A "classic" Github Personal Access Token (PAT) with theread:packages scope (ex:gitHubToken=gph_xx...xx). These can be generated by going to theGithub tokens page. Seethe Github Packages user documentation concerning authentication for more details.

3. Setup the code style formatter:

   All code must follow the guidelines described in theCode Style Guidelines document. To aid in adhering to these rules, all contributors should applydocs/bitwarden-style.xml as their code style scheme. In IntelliJ / Android Studio:

   • Navigate toPreferences > Editor > Code Style.
   • Hit theManage button next toScheme.
   • SelectImport.
   • Find thebitwarden-style.xml file in the project'sdocs/ directory.
   • Import "from"BitwardenStyle "to"BitwardenStyle.
   • HitApply andOK to save the changes and exit Preferences.

   Note that in some cases you may need to restart Android Studio for the changes to take effect.

   All code should be formatted before submitting a pull request. This can be done manually but it can also be helpful to create a macro with a custom keyboard binding to auto-format when saving. In Android Studio on OS X:

   • SelectEdit > Macros > Start Macro Recording
   • SelectCode > Optimize Imports
   • SelectCode > Reformat Code
   • SelectFile > Save All
   • SelectEdit > Macros > Stop Macro Recording

   This can then be mapped to a set of keys by navigating toAndroid Studio > Preferences and editing the macro underKeymap (ex : shift + command + s).

   Please avoid mixing formatting and logical changes in the same commit/PR. When possible, fix any large formatting issues in a separate PR before opening one to make logical changes to the same code. This helps others focus on the meaningful code changes when reviewing the code.

Code contributions are welcome! Please commit any pull requests against themain branch. Learn more about how to contribute by reading theContributing Guidelines. Check out theContributing Documentation for how to get started with your first contribution.

Security audits and feedback are welcome. Please open an issue or email us privately if the report is sensitive in nature. You can read our security policy in theSECURITY.md file.