diff --git a/README.md b/README.md index b5a4c35..43776f8 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,24 @@ # SailOTP -SailOTP is a Sailfish Implementation of the Google-Authenticator algorithm, -also known as Timebased One Time Pad (TOPT) as described in RFC 6238. A growing +SailOTP is a Sailfish Implementation of the Google-Authenticator algorithms, +also known as TOPT (timer based) and HOTP (counter based) as described in RFC 6238 and 4226. A growing number of sites uses this algorithm for two-factor-authentication, including Github, Linode and several Google services. -One can add new OTP-entries using the pulley-menu. The main view of the app will show a list -off all entries and their current One-Time-Tokens. The entries will be regenerated every 30 seconds, -the remaining time for the current tokens is shown through a progress bar at the top of the app. +One can add new OTP-entries using the pulley-menu. The type of token can be selected. Title and the shared +secret have to be provided. For counter based HOTP-tokens the counter value for the next update of the +Token can be set. The default of 1 is the standard value for new HOTP-tokens and should not be changed. + +The main view of the app will show a list off all entries and their current One-Time-Tokens. +The entries will be regenerated every 30 seconds, the remaining time for the current tokens is shown +through a progress bar at the top of the app. HOTP-type tokens are not updated automatically, instead +a refresh button is shown on the right of the token to calculate the next value and increment the counter An entry can be edited or deleted by long-pressing on it. One entry can be stared by tapping the star icon on the left. the stared item will be shown -on the ActiveCover and refreshed every 30 seconds. 5 seconds before the token changes it's -color will change to red. The Item can be unstared by tapping it again. +on the ActiveCover. If the Token is timer based, it will be refreshed every 30 seconds. 5 seconds before the token changes it's +color will change to red. For counter based tokens a cover action to calculate the next token is shown instead. +The item can be unstared by tapping the star icon again on the main view. From the main view a token can be copied to the clipboard by tapping on it. diff --git a/qml/pages/About.qml b/qml/pages/About.qml index bd5263f..d2dcf17 100644 --- a/qml/pages/About.qml +++ b/qml/pages/About.qml @@ -44,14 +44,14 @@ Page { anchors.horizontalCenter: parent.horizontalCenter y: 320 font.bold: true - text: "SailOTP 0.3" + text: "SailOTP 0.4" } Text { id: desc anchors.horizontalCenter: parent.horizontalCenter anchors.top: name.bottom anchors.topMargin: 20 - text: "A Simple Sailfish TOTP Generator
(RFC 6238 compatible)" + text: "A Simple Sailfish OTP Generator
(RFC 6238/4226 compatible)" color: "white" } Text { diff --git a/rpm/harbour-sailotp.yaml b/rpm/harbour-sailotp.yaml index fe70ee5..a48c866 100644 --- a/rpm/harbour-sailotp.yaml +++ b/rpm/harbour-sailotp.yaml @@ -1,6 +1,6 @@ Name: harbour-sailotp Summary: SailOTP -Version: 0.3 +Version: 0.4 Release: 1 Group: Security URL: https://github.com/seiichiro0185/sailotp/ @@ -8,7 +8,7 @@ License: "BSD\t" Sources: - '%{name}-%{version}.tar.bz2' Description: | - A Sailfish implementation of the Timebased One Time Pad algorithm as used by Google Authenticator and a growing number of Websites. + A Sailfish implementation of the One Time Pad algorithm as used by Google Authenticator and a growing number of Websites. Configure: none Builder: qtc5 PkgConfigBR: