2014-03-11 00:16:58 +00:00
package registry
2013-03-15 00:43:59 +00:00
import (
"encoding/base64"
"encoding/json"
2013-05-29 00:35:10 +00:00
"errors"
2013-03-15 00:43:59 +00:00
"fmt"
"io/ioutil"
"net/http"
"os"
2013-03-22 09:19:39 +00:00
"path"
2013-03-15 00:43:59 +00:00
"strings"
2014-06-03 00:46:06 +00:00
2014-07-24 22:19:50 +00:00
"github.com/docker/docker/utils"
2013-03-15 00:43:59 +00:00
)
// Where we store the config file
2013-03-22 09:19:39 +00:00
const CONFIGFILE = ".dockercfg"
2013-03-15 00:43:59 +00:00
2013-07-05 19:20:58 +00:00
// Only used for user auth + account creation
2013-07-22 23:16:31 +00:00
const INDEXSERVER = "https://index.docker.io/v1/"
2013-03-15 00:43:59 +00:00
2014-07-24 22:19:50 +00:00
//const INDEXSERVER = "https://registry-stage.hub.docker.com/v1/"
2013-05-29 00:35:10 +00:00
var (
2013-06-04 13:51:12 +00:00
ErrConfigFileMissing = errors . New ( "The Auth config file is missing" )
2013-05-29 00:35:10 +00:00
)
2013-03-15 00:43:59 +00:00
type AuthConfig struct {
2013-09-03 18:45:49 +00:00
Username string ` json:"username,omitempty" `
Password string ` json:"password,omitempty" `
Auth string ` json:"auth" `
Email string ` json:"email" `
ServerAddress string ` json:"serveraddress,omitempty" `
2013-03-15 00:43:59 +00:00
}
2013-07-23 15:04:31 +00:00
type ConfigFile struct {
Configs map [ string ] AuthConfig ` json:"configs,omitempty" `
rootPath string
2013-03-22 12:52:13 +00:00
}
2013-05-08 17:21:21 +00:00
func IndexServerAddress ( ) string {
2013-06-04 18:00:22 +00:00
return INDEXSERVER
2013-05-08 17:21:21 +00:00
}
2013-03-15 00:43:59 +00:00
// create a base64 encoded auth string to store in config
2013-05-30 15:39:43 +00:00
func encodeAuth ( authConfig * AuthConfig ) string {
2013-03-15 00:43:59 +00:00
authStr := authConfig . Username + ":" + authConfig . Password
msg := [ ] byte ( authStr )
encoded := make ( [ ] byte , base64 . StdEncoding . EncodedLen ( len ( msg ) ) )
base64 . StdEncoding . Encode ( encoded , msg )
return string ( encoded )
}
// decode the auth string
2013-07-23 15:04:31 +00:00
func decodeAuth ( authStr string ) ( string , string , error ) {
2013-03-15 00:43:59 +00:00
decLen := base64 . StdEncoding . DecodedLen ( len ( authStr ) )
decoded := make ( [ ] byte , decLen )
authByte := [ ] byte ( authStr )
n , err := base64 . StdEncoding . Decode ( decoded , authByte )
if err != nil {
2013-07-23 15:04:31 +00:00
return "" , "" , err
2013-03-15 00:43:59 +00:00
}
if n > decLen {
2013-07-23 15:04:31 +00:00
return "" , "" , fmt . Errorf ( "Something went wrong decoding auth config" )
2013-03-15 00:43:59 +00:00
}
2013-11-29 23:14:36 +00:00
arr := strings . SplitN ( string ( decoded ) , ":" , 2 )
2013-03-22 09:19:39 +00:00
if len ( arr ) != 2 {
2013-07-23 15:04:31 +00:00
return "" , "" , fmt . Errorf ( "Invalid auth configuration file" )
2013-03-22 09:19:39 +00:00
}
2013-03-15 00:43:59 +00:00
password := strings . Trim ( arr [ 1 ] , "\x00" )
2013-07-23 15:04:31 +00:00
return arr [ 0 ] , password , nil
2013-03-15 00:43:59 +00:00
}
// load up the auth config information and return values
2013-03-22 09:19:39 +00:00
// FIXME: use the internal golang config parser
2013-07-23 15:04:31 +00:00
func LoadConfig ( rootPath string ) ( * ConfigFile , error ) {
configFile := ConfigFile { Configs : make ( map [ string ] AuthConfig ) , rootPath : rootPath }
2013-03-22 09:19:39 +00:00
confFile := path . Join ( rootPath , CONFIGFILE )
if _ , err := os . Stat ( confFile ) ; err != nil {
2013-08-16 14:29:40 +00:00
return & configFile , nil //missing file is not an error
2013-03-22 09:19:39 +00:00
}
b , err := ioutil . ReadFile ( confFile )
if err != nil {
2013-08-14 10:26:18 +00:00
return & configFile , err
2013-03-22 09:19:39 +00:00
}
2013-07-23 15:04:31 +00:00
if err := json . Unmarshal ( b , & configFile . Configs ) ; err != nil {
arr := strings . Split ( string ( b ) , "\n" )
if len ( arr ) < 2 {
2013-08-16 14:29:40 +00:00
return & configFile , fmt . Errorf ( "The Auth config file is empty" )
2013-07-23 15:04:31 +00:00
}
authConfig := AuthConfig { }
origAuth := strings . Split ( arr [ 0 ] , " = " )
2013-09-30 11:07:32 +00:00
if len ( origAuth ) != 2 {
return & configFile , fmt . Errorf ( "Invalid Auth config file" )
}
2013-07-23 15:04:31 +00:00
authConfig . Username , authConfig . Password , err = decodeAuth ( origAuth [ 1 ] )
if err != nil {
2013-08-16 14:29:40 +00:00
return & configFile , err
2013-07-23 15:04:31 +00:00
}
origEmail := strings . Split ( arr [ 1 ] , " = " )
2013-09-30 11:07:32 +00:00
if len ( origEmail ) != 2 {
return & configFile , fmt . Errorf ( "Invalid Auth config file" )
}
2013-07-23 15:04:31 +00:00
authConfig . Email = origEmail [ 1 ]
2013-09-03 18:45:49 +00:00
authConfig . ServerAddress = IndexServerAddress ( )
2013-07-23 15:04:31 +00:00
configFile . Configs [ IndexServerAddress ( ) ] = authConfig
} else {
for k , authConfig := range configFile . Configs {
authConfig . Username , authConfig . Password , err = decodeAuth ( authConfig . Auth )
if err != nil {
2013-08-16 14:29:40 +00:00
return & configFile , err
2013-07-23 15:04:31 +00:00
}
2013-07-24 12:28:22 +00:00
authConfig . Auth = ""
2013-07-23 15:04:31 +00:00
configFile . Configs [ k ] = authConfig
2013-09-03 18:45:49 +00:00
authConfig . ServerAddress = k
2013-07-23 15:04:31 +00:00
}
2013-03-15 00:43:59 +00:00
}
2013-07-23 15:04:31 +00:00
return & configFile , nil
2013-03-15 00:43:59 +00:00
}
// save the auth config
2013-07-23 15:04:31 +00:00
func SaveConfig ( configFile * ConfigFile ) error {
confFile := path . Join ( configFile . rootPath , CONFIGFILE )
if len ( configFile . Configs ) == 0 {
2013-05-01 23:36:01 +00:00
os . Remove ( confFile )
return nil
}
2013-07-25 00:35:52 +00:00
configs := make ( map [ string ] AuthConfig , len ( configFile . Configs ) )
2013-07-23 15:04:31 +00:00
for k , authConfig := range configFile . Configs {
2013-07-25 00:35:52 +00:00
authCopy := authConfig
authCopy . Auth = encodeAuth ( & authCopy )
authCopy . Username = ""
authCopy . Password = ""
2013-09-03 18:45:49 +00:00
authCopy . ServerAddress = ""
2013-07-25 00:35:52 +00:00
configs [ k ] = authCopy
2013-07-23 15:04:31 +00:00
}
2013-07-25 00:35:52 +00:00
b , err := json . Marshal ( configs )
2013-07-23 15:04:31 +00:00
if err != nil {
return err
}
err = ioutil . WriteFile ( confFile , b , 0600 )
2013-03-15 00:43:59 +00:00
if err != nil {
return err
}
return nil
}
// try to register/login to the registry server
2013-08-02 07:30:45 +00:00
func Login ( authConfig * AuthConfig , factory * utils . HTTPRequestFactory ) ( string , error ) {
2014-02-06 00:49:43 +00:00
var (
2014-06-03 00:46:06 +00:00
status string
reqBody [ ] byte
err error
client = & http . Client {
Transport : & http . Transport {
DisableKeepAlives : true ,
Proxy : http . ProxyFromEnvironment ,
} ,
CheckRedirect : AddRequiredHeadersToRedirectedRequests ,
}
2014-02-06 00:49:43 +00:00
reqStatusCode = 0
serverAddress = authConfig . ServerAddress
)
2013-09-03 18:45:49 +00:00
if serverAddress == "" {
serverAddress = IndexServerAddress ( )
}
loginAgainstOfficialIndex := serverAddress == IndexServerAddress ( )
2013-12-25 00:37:00 +00:00
// to avoid sending the server address to the server it should be removed before being marshalled
2013-09-03 18:45:49 +00:00
authCopy := * authConfig
authCopy . ServerAddress = ""
jsonBody , err := json . Marshal ( authCopy )
2013-03-15 21:41:55 +00:00
if err != nil {
2013-04-24 16:11:29 +00:00
return "" , fmt . Errorf ( "Config Error: %s" , err )
2013-03-15 21:41:55 +00:00
}
2013-04-02 10:00:21 +00:00
// using `bytes.NewReader(jsonBody)` here causes the server to respond with a 411 status.
b := strings . NewReader ( string ( jsonBody ) )
2013-09-03 18:45:49 +00:00
req1 , err := http . Post ( serverAddress + "users/" , "application/json; charset=utf-8" , b )
2013-03-15 01:43:02 +00:00
if err != nil {
2013-04-24 16:11:29 +00:00
return "" , fmt . Errorf ( "Server Error: %s" , err )
2013-03-15 00:43:59 +00:00
}
2013-03-15 01:43:02 +00:00
reqStatusCode = req1 . StatusCode
2013-03-15 21:41:55 +00:00
defer req1 . Body . Close ( )
reqBody , err = ioutil . ReadAll ( req1 . Body )
if err != nil {
2013-04-24 16:11:29 +00:00
return "" , fmt . Errorf ( "Server Error: [%#v] %s" , reqStatusCode , err )
2013-03-15 21:41:55 +00:00
}
2013-03-15 01:43:02 +00:00
2013-03-15 00:43:59 +00:00
if reqStatusCode == 201 {
2013-09-03 18:45:49 +00:00
if loginAgainstOfficialIndex {
status = "Account created. Please use the confirmation link we sent" +
" to your e-mail to activate it."
} else {
status = "Account created. Please see the documentation of the registry " + serverAddress + " for instructions how to activate it."
}
2013-03-15 00:43:59 +00:00
} else if reqStatusCode == 400 {
2013-05-01 16:06:17 +00:00
if string ( reqBody ) == "\"Username or email already exists\"" {
2013-09-03 18:45:49 +00:00
req , err := factory . NewRequest ( "GET" , serverAddress + "users/" , nil )
2013-03-15 00:43:59 +00:00
req . SetBasicAuth ( authConfig . Username , authConfig . Password )
resp , err := client . Do ( req )
if err != nil {
return "" , err
}
defer resp . Body . Close ( )
body , err := ioutil . ReadAll ( resp . Body )
if err != nil {
return "" , err
}
if resp . StatusCode == 200 {
2013-06-14 13:38:51 +00:00
status = "Login Succeeded"
2013-05-01 23:36:01 +00:00
} else if resp . StatusCode == 401 {
return "" , fmt . Errorf ( "Wrong login/password, please try again" )
2013-12-05 23:10:44 +00:00
} else if resp . StatusCode == 403 {
if loginAgainstOfficialIndex {
return "" , fmt . Errorf ( "Login: Account is not Active. Please check your e-mail for a confirmation link." )
}
return "" , fmt . Errorf ( "Login: Account is not Active. Please see the documentation of the registry %s for instructions how to activate it." , serverAddress )
2013-03-15 00:43:59 +00:00
} else {
2013-12-05 23:10:44 +00:00
return "" , fmt . Errorf ( "Login: %s (Code: %d; Headers: %s)" , body , resp . StatusCode , resp . Header )
2013-03-15 00:43:59 +00:00
}
} else {
2013-04-24 16:11:29 +00:00
return "" , fmt . Errorf ( "Registration: %s" , reqBody )
2013-03-15 00:43:59 +00:00
}
2013-11-07 18:36:02 +00:00
} else if reqStatusCode == 401 {
// This case would happen with private registries where /v1/users is
// protected, so people can use `docker login` as an auth check.
req , err := factory . NewRequest ( "GET" , serverAddress + "users/" , nil )
req . SetBasicAuth ( authConfig . Username , authConfig . Password )
resp , err := client . Do ( req )
if err != nil {
return "" , err
}
defer resp . Body . Close ( )
body , err := ioutil . ReadAll ( resp . Body )
if err != nil {
return "" , err
2013-12-05 23:10:44 +00:00
}
2013-11-07 18:36:02 +00:00
if resp . StatusCode == 200 {
status = "Login Succeeded"
} else if resp . StatusCode == 401 {
return "" , fmt . Errorf ( "Wrong login/password, please try again" )
} else {
return "" , fmt . Errorf ( "Login: %s (Code: %d; Headers: %s)" , body ,
resp . StatusCode , resp . Header )
}
2013-03-15 01:43:02 +00:00
} else {
2013-04-24 16:11:29 +00:00
return "" , fmt . Errorf ( "Unexpected status code [%d] : %s" , reqStatusCode , reqBody )
2013-03-15 00:43:59 +00:00
}
return status , nil
}
2013-09-03 18:45:49 +00:00
// this method matches a auth configuration to a server address or a url
2014-02-20 22:57:58 +00:00
func ( config * ConfigFile ) ResolveAuthConfig ( hostname string ) AuthConfig {
if hostname == IndexServerAddress ( ) || len ( hostname ) == 0 {
2013-09-03 18:45:49 +00:00
// default to the index server
return config . Configs [ IndexServerAddress ( ) ]
}
2014-02-20 22:57:58 +00:00
// First try the happy case
if c , found := config . Configs [ hostname ] ; found {
return c
2013-09-03 18:45:49 +00:00
}
2014-02-20 22:57:58 +00:00
convertToHostname := func ( url string ) string {
stripped := url
if strings . HasPrefix ( url , "http://" ) {
stripped = strings . Replace ( url , "http://" , "" , 1 )
} else if strings . HasPrefix ( url , "https://" ) {
stripped = strings . Replace ( url , "https://" , "" , 1 )
2013-09-03 18:45:49 +00:00
}
2014-02-20 22:57:58 +00:00
nameParts := strings . SplitN ( stripped , "/" , 2 )
return nameParts [ 0 ]
2013-09-03 18:45:49 +00:00
}
2014-02-20 22:57:58 +00:00
// Maybe they have a legacy config file, we will iterate the keys converting
// them to the new format and testing
normalizedHostename := convertToHostname ( hostname )
for registry , config := range config . Configs {
if registryHostname := convertToHostname ( registry ) ; registryHostname == normalizedHostename {
return config
}
2013-09-03 18:45:49 +00:00
}
2014-02-20 22:57:58 +00:00
// When all else fails, return an empty auth config
return AuthConfig { }
2013-09-03 18:45:49 +00:00
}