com.microsoft.azure.sdk.iot.device.auth.IotHubSasTokenWithRefreshAuthenticationProvider Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of iot-device-client Show documentation
The Microsoft Azure IoT Device SDK for Java
There is a newer version: 2.5.0
/*
 *  Copyright (c) Microsoft. All rights reserved.
 *  Licensed under the MIT license. See LICENSE file in the project root for full license information.
 */

package com.microsoft.azure.sdk.iot.device.auth;

import com.microsoft.azure.sdk.iot.device.transport.TransportException;
import lombok.extern.slf4j.Slf4j;

import javax.net.ssl.SSLContext;
import java.io.IOException;
import java.io.UnsupportedEncodingException;
import java.net.URLEncoder;
import java.nio.charset.StandardCharsets;

/**
 * Authentication method that uses a shared access signature token and allows for token refresh.
 */
@Slf4j
public abstract class IotHubSasTokenWithRefreshAuthenticationProvider extends IotHubSasTokenAuthenticationProvider
{
    /**
     * Constructor for IotHubSasTokenWithRefreshAuthenticationProvider
     * @param hostname the hostname
     * @param gatewayHostName the gateway hostname
     * @param deviceId the device id
     * @param moduleId the module id
     * @param sharedAccessToken the shared access token
     * @param suggestedTimeToLiveSeconds the time to live for generated tokens
     * @param timeBufferPercentage the percent of a sas token's life to live before renewing
     */
    protected IotHubSasTokenWithRefreshAuthenticationProvider(String hostname, String gatewayHostName, String deviceId, String moduleId, String sharedAccessToken, int suggestedTimeToLiveSeconds, int timeBufferPercentage)
    {
        super(hostname, gatewayHostName, deviceId, moduleId, suggestedTimeToLiveSeconds, timeBufferPercentage);
        this.sasToken = new IotHubSasToken(hostname, deviceId, null, sharedAccessToken, moduleId, getExpiryTimeInSeconds());
    }

    /**
     * Constructor for IotHubSasTokenWithRefreshAuthenticationProvider
     * @param hostname the hostname
     * @param gatewayHostName the gateway hostname
     * @param deviceId the device id
     * @param moduleId the module id
     * @param sharedAccessToken the shared access token
     * @param suggestedTimeToLiveSeconds the time to live for generated tokens
     * @param timeBufferPercentage the percent of a sas token's life to live before renewing
     * @param sslContext the SSLContext the connection will use
     */
    protected IotHubSasTokenWithRefreshAuthenticationProvider(String hostname, String gatewayHostName, String deviceId, String moduleId, String sharedAccessToken, int suggestedTimeToLiveSeconds, int timeBufferPercentage, SSLContext sslContext)
    {
        super(hostname, gatewayHostName, deviceId, moduleId, suggestedTimeToLiveSeconds, timeBufferPercentage, sslContext);
        this.sasToken = new IotHubSasToken(hostname, deviceId, null, sharedAccessToken, moduleId, getExpiryTimeInSeconds());
    }

    /**
     * Constructs the audience string to be used in a sas token
     * @param hostname the hostname
     * @param deviceId the device id
     * @param moduleId the module id
     * @return the audience
     * @throws UnsupportedEncodingException if UTF-8 encoding is not supported
     */
    protected static String buildAudience(String hostname, String deviceId, String moduleId) throws UnsupportedEncodingException
    {
        if (hostname == null || deviceId == null || moduleId == null || hostname.isEmpty() || deviceId.isEmpty() || moduleId.isEmpty())
        {
            throw new IllegalArgumentException("No argument can be null or empty");
        }

        return URLEncoder.encode(String.format("%s/devices/%s/modules/%s", hostname, deviceId, moduleId), StandardCharsets.UTF_8.name());
    }

    /**
     * Returns false as instances of this class will always be able to renew their own sas token
     * @return false
     */
    @Override
    public boolean isAuthenticationProviderRenewalNecessary()
    {
        return false;
    }

    /**
     * Renew the saved sas token
     * @throws IOException If an IOException is encountered while refreshing the sas token
     * @throws TransportException If a TransportException is encountered while refreshing the sas token
     */
    public abstract void refreshSasToken() throws IOException, TransportException;

    /**
     * Check if sas token should be renewed at all, and then renew it if necessary
     * @return the renewed token, or the old token if it did not need to be renewed
     * @throws IOException If an IOException is encountered while refreshing the sas token
     * @throws TransportException If a TransportException is encountered while refreshing the sas token
     */
    @Override
    public char[] getSasToken() throws IOException, TransportException
    {
        log.debug("Renewing the internal sas token");
        this.refreshSasToken();

        return this.sasToken.toString().toCharArray();
    }
}