com.slack.api.token_rotation.TokenRotator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of slack-api-client Show documentation
The newest version!
package com.slack.api.token_rotation;

import com.slack.api.RequestConfigurator;
import com.slack.api.Slack;
import com.slack.api.methods.MethodsClient;
import com.slack.api.methods.SlackApiException;
import com.slack.api.methods.response.oauth.OAuthV2AccessResponse;
import lombok.Data;

import java.io.IOException;
import java.util.Optional;

/**
 * A utility to perform Slack token rotation.
 */
@Data
public class TokenRotator {
    private static MethodsClient DEFAULT_METHODS_CLIENT = Slack.getInstance().methods();
    public static long DEFAULT_MILLISECONDS_BEFORE_EXPIRATION = 1000 * 60 * 60 * 2;

    private MethodsClient methodsClient;
    private long millisecondsBeforeExpiration;
    private String clientId;
    private String clientSecret;

    public TokenRotator(
            String clientId,
            String clientSecret
    ) {
        this(DEFAULT_METHODS_CLIENT, DEFAULT_MILLISECONDS_BEFORE_EXPIRATION, clientId, clientSecret);
    }

    public TokenRotator(
            MethodsClient methodsClient,
            long millisecondsBeforeExpiration,
            String clientId,
            String clientSecret
    ) {
        this.methodsClient = methodsClient;
        this.millisecondsBeforeExpiration = millisecondsBeforeExpiration;
        this.clientId = clientId;
        this.clientSecret = clientSecret;
    }

    /**
     * Performs token rotation for the given set of token and refresh token. This method returns non-empty value
     * only when the rotation is done. If you get the refreshed token data, your datastore must update the database
     * record to have the new ones.
     */
    public Optional performTokenRotation(
            RequestConfigurator configurator
    ) throws TokenRotationException {
        return performTokenRotation(configurator.configure(CurrentToken.builder()).build());
    }

    /**
     * Performs token rotation for the given set of token and refresh token. This method returns non-empty value
     * only when the rotation is done. If you get the refreshed token data, your datastore must update the database
     * record to have the new ones.
     */
    public Optional performTokenRotation(
            CurrentToken current
    ) throws TokenRotationException {
        if (current.getExpiresAt() >
                System.currentTimeMillis() + this.getMillisecondsBeforeExpiration()) {
            // As the token is still active, no need to refresh the stored token
            return Optional.empty();
        }
        try {
            OAuthV2AccessResponse refreshResponse = this.getMethodsClient().oauthV2Access(r -> r
                    .clientId(this.getClientId())
                    .clientSecret(this.getClientSecret())
                    .refreshToken(current.getRefreshToken())
                    .grantType("refresh_token")
            );
            if (!refreshResponse.isOk()) {
                throw new TokenRotationException(
                        "Received an error code in oauth.v2.access response body: " + refreshResponse.getError());
            }
            RefreshedToken refreshed = new RefreshedToken();
            refreshed.setAccessToken(refreshResponse.getAccessToken());
            refreshed.setRefreshToken(refreshResponse.getRefreshToken());
            refreshed.setExpiresAt(System.currentTimeMillis() + (refreshResponse.getExpiresIn() * 1000));
            return Optional.of(refreshed);
        } catch (IOException e) {
            throw new TokenRotationException(
                    "Failed to connect to the Slack server (error: " + e.getMessage() + ")", e);
        } catch (SlackApiException e) {
            String message = "Received unexpected HTTP status code from the Slack server (code: " +
                    e.getResponse().code() + ", body: " + e.getResponseBody() + ")";
            throw new TokenRotationException(message, e);
        }
    }
}