Odświeżanie tokenu OAuth przy użyciu funkcji Retrofit bez modyfikowania wszystkich wywołań

Używamy Retrofit w naszej aplikacji na Androida, aby komunikować się z serwerem zabezpieczonym OAuth2. Wszystko działa świetnie, używamy RequestInterceptor do dołączania tokenu dostępu do każdego wywołania. Jednak zdarzają się sytuacje, w których token dostępu wygaśnie i będzie wymagał odświeżenia. Po wygaśnięciu tokenu następne wywołanie zwróci z nieautoryzowanym kodem HTTP, więc jest to łatwe do monitorowania. Moglibyśmy zmodyfikować każde wywołanie Retrofit w następujący sposób: W wywołaniu zwrotnym błędu, sprawdź kod błędu, jeśli jest równy Unauthorized, odśwież token OAuth, a następnie powtórz wywołanie Retrofit. Jednak w tym celu wszystkie wywołania powinny zostać zmodyfikowane, co nie jest łatwym w utrzymaniu i dobrym rozwiązaniem. Czy można to zrobić bez modyfikowania wszystkich wywołań dotyczących modernizacji?

Nie używaj go Interceptorsdo uwierzytelniania.

Obecnie najlepszym podejściem do obsługi uwierzytelniania jest użycie nowego Authenticatorinterfejsu API, zaprojektowanego specjalnie do tego celu .

OkHttp zostanie automatycznie zapytaćAuthenticator o poświadczenia, gdy odpowiedź jest 401 Not Authorised Ponowna próba nie powiodła się ostatni wniosek z nimi.

public class TokenAuthenticator implements Authenticator {
    @Override
    public Request authenticate(Proxy proxy, Response response) throws IOException {
        // Refresh your access_token using a synchronous api request
        newAccessToken = service.refreshToken();

        // Add new header to rejected request and retry it
        return response.request().newBuilder()
                .header(AUTHORIZATION, newAccessToken)
                .build();
    }

    @Override
    public Request authenticateProxy(Proxy proxy, Response response) throws IOException {
        // Null indicates no attempt to authenticate.
        return null;
    }

Dołącz Authenticatordo w OkHttpClienttaki sam sposób, w jaki robisz to zInterceptors

OkHttpClient okHttpClient = new OkHttpClient();
okHttpClient.setAuthenticator(authAuthenticator);

Użyj tego klienta podczas tworzenia Retrofit RestAdapter

RestAdapter restAdapter = new RestAdapter.Builder()
                .setEndpoint(ENDPOINT)
                .setClient(new OkClient(okHttpClient))
                .build();
return restAdapter.create(API.class);

Jeśli używasz Retrofit > =, 1.9.0możesz skorzystać z nowego Interceptora OkHttp , który został wprowadzony w . Chciałbyś użyć Application Interceptor , który na to pozwala .OkHttp 2.2.0retry and make multiple calls

Twój Interceptor może wyglądać mniej więcej tak, jak ten pseudokod:

public class CustomInterceptor implements Interceptor {

    @Override
    public Response intercept(Chain chain) throws IOException {
        Request request = chain.request();

        // try the request
        Response response = chain.proceed(request);

        if (response shows expired token) {

            // get a new token (I use a synchronous Retrofit call)

            // create a new request and modify it accordingly using the new token
            Request newRequest = request.newBuilder()...build();

            // retry the request
            return chain.proceed(newRequest);
        }

        // otherwise just pass the original response on
        return response;
    }

}

Po zdefiniowaniu Interceptorutwórz OkHttpClienti dodaj przechwytywacz jako element przechwytujący aplikacji .

    OkHttpClient okHttpClient = new OkHttpClient();
    okHttpClient.interceptors().add(new CustomInterceptor());

I na koniec użyj tego OkHttpClientpodczas tworzenia swojego RestAdapter.

    RestService restService = new RestAdapter().Builder
            ...
            .setClient(new OkClient(okHttpClient))
            .create(RestService.class);

Ostrzeżenie: jak Jesse Wilsonwspomina (z Square) tutaj , jest to niebezpieczna ilość mocy.

Mając to na uwadze, zdecydowanie uważam, że to najlepszy sposób na teraz poradzenie sobie z czymś takim. Jeśli masz jakieś pytania, nie wahaj się zadać w komentarzu.

TokenAuthenticator zależy od klasy usługi. Klasa usługi zależy od instancji OkHttpClient. Aby utworzyć OkHttpClient, potrzebuję TokenAuthenticator. Jak mogę przerwać ten cykl? Dwóch różnych klientów OkHttp? Będą mieć różne pule połączeń.

Jeśli masz, powiedzmy, Retrofit TokenService, którego potrzebujesz w swoim, Authenticatorale chciałbyś skonfigurować tylko taki, dla OkHttpClientktórego możesz użyć TokenServiceHolderjako zależności TokenAuthenticator. Musiałbyś zachować odniesienie do niego na poziomie aplikacji (singleton). Jest to łatwe, jeśli używasz Daggera 2, w przeciwnym razie po prostu utwórz pole klasy w aplikacji.

W TokenAuthenticator.java

public class TokenAuthenticator implements Authenticator {

    private final TokenServiceHolder tokenServiceHolder;

    public TokenAuthenticator(TokenServiceHolder tokenServiceHolder) {
        this.tokenServiceHolder = tokenServiceHolder;
    }

    @Override
    public Request authenticate(Proxy proxy, Response response) throws IOException {

        //is there a TokenService?
        TokenService service = tokenServiceHolder.get();
        if (service == null) {
            //there is no way to answer the challenge
            //so return null according to Retrofit's convention
            return null;
        }

        // Refresh your access_token using a synchronous api request
        newAccessToken = service.refreshToken().execute();

        // Add new header to rejected request and retry it
        return response.request().newBuilder()
                .header(AUTHORIZATION, newAccessToken)
                .build();
    }

    @Override
    public Request authenticateProxy(Proxy proxy, Response response) throws IOException {
        // Null indicates no attempt to authenticate.
        return null;
    }

W TokenServiceHolder.java:

public class TokenServiceHolder {

    TokenService tokenService = null;

    @Nullable
    public TokenService get() {
        return tokenService;
    }

    public void set(TokenService tokenService) {
        this.tokenService = tokenService;
    }
}

Konfiguracja klienta:

//obtain instance of TokenServiceHolder from application or singleton-scoped component, then
TokenAuthenticator authenticator = new TokenAuthenticator(tokenServiceHolder);
OkHttpClient okHttpClient = new OkHttpClient();    
okHttpClient.setAuthenticator(tokenAuthenticator);

Retrofit retrofit = new Retrofit.Builder()
    .baseUrl("https://api.github.com/")
    .client(okHttpClient)
    .build();

TokenService tokenService = retrofit.create(TokenService.class);
tokenServiceHolder.set(tokenService);

Jeśli używasz Daggera 2 lub podobnego frameworka wstrzykiwania zależności, w odpowiedziach na to pytanie znajduje się kilka przykładów

Użycie TokenAuthenticatorodpowiedzi like @theblang jest poprawnym sposobem obsługi refresh_token.

Oto moje narzędzie (ja używam Kotlin, Dagger, RX ale możesz wykorzystać ten pomysł na implementację do swojego przypadku)
TokenAuthenticator

class TokenAuthenticator @Inject constructor(private val noneAuthAPI: PotoNoneAuthApi, private val accessTokenWrapper: AccessTokenWrapper) : Authenticator {

    override fun authenticate(route: Route, response: Response): Request? {
        val newAccessToken = noneAuthAPI.refreshToken(accessTokenWrapper.getAccessToken()!!.refreshToken).blockingGet()
        accessTokenWrapper.saveAccessToken(newAccessToken) // save new access_token for next called
        return response.request().newBuilder()
                .header("Authorization", newAccessToken.token) // just only need to override "Authorization" header, don't need to override all header since this new request is create base on old request
                .build()
    }
}

Aby zapobiec cyklowi zależności, jak komentarz @Brais Gabin, tworzę 2 interfejsy, takie jak

interface PotoNoneAuthApi { // NONE authentication API
    @POST("/login")
    fun login(@Body request: LoginRequest): Single<AccessToken>

    @POST("refresh_token")
    @FormUrlEncoded
    fun refreshToken(@Field("refresh_token") refreshToken: String): Single<AccessToken>
}

i

interface PotoAuthApi { // Authentication API
    @GET("api/images")
    fun getImage(): Single<GetImageResponse>
}

AccessTokenWrapper klasa

class AccessTokenWrapper constructor(private val sharedPrefApi: SharedPrefApi) {
    private var accessToken: AccessToken? = null

    // get accessToken from cache or from SharePreference
    fun getAccessToken(): AccessToken? {
        if (accessToken == null) {
            accessToken = sharedPrefApi.getObject(SharedPrefApi.ACCESS_TOKEN, AccessToken::class.java)
        }
        return accessToken
    }

    // save accessToken to SharePreference
    fun saveAccessToken(accessToken: AccessToken) {
        this.accessToken = accessToken
        sharedPrefApi.putObject(SharedPrefApi.ACCESS_TOKEN, accessToken)
    }
}

AccessToken klasa

data class AccessToken(
        @Expose
        var token: String,

        @Expose
        var refreshToken: String)

My Interceptor

class AuthInterceptor @Inject constructor(private val accessTokenWrapper: AccessTokenWrapper): Interceptor {

    override fun intercept(chain: Interceptor.Chain): Response {
        val originalRequest = chain.request()
        val authorisedRequestBuilder = originalRequest.newBuilder()
                .addHeader("Authorization", accessTokenWrapper.getAccessToken()!!.token)
                .header("Accept", "application/json")
        return chain.proceed(authorisedRequestBuilder.build())
    }
}

Na koniec dodaj Interceptori Authenticatordo swojego OKHttpClientpodczas tworzenia usługi PotoAuthApi

Próbny

https://github.com/PhanVanLinh/AndroidMVPKotlin

Uwaga

• Przykładowy getImage()kod błędu API zwrócił 401
• authenticateMetoda wewnątrz TokenAuthenticatorzostanie zwolniona
• Synchronizuj noneAuthAPI.refreshToken(...)wywołane
• Po noneAuthAPI.refreshToken(...)odpowiedzi -> nowy token zostanie dodany do nagłówka
• getImage()wywoła AUTO z nowym nagłówkiem ( HttpLogging NIE BĘDZIE zarejestrować tego połączenia) ( interceptwewnątrz AuthInterceptor NIE BĘDZIE WYWOŁANE )

• Jeśli getImage()nadal nie powiodło się z błędem 401, authenticatemetoda wewnętrzna TokenAuthenticatorzostanie uruchomiona PONOWNIE i PONOWNIE, a następnie wiele razy ( java.net.ProtocolException: Too many follow-up requests) wyrzuci błąd dotyczący wywołania metody . Możesz temu zapobiec, licząc odpowiedź . Przykładowo, jeśli return nullw authenticatepo 3 razy powtórzyć, getImage()będzie skończyć ireturn response 401

• Jeśli getImage()odpowiedź zakończy się sukcesem => otrzymamy wynik normalnie (jak dzwonisz getImage()bez błędu)

Mam nadzieję, że to pomoże

Wiem, że to stara nitka, ale na wszelki wypadek, gdyby ktoś się w nią potknął.

TokenAuthenticator zależy od klasy usługi. Klasa usługi zależy od instancji OkHttpClient. Aby utworzyć OkHttpClient, potrzebuję TokenAuthenticator. Jak mogę przerwać ten cykl? Dwóch różnych klientów OkHttp? Będą mieć różne pule połączeń.

Miałem ten sam problem, ale chciałem utworzyć tylko jednego OkHttpClient, ponieważ nie sądzę, że potrzebuję innego tylko dla samego TokenAuthenticator, używałem Dagger2, więc ostatecznie zapewniłem klasę usługi jako Lazy wstrzykniętą w TokenAuthenticator, możesz przeczytać więcej o leniwym wstrzyknięciu w sztylet 2 tutaj , ale w zasadzie to tak, jakbyś powiedział Daggerowi, aby NIE iść i od razu tworzyć usługę potrzebną TokenAuthenticator.

Możesz odwołać się do tego wątku SO po przykładowy kod: Jak rozwiązać zależność cykliczną, nadal używając Dagger2?

Możesz spróbować utworzyć klasę bazową dla wszystkich programów ładujących, w której byłbyś w stanie złapać określony wyjątek, a następnie działać tak, jak potrzebujesz. Spraw, aby wszystkie różne programy ładujące rozszerzały się z klasy bazowej, aby rozpowszechnić zachowanie.

Po długich badaniach dostosowałem klienta Apache do obsługi odświeżania AccessToken For Retrofit, w którym wysyłasz token dostępu jako parametr.

Zainicjuj swój Adapter za pomocą trwałego klienta cookie

restAdapter = new RestAdapter.Builder()
                .setEndpoint(SERVER_END_POINT)
                .setClient(new CookiePersistingClient())
                .setLogLevel(RestAdapter.LogLevel.FULL).build();

Cookie Trwały klient, który przechowuje pliki cookie dla wszystkich żądań i sprawdza przy każdej odpowiedzi na żądanie, jeśli jest to nieautoryzowany dostęp ERROR_CODE = 401, odświeża token dostępu i przywołuje żądanie, w przeciwnym razie tylko przetwarza żądanie.

private static class CookiePersistingClient extends ApacheClient {

