org.eclipse.jkube.kit.build.service.docker.auth

Class AuthConfigFactory

java.lang.Object

org.eclipse.jkube.kit.build.service.docker.auth.AuthConfigFactory

public class AuthConfigFactory
extends Object

Factory for creating docker specific authentication configuration

Since:

29.07.14

Author:

roland

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	AuthConfigFactory.LookupMode

Constructor Summary

Constructors

Constructor and Description
AuthConfigFactory(KitLogger log)

Method Summary

Modifier and Type	Method and Description
AuthConfig	createAuthConfig(boolean isPush, boolean skipExtendedAuth, Map authConfig, List<RegistryServerConfiguration> settings, String user, String registry, UnaryOperator<String> passwordDecryptionMethod) Create an authentication config object which can be used for communication with a Docker registry The authentication information is looked up at various places (in this order): From system properties From the provided map which can contain key-value pairs From the openshift settings in ~/.config/kube From the Maven settings stored typically in ~/.m2/settings.xml From the Docker settings stored in ~/.docker/config.json The following properties (prefix with 'docker.') and config key are evaluated: username: User to authenticate password: Password to authenticate.
protected static AuthConfig	getAuthConfigFromDockerConfig(String registry, KitLogger log)
protected static AuthConfig	getAuthConfigFromOpenShiftConfig(AuthConfigFactory.LookupMode lookupMode, Map authConfigMap)
protected static AuthConfig	getAuthConfigFromPluginConfiguration(AuthConfigFactory.LookupMode lookupMode, Map<String,?> authConfig, UnaryOperator<String> passwordDecryptionMethod)
protected static AuthConfig	getAuthConfigFromSettings(List<RegistryServerConfiguration> settings, String user, String registry, UnaryOperator<String> passwordDecryptionMethod)
protected static AuthConfig	getAuthConfigFromSystemProperties(AuthConfigFactory.LookupMode lookupMode, UnaryOperator<String> passwordDecryptionMethod)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AuthConfigFactory

public AuthConfigFactory(KitLogger log)

Method Detail

createAuthConfig

public AuthConfig createAuthConfig(boolean isPush,
                                   boolean skipExtendedAuth,
                                   Map authConfig,
                                   List<RegistryServerConfiguration> settings,
                                   String user,
                                   String registry,
                                   UnaryOperator<String> passwordDecryptionMethod)
                            throws IOException

Create an authentication config object which can be used for communication with a Docker registry The authentication information is looked up at various places (in this order):

• From system properties
• From the provided map which can contain key-value pairs
• From the openshift settings in ~/.config/kube
• From the Maven settings stored typically in ~/.m2/settings.xml
• From the Docker settings stored in ~/.docker/config.json

The following properties (prefix with 'docker.') and config key are evaluated:

• username: User to authenticate
• password: Password to authenticate. Can be encrypted
• email: Optional EMail address which is send to the registry, too

If the repository is in an aws ecr registry and skipExtendedAuth is not true, if found credentials are not from docker settings, they will be interpreted as iam credentials and exchanged for ecr credentials.

Parameters:

isPush - if true this AuthConfig is created for a push, if false it's for a pull

skipExtendedAuth - if false, do not execute extended authentication methods

authConfig - String-String Map holding configuration info from the plugin's configuration. Can be null in which case the settings are consulted.

settings - the global Maven settings object

user - user to check for

registry - registry to use, might be null in which case a default registry is checked,

passwordDecryptionMethod - a functional interface to customize how password should be decoded

Returns:

the authentication configuration or null if none could be found

Throws:

IOException - mojo failure exception

getAuthConfigFromSystemProperties

protected static AuthConfig getAuthConfigFromSystemProperties(AuthConfigFactory.LookupMode lookupMode,
                                                              UnaryOperator<String> passwordDecryptionMethod)
                                                       throws IOException

Throws:

IOException

getAuthConfigFromOpenShiftConfig

protected static AuthConfig getAuthConfigFromOpenShiftConfig(AuthConfigFactory.LookupMode lookupMode,
                                                             Map authConfigMap)

getAuthConfigFromPluginConfiguration

protected static AuthConfig getAuthConfigFromPluginConfiguration(AuthConfigFactory.LookupMode lookupMode,
                                                                 Map<String,?> authConfig,
                                                                 UnaryOperator<String> passwordDecryptionMethod)

getAuthConfigFromSettings

protected static AuthConfig getAuthConfigFromSettings(List<RegistryServerConfiguration> settings,
                                                      String user,
                                                      String registry,
                                                      UnaryOperator<String> passwordDecryptionMethod)

getAuthConfigFromDockerConfig

protected static AuthConfig getAuthConfigFromDockerConfig(String registry,
                                                          KitLogger log)
                                                   throws IOException

Throws:

IOException