diff --git a/CHANGELOG.md b/CHANGELOG.md index d7c274e..1d19ce1 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,18 @@ +# Change Log + +## [0.3.0](https://github.com/auth0/Guardian.Android/tree/0.3.0) (2017-06-01) +[Full Changelog](https://github.com/auth0/Guardian.Android/compare/0.2.0...0.3.0) + +**Added** +- Use Auth0 OSS release plugin [\#70](https://github.com/auth0/Guardian.Android/pull/70) ([nikolaseu](https://github.com/nikolaseu)) +- Add support for appliance [\#69](https://github.com/auth0/Guardian.Android/pull/69) ([nikolaseu](https://github.com/nikolaseu)) + +## [0.2.0](https://github.com/auth0/Guardian.Android/tree/0.2.0) (2016-12-07) +[Full Changelog](https://github.com/auth0/Guardian.Android/compare/0.1.0...0.2.0) + +**Added** +- Add method to get errorCode and isLoginTransactionNotFound() [#62](https://github.com/auth0/Guardian.Android/pull/62) ([nikolaseu](https://github.com/nikolaseu)) + ## [0.1.0](https://github.com/auth0/Guardian.Android/tree/0.1.0) (2016-11-23) First release of Guardian for Android diff --git a/README.md b/README.md index dfaaa65..c681698 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ Guardian SDK for Android [![Coverage Status](https://img.shields.io/codecov/c/github/auth0/Guardian.Android/master.svg)](https://codecov.io/github/auth0/Guardian.Android) [![License](http://img.shields.io/:license-mit-blue.svg)](http://doge.mit-license.org) [![Maven Central](https://img.shields.io/maven-central/v/com.auth0.android/guardian.svg)](http://search.maven.org/#search%7Cga%7C1%7Cg%3A%22com.auth0.android%22%20AND%20a%3A%22guardian%22) -[ ![Download](https://api.bintray.com/packages/auth0/android/Guardian.Android/images/download.svg) ](https://bintray.com/auth0/android/Guardian.Android/_latestVersion) +[ ![Download](https://api.bintray.com/packages/auth0/android/guardian/images/download.svg) ](https://bintray.com/auth0/android/guardian/_latestVersion) [Guardian](https://auth0.com/docs/multifactor-authentication/guardian) is Auth0's multi-factor authentication (MFA) service that provides a simple, safe way for you to implement MFA. @@ -33,7 +33,7 @@ GuardianSDK is available both in [Maven Central](http://search.maven.org) and To start using *GuardianSDK* add these lines to your `build.gradle` dependencies file: ```gradle -compile 'com.auth0.android:guardian:0.2.0' +compile 'com.auth0.android:guardian:0.3.0' ``` ## Usage diff --git a/guardian/build.gradle b/guardian/build.gradle index 2dc24f6..7b5c4a1 100644 --- a/guardian/build.gradle +++ b/guardian/build.gradle @@ -3,7 +3,7 @@ apply plugin: 'com.auth0.gradle.oss-library.android' logger.lifecycle("Using version ${version} for ${name}") oss { - name 'guardian' + name 'Guardian.Android' repository 'Guardian.Android' organization 'auth0' description 'Android toolkit for Auth0 Guardian API' diff --git a/guardian/src/main/java/com/auth0/android/guardian/sdk/Notification.java b/guardian/src/main/java/com/auth0/android/guardian/sdk/Notification.java index c495f7d..3a018ee 100644 --- a/guardian/src/main/java/com/auth0/android/guardian/sdk/Notification.java +++ b/guardian/src/main/java/com/auth0/android/guardian/sdk/Notification.java @@ -34,66 +34,88 @@ public interface Notification { /** * The id of the enrollment + * + * @return the id of the enrollment */ @NonNull String getEnrollmentId(); /** * The transaction token, used to identify the authentication request + * + * @return the transaction token */ @NonNull String getTransactionToken(); /** * The Guardian server url + * + * @return the server URL */ @NonNull String getUrl(); /** * The date/time when the authentication request was initiated + * + * @return the request start date */ @NonNull Date getDate(); /** * The name of the operating system where the authentication request was initiated + * + * @return the OS name */ @Nullable String getOsName(); /** * The version of the operating system + * + * @return the OS version */ @Nullable String getOsVersion(); /** * The name of the browser where the authentication request was initiated + * + * @return the browser name */ @Nullable String getBrowserName(); /** * The version of the browser + * + * @return the browser version */ @Nullable String getBrowserVersion(); /** * The name of the (approximate) location where the authentication request was initiated + * + * @return the location */ @Nullable String getLocation(); /** * The latitude of the (approximate) location + * + * @return the latitude */ @Nullable Double getLatitude(); /** * The longitude of the (approximate) location + * + * @return the longitude */ @Nullable Double getLongitude(); @@ -101,6 +123,8 @@ public interface Notification { /** * The challenge sent by the server. The same challenge should be sent back when trying to * allow or reject an authentication request + * + * @return the challenge */ @NonNull String getChallenge(); diff --git a/guardian/src/main/java/com/auth0/android/guardian/sdk/otp/TOTP.java b/guardian/src/main/java/com/auth0/android/guardian/sdk/otp/TOTP.java index 1745553..40e3fad 100755 --- a/guardian/src/main/java/com/auth0/android/guardian/sdk/otp/TOTP.java +++ b/guardian/src/main/java/com/auth0/android/guardian/sdk/otp/TOTP.java @@ -31,11 +31,11 @@ /** * This class generates One-Time-Passwords following the TOTP algorithm. It is an extension of the * HOTP algorithm. - *

+ *

* The supported crypto algorithms are 'sha1', 'sha256' and 'sha512'. - *

+ *

* The code is based on the sample implementation provided in the spec. - *

+ *

* See https://tools.ietf.org/html/rfc4226 and * https://tools.ietf.org/html/rfc6238 for more * information. diff --git a/guardian/src/main/java/com/auth0/android/guardian/sdk/otp/utils/Base32.java b/guardian/src/main/java/com/auth0/android/guardian/sdk/otp/utils/Base32.java index b3e0d27..ffb1479 100644 --- a/guardian/src/main/java/com/auth0/android/guardian/sdk/otp/utils/Base32.java +++ b/guardian/src/main/java/com/auth0/android/guardian/sdk/otp/utils/Base32.java @@ -23,7 +23,7 @@ /** * Encodes arbitrary byte arrays as case-insensitive base-32 strings. - *

+ *

* The implementation is slightly different than in RFC 4648. During encoding, * padding is not added, and during decoding the last incomplete chunk is not * taken into account. The result is that multiple strings decode to the same diff --git a/settings.gradle b/settings.gradle index 960222f..482d59a 100644 --- a/settings.gradle +++ b/settings.gradle @@ -1,2 +1,4 @@ +rootProject.name = 'Guardian.Android' + include ':app' include ':guardian'