    private static final int HTTPS_PORT = 443;
    private static final int SOCKET_TIMEOUT = 300000;
    private static final int CONNECTION_TIMEOUT = 300000;

    public CookiePersistingClient() {
        super(createDefaultClient());
    }

    private static HttpClient createDefaultClient() {
        // Registering https clients.
        SSLSocketFactory sf = null;
        try {
            KeyStore trustStore = KeyStore.getInstance(KeyStore
                    .getDefaultType());
            trustStore.load(null, null);

            sf = new MySSLSocketFactory(trustStore);
            sf.setHostnameVerifier(SSLSocketFactory.ALLOW_ALL_HOSTNAME_VERIFIER);
        } catch (KeyManagementException e) {
            e.printStackTrace();
        } catch (UnrecoverableKeyException e) {
            e.printStackTrace();
        } catch (KeyStoreException e) {
            e.printStackTrace();
        } catch (NoSuchAlgorithmException e) {
            e.printStackTrace();
        } catch (CertificateException e) {
            e.printStackTrace();
        } catch (IOException e) {
            e.printStackTrace();
        }
        HttpParams params = new BasicHttpParams();
        HttpConnectionParams.setConnectionTimeout(params,
                CONNECTION_TIMEOUT);
        HttpConnectionParams.setSoTimeout(params, SOCKET_TIMEOUT);
        SchemeRegistry registry = new SchemeRegistry();
        registry.register(new Scheme("https", sf, HTTPS_PORT));
        // More customization (https / timeouts etc) can go here...

        ClientConnectionManager cm = new ThreadSafeClientConnManager(
                params, registry);
        DefaultHttpClient client = new DefaultHttpClient(cm, params);

        // Set the default cookie store
        client.setCookieStore(COOKIE_STORE);

        return client;
    }

    @Override
    protected HttpResponse execute(final HttpClient client,
            final HttpUriRequest request) throws IOException {
        // Set the http context's cookie storage
        BasicHttpContext mHttpContext = new BasicHttpContext();
        mHttpContext.setAttribute(ClientContext.COOKIE_STORE, COOKIE_STORE);
        return client.execute(request, mHttpContext);
    }

    @Override
    public Response execute(final Request request) throws IOException {
        Response response = super.execute(request);
        if (response.getStatus() == 401) {

            // Retrofit Callback to handle AccessToken
            Callback<AccessTockenResponse> accessTokenCallback = new Callback<AccessTockenResponse>() {

                @SuppressWarnings("deprecation")
                @Override
                public void success(
                        AccessTockenResponse loginEntityResponse,
                        Response response) {
                    try {
                        String accessToken =  loginEntityResponse
                                .getAccessToken();
                        TypedOutput body = request.getBody();
                        ByteArrayOutputStream byte1 = new ByteArrayOutputStream();
                        body.writeTo(byte1);
                        String s = byte1.toString();
                        FormUrlEncodedTypedOutput output = new FormUrlEncodedTypedOutput();
                        String[] pairs = s.split("&");
                        for (String pair : pairs) {
                            int idx = pair.indexOf("=");
                            if (URLDecoder.decode(pair.substring(0, idx))
                                    .equals("access_token")) {
                                output.addField("access_token",
                                        accessToken);
                            } else {
                                output.addField(URLDecoder.decode(
                                        pair.substring(0, idx), "UTF-8"),
                                        URLDecoder.decode(
                                                pair.substring(idx + 1),
                                                "UTF-8"));
                            }
                        }
                        execute(new Request(request.getMethod(),
                                request.getUrl(), request.getHeaders(),
                                output));
                    } catch (IOException e) {
                        e.printStackTrace();
                    }

                }

                @Override
                public void failure(RetrofitError error) {
                    // Handle Error while refreshing access_token
                }
            };
            // Call Your retrofit method to refresh ACCESS_TOKEN
            refreshAccessToken(GRANT_REFRESH,CLIENT_ID, CLIENT_SECRET_KEY,accessToken, accessTokenCallback);
        }

        return response;
    }
}

Używając jednego Interceptora (wstrzyknij token) i jednego Authenticatora (operacje odświeżania) wykonują zadanie, ale:

Miałem też problem z podwójnym połączeniem: pierwsze połączenie zawsze zwracało 401 : token nie został wstrzyknięty przy pierwszym wywołaniu (przechwytywacz) i został wywołany element uwierzytelniający: wykonano dwa żądania.

Poprawka polegała tylko na ponownym wpłynięciu żądania na kompilację w Interceptorze:

PRZED:

private Interceptor getInterceptor() {
    return (chain) -> {
        Request request = chain.request();
        //...
        request.newBuilder()
                .header(AUTHORIZATION, token))
                .build();
        return chain.proceed(request);
    };
}

PO:

private Interceptor getInterceptor() {
    return (chain) -> {
        Request request = chain.request();
        //...
        request = request.newBuilder()
                .header(AUTHORIZATION, token))
                .build();
        return chain.proceed(request);
    };
}

W JEDNYM BLOKU:

private Interceptor getInterceptor() {
    return (chain) -> {
        Request request = chain.request().newBuilder()
                .header(AUTHORIZATION, token))
                .build();
        return chain.proceed(request);
    };
}

Mam nadzieję, że to pomoże.

Edycja: nie znalazłem sposobu, aby uniknąć pierwszego wywołania zawsze zwracającego 401 przy użyciu tylko uwierzytelniacza i bez przechwytywacza

Do każdego, kto chciał rozwiązać współbieżne / równoległe wywołania podczas odświeżania tokenu. Oto obejście

class TokenAuthenticator: Authenticator {

    override fun authenticate(route: Route?, response: Response?): Request? {
        response?.let {
            if (response.code() == 401) {
                while (true) {
                    if (!isRefreshing) {
                        val requestToken = response.request().header(AuthorisationInterceptor.AUTHORISATION)
                        val currentToken = OkHttpUtil.headerBuilder(UserService.instance.token)

                        currentToken?.let {
                            if (requestToken != currentToken) {
                                return generateRequest(response, currentToken)
                            }
                        }

                        val token = refreshToken()
                        token?.let {
                            return generateRequest(response, token)
                        }
                    }
                }
            }
        }

        return null
    }

    private fun generateRequest(response: Response, token: String): Request? {
        return response.request().newBuilder()
                .header(AuthorisationInterceptor.USER_AGENT, OkHttpUtil.UA)
                .header(AuthorisationInterceptor.AUTHORISATION, token)
                .build()
    }

    private fun refreshToken(): String? {
        synchronized(TokenAuthenticator::class.java) {
            UserService.instance.token?.let {
                isRefreshing = true

                val call = ApiHelper.refreshToken()
                val token = call.execute().body()
                UserService.instance.setToken(token, false)

                isRefreshing = false

                return OkHttpUtil.headerBuilder(token)
            }
        }

        return null
    }

    companion object {
        var isRefreshing = false
    }
}