Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
46 changes: 19 additions & 27 deletions docker/auth/auth.py
Original file line number Diff line number Diff line change
Expand Up @@ -26,14 +26,6 @@
DOCKER_CONFIG_FILENAME = '.dockercfg'


def swap_protocol(url):
if url.startswith('http://'):
return url.replace('http://', 'https://', 1)
if url.startswith('https://'):
return url.replace('https://', 'http://', 1)
return url


def expand_registry_url(hostname, insecure=False):
if hostname.startswith('http:') or hostname.startswith('https:'):
return hostname
Expand Down Expand Up @@ -68,29 +60,29 @@ def resolve_repository_name(repo_name, insecure=False):


def resolve_authconfig(authconfig, registry=None):
"""Return the authentication data from the given auth configuration for a
specific registry. We'll do our best to infer the correct URL for the
registry, trying both http and https schemes. Returns an empty dictionnary
if no data exists."""
"""
Returns the authentication data from the given auth configuration for a
specific registry. As with the Docker client, legacy entries in the config
with full URLs are stripped down to hostnames before checking for a match.
Returns None if no match was found.
"""
# Default to the public index server
registry = registry or INDEX_URL

# If it's not the index server there are three cases:
#
# 1. this is a full config url -> it should be used as is
# 2. it could be a full url, but with the wrong protocol
# 3. it can be the hostname optionally with a port
#
# as there is only one auth entry which is fully qualified we need to start
# parsing and matching
if '/v1/' not in registry:
registry = os.path.join(registry, 'v1/')
if not registry.startswith('http:') and not registry.startswith('https:'):
registry = 'https://' + registry
registry = convert_to_hostname(registry) if registry else INDEX_URL

if registry in authconfig:
return authconfig[registry]
return authconfig.get(swap_protocol(registry), None)

for key, config in six.iteritems(authconfig):
if convert_to_hostname(key) == registry:
return config

return None


def convert_to_hostname(url):
url = url.replace('http://', '')
url = url.replace('https://', '')
return url.split('/', 1)[0]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

maybe use https://docs.python.org/2/library/urlparse.html#urlparse.urlparse instead ? It should be more robust to unexpected parts of the url.

It's available as six.moves.urllib.parse.urlparse

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Arguably better, yes, but I wanted to stick close to the Docker client's behaviour. Not sure what's the stronger principle here!



def encode_auth(auth_info):
Expand Down
3 changes: 1 addition & 2 deletions docker/client.py
Original file line number Diff line number Diff line change
Expand Up @@ -627,8 +627,7 @@ def login(self, username, password=None, email=None, registry=None,
elif not self._auth_configs:
self._auth_configs = auth.load_config()

registry = auth.expand_registry_url(registry, insecure_registry) \
if registry else auth.INDEX_URL
registry = registry or auth.INDEX_URL

authcfg = auth.resolve_authconfig(self._auth_configs, registry)
# If we found an existing auth config for this registry and username
Expand Down
12 changes: 11 additions & 1 deletion tests/utils_test.py
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,8 @@ def test_create_host_config(self):
def test_resolve_authconfig(self):
auth_config = {
'https://index.docker.io/v1/': {'auth': 'indexuser'},
'http://my.registry.net/v1/': {'auth': 'privateuser'}
'my.registry.net': {'auth': 'privateuser'},
'http://legacy.registry.url/v1/': {'auth': 'legacyauth'}
}
# hostname only
self.assertEqual(
Expand Down Expand Up @@ -154,6 +155,15 @@ def test_resolve_authconfig(self):
resolve_authconfig(auth_config, 'http://my.registry.net/v1/'),
{'auth': 'privateuser'}
)
# legacy entry in config
self.assertEqual(
resolve_authconfig(auth_config, 'legacy.registry.url'),
{'auth': 'legacyauth'}
)
# no matching entry
self.assertTrue(
resolve_authconfig(auth_config, 'does.not.exist') is None
)


if __name__ == '__main__':
Expand Down