andOTP/README.md

#  andOTP -  Android OTP Authenticator

[![Build Status](https://travis-ci.org/flocke/andOTP.svg?branch=master)](https://travis-ci.org/flocke/andOTP)
[![Current release](https://img.shields.io/github/release/flocke/andOTP/all.svg)](https://github.com/flocke/andOTP/releases/download/v0.2.6/andOTP_v0.2.6.apk)

![andOTP](./assets/logo.png)

andOTP is a two-factor authentication App for Android 4.4+.

It implements Time-based One-time Passwords (TOTP) like specified in RFC 6238.  
Simply scan the QR code and login with the generated 6-digit code. 

This is a fork of the great OTP Authenticator app written by Bruno Bierbaumer,
which has sadly been inactive since 2015. All credit for the original version
goes to Bruno.

## Features:

 * Free and Open-Source
 * Requires minimal permissions
   - Camera access for QR code scanning
   - Storage access for import and export of the database
 * Encrypted storage
 * Multiple backup options:
   - Plain-text
   - Password-protected
   - OpenPGP-encrypted
 * Sleek minimalistic Material Design with a Dark and Light theme
 * Great Usability
 * Compatible with Google Authenticator

## Backups:

To keep your account information as secure as possible andOTP only stores it in
encrypted data files. A part of the encryption key used for that is stored in the
Android KeyStore system. The advantage of this approach is that the key is kept
separate from the apps data and, as a bonus, can be backed by hardware cryptography
(if your device supports this).

However, due to that separation, backups with 3rd-party apps like Titanium Backup can not
be used with andOTP. Such apps only backup the encrypted data files and not the encryption
key, which renders them useless.

**Please only use the internal backup functions provided by andOTP to backup your accounts!**
**Everything else WILL result in data loss.**

### Opening the backups on your PC:

 * [OpenPGP](http://openpgp.org/): OpenPGP can be used to easily decrypt the OpenPGP-encrypted backups on your PC.
 * [andOTP-decrypt](https://github.com/asmw/andOTP-decrypt): A python script written by @asmw to decrypt password-protected backups on your PC (needs more testing).

## Migration:

 * [FreeOTP](https://freeotp.github.io/): https://github.com/viljoviitanen/freeotp-export

## Downloads:

[<img height=80 alt="Get it on Google Play" src="https://play.google.com/intl/en_us/badges/images/generic/en-play-badge.png" />](https://play.google.com/store/apps/details?id=org.shadowice.flocke.andotp)
[<img height=80 alt="Get it on F-Droid" src="https://f-droid.org/badge/get-it-on.png" />](https://f-droid.org/packages/org.shadowice.flocke.andotp/)
[<img height=80 alt="Get it on GitHub" src="https://raw.githubusercontent.com/flocke/andOTP/master/assets/badges/get-it-on-github.png" />](https://github.com/flocke/andOTP/releases)

**Warning**: All three versions (Google Play, F-Droid and the APKs) are not compatible (not signed by the same key)!
You will have to uninstall one to install the other, which will delete all your data.
So make sure you have a **current backup** before switching!

## Contribute:

 * **Translation**: If you want to help translate andOTP into your language head over to the [Crowdin project](https://crowdin.com/project/andotp).
 * **Bug reports and feature requests**: You can report bugs and request features in the [Issue tracker](https://github.com/flocke/andOTP/issues) on GitHub.
 * **Discussion**: You can discuss anything related to andOTP in the [XDA thread](https://forum.xda-developers.com/android/apps-games/app-andotp-android-otp-authenticator-t3636993).

#### Contributors:

 * [Carlos Melero](https://github.com/carmebar) ([view contributions](https://github.com/flocke/andOTP/commits/master?author=carmebar))
 * [SuperVirus](https://github.com/SuperVirus) ([view contributions](https://github.com/flocke/andOTP/commits/master?author=SuperVirus))

#### Translators:

 * 🇵🇱 Polish (pl-rPL): [Daniel Pustuła](https://github.com/9Cube-dpustula)
 * :es: Spanish (es-rES): [Carlos Melero](https://crowdin.com/profile/carmebar)
 * :de: German (de-rDE): [SuperVirus](https://crowdin.com/profile/SuperVirus)

## Screenshots:

[<img width=200 alt="Main Activity" src="https://raw.githubusercontent.com/flocke/andOTP/master/assets/screenshots/main_activity.png">](https://raw.githubusercontent.com/flocke/andOTP/master/assets/screenshots/main_activity.png)
[<img width=200 alt="Main Activity" src="https://raw.githubusercontent.com/flocke/andOTP/master/assets/screenshots/settings_activity.png">](https://raw.githubusercontent.com/flocke/andOTP/master/assets/screenshots/settings_activity.png)
[<img width=200 alt="Main Activity" src="https://raw.githubusercontent.com/flocke/andOTP/master/assets/screenshots/backup_activity.png">](https://raw.githubusercontent.com/flocke/andOTP/master/assets/screenshots/backup_activity.png)

[<img width=200 alt="Main Activity" src="https://raw.githubusercontent.com/flocke/andOTP/master/assets/screenshots/main_activity_dark.png">](https://raw.githubusercontent.com/flocke/andOTP/master/assets/screenshots/main_activity_dark.png)
[<img width=200 alt="Main Activity" src="https://raw.githubusercontent.com/flocke/andOTP/master/assets/screenshots/settings_activity_dark.png">](https://raw.githubusercontent.com/flocke/andOTP/master/assets/screenshots/settings_activity_dark.png)
[<img width=200 alt="Main Activity" src="https://raw.githubusercontent.com/flocke/andOTP/master/assets/screenshots/backup_activity_dark.png">](https://raw.githubusercontent.com/flocke/andOTP/master/assets/screenshots/backup_activity_dark.png)

## Acknowledgments:
#### Open-source components used:

 * [Apache Commons Codec](https://commons.apache.org/proper/commons-codec/)
 * [LicensesDialog](https://github.com/PSDev/LicensesDialog)
 * [MaterialProgressBar](https://github.com/DreaminginCodeZH/MaterialProgressBar)
 * [OpenPGP API library](https://github.com/open-keychain/openpgp-api)
 * [VNTNumberPickerPreference](https://github.com/vanniktech/VNTNumberPickerPreference)
 * [ZXing Android Embedded](https://github.com/journeyapps/zxing-android-embedded)

#### Code examples used:

 * [Android-ItemTouchHelper-Demo](https://github.com/iPaulPro/Android-ItemTouchHelper-Demo/tree/master/app/src/main/java/co/paulburke/android/itemtouchhelperdemo/helper)
 * [Code Parts from Google's Android Samples](https://android.googlesource.com/platform/development/+/master/samples/Vault/src/com/example/android/vault)
 * [FloatingActionMenuAndroid](https://github.com/pmahsky/FloatingActionMenuAndroid)

## License:
```
Copyright (C) 2017 Jakob Nixdorf <flocke@shadowice.org>
Copyright (C) 2015 Bruno Bierbaumer

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in the
Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE
OR OTHER DEALINGS IN THE SOFTWARE.
```
Rebrand my fork as andOTP 2017-06-28 08:29:18 +00:00			`# andOTP - Android OTP Authenticator`
Add some badges to the README 2017-07-05 12:57:49 +00:00
			`[![Build Status](https://travis-ci.org/flocke/andOTP.svg?branch=master)](https://travis-ci.org/flocke/andOTP)`
Bump to version 0.2.6 2017-08-22 08:13:41 +00:00			`[![Current release](https://img.shields.io/github/release/flocke/andOTP/all.svg)](https://github.com/flocke/andOTP/releases/download/v0.2.6/andOTP_v0.2.6.apk)`
Add some badges to the README 2017-07-05 12:57:49 +00:00
New logo for my fork 2017-06-28 11:17:53 +00:00			`![andOTP](./assets/logo.png)`
Update README.md 2015-11-22 00:07:14 +00:00
Bump minSdkVersion to 19 (KitKat 4.4) This is needed for the file selector dialog 2017-07-02 15:42:51 +00:00			`andOTP is a two-factor authentication App for Android 4.4+.`
Update README.md 2015-11-25 23:21:17 +00:00
Update README.md 2015-11-25 23:39:20 +00:00			`It implements Time-based One-time Passwords (TOTP) like specified in RFC 6238.`
Update README.md 2015-11-25 23:49:03 +00:00			`Simply scan the QR code and login with the generated 6-digit code.`
Update README.md 2015-11-25 23:27:58 +00:00
Rebrand my fork as andOTP 2017-06-28 08:29:18 +00:00			`This is a fork of the great OTP Authenticator app written by Bruno Bierbaumer,`
			`which has sadly been inactive since 2015. All credit for the original version`
			`goes to Bruno.`
Update README.md 2015-11-25 23:27:58 +00:00
Update README.md 2015-11-25 21:54:09 +00:00			`## Features:`
Update README 2017-06-30 16:21:57 +00:00
			`* Free and Open-Source`
			`* Requires minimal permissions`
Update README 2017-07-03 11:17:57 +00:00			`- Camera access for QR code scanning`
			`- Storage access for import and export of the database`
Update README 2017-06-30 16:21:57 +00:00			`* Encrypted storage`
Update README and CHANGELOG 2017-07-31 21:20:21 +00:00			`* Multiple backup options:`
			`- Plain-text`
			`- Password-protected`
			`- OpenPGP-encrypted`
			`* Sleek minimalistic Material Design with a Dark and Light theme`
Update README 2017-06-30 16:21:57 +00:00			`* Great Usability`
			`* Compatible with Google Authenticator`

Update README 2017-07-20 11:14:22 +00:00			`## Backups:`

Fix README 2017-07-20 13:07:24 +00:00			`To keep your account information as secure as possible andOTP only stores it in`
			`encrypted data files. A part of the encryption key used for that is stored in the`
			`Android KeyStore system. The advantage of this approach is that the key is kept`
			`separate from the apps data and, as a bonus, can be backed by hardware cryptography`
			`(if your device supports this).`

			`However, due to that separation, backups with 3rd-party apps like Titanium Backup can not`
			`be used with andOTP. Such apps only backup the encrypted data files and not the encryption`
			`key, which renders them useless.`
Update README 2017-07-20 11:14:22 +00:00
			`Please only use the internal backup functions provided by andOTP to backup your accounts!`
			`Everything else WILL result in data loss.`

README: add opening of encrypted backup on the PC Closes #19 2017-07-30 14:38:17 +00:00			`### Opening the backups on your PC:`

			`* [OpenPGP](http://openpgp.org/): OpenPGP can be used to easily decrypt the OpenPGP-encrypted backups on your PC.`
			`* [andOTP-decrypt](https://github.com/asmw/andOTP-decrypt): A python script written by @asmw to decrypt password-protected backups on your PC (needs more testing).`

README: add info on migration from FreeOTP Closes #2 2017-08-04 11:03:30 +00:00			`## Migration:`

			`* [FreeOTP](https://freeotp.github.io/): https://github.com/viljoviitanen/freeotp-export`

Add Downloads to the README 2017-07-15 07:22:24 +00:00			`## Downloads:`
README.md: add F-Droid link 2015-12-20 22:40:21 +00:00
Add F-Droid badge (even if the app is not yet on the website) 2017-07-23 09:22:46 +00:00			`[<img height=80 alt="Get it on Google Play" src="https://play.google.com/intl/en_us/badges/images/generic/en-play-badge.png" />](https://play.google.com/store/apps/details?id=org.shadowice.flocke.andotp)`
			`[<img height=80 alt="Get it on F-Droid" src="https://f-droid.org/badge/get-it-on.png" />](https://f-droid.org/packages/org.shadowice.flocke.andotp/)`
Use the correct link for the badge 2017-07-24 08:30:24 +00:00			`[<img height=80 alt="Get it on GitHub" src="https://raw.githubusercontent.com/flocke/andOTP/master/assets/badges/get-it-on-github.png" />](https://github.com/flocke/andOTP/releases)`
Play Store release 2017-07-15 19:22:51 +00:00
Add F-Droid badge (even if the app is not yet on the website) 2017-07-23 09:22:46 +00:00			`Warning: All three versions (Google Play, F-Droid and the APKs) are not compatible (not signed by the same key)!`
Play Store release 2017-07-15 19:22:51 +00:00			`You will have to uninstall one to install the other, which will delete all your data.`
			`So make sure you have a current backup before switching!`
Add Downloads to the README 2017-07-15 07:22:24 +00:00
Add a Contribute section to the README 2017-08-07 18:55:57 +00:00			`## Contribute:`

			`* Translation: If you want to help translate andOTP into your language head over to the [Crowdin project](https://crowdin.com/project/andotp).`
			`* Bug reports and feature requests: You can report bugs and request features in the [Issue tracker](https://github.com/flocke/andOTP/issues) on GitHub.`
README: reformat a little 2017-08-07 19:02:36 +00:00			`* Discussion: You can discuss anything related to andOTP in the [XDA thread](https://forum.xda-developers.com/android/apps-games/app-andotp-android-otp-authenticator-t3636993).`

README: add contributors 2017-08-10 07:28:16 +00:00			`#### Contributors:`

Update README 2017-08-10 09:34:37 +00:00			`* [Carlos Melero](https://github.com/carmebar) ([view contributions](https://github.com/flocke/andOTP/commits/master?author=carmebar))`
Add SuperVirus to contributors 2017-08-18 11:01:56 +00:00			`* [SuperVirus](https://github.com/SuperVirus) ([view contributions](https://github.com/flocke/andOTP/commits/master?author=SuperVirus))`
README: add contributors 2017-08-10 07:28:16 +00:00
README: move translators up 2017-08-08 20:05:42 +00:00			`#### Translators:`

Add credits for polish translation 2017-08-09 05:44:07 +00:00			`* 🇵🇱 Polish (pl-rPL): [Daniel Pustuła](https://github.com/9Cube-dpustula)`
README: move translators up 2017-08-08 20:05:42 +00:00			`* :es: Spanish (es-rES): [Carlos Melero](https://crowdin.com/profile/carmebar)`
Translation: add de-rDE from Crowdin 2017-08-18 13:44:06 +00:00			`* :de: German (de-rDE): [SuperVirus](https://crowdin.com/profile/SuperVirus)`
README: move translators up 2017-08-08 20:05:42 +00:00
README: reformat a little 2017-08-07 19:02:36 +00:00			`## Screenshots:`

			`[<img width=200 alt="Main Activity" src="https://raw.githubusercontent.com/flocke/andOTP/master/assets/screenshots/main_activity.png">](https://raw.githubusercontent.com/flocke/andOTP/master/assets/screenshots/main_activity.png)`
			`[<img width=200 alt="Main Activity" src="https://raw.githubusercontent.com/flocke/andOTP/master/assets/screenshots/settings_activity.png">](https://raw.githubusercontent.com/flocke/andOTP/master/assets/screenshots/settings_activity.png)`
			`[<img width=200 alt="Main Activity" src="https://raw.githubusercontent.com/flocke/andOTP/master/assets/screenshots/backup_activity.png">](https://raw.githubusercontent.com/flocke/andOTP/master/assets/screenshots/backup_activity.png)`

			`[<img width=200 alt="Main Activity" src="https://raw.githubusercontent.com/flocke/andOTP/master/assets/screenshots/main_activity_dark.png">](https://raw.githubusercontent.com/flocke/andOTP/master/assets/screenshots/main_activity_dark.png)`
			`[<img width=200 alt="Main Activity" src="https://raw.githubusercontent.com/flocke/andOTP/master/assets/screenshots/settings_activity_dark.png">](https://raw.githubusercontent.com/flocke/andOTP/master/assets/screenshots/settings_activity_dark.png)`
			`[<img width=200 alt="Main Activity" src="https://raw.githubusercontent.com/flocke/andOTP/master/assets/screenshots/backup_activity_dark.png">](https://raw.githubusercontent.com/flocke/andOTP/master/assets/screenshots/backup_activity_dark.png)`
Add a Contribute section to the README 2017-08-07 18:55:57 +00:00
Improve the progress bar 2017-06-29 15:10:18 +00:00			`## Acknowledgments:`
Update README 2017-07-05 10:48:47 +00:00			`#### Open-source components used:`
Improve the progress bar 2017-06-29 15:10:18 +00:00
Fix small typo in README 2017-07-05 11:11:30 +00:00			`* [Apache Commons Codec](https://commons.apache.org/proper/commons-codec/)`
Move the about dialog to a new activity 2017-07-13 10:15:54 +00:00			`* [LicensesDialog](https://github.com/PSDev/LicensesDialog)`
Improve the progress bar 2017-06-29 15:10:18 +00:00			`* [MaterialProgressBar](https://github.com/DreaminginCodeZH/MaterialProgressBar)`
Initial implementation of OpenPGP exports (WIP) 2017-07-14 10:53:29 +00:00			`* [OpenPGP API library](https://github.com/open-keychain/openpgp-api)`
Make the font size of the labels configurable Closes #18 2017-07-30 19:38:45 +00:00			`* [VNTNumberPickerPreference](https://github.com/vanniktech/VNTNumberPickerPreference)`
Improve the progress bar 2017-06-29 15:10:18 +00:00			`* [ZXing Android Embedded](https://github.com/journeyapps/zxing-android-embedded)`

Update README 2017-07-05 10:48:47 +00:00			`#### Code examples used:`

			`* [Android-ItemTouchHelper-Demo](https://github.com/iPaulPro/Android-ItemTouchHelper-Demo/tree/master/app/src/main/java/co/paulburke/android/itemtouchhelperdemo/helper)`
			`* [Code Parts from Google's Android Samples](https://android.googlesource.com/platform/development/+/master/samples/Vault/src/com/example/android/vault)`
			`* [FloatingActionMenuAndroid](https://github.com/pmahsky/FloatingActionMenuAndroid)`

Update README.md 2015-11-22 00:07:14 +00:00			`## License:`
			```
Rebrand my fork as andOTP 2017-06-28 08:29:18 +00:00			`Copyright (C) 2017 Jakob Nixdorf <flocke@shadowice.org>`
Update README.md 2015-11-22 01:31:45 +00:00			`Copyright (C) 2015 Bruno Bierbaumer`
Update license formating in the README 2017-07-07 08:57:32 +00:00
Update README.md 2015-11-22 00:07:14 +00:00			`Permission is hereby granted, free of charge, to any person obtaining a copy of`
			`this software and associated documentation files (the "Software"), to deal in the`
			`Software without restriction, including without limitation the rights to`
			`use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of`
			`the Software, and to permit persons to whom the Software is furnished to do so,`
			`subject to the following conditions:`
Update license formating in the README 2017-07-07 08:57:32 +00:00
Update README.md 2015-11-22 00:07:14 +00:00			`The above copyright notice and this permission notice shall be included in all`
			`copies or substantial portions of the Software.`
Update license formating in the README 2017-07-07 08:57:32 +00:00
Update README.md 2015-11-22 00:07:14 +00:00			`THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,`
			`INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR`
			`PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE`
			`LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,`
			`TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE`
			`OR OTHER DEALINGS IN THE SOFTWARE.`
			```