com.amazonaws.auth.STSSessionCredentials Maven / Gradle / Ivy
Show all versions of aws-java-sdk-sts Show documentation
/*
* Copyright 2011-2022 Amazon Technologies, Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at:
*
* http://aws.amazon.com/apache2.0
*
* This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES
* OR CONDITIONS OF ANY KIND, either express or implied. See the
* License for the specific language governing permissions and
* limitations under the License.
*/
package com.amazonaws.auth;
import java.util.Date;
import com.amazonaws.services.securitytoken.AWSSecurityTokenService;
import com.amazonaws.services.securitytoken.AWSSecurityTokenServiceClient;
import com.amazonaws.services.securitytoken.model.Credentials;
import com.amazonaws.services.securitytoken.model.GetSessionTokenRequest;
import com.amazonaws.services.securitytoken.model.GetSessionTokenResult;
/**
* Session credentials periodically refreshed by AWS SecurityTokenService.
*
* Calls to {@link STSSessionCredentials#getAWSAccessKeyId()},
* {@link STSSessionCredentials#getAWSSecretKey()}, and
* {@link STSSessionCredentials#getSessionToken()} should be synchronized on
* this object to prevent races on the boundary of session expiration.
* Alternately, clients can call
* {@link STSSessionCredentials#getImmutableCredentials()} to ensure a
* consistent set of access key, secret key, and token.
*
* This class is deprecated and should not be used anymore.
* Instead, use {@link STSSessionCredentialsProvider}.
*/
@Deprecated
public class STSSessionCredentials implements AWSRefreshableSessionCredentials {
private final AWSSecurityTokenService securityTokenService;
private final int sessionDurationSeconds;
private Credentials sessionCredentials;
public static final int DEFAULT_DURATION_SECONDS = 3600;
/**
* Create a new credentials object that will periodically and automatically
* obtain a session from STS.
*
* @param credentials
* Primary AWS account credentials.
*/
public STSSessionCredentials(AWSCredentials credentials) {
this(credentials, DEFAULT_DURATION_SECONDS);
}
/**
* Create a new credentials object that will periodically and automatically
* obtain a session from STS.
*
* @param credentials
* Primary AWS account credentials.
* @param sessionDurationSeconds
* The duration, in seconds, for each session to last.
*/
public STSSessionCredentials(AWSCredentials credentials, int sessionDurationSeconds) {
this.securityTokenService = new AWSSecurityTokenServiceClient(credentials);
this.sessionDurationSeconds = sessionDurationSeconds;
}
/**
* Create a new credentials object that will periodically and automatically
* obtain a session from STS, using a preconfigured STS client.
*
* @param stsClient
* A pre-configured STS client from which to get credentials.
*/
public STSSessionCredentials(AWSSecurityTokenService stsClient) {
this(stsClient, DEFAULT_DURATION_SECONDS);
}
/**
* Create a new credentials object that will periodically and automatically
* obtain a session from STS, using a preconfigured STS client.
*
* @param stsClient
* A pre-configured STS client from which to get credentials.
* @param settings
* Session settings for all sessions created
*/
public STSSessionCredentials(AWSSecurityTokenService stsClient, int sessionDuratinSeconds) {
this.securityTokenService = stsClient;
this.sessionDurationSeconds = sessionDuratinSeconds;
}
/**
* Returns the AWS access key for the current STS session, beginning a new
* one if necessary.
*
* Clients are encouraged to call the atomic
* {@link RenewableAWSSessionCredentials#getImmutableCredentials()} as a proxy to this method.
*/
@Override
public synchronized String getAWSAccessKeyId() {
return getSessionCredentials().getAccessKeyId();
}
/**
* Returns the AWS secret key for the current STS session, beginning a new
* one if necessary.
*
* Clients are encouraged to call the atomic
* {@link RenewableAWSSessionCredentials#getImmutableCredentials()} as a proxy to this method.
*/
@Override
public synchronized String getAWSSecretKey() {
return getSessionCredentials().getSecretAccessKey();
}
/**
* Returns the session token for the current STS session, beginning a new
* one if necessary.
*
* Clients are encouraged to call the atomic
* {@link RenewableAWSSessionCredentials#getImmutableCredentials()} as a proxy to this method.
*/
@Override
public synchronized String getSessionToken() {
return getSessionCredentials().getSessionToken();
}
/**
* Returns immutable session credentials for this session, beginning a new one if necessary.
*/
public synchronized AWSSessionCredentials getImmutableCredentials() {
Credentials creds = getSessionCredentials();
return new BasicSessionCredentials(creds.getAccessKeyId(), creds.getSecretAccessKey(), creds.getSessionToken());
}
/**
* Refreshes the session credentials from STS.
*/
@Override
public synchronized void refreshCredentials() {
GetSessionTokenResult sessionTokenResult = securityTokenService
.getSessionToken(new GetSessionTokenRequest().withDurationSeconds(sessionDurationSeconds));
sessionCredentials = sessionTokenResult.getCredentials();
}
/**
* Gets a current session credentials object, reinitializing if necessary.
*/
private synchronized Credentials getSessionCredentials() {
if ( needsNewSession() )
refreshCredentials();
return sessionCredentials;
}
private boolean needsNewSession() {
if ( sessionCredentials == null )
return true;
Date expiration = sessionCredentials.getExpiration();
long timeRemaining = expiration.getTime() - System.currentTimeMillis();
if ( timeRemaining < (60 * 1000) )
return true;
return false;
}
}