Add CredentialsManager and generic Storage #96

lbalmaceda · 2017-06-14T19:18:42Z

A Credentials Manager will save credentials and retrieve them checking for valid values, expiration and even refreshing them if needed. If an error arises the user receives a CredentialsManagerException.

Usage

Instantiate the manager: the Storage interface will let the user customize the persistence of the values.

AuthenticationAPIClient authClient = //create auth client
Storage storage = //create new storage
CredentialsManager manager = new CredentialsManager(authClient, storage);

Save credentials: An access_token or id_token value is needed along with a valid expires_in value, if not it will raise CredentialsManagerException.

Credentials credentials = //login to Auth0, i.e. by using the authClient
manager.setCredentials(credentials);

Retrieve credentials: If the access_token or id_token was not set it will raise CredentialsManagerException. If the saved credentials haven't expired they will be returned. If the credentials have expired and the refresh_token is null a CredentialsManagerException will be raised; else it will try to renew them by using the given authClient.

manager.getCredentials(new BaseCallback<Credentials, CredentialsManagerException>(){
   public void onSuccess(Credentials credentials){
      //success
   }

    public void onFailure(CredentialsManagerException error){
      //error
   }
});

TODO

Add tests
Provide an implementation of Storage with the library that uses SharedPreferences.
Javadoc
README

nikolaseu · 2017-06-14T21:46:51Z

auth0/src/main/java/com/auth0/android/authentication/storage/CredentialsManager.java

+        storage.store(KEY_ID_TOKEN, credentials.getIdToken());
+        storage.store(KEY_TOKEN_TYPE, credentials.getType());
+
+        long expiresIn = credentials.getExpiresIn() == null ? 0 : credentials.getExpiresIn();


you throw an exception if credentials.getExpiresIn() is null, so there's no need to check again

nikolaseu · 2017-06-14T21:52:33Z

auth0/src/main/java/com/auth0/android/authentication/storage/CredentialsManager.java

+        String expirationTimeValue = storage.retrieve(KEY_EXPIRATION_TIME);
+        Long expiresIn = Long.parseLong(expiresInValue);
+
+        boolean invalidTokens = isEmpty(accessToken) && isEmpty(idToken);


only a suggestion: I don't think a variable is necessary here..
this condition is way simpler than the if in https://github.com/auth0/Auth0.Android/pull/96/files#diff-2651976c12b43b2192543b92b10ed2e4R46

nikolaseu · 2017-06-14T21:53:36Z

auth0/src/main/java/com/auth0/android/authentication/storage/CredentialsManager.java

+
+        boolean invalidTokens = isEmpty(accessToken) && isEmpty(idToken);
+        if (invalidTokens) {
+            callback.onFailure(new CredentialsManagerException("No Credentials where previously set."));


"where" -> "were"

nikolaseu · 2017-06-14T22:13:21Z

auth0/src/main/java/com/auth0/android/authentication/storage/CredentialsManager.java

+            callback.onFailure(new CredentialsManagerException("No Credentials where previously set."));
+            return;
+        }
+        long expirationTime = expirationTimeValue == null ? 0 : Long.parseLong(expirationTimeValue);


expirationTimeValue should never be null from what I can see, but I guess it's almost the same, this will fail below

nikolaseu · 2017-06-14T22:20:54Z

auth0/src/main/java/com/auth0/android/result/Credentials.java

+     * Getter for the amount of seconds since the tokens were issued in which they will be deemed invalid.
+     * To know precisely when this is going to happen you need to save the time every time you request a new pair of tokens.
+     *
+     * @return the seconds since the tokens where issued in which they will be deemed invalid.


minor comment, but this is like a TTL, maybe the method and return description is easier to understand if you just say that.
or have a native english speaker help here, this doesn't sound that well

nikolaseu · 2017-06-15T17:27:42Z

auth0/src/main/java/com/auth0/android/authentication/storage/CredentialsManager.java

        if (expirationTime > getCurrentTimeInMillis()) {
+            Long expiresIn = Long.parseLong(expiresInValue);


expiresIn value is not right anymore in this case. you can use the expirationTimeValue - currentTime if necessary.

nikolaseu · 2017-06-15T17:30:39Z

auth0/src/main/java/com/auth0/android/authentication/storage/CredentialsManager.java

+        }
+        long expirationTime = Long.parseLong(expirationTimeValue);
+        if (expirationTime > getCurrentTimeInMillis()) {
+            Long expiresIn = Long.parseLong(expiresInValue);


the comment should be here ... sorry I commented with the link on the email and it comments on the commit not in the general PR

nikolaseu

LGTM, only a comment/suggestion about the usefulness of a fixed "expires_in" without knowing the issuing time.

nikolaseu · 2017-06-15T19:30:40Z

auth0/src/main/java/com/auth0/android/result/Credentials.java

+     * Getter for the token lifetime in seconds.
+     * Once expired, the token can no longer be used to access an API and a new token needs to be obtained.
+     *
+     * @return the token lifetime in seconds.


"since the time it was returned".
but is this any useful? I know the spec uses 'expires in' but maybe it's better if it's calculated? you save the calculated expiration time when the token is created, and then return "exp minus now" ?
or directly add a method to return the approximate expiration time and delete this one?

hzalaz · 2017-06-15T19:32:49Z

README.md

+```java
+AuthenticationAPIClient authClient = //create auth client
+Storage storage = //create new storage
+CredentialsManager manager = new CredentialsManager(authClient, storage);


Show how to use the default storage with the implementation warning:

The storage implementation is up to you. We provide a `SharedPreferencesStorage` that uses `SharedPreferences` to create a file in the application directory with Context.MODE_PRIVATE mode.

Also mention if this needs to be singleton or not, maybe a better example here on in QS

hzalaz · 2017-06-15T19:33:53Z

README.md

+
+```java
+Credentials credentials = //login to Auth0, i.e. by using the authClient
+manager.setCredentials(credentials);


store or save might be better

hzalaz · 2017-06-15T19:46:50Z

auth0/src/main/java/com/auth0/android/authentication/storage/Storage.java

+ * Represents a Storage of key-value data.
+ */
+@SuppressWarnings("WeakerAccess")
+public interface Storage {


The Storage should handle the types to store and its conversion so if it needs to store String and Long it should have methods to set and get them

lbalmaceda requested review from nikolaseu and hzalaz June 14, 2017 19:18

lbalmaceda force-pushed the credentials-storage branch from dcff045 to 36a4faa Compare June 14, 2017 19:20

nikolaseu reviewed Jun 14, 2017

View reviewed changes

nikolaseu reviewed Jun 15, 2017

View reviewed changes

nikolaseu approved these changes Jun 15, 2017

View reviewed changes

hzalaz suggested changes Jun 15, 2017

View reviewed changes

hzalaz approved these changes Jun 26, 2017

View reviewed changes

lbalmaceda added this to the v1-Next milestone Jun 29, 2017

lbalmaceda added the CH: Added label Jun 29, 2017

hzalaz approved these changes Jun 29, 2017

View reviewed changes

lbalmaceda added 12 commits June 29, 2017 18:25

add credentials manager

550f0bc

add javadoc

29e9c34

make Storage an interface

36e8d4a

add CredentialsManager tests

38be907

add Storage implementation using SharedPreferences in Mode.PRIVATE

5150aae

chore pr comments

f1bd126

add readme notes about the CredentialsManager

5530e78

recalculate expires_in value

4de7dad

Make Storage use generics to store/retrieve data.

1f6028c

make credentials calculate the expiration date on creation

4d3c802

simplify storage. Allow to manage strings, longs and integers

9a64dde

update readme sample

4c7dbe0

lbalmaceda force-pushed the credentials-storage branch from 05e9c9f to 4c7dbe0 Compare June 30, 2017 21:34

lbalmaceda merged commit 918b403 into master Jun 30, 2017

lbalmaceda deleted the credentials-storage branch June 30, 2017 21:49

lbalmaceda modified the milestones: v1-Next, 1.9.0 Jul 10, 2017

lbalmaceda removed this from the v1-Next milestone Jul 10, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add CredentialsManager and generic Storage #96

Add CredentialsManager and generic Storage #96

lbalmaceda commented Jun 14, 2017 •

edited

nikolaseu Jun 14, 2017

nikolaseu Jun 14, 2017

nikolaseu Jun 14, 2017

nikolaseu Jun 14, 2017

nikolaseu Jun 14, 2017

nikolaseu Jun 15, 2017

nikolaseu Jun 15, 2017

nikolaseu left a comment

nikolaseu Jun 15, 2017

hzalaz Jun 15, 2017

hzalaz Jun 15, 2017

hzalaz Jun 15, 2017

hzalaz Jun 15, 2017

		if (expirationTime > getCurrentTimeInMillis()) {
		Long expiresIn = Long.parseLong(expiresInValue);

Add CredentialsManager and generic Storage #96

Add CredentialsManager and generic Storage #96

Conversation

lbalmaceda commented Jun 14, 2017 • edited

Usage

TODO

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

nikolaseu left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lbalmaceda commented Jun 14, 2017 •

edited