Repository files navigation

This project is an open source fork of the Google Authenticator Android app onthePlay Store. While this fork is open source, theofficial version of the app still remains proprietary. There is noguarantee that theopen source repository will receive any changesmade upstream (or vice versa).

Google Authenticator generates 2-Step Verification codes on your phone.

2-Step Verification provides stronger security for your Google Account byrequiring a second step of verification when you sign in. In addition to yourpassword, you’ll also need a code generated by the Google Authenticator app onyour phone.

Learn more about 2-Step Verification:https://g.co/2step

Features:

• Generate verification codes without a data connection
• Google Authenticator works with many providers & accounts
• Dark theme available
• Automatic setup via QR code

Disclaimer: Thisopen source fork of Authenticator isnot anofficially supported Google product.

The Google Authenticator project includes implementations of one-time passcodegenerators for several mobile platforms, as well as a Pluggable AuthenticationModule(PAM). One-time passcodes are generated using open standardsdeveloped by theInitiative for Open Authentication (OATH) (which isunrelated toOAuth).

• This project contains the Android app.All other apps and thePAM module are hosted in separate projects.

• The Android implementation supports the HMAC-Based One-time Password (HOTP)algorithm specified inRFC 4226 and the Time-based One-time Password(TOTP) algorithm specified inRFC 6238.

• By design, there areno account backups in any of the apps.

Further documentation is available in theWiki.

The APKs for the official version and the open source version of Authenticatorare hosted separately. Installing the app should be as simple as downloading theAPK from your desired source.

You can install the official (proprietary) version of Google Authenticator fromtheGoogle Play Store.

The easiest way to install the open source flavor of Authenticator is todownload the latest version of the APK from thereleases page from theGitHub repository. To build the APK from the source code, see the section aboutbuilding from source.

Interested in developing with Authenticator? Instructions to get started arebelow. Please be sure to review theContributor Guide and theCode of Conduct if you would like to contribute to thisrepository.

• Android SDK v28
• Android Build Tools v28.0.3
• Bazel 0.12.0+
• Git

Google Authenticator is built withBazel. To install Bazel on your machine,follow theinstallation instructions provided in the officialBazel documentation. You can download the appropriate versions of the AndroidSDK and Build Tools via the AndroidSDK Manager.

1. Clone the repository.

   git clone https://github.com/google/google-authenticator-android.gitcd google-authenticator-android

2. Set theANDROID_HOME environment variable to the path of your Android SDK,or hardcode the value into theWORKSPACE file.

   export ANDROID_HOME="/path/to/sdk"# or$EDITOR WORKSPACE

3. Build the APK with Bazel. The APK build target is at//java/com/google/android/apps/authenticator. If you already have anemulator running or device attached to your machine, you can use themobile-install Bazel directive to put the app directly on your Androiddevice. Otherwise, build the APK normally and install it on your device viaadb.

   bazel mobile-install //java/com/google/android/apps/authenticator# orbazel build //java/com/google/android/apps/authenticator \&& adb install -r -d bazel-bin/java/com/google/android/apps/authenticator/authenticator.apk

Running the tests for Authenticator requires additionalprerequisites described in theandroid_instrumentation_test documentation. Most notably, at the moment,tests can only be run onLinux. There is an opentracking issue for adding test support to otheroperating systems. Please file Bazel-related issues against theBazel repository instead of this repository.

Running tests also requires the appropriate Android emulator images to beinstalled (depending on the specific test target). You can download anynecessary images from theAVD Manager.

All test targets can be found under thejavatests/ directory.

bazeltest //javatests/...

By default, all tests will be run on a headless emulator. To see the Androiddevice running the test, or to run tests on a specific device or emulator,specify the value of theconfig flag in the Bazel test command to be one ofheadless,gui, orlocal_device.

# Run headless tests (default)bazeltest --config=headless //javatests/com/google/android/apps/authenticator:authenticator_instrumentation_tests-19# Run tests on an ephemeral emulator that displays the GUIbazeltest --config=gui //javatests/com/google/android/apps/authenticator:authenticator_instrumentation_tests-19# Run tests on an emulator or attached devicebazeltest --config=local_device //javatests/com/google/android/apps/authenticator:authenticator_instrumentation_tests-19

WARNING: Running tests on a real device may delete your preexisting OTPseeds. Do it at your own risk. If you must run tests on a real device, it isrecommended to use a test device that doesn't hold important data.

Copyright 2019 Google LLCLicensed under the Apache License, Version 2.0 (the "License");you may not use this file except in compliance with the License.You may obtain a copy of the License at    https://www.apache.org/licenses/LICENSE-2.0Unless required by applicable law or agreed to in writing, softwaredistributed under the License is distributed on an "AS IS" BASIS,WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.See the License for the specific language governing permissions andlimitations under the License.