From 593b88e41487f481d4368a4d331146914c1c2981 Mon Sep 17 00:00:00 2001 From: Jordi Boggiano Date: Tue, 26 Jan 2016 19:09:44 +0000 Subject: [PATCH] Let users configure *any auth* via COMPOSER_AUTH and add it to the docs, refs #4546 --- doc/03-cli.md | 7 +++++++ src/Composer/IO/BaseIO.php | 34 ++++++++++++++++++++++------------ 2 files changed, 29 insertions(+), 12 deletions(-) diff --git a/doc/03-cli.md b/doc/03-cli.md index cb47f7cc4..94a7a963c 100644 --- a/doc/03-cli.md +++ b/doc/03-cli.md @@ -717,6 +717,13 @@ commands) to finish executing. The default value is 300 seconds (5 minutes). By setting this environmental value, you can set a path to a certificate bundle file to be used during SSL/TLS peer verification. +### COMPOSER_AUTH + +The `COMPOSER_AUTH` var allows you to set up authentication as an environment variable. +The contents of the variable should be a JSON formatted object containing http-basic, +github-oauth, ... objects as needed, and following the +[spec from the config](06-config.md#gitlab-oauth). + ### COMPOSER_DISCARD_CHANGES This env var controls the [`discard-changes`](06-config.md#discard-changes) config option. diff --git a/src/Composer/IO/BaseIO.php b/src/Composer/IO/BaseIO.php index 43248c92c..3a5a1d701 100644 --- a/src/Composer/IO/BaseIO.php +++ b/src/Composer/IO/BaseIO.php @@ -60,22 +60,32 @@ abstract class BaseIO implements IOInterface */ public function loadConfiguration(Config $config) { - // Use COMPOSER_AUTH environment variable if set - if ($envvar_data = getenv('COMPOSER_AUTH')) { - $auth_data = json_decode($envvar_data); + $githubOauth = $config->get('github-oauth'); + $gitlabOauth = $config->get('gitlab-oauth'); + $httpBasic = $config->get('http-basic'); - if (is_null($auth_data)) { + // Use COMPOSER_AUTH environment variable if set + if ($composerAuthEnv = getenv('COMPOSER_AUTH')) { + $authData = json_decode($composerAuthEnv, true); + + if (is_null($authData)) { throw new \UnexpectedValueException('COMPOSER_AUTH environment variable is malformed'); } - foreach ($auth_data as $domain => $credentials) { - $this->setAuthentication($domain, $credentials->username, $credentials->password); + if (isset($authData['github-oauth'])) { + $githubOauth = array_merge($githubOauth, $authData['github-oauth']); + } + if (isset($authData['gitlab-oauth'])) { + $gitlabOauth = array_merge($gitlabOauth, $authData['gitlab-oauth']); + } + if (isset($authData['http-basic'])) { + $httpBasic = array_merge($httpBasic, $authData['http-basic']); } } // reload oauth token from config if available - if ($tokens = $config->get('github-oauth')) { - foreach ($tokens as $domain => $token) { + if ($githubOauth) { + foreach ($githubOauth as $domain => $token) { if (!preg_match('{^[a-z0-9]+$}', $token)) { throw new \UnexpectedValueException('Your github oauth token for '.$domain.' contains invalid characters: "'.$token.'"'); } @@ -83,15 +93,15 @@ abstract class BaseIO implements IOInterface } } - if ($tokens = $config->get('gitlab-oauth')) { - foreach ($tokens as $domain => $token) { + if ($gitlabOauth) { + foreach ($gitlabOauth as $domain => $token) { $this->setAuthentication($domain, $token, 'oauth2'); } } // reload http basic credentials from config if available - if ($creds = $config->get('http-basic')) { - foreach ($creds as $domain => $cred) { + if ($httpBasic) { + foreach ($httpBasic as $domain => $cred) { $this->setAuthentication($domain, $cred['username'], $cred['password']); } }