Spring/spring-boot
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Support authentication to private docker registry

Browse Source 
This commit adds the ability to configure Docker image registry
authentication credentials in the Maven and Gradle plugins. The
authentication credentials are passed to the Docker daemon with
all daemon API calls, and the daemon forwards the credentials to the
image registry when necessary. This makes it possible to use
builder and run images stored in a private Docker registry.

See gh-22972
This commit is contained in:
姜为
2020-08-16 08:51:55 +08:00
committed by Scott Frederick
parent f0dfff81d4
commit e8f555e13d
22 changed files with 922 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
spring-boot-project/spring-boot-tools/spring-boot-buildpack-platform/src/test/java/org/springframework/boot/buildpack/platform/build/BuilderTests.java
View File

@@ -30,6 +30,7 @@ import org.springframework.boot.buildpack.platform.docker.DockerApi.ContainerApi
import org.springframework.boot.buildpack.platform.docker.DockerApi.ImageApi;
import org.springframework.boot.buildpack.platform.docker.DockerApi.VolumeApi;
import org.springframework.boot.buildpack.platform.docker.TotalProgressPullListener;
import org.springframework.boot.buildpack.platform.docker.configuration.DockerConfiguration;
import org.springframework.boot.buildpack.platform.docker.transport.DockerEngineException;
import org.springframework.boot.buildpack.platform.docker.type.ContainerReference;
import org.springframework.boot.buildpack.platform.docker.type.ContainerStatus;
@@ -60,7 +61,14 @@ class BuilderTests {
@Test
void createWhenLogIsNullThrowsException() {
assertThatIllegalArgumentException().isThrownBy(() -> new Builder(null)).withMessage("Log must not be null");
assertThatIllegalArgumentException().isThrownBy(() -> new Builder((BuildLog) null))
.withMessage("Log must not be null");
}
@Test
void createWithDockerConfiguration() {
Builder builder = new Builder(BuildLog.toSystemOut(), new DockerConfiguration());
assertThat(builder).isNotNull();
}
@Test

45
spring-boot-project/spring-boot-tools/spring-boot-buildpack-platform/src/test/java/org/springframework/boot/buildpack/platform/docker/DockerApiTests.java
View File

@@ -20,7 +20,9 @@ import java.io.ByteArrayOutputStream;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.URI;
import java.util.Collection;
import org.apache.http.Header;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Nested;
import org.junit.jupiter.api.Test;
@@ -34,6 +36,8 @@ import org.mockito.junit.jupiter.MockitoExtension;
import org.springframework.boot.buildpack.platform.docker.DockerApi.ContainerApi;
import org.springframework.boot.buildpack.platform.docker.DockerApi.ImageApi;
import org.springframework.boot.buildpack.platform.docker.DockerApi.VolumeApi;
import org.springframework.boot.buildpack.platform.docker.configuration.DockerConfiguration;
import org.springframework.boot.buildpack.platform.docker.configuration.DockerRegistryConfiguration;
import org.springframework.boot.buildpack.platform.docker.transport.HttpTransport;
import org.springframework.boot.buildpack.platform.docker.transport.HttpTransport.Response;
import org.springframework.boot.buildpack.platform.docker.type.ContainerConfig;
@@ -48,6 +52,7 @@ import org.springframework.boot.buildpack.platform.io.Content;
import org.springframework.boot.buildpack.platform.io.IOConsumer;
import org.springframework.boot.buildpack.platform.io.Owner;
import org.springframework.boot.buildpack.platform.io.TarArchive;
import org.springframework.util.Base64Utils;
import static org.assertj.core.api.Assertions.assertThat;
import static org.assertj.core.api.Assertions.assertThatIllegalArgumentException;
@@ -113,6 +118,46 @@ class DockerApiTests {
};
}
@Test
void createDockerApi() {
DockerApi api = new DockerApi();
assertThat(api).isNotNull();
}
@Test
void createDockerApiWithDockerConfiguration() {
DockerApi api = new DockerApi(new DockerConfiguration());
assertThat(api).isNotNull();
}
@Test
void createWhenDockerConfigurationIsNullThrowsException() {
assertThatIllegalArgumentException().isThrownBy(() -> new DockerApi((DockerConfiguration) null))
.withMessage("Docker configuration must not be null");
}
@Test
void createDockerEngineAuthenticationHeaders() {
DockerRegistryConfiguration dockerRegistryConfiguration = new DockerRegistryConfiguration();
dockerRegistryConfiguration.setUsername("username");
dockerRegistryConfiguration.setPassword("password");
dockerRegistryConfiguration.setEmail("mock@spring.com");
dockerRegistryConfiguration.setUrl("http://mock.docker.registry");
DockerConfiguration dockerConfiguration = new DockerConfiguration();
dockerConfiguration.setDockerRegistryConfiguration(dockerRegistryConfiguration);
Collection<Header> dockerEngineAuthenticationHeaders = DockerApi
.createDockerEngineAuthenticationHeaders(dockerConfiguration);
assertThat(dockerEngineAuthenticationHeaders.size() == 1).isTrue();
Header header = dockerEngineAuthenticationHeaders.iterator().next();
assertThat(header.getName()).isEqualTo("X-Registry-Auth");
assertThat(header.getValue()).isEqualTo(
"ewogICJ1c2VybmFtZSIgOiAidXNlcm5hbWUiLAogICJwYXNzd29yZCIgOiAicGFzc3dvcmQiLAogICJlbWFpbCIgOiAibW9ja0BzcHJpbmcuY29tIiwKICAic2VydmVyYWRkcmVzcyIgOiAiaHR0cDovL21vY2suZG9ja2VyLnJlZ2lzdHJ5Igp9");
assertThat(new String(Base64Utils.decodeFromString(header.getValue())))
.isEqualTo("{\n" + " \"username\" : \"username\",\n" + " \"password\" : \"password\",\n"
+ " \"email\" : \"mock@spring.com\",\n"
+ " \"serveraddress\" : \"http://mock.docker.registry\"\n" + "}");
}
@Nested
class ImageDockerApiTests {

35
spring-boot-project/spring-boot-tools/spring-boot-buildpack-platform/src/test/java/org/springframework/boot/buildpack/platform/docker/configuration/DockerConfigurationTests.java Normal file
View File

@@ -0,0 +1,35 @@
/*
* Copyright 2012-2020 the original author or authors.
*
* 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
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License 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 org.springframework.boot.buildpack.platform.docker.configuration;
import org.junit.jupiter.api.Test;
import static org.assertj.core.api.Assertions.assertThat;
/**
* Tests for {@link DockerConfiguration}.
*
* @author Wei Jiang
*/
public class DockerConfigurationTests {
@Test
void createDockerConfiguration() {
assertThat(new DockerConfiguration()).isNotNull();
}
}

79
spring-boot-project/spring-boot-tools/spring-boot-buildpack-platform/src/test/java/org/springframework/boot/buildpack/platform/docker/configuration/DockerRegistryConfigurationTests.java Normal file
View File

@@ -0,0 +1,79 @@
/*
* Copyright 2012-2020 the original author or authors.
*
* 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
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License 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 org.springframework.boot.buildpack.platform.docker.configuration;
import org.junit.jupiter.api.Test;
import org.springframework.util.Base64Utils;
import static org.assertj.core.api.Assertions.assertThat;
/**
* Tests for {@link DockerRegistryConfiguration}.
*
* @author Wei Jiang
*/
public class DockerRegistryConfigurationTests {
@Test
void createDockerRegistryAuthTokenWithToken() {
DockerRegistryConfiguration dockerRegistryConfiguration = new DockerRegistryConfiguration();
dockerRegistryConfiguration.setToken("mockToken");
assertThat(dockerRegistryConfiguration.createDockerRegistryAuthToken()).isEqualTo("mockToken");
}
@Test
void createDockerRegistryAuthTokenWithoutToken() {
DockerRegistryConfiguration dockerRegistryConfiguration = new DockerRegistryConfiguration();
dockerRegistryConfiguration.setUsername("username");
dockerRegistryConfiguration.setPassword("password");
dockerRegistryConfiguration.setEmail("mock@spring.com");
dockerRegistryConfiguration.setUrl("http://mock.docker.registry");
String token = dockerRegistryConfiguration.createDockerRegistryAuthToken();
assertThat(token).isEqualTo(
"ewogICJ1c2VybmFtZSIgOiAidXNlcm5hbWUiLAogICJwYXNzd29yZCIgOiAicGFzc3dvcmQiLAogICJlbWFpbCIgOiAibW9ja0BzcHJpbmcuY29tIiwKICAic2VydmVyYWRkcmVzcyIgOiAiaHR0cDovL21vY2suZG9ja2VyLnJlZ2lzdHJ5Igp9");
assertThat(new String(Base64Utils.decodeFromString(token))).isEqualTo("{\n" + " \"username\" : \"username\",\n"
+ " \"password\" : \"password\",\n" + " \"email\" : \"mock@spring.com\",\n"
+ " \"serveraddress\" : \"http://mock.docker.registry\"\n" + "}");
}
@Test
void createDockerRegistryAuthTokenWithUsernameAndPassword() {
DockerRegistryConfiguration dockerRegistryConfiguration = new DockerRegistryConfiguration();
dockerRegistryConfiguration.setUsername("username");
dockerRegistryConfiguration.setPassword("password");
String token = dockerRegistryConfiguration.createDockerRegistryAuthToken();
assertThat(dockerRegistryConfiguration.getEmail()).isNull();
assertThat(dockerRegistryConfiguration.getUrl()).isNull();
assertThat(token).isEqualTo(
"ewogICJ1c2VybmFtZSIgOiAidXNlcm5hbWUiLAogICJwYXNzd29yZCIgOiAicGFzc3dvcmQiLAogICJlbWFpbCIgOiBudWxsLAogICJzZXJ2ZXJhZGRyZXNzIiA6IG51bGwKfQ==");
assertThat(new String(Base64Utils.decodeFromString(token))).isEqualTo("{\n" + " \"username\" : \"username\",\n"
+ " \"password\" : \"password\",\n" + " \"email\" : null,\n" + " \"serveraddress\" : null\n" + "}");
}
@Test
void createDockerRegistryAuthTokenWithTokenAndUsername() {
DockerRegistryConfiguration dockerRegistryConfiguration = new DockerRegistryConfiguration();
dockerRegistryConfiguration.setToken("mockToken");
dockerRegistryConfiguration.setUsername("username");
dockerRegistryConfiguration.setPassword("password");
dockerRegistryConfiguration.setEmail("mock@spring.com");
dockerRegistryConfiguration.setUrl("http://mock.docker.registry");
assertThat(dockerRegistryConfiguration.createDockerRegistryAuthToken()).isEqualTo("mockToken");
}
}

12
spring-boot-project/spring-boot-tools/spring-boot-buildpack-platform/src/test/java/org/springframework/boot/buildpack/platform/docker/transport/HttpTransportTests.java
View File

@@ -19,9 +19,13 @@ package org.springframework.boot.buildpack.platform.docker.transport;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.Map;
import org.apache.http.Header;
import org.apache.http.message.BasicHeader;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.io.TempDir;
@@ -65,4 +69,12 @@ class HttpTransportTests {
assertThat(transport).isInstanceOf(LocalHttpClientTransport.class);
}
@Test
void createWithDockerEngineAuthenticationHeaders() {
Collection<Header> dockerEngineAuthenticationHeaders = Arrays.asList(new BasicHeader("X-Registry-Auth",
"eyJ1c2VybmFtZSI6ICJ1c2VybmFtZSIsInBhc3N3b3JkIjogInBhc3N3b3JkIiwiZW1haWwiOiAibW9ja0BzcHJpbmcuY29tIiwic2VydmVyYWRkcmVzcyI6ICJodHRwOi8vbW9jay5kb2NrZXIucmVnaXN0cnkifQ=="));
HttpTransport transport = HttpTransport.create((name) -> null, dockerEngineAuthenticationHeaders);
assertThat(transport).isInstanceOf(LocalHttpClientTransport.class);
}
}

