Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Use modular AWS SDK #20

Merged
merged 1 commit into from
Oct 12, 2021
Merged

Use modular AWS SDK #20

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,8 +95,8 @@
<version>2.6.1</version>
</dependency>
<dependency>
<groupId>org.jenkins-ci.plugins</groupId>
<artifactId>aws-java-sdk</artifactId>
<groupId>org.jenkins-ci.plugins.aws-java-sdk</groupId>
<artifactId>aws-java-sdk-ecr</artifactId>
<version>1.12.80</version>
</dependency>
<dependency>
Expand Down
227 changes: 131 additions & 96 deletions src/main/java/com/cloudbees/jenkins/plugins/amazonecr/AmazonECSRegistryCredential.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
* The MIT License
*
* Copyright (c) 2015, CloudBees, Inc.
* Copyright (c) 2021, TobiX
*
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
Expand All @@ -25,131 +26,165 @@

package com.cloudbees.jenkins.plugins.amazonecr;

import com.amazonaws.ClientConfiguration;
import com.amazonaws.regions.Region;
import com.amazonaws.regions.Regions;
import com.amazonaws.services.ecr.AmazonECRClient;
import com.amazonaws.services.ecr.AmazonECR;
import com.amazonaws.services.ecr.AmazonECRClientBuilder;
import com.amazonaws.services.ecr.model.AuthorizationData;
import com.amazonaws.services.ecr.model.GetAuthorizationTokenRequest;
import com.amazonaws.services.ecr.model.GetAuthorizationTokenResult;
import com.cloudbees.jenkins.plugins.awscredentials.AmazonWebServicesCredentials;
import com.cloudbees.plugins.credentials.CredentialsNameProvider;
import com.cloudbees.plugins.credentials.CredentialsProvider;
import com.cloudbees.plugins.credentials.CredentialsScope;
import com.cloudbees.plugins.credentials.common.StandardUsernamePasswordCredentials;
import com.cloudbees.plugins.credentials.impl.BaseStandardCredentials;
import hudson.model.ItemGroup;
import hudson.security.ACL;
import hudson.util.Secret;
import org.apache.commons.lang.StringUtils;

import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;
import java.util.Collections;
import java.util.List;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.annotation.CheckForNull;
import javax.annotation.Nonnull;
import jenkins.model.Jenkins;
import org.apache.commons.lang.StringUtils;

/**
* This new kind of credential provides an embedded {@link com.amazonaws.auth.AWSCredentials}
* when a credential for Amazon ECS Registry end point is needed.
* This new kind of credential provides an embedded {@link com.amazonaws.auth.AWSCredentials} when a
* credential for Amazon ECS Registry end point is needed.
*/
public class AmazonECSRegistryCredential extends BaseStandardCredentials implements StandardUsernamePasswordCredentials {
private static final Logger LOG = Logger.getLogger(AmazonECSRegistryCredential.class.getName());

private final String credentialsId;

private final Regions region;

private final ItemGroup itemGroup;
public class AmazonECSRegistryCredential extends BaseStandardCredentials
implements StandardUsernamePasswordCredentials {
private static final Logger LOG = Logger.getLogger(AmazonECSRegistryCredential.class.getName());

private final String credentialsId;

private final Regions region;

private final ItemGroup itemGroup;

public AmazonECSRegistryCredential(
CredentialsScope scope,
@Nonnull String credentialsId,
String description,
ItemGroup itemGroup) {
this(scope, credentialsId, Regions.US_EAST_1, description, (ItemGroup<?>) itemGroup);
}

public AmazonECSRegistryCredential(
@CheckForNull CredentialsScope scope,
@Nonnull String credentialsId,
Regions region,
String description,
ItemGroup itemGroup) {
super(
scope,
"ecr:" + region.getName() + ":" + credentialsId,
"Amazon ECR Registry:"
+ (StringUtils.isNotBlank(description) ? description : credentialsId)
+ "-"
+ region);
this.credentialsId = credentialsId;
this.region = region;
this.itemGroup = itemGroup;
}

@Nonnull
public String getCredentialsId() {
return credentialsId;
}

public @CheckForNull AmazonWebServicesCredentials getCredentials() {
LOG.log(
Level.FINE,
"Looking for Amazon web credentials ID: {0} Region: {1}",
new Object[] {this.credentialsId, this.region});
List<AmazonWebServicesCredentials> credentials =
CredentialsProvider.lookupCredentials(
AmazonWebServicesCredentials.class, itemGroup, ACL.SYSTEM, Collections.EMPTY_LIST);

public AmazonECSRegistryCredential(CredentialsScope scope, @Nonnull String credentialsId,
String description, ItemGroup itemGroup) {
this(scope, credentialsId, Regions.US_EAST_1, description, (ItemGroup<?>)itemGroup);
if (LOG.isLoggable(Level.FINEST)) {
String fullStackTrace =
org.apache.commons.lang.exception.ExceptionUtils.getStackTrace(new Throwable());
LOG.log(Level.FINEST, "Trace: {0}", fullStackTrace);
}

public AmazonECSRegistryCredential(@CheckForNull CredentialsScope scope, @Nonnull String credentialsId,
Regions region, String description, ItemGroup itemGroup) {
super(scope, "ecr:" + region.getName() + ":" + credentialsId, "Amazon ECR Registry:"
+ (StringUtils.isNotBlank(description) ? description : credentialsId) + "-" + region);
this.credentialsId = credentialsId;
this.region = region;
this.itemGroup = itemGroup;
if (credentials.isEmpty()) {
LOG.fine("ID not found");
return null;
}


@Nonnull
public String getCredentialsId() {
return credentialsId;
for (AmazonWebServicesCredentials awsCredentials : credentials) {
if (awsCredentials.getId().equals(this.credentialsId)) {
LOG.log(Level.FINE, "ID found {0}", this.credentialsId);
return awsCredentials;
}
}

public @CheckForNull AmazonWebServicesCredentials getCredentials() {
LOG.log(Level.FINE,"Looking for Amazon web credentials ID: {0} Region: {1}", new Object[]{this.credentialsId,this.region});
List<AmazonWebServicesCredentials> credentials = CredentialsProvider.lookupCredentials(
AmazonWebServicesCredentials.class, itemGroup, ACL.SYSTEM, Collections.EMPTY_LIST);

if(LOG.isLoggable(Level.FINEST)){
String fullStackTrace = org.apache.commons.lang.exception.ExceptionUtils.getStackTrace(new Throwable());
LOG.log(Level.FINEST,"Trace : {0}", fullStackTrace);
}

if (credentials.isEmpty()) {
LOG.fine("ID Not found");
return null;
}

for (AmazonWebServicesCredentials awsCredentials : credentials) {
if (awsCredentials.getId().equals(this.credentialsId)) {
LOG.log(Level.FINE,"ID found {0}" , this.credentialsId);
return awsCredentials;
}
}
LOG.fine("ID Not found");
return null;
LOG.fine("ID not found");
return null;
}

@Nonnull
public String getDescription() {
String description = super.getDescription();
LOG.finest(description);
return description;
}

@Nonnull
@Override
public Secret getPassword() {
final AmazonWebServicesCredentials credentials = getCredentials();
if (credentials == null) throw new IllegalStateException("Invalid credentials");
LOG.log(
Level.FINE,
"Get password for {0} region : {1}",
new Object[] {credentials.getDisplayName(), region});
if (LOG.isLoggable(Level.ALL)) {
String fullStackTrace =
org.apache.commons.lang.exception.ExceptionUtils.getStackTrace(new Throwable());
LOG.log(Level.ALL, "Trace: {0}", fullStackTrace);
}

@Nonnull
public String getDescription() {
String description = super.getDescription();
LOG.finest(description);
return description;
}

@Nonnull
@Override
public Secret getPassword() {
final AmazonWebServicesCredentials credentials = getCredentials();
if (credentials == null) throw new IllegalStateException("Invalid credentials");
LOG.log(Level.FINE,"Get Password for {0} region : {1}", new Object[]{credentials.getDisplayName(), region});
if(LOG.isLoggable(Level.ALL)){
String fullStackTrace = org.apache.commons.lang.exception.ExceptionUtils.getStackTrace(new Throwable());
LOG.log(Level.ALL,"Trace : {0}", fullStackTrace);
}
com.amazonaws.AmazonECRClientFactory factory = new com.amazonaws.AmazonECRClientFactory();
final AmazonECRClient client = factory.getAmazonECRClientWithProxy(credentials.getCredentials());
client.setRegion(Region.getRegion(region));

GetAuthorizationTokenRequest request = new GetAuthorizationTokenRequest();
final GetAuthorizationTokenResult authorizationToken = client.getAuthorizationToken(request);
final List<AuthorizationData> authorizationData = authorizationToken.getAuthorizationData();
if (authorizationData == null || authorizationData.isEmpty()) {
throw new IllegalStateException("Failed to retrieve authorization token for Amazon ECR");
}
LOG.fine("Success ");
if(LOG.isLoggable(Level.ALL)){
LOG.finest("Auth token: " + authorizationToken.toString());
LOG.finest("Request: " + request.toString());
}
return Secret.fromString(authorizationData.get(0).getAuthorizationToken());
ClientConfiguration conf = new ClientConfiguration();
Jenkins j = Jenkins.get();
if (j.proxy != null) {
conf.setProxyHost(j.proxy.name);
conf.setProxyPort(j.proxy.port);
conf.setProxyUsername(j.proxy.getUserName());
Secret password = j.proxy.getSecretPassword();
if (password != null) conf.setProxyPassword(password.getPlainText());
}

@Nonnull
@Override
public String getUsername() {
return "AWS";
AmazonECRClientBuilder builder = AmazonECRClientBuilder.standard();
builder.setCredentials(credentials);
builder.setClientConfiguration(conf);
builder.setRegion(Region.getRegion(region).getName());
final AmazonECR client = builder.build();

GetAuthorizationTokenRequest request = new GetAuthorizationTokenRequest();
final GetAuthorizationTokenResult authorizationToken = client.getAuthorizationToken(request);
final List<AuthorizationData> authorizationData = authorizationToken.getAuthorizationData();
if (authorizationData == null || authorizationData.isEmpty()) {
throw new IllegalStateException("Failed to retrieve authorization token for Amazon ECR");
}

@Nonnull
public String getEmail() {
return "[email protected]";
LOG.fine("Success");
if (LOG.isLoggable(Level.ALL)) {
LOG.finest("Auth token: " + authorizationToken);
LOG.finest("Request: " + request);
}
return Secret.fromString(authorizationData.get(0).getAuthorizationToken());
}

@Nonnull
@Override
public String getUsername() {
return "AWS";
}

@Nonnull
public String getEmail() {
return "[email protected]";
}
}