Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 0738317b authored by daquexian's avatar daquexian
Browse files

Get token by Android account system when it is available

parent fbf14593

k9mail-library/src/main/java/com/fsck/k9/mail/TransportProvider.java

+3 −2
Original line number Diff line number Diff line
@@ -3,6 +3,7 @@ package com.fsck.k9.mail; 


import android.content.Context;



import com.fsck.k9.mail.oauth.OAuth2AuthorizationCodeFlowTokenProvider;

import com.fsck.k9.mail.oauth.OAuth2TokenProvider;

import com.fsck.k9.mail.ssl.DefaultTrustedSocketFactory;

import com.fsck.k9.mail.store.StoreConfig;
@@ -22,11 +23,11 @@ public class TransportProvider { 
    }



    public synchronized Transport getTransport(Context context, StoreConfig storeConfig,

            OAuth2TokenProvider oauth2TokenProvider) throws MessagingException {

            OAuth2TokenProvider oAuth2TokenProvider) throws MessagingException {

        String uri = storeConfig.getTransportUri();

        if (uri.startsWith("smtp")) {

            return new SmtpTransport(storeConfig, new DefaultTrustedSocketFactory(context),

                    oauth2TokenProvider);

                    oAuth2TokenProvider);

        } else if (uri.startsWith("webdav")) {

            return new WebDavTransport(storeConfig);

        } else {

k9mail-library/src/main/java/com/fsck/k9/mail/oauth/OAuth2AuthorizationCodeFlowTokenProvider.java

0 → 100644
+101 −0
Original line number Diff line number Diff line 
package com.fsck.k9.mail.oauth;





import com.fsck.k9.mail.AuthenticationFailedException;

import com.fsck.k9.mail.OAuth2NeedUserPromptException;



import java.util.HashMap;

import java.util.Map;





public abstract class OAuth2AuthorizationCodeFlowTokenProvider {

    /**

     * A default timeout value to use when fetching tokens.

     */

    public static int OAUTH2_TIMEOUT = 30000;



    private Map<String,String> authTokens = new HashMap<>();



    public void exchangeCode(String email, String code) throws AuthenticationFailedException {

        SpecificOAuth2TokenProvider specificProvider = getSpecificProviderFromEmail(email);

        Tokens tokens = specificProvider.exchangeCode(email, code);



        authTokens.put(email, tokens.accessToken);

        saveRefreshToken(email, tokens.refreshToken);

    }



    protected abstract void saveRefreshToken(String email, String refreshToken);



    /**

     * Fetch a token. No guarantees are provided for validity.

     * @param email Username

     * @return Token string

     * @throws AuthenticationFailedException throw when error occurs

     * @throws OAuth2NeedUserPromptException throw it when user haven't allow us to login

     */

    public String getToken(String email, long timeoutMillis)

            throws AuthenticationFailedException, OAuth2NeedUserPromptException {

        if (!authTokens.containsKey(email)) {

            String refreshToken = getRefreshToken(email);

            if (refreshToken != null) {

                try {

                    refreshToken(email, refreshToken);

                } catch (Exception e) {

                    throw new AuthenticationFailedException(e.getMessage());

                }

            } else {

                showAuthDialog(email);

                throw new OAuth2NeedUserPromptException();

            }

        }

        return authTokens.get(email);

    }



    protected abstract void showAuthDialog(String email);



    /**

     * get refresh token got before

     * @param username username (usually email address)

     * @return refresh token

     */

    protected abstract String getRefreshToken(String username);



    /**

     * refresh access token with refresh token

     * @param email email address

     * @param refreshToken refresh token got before

     * @throws AuthenticationFailedException throws it when error occurs

     */

    private void refreshToken(String email, String refreshToken) throws AuthenticationFailedException {

        SpecificOAuth2TokenProvider provider = getSpecificProviderFromEmail(email);

        String newToken = provider.refreshToken(email, refreshToken);

        authTokens.put(email, newToken);

    }



    /**

     * Invalidate the token for this email.

     *

     * <p>

     * Note that the token should always be invalidated on credential failure. However invalidating a token every

     * single time is not recommended.

     * <p>

     * Invalidating a token and then failure with a new token should be treated as a permanent failure.

     */

    public void invalidateAccessToken(String email) {

        authTokens.remove(email);

    }



    public abstract void invalidateRefreshToken(String username);



    protected abstract SpecificOAuth2TokenProvider getSpecificProviderFromEmail(String email);



    public static class Tokens {

        String accessToken;

        String refreshToken;



        public Tokens(String accessToken, String refreshToken) {

            this.accessToken = accessToken;

            this.refreshToken = refreshToken;

        }

    }

}

k9mail-library/src/main/java/com/fsck/k9/mail/oauth/OAuth2TokenProvider.java

+4 −86
Original line number Diff line number Diff line
@@ -4,9 +4,6 @@ package com.fsck.k9.mail.oauth; 
import com.fsck.k9.mail.AuthenticationFailedException;

import com.fsck.k9.mail.OAuth2NeedUserPromptException;



import java.util.HashMap;

import java.util.Map;





public abstract class OAuth2TokenProvider {

    /**
@@ -14,88 +11,9 @@ public abstract class OAuth2TokenProvider { 
     */

    public static int OAUTH2_TIMEOUT = 30000;



    private Map<String,String> authTokens = new HashMap<>();



    public void exchangeCode(String email, String code) throws AuthenticationFailedException {

        SpecificOAuth2TokenProvider specificProvider = getSpecificProviderFromEmail(email);

        Tokens tokens = specificProvider.exchangeCode(email, code);



        authTokens.put(email, tokens.accessToken);

        saveRefreshToken(email, tokens.refreshToken);

    }



    protected abstract void saveRefreshToken(String email, String refreshToken);

    public abstract String getToken(String email, long timeoutMillis) throws AuthenticationFailedException,

            OAuth2NeedUserPromptException;



    /**

     * Fetch a token. No guarantees are provided for validity.

     * @param email Username

     * @return Token string

     * @throws AuthenticationFailedException throw when error occurs

     * @throws OAuth2NeedUserPromptException throw it when user haven't allow us to login

     */

    public String getToken(String email, long timeoutMillis)

            throws AuthenticationFailedException, OAuth2NeedUserPromptException {

        if (!authTokens.containsKey(email)) {

            String refreshToken = getRefreshToken(email);

            if (refreshToken != null) {

                try {

                    refreshToken(email, refreshToken);

                } catch (Exception e) {

                    throw new AuthenticationFailedException(e.getMessage());

                }

            } else {

                showAuthDialog(email);

                throw new OAuth2NeedUserPromptException();

            }

        }

        return authTokens.get(email);

    }



    public abstract void showAuthDialog(String email);



    /**

     * get refresh token got before

     * @param username username (usually email address)

     * @return refresh token

     */

    protected abstract String getRefreshToken(String username);



    /**

     * refresh access token with refresh token

     * @param email email address

     * @param refreshToken refresh token got before

     * @throws AuthenticationFailedException throws it when error occurs

     */

    private void refreshToken(String email, String refreshToken) throws AuthenticationFailedException {

        SpecificOAuth2TokenProvider provider = getSpecificProviderFromEmail(email);

        String newToken = provider.refreshToken(email, refreshToken);

        authTokens.put(email, newToken);

    }



    /**

     * Invalidate the token for this email.

     *

     * <p>

     * Note that the token should always be invalidated on credential failure. However invalidating a token every

     * single time is not recommended.

     * <p>

     * Invalidating a token and then failure with a new token should be treated as a permanent failure.

     */

    public void invalidateAccessToken(String email) {

        authTokens.remove(email);

    }



    public abstract void invalidateRefreshToken(String username);



    protected abstract SpecificOAuth2TokenProvider getSpecificProviderFromEmail(String email);



    public static class Tokens {

        String accessToken;

        String refreshToken;



        public Tokens(String accessToken, String refreshToken) {

            this.accessToken = accessToken;

            this.refreshToken = refreshToken;

        }

    }

    public abstract void invalidateToken(String email);

    public abstract void disconnectEmailWithK9(String email);

}

k9mail-library/src/main/java/com/fsck/k9/mail/oauth/SpecificOAuth2TokenProvider.java

+1 −1
Original line number Diff line number Diff line
@@ -3,7 +3,7 @@ package com.fsck.k9.mail.oauth; 
import com.fsck.k9.mail.AuthenticationFailedException;



public abstract class SpecificOAuth2TokenProvider {

    public abstract OAuth2TokenProvider.Tokens exchangeCode(String username, String code) throws AuthenticationFailedException;

    public abstract OAuth2AuthorizationCodeFlowTokenProvider.Tokens exchangeCode(String username, String code) throws AuthenticationFailedException;



    public abstract String refreshToken(String username, String refreshToken) throws AuthenticationFailedException;

k9mail-library/src/main/java/com/fsck/k9/mail/store/RemoteStore.java

+2 −1
Original line number Diff line number Diff line
@@ -11,6 +11,7 @@ import com.fsck.k9.mail.MessagingException; 
import com.fsck.k9.mail.ServerSettings;

import com.fsck.k9.mail.ServerSettings.Type;

import com.fsck.k9.mail.Store;

import com.fsck.k9.mail.oauth.OAuth2AuthorizationCodeFlowTokenProvider;

import com.fsck.k9.mail.oauth.OAuth2TokenProvider;

import com.fsck.k9.mail.ssl.DefaultTrustedSocketFactory;

import com.fsck.k9.mail.ssl.TrustedSocketFactory;