14
spring-boot-project/spring-boot-tools/spring-boot-buildpack-platform/src/test/java/org/springframework/boot/buildpack/platform/docker/transport/RemoteHttpClientTransportTests.java
View File

@@ -19,13 +19,17 @@ package org.springframework.boot.buildpack.platform.docker.transport;
import java.io.IOException;
import java.nio.file.Files;
import java.nio.file.Path;
import java.util.Arrays;
import java.util.Collection;
import java.util.LinkedHashMap;
import java.util.Map;
import java.util.function.Consumer;
import javax.net.ssl.SSLContext;
import org.apache.http.Header;
import org.apache.http.HttpHost;
import org.apache.http.message.BasicHeader;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.io.TempDir;
@@ -68,6 +72,16 @@ class RemoteHttpClientTransportTests {
assertThat(transport).isNotNull();
}
@Test
void createWithDockerEngineAuthenticationHeaders() {
Collection<Header> dockerEngineAuthenticationHeaders = Arrays.asList(new BasicHeader("X-Registry-Auth",
"eyJ1c2VybmFtZSI6ICJ1c2VybmFtZSIsInBhc3N3b3JkIjogInBhc3N3b3JkIiwiZW1haWwiOiAibW9ja0BzcHJpbmcuY29tIiwic2VydmVyYWRkcmVzcyI6ICJodHRwOi8vbW9jay5kb2NrZXIucmVnaXN0cnkifQ=="));
this.environment.put("DOCKER_HOST", "tcp://192.168.1.2:2376");
RemoteHttpClientTransport transport = RemoteHttpClientTransport.createIfPossible(this.environment::get,
dockerEngineAuthenticationHeaders);
assertThat(transport).isNotNull();
}
@Test
void createIfPossibleWhenTlsVerifyWithMissingCertPathThrowsException() {
this.environment.put("DOCKER_HOST", "tcp://192.168.1.2:2376");