Эхлэл Бүгдийг харах Тусламж
Нэвтрэх
Apq
/
docker-compose
-ын хуулбар https://github.com/docker/compose.git
1
0
Салаа 0
Файлууд Асуудлууд 0 Мэдлэгийн сан
Эх сурвалжийг харах

Merge pull request #146 from docker/chore-refactor-azure-login

Refactor Azure login local server
Guillaume Tardif 5 жил өмнө
parent
c37f666c07 e5335adedd
commit
427527d197
6 өөрчлөгдсөн 180 нэмэгдсэн , 134 устгасан
Өөрчлөлтийг ялгаж харах Өөрчлөлтийн статистик харах
  1. 119 0
      azure/login/local_server.go
  2. 34 33
      azure/login/login.go
  3. 12 13
      azure/login/login_test.go
  4. 0 83
      azure/login/logingLocalServer.go
  5. 14 4
      cli/cmd/login/login.go
  6. 1 1
      tests/e2e/e2e_test.go

+ 119 - 0
azure/login/local_server.go
Файл харах 

@@ -0,0 +1,119 @@
 
+package login
 
+
 
+import (
 
+	"fmt"
 
+	"net"
 
+	"net/http"
 
+	"net/url"
 
+
 
+	"github.com/pkg/errors"
 
+)
 
+
 
+const failHTML = `
 
+<!DOCTYPE html>
 
+<html>
 
+<head>
 
+	<meta charset="utf-8" />
 
+	<title>Login failed</title>
 
+</head>
 
+<body>
 
+	<h4>Some failures occurred during the authentication</h4>
 
+	<p>You can log an issue at <a href="https://github.com/azure/azure-cli/issues">Azure CLI GitHub Repository</a> and we will assist you in resolving it.</p>
 
+</body>
 
+</html>
 
+`
 
+
 
+const successHTML = `
 
+<!DOCTYPE html>
 
+<html>
 
+<head>
 
+	<meta charset="utf-8" />
 
+	<meta http-equiv="refresh" content="10;url=https://docs.microsoft.com/cli/azure/">
 
+	<title>Login successfully</title>
 
+</head>
 
+<body>
 
+	<h4>You have logged into Microsoft Azure!</h4>
 
+	<p>You can close this window, or we will redirect you to the <a href="https://docs.microsoft.com/cli/azure/">Azure CLI documents</a> in 10 seconds.</p>
 
+</body>
 
+</html>
 
+`
 
+
 
+const (
 
+	// redirectHost is where the user's browser is redirected on authentication
 
+	// completion. Note that only registered hosts can be used. i.e.:
 
+	// "localhost" works but "127.0.0.1" does not.
 
+	redirectHost = "localhost"
 
+)
 
+
 
+type localResponse struct {
 
+	values url.Values
 
+	err    error
 
+}
 
+
 
+// LocalServer is an Azure login server
 
+type LocalServer struct {
 
+	httpServer *http.Server
 
+	listener   net.Listener
 
+	queryCh    chan localResponse
 
+}
 
+
 
+// NewLocalServer creates an Azure login server
 
+func NewLocalServer(queryCh chan localResponse) (*LocalServer, error) {
 
+	s := &LocalServer{queryCh: queryCh}
 
+	mux := http.NewServeMux()
 
+	mux.HandleFunc("/", s.handler())
 
+	s.httpServer = &http.Server{Handler: mux}
 
+	l, err := net.Listen("tcp", redirectHost+":0")
 
+	if err != nil {
 
+		return nil, err
 
+	}
 
+	s.listener = l
 
+	p := l.Addr().(*net.TCPAddr).Port
 
+	if p == 0 {
 
+		return nil, errors.New("unable to allocate login server port")
 
+	}
 
+	return s, nil
 
+}
 
+
 
+// Serve starts the local Azure login server
 
+func (s *LocalServer) Serve() {
 
+	go func() {
 
+		if err := s.httpServer.Serve(s.listener); err != nil {
 
+			s.queryCh <- localResponse{
 
+				err: errors.Wrap(err, "unable to start login server"),
 
+			}
 
+		}
 
+	}()
 
+}
 
+
 
+// Close stops the local Azure login server
 
+func (s *LocalServer) Close() {
 
+	_ = s.httpServer.Close()
 
+}
 
+
 
+// Addr returns the address that the local Azure server is service to
 
+func (s *LocalServer) Addr() string {
 
+	return fmt.Sprintf("http://%s:%d", redirectHost, s.listener.Addr().(*net.TCPAddr).Port)
 
+}
 
+
 
+func (s *LocalServer) handler() func(w http.ResponseWriter, r *http.Request) {
 
+	return func(w http.ResponseWriter, r *http.Request) {
 
+		if _, hasCode := r.URL.Query()["code"]; hasCode {
 
+			if _, err := w.Write([]byte(successHTML)); err != nil {
 
+				s.queryCh <- localResponse{
 
+					err: errors.Wrap(err, "unable to write success HTML"),
 
+				}
 
+			} else {
 
+				s.queryCh <- localResponse{values: r.URL.Query()}
 
+			}
 
+		} else {
 
+			if _, err := w.Write([]byte(failHTML)); err != nil {
 
+				s.queryCh <- localResponse{
 
+					err: errors.Wrap(err, "unable to write fail HTML"),
 
+				}
 
+			} else {
 
+				s.queryCh <- localResponse{values: r.URL.Query()}
 
+			}
 
+		}
 
+	}
 
+}

+ 34 - 33
azure/login/login.go
Файл харах 

@@ -5,6 +5,7 @@ import (
 
 	"encoding/json"
 
 	"fmt"
 
 	"log"
 
+	"net/http"
 
 	"net/url"
 
 	"os/exec"
 
 	"path/filepath"
 
@@ -12,15 +13,14 @@ import (
 
 	"strconv"
 
 	"time"
 
 
-	"github.com/docker/api/errdefs"
 
-
 
 	"github.com/Azure/go-autorest/autorest"
 
 	"github.com/Azure/go-autorest/autorest/adal"
 
 	"github.com/Azure/go-autorest/autorest/azure/cli"
 
 	"github.com/Azure/go-autorest/autorest/date"
 
+	"github.com/pkg/errors"
 
 	"golang.org/x/oauth2"
 
 
-	"github.com/pkg/errors"
 
+	"github.com/docker/api/errdefs"
 
 )
 
 
 //go login process, derived from code sample provided by MS at https://github.com/devigned/go-az-cli-stuff
 
@@ -77,28 +77,32 @@ func newAzureLoginServiceFromPath(tokenStorePath string, helper apiHelper) (Azur
 
 	}, nil
 
 }
 
 
-//Login perform azure login through browser
 
+// Login performs an Azure login through a web browser
 
 func (login AzureLoginService) Login(ctx context.Context) error {
 
-	queryCh := make(chan url.Values, 1)
 
-	serverPort, err := startLoginServer(queryCh)
 
+	queryCh := make(chan localResponse, 1)
 
+	s, err := NewLocalServer(queryCh)
 
 	if err != nil {
 
 		return err
 
 	}
 
+	s.Serve()
 
+	defer s.Close()
 
 
-	redirectURL := "http://localhost:" + strconv.Itoa(serverPort)
 
+	redirectURL := s.Addr()
 
+	if redirectURL == "" {
 
+		return errors.Wrap(errdefs.ErrLoginFailed, "empty redirect URL")
 
+	}
 
 	login.apiHelper.openAzureLoginPage(redirectURL)
 
 
 	select {
 
 	case <-ctx.Done():
 
-		return nil
 
-	case qsValues := <-queryCh:
 
-		errorMsg, hasError := qsValues["error"]
 
-		if hasError {
 
-			return fmt.Errorf("login failed : %s", errorMsg)
 
+		return ctx.Err()
 
+	case q := <-queryCh:
 
+		if q.err != nil {
 
+			return errors.Wrapf(errdefs.ErrLoginFailed, "unhandled local login server error: %s", err)
 
 		}
 
-		code, hasCode := qsValues["code"]
 
+		code, hasCode := q.values["code"]
 
 		if !hasCode {
 
-			return errdefs.ErrLoginFailed
 
+			return errors.Wrap(errdefs.ErrLoginFailed, "no login code")
 
 		}
 
 		data := url.Values{
 
 			"grant_type":   []string{"authorization_code"},
 
@@ -109,38 +113,35 @@ func (login AzureLoginService) Login(ctx context.Context) error {
 
 		}
 
 		token, err := login.apiHelper.queryToken(data, "organizations")
 
 		if err != nil {
 
-			return errors.Wrap(err, "Access token request failed")
 
+			return errors.Wrapf(errdefs.ErrLoginFailed, "access token request failed: %s", err)
 
 		}
 
 
 		bits, statusCode, err := login.apiHelper.queryAuthorizationAPI(authorizationURL, fmt.Sprintf("Bearer %s", token.AccessToken))
 
 		if err != nil {
 
-			return errors.Wrap(err, "login failed")
 
+			return errors.Wrapf(errdefs.ErrLoginFailed, "check auth failed: %s", err)
 
 		}
 
 
-		if statusCode == 200 {
 
-			var tenantResult tenantResult
 
-			if err := json.Unmarshal(bits, &tenantResult); err != nil {
 
-				return errors.Wrap(err, "login failed")
 
+		switch statusCode {
 
+		case http.StatusOK:
 
+			var t tenantResult
 
+			if err := json.Unmarshal(bits, &t); err != nil {
 
+				return errors.Wrapf(errdefs.ErrLoginFailed, "unable to unmarshal tenant: %s", err)
 
 			}
 
-			tenantID := tenantResult.Value[0].TenantID
 
-			tenantToken, err := login.refreshToken(token.RefreshToken, tenantID)
 
+			tID := t.Value[0].TenantID
 
+			tToken, err := login.refreshToken(token.RefreshToken, tID)
 
 			if err != nil {
 
-				return errors.Wrap(err, "login failed")
 
+				return errors.Wrapf(errdefs.ErrLoginFailed, "unable to refresh token: %s", err)
 
 			}
 
-			loginInfo := TokenInfo{TenantID: tenantID, Token: tenantToken}
 
-
 
-			err = login.tokenStore.writeLoginInfo(loginInfo)
 
+			loginInfo := TokenInfo{TenantID: tID, Token: tToken}
 
 
-			if err != nil {
 
-				return errors.Wrap(err, "login failed")
 
+			if err := login.tokenStore.writeLoginInfo(loginInfo); err != nil {
 
+				return errors.Wrapf(errdefs.ErrLoginFailed, "could not store login info: %s", err)
 
 			}
 
-			fmt.Println("Login Succeeded")
 
-
 
-			return nil
 
+		default:
 
+			return errors.Wrapf(errdefs.ErrLoginFailed, "unable to login status code %d: %s", statusCode, bits)
 
 		}
 
-
 
-		return fmt.Errorf("login failed : " + string(bits))
 
 	}
 
+	return nil
 
 }
 
 
 func getTokenStorePath() string {

+ 12 - 13
azure/login/login_test.go
Файл харах 

@@ -2,7 +2,6 @@ package login
 
 
 import (
 
 	"context"
 
-	"errors"
 
 	"io/ioutil"
 
 	"net/http"
 
 	"net/url"
 
@@ -20,14 +19,14 @@ import (
 
 	. "github.com/onsi/gomega"
 
 )
 
 
-type LoginSuiteTest struct {
 
+type LoginSuite struct {
 
 	suite.Suite
 
 	dir        string
 
 	mockHelper *MockAzureHelper
 
 	azureLogin AzureLoginService
 
 }
 
 
-func (suite *LoginSuiteTest) BeforeTest(suiteName, testName string) {
 
+func (suite *LoginSuite) BeforeTest(suiteName, testName string) {
 
 	dir, err := ioutil.TempDir("", "test_store")
 
 	Expect(err).To(BeNil())
 
 
@@ -37,12 +36,12 @@ func (suite *LoginSuiteTest) BeforeTest(suiteName, testName string) {
 
 	Expect(err).To(BeNil())
 
 }
 
 
-func (suite *LoginSuiteTest) AfterTest(suiteName, testName string) {
 
+func (suite *LoginSuite) AfterTest(suiteName, testName string) {
 
 	err := os.RemoveAll(suite.dir)
 
 	Expect(err).To(BeNil())
 
 }
 
 
-func (suite *LoginSuiteTest) TestRefreshInValidToken() {
 
+func (suite *LoginSuite) TestRefreshInValidToken() {
 
 	data := refreshTokenData("refreshToken")
 
 	suite.mockHelper.On("queryToken", data, "123456").Return(azureToken{
 
 		RefreshToken: "newRefreshToken",
 
@@ -77,7 +76,7 @@ func (suite *LoginSuiteTest) TestRefreshInValidToken() {
 
 	Expect(storedToken.Token.Expiry).To(BeTemporally(">", time.Now().Add(3500*time.Second)))
 
 }
 
 
-func (suite *LoginSuiteTest) TestDoesNotRefreshValidToken() {
 
+func (suite *LoginSuite) TestDoesNotRefreshValidToken() {
 
 	expiryDate := time.Now().Add(1 * time.Hour)
 
 	err := suite.azureLogin.tokenStore.writeLoginInfo(TokenInfo{
 
 		TenantID: "123456",
 
@@ -96,10 +95,10 @@ func (suite *LoginSuiteTest) TestDoesNotRefreshValidToken() {
 
 	Expect(token.AccessToken).To(Equal("accessToken"))
 
 }
 
 
-func (suite *LoginSuiteTest) TestInvalidLogin() {
 
+func (suite *LoginSuite) TestInvalidLogin() {
 
 	suite.mockHelper.On("openAzureLoginPage", mock.AnythingOfType("string")).Run(func(args mock.Arguments) {
 
 		redirectURL := args.Get(0).(string)
 
-		err := queryKeyValue(redirectURL, "error", "access denied")
 
+		err := queryKeyValue(redirectURL, "error", "access denied: login failed")
 
 		Expect(err).To(BeNil())
 
 	})
 
 
@@ -108,10 +107,10 @@ func (suite *LoginSuiteTest) TestInvalidLogin() {
 
 	Expect(err).To(BeNil())
 
 
 	err = azureLogin.Login(context.TODO())
 
-	Expect(err).To(MatchError(errors.New("login failed : [access denied]")))
 
+	Expect(err.Error()).To(BeEquivalentTo("no login code: login failed"))
 
 }
 
 
-func (suite *LoginSuiteTest) TestValidLogin() {
 
+func (suite *LoginSuite) TestValidLogin() {
 
 	var redirectURL string
 
 	suite.mockHelper.On("openAzureLoginPage", mock.AnythingOfType("string")).Run(func(args mock.Arguments) {
 
 		redirectURL = args.Get(0).(string)
 
@@ -161,7 +160,7 @@ func (suite *LoginSuiteTest) TestValidLogin() {
 
 	Expect(loginToken.Token.Type()).To(Equal("Bearer"))
 
 }
 
 
-func (suite *LoginSuiteTest) TestLoginAuthorizationFailed() {
 
+func (suite *LoginSuite) TestLoginAuthorizationFailed() {
 
 	var redirectURL string
 
 	suite.mockHelper.On("openAzureLoginPage", mock.AnythingOfType("string")).Run(func(args mock.Arguments) {
 
 		redirectURL = args.Get(0).(string)
 
@@ -193,7 +192,7 @@ func (suite *LoginSuiteTest) TestLoginAuthorizationFailed() {
 
 	Expect(err).To(BeNil())
 
 
 	err = azureLogin.Login(context.TODO())
 
-	Expect(err).To(MatchError(errors.New("login failed : [access denied]")))
 
+	Expect(err.Error()).To(BeEquivalentTo("unable to login status code 400: [access denied]: login failed"))
 
 }
 
 
 func refreshTokenData(refreshToken string) url.Values {
 
@@ -218,7 +217,7 @@ func queryKeyValue(redirectURL string, key string, value string) error {
 
 
 func TestLoginSuite(t *testing.T) {
 
 	RegisterTestingT(t)
 
-	suite.Run(t, new(LoginSuiteTest))
 
+	suite.Run(t, new(LoginSuite))
 
 }
 
 
 type MockAzureHelper struct {

+ 0 - 83
azure/login/logingLocalServer.go
Файл харах 

@@ -1,83 +0,0 @@
 
-package login
 
-
 
-import (
 
-	"fmt"
 
-	"net"
 
-	"net/http"
 
-	"net/url"
 
-)
 
-
 
-const loginFailedHTML = `
 
-	<!DOCTYPE html>
 
-	<html>
 
-	<head>
 
-	    <meta charset="utf-8" />
 
-	    <title>Login failed</title>
 
-	</head>
 
-	<body>
 
-	    <h4>Some failures occurred during the authentication</h4>
 
-	    <p>You can log an issue at <a href="https://github.com/azure/azure-cli/issues">Azure CLI GitHub Repository</a> and we will assist you in resolving it.</p>
 
-	</body>
 
-	</html>
 
-	`
 
-
 
-const successfullLoginHTML = `
 
-	<!DOCTYPE html>
 
-	<html>
 
-	<head>
 
-	    <meta charset="utf-8" />
 
-	    <meta http-equiv="refresh" content="10;url=https://docs.microsoft.com/cli/azure/">
 
-	    <title>Login successfully</title>
 
-	</head>
 
-	<body>
 
-	    <h4>You have logged into Microsoft Azure!</h4>
 
-	    <p>You can close this window, or we will redirect you to the <a href="https://docs.microsoft.com/cli/azure/">Azure CLI documents</a> in 10 seconds.</p>
 
-	</body>
 
-	</html>
 
-	`
 
-
 
-func startLoginServer(queryCh chan url.Values) (int, error) {
 
-	mux := http.NewServeMux()
 
-	mux.HandleFunc("/", queryHandler(queryCh))
 
-	listener, err := net.Listen("tcp", ":0")
 
-	if err != nil {
 
-		return 0, err
 
-	}
 
-
 
-	availablePort := listener.Addr().(*net.TCPAddr).Port
 
-	server := &http.Server{Handler: mux}
 
-	go func() {
 
-		if err := server.Serve(listener); err != nil {
 
-			queryCh <- url.Values{
 
-				"error": []string{fmt.Sprintf("error starting http server with: %v", err)},
 
-			}
 
-		}
 
-	}()
 
-	return availablePort, nil
 
-}
 
-
 
-func queryHandler(queryCh chan url.Values) func(w http.ResponseWriter, r *http.Request) {
 
-	queryHandler := func(w http.ResponseWriter, r *http.Request) {
 
-		_, hasCode := r.URL.Query()["code"]
 
-		if hasCode {
 
-			_, err := w.Write([]byte(successfullLoginHTML))
 
-			if err != nil {
 
-				queryCh <- url.Values{
 
-					"error": []string{err.Error()},
 
-				}
 
-			} else {
 
-				queryCh <- r.URL.Query()
 
-			}
 
-		} else {
 
-			_, err := w.Write([]byte(loginFailedHTML))
 
-			if err != nil {
 
-				queryCh <- url.Values{
 
-					"error": []string{err.Error()},
 
-				}
 
-			} else {
 
-				queryCh <- r.URL.Query()
 
-			}
 
-		}
 
-	}
 
-	return queryHandler
 
-}

+ 14 - 4
cli/cmd/login/login.go
Файл харах 

@@ -1,6 +1,8 @@
 
 package login
 
 
 import (
 
+	"context"
 
+	"fmt"
 
 	"strings"
 
 
 	"github.com/pkg/errors"
 
@@ -8,6 +10,7 @@ import (
 
 
 	"github.com/docker/api/cli/dockerclassic"
 
 	"github.com/docker/api/client"
 
+	"github.com/docker/api/errdefs"
 
 )
 
 
 // Command returns the login command
 
@@ -35,7 +38,7 @@ func runLogin(cmd *cobra.Command, args []string) error {
 
 		case "azure":
 
 			return cloudLogin(cmd, "aci")
 
 		default:
 
-			return errors.New("Unknown backend type for cloud login : " + backend)
 
+			return errors.New("unknown backend type for cloud login: " + backend)
 
 		}
 
 	}
 
 	return dockerclassic.ExecCmd(cmd)
 
@@ -45,8 +48,15 @@ func cloudLogin(cmd *cobra.Command, backendType string) error {
 
 	ctx := cmd.Context()
 
 	cs, err := client.GetCloudService(ctx, backendType)
 
 	if err != nil {
 
-		return errors.Wrap(err, "cannot connect to backend")
 
+		return errors.Wrap(errdefs.ErrLoginFailed, "cannot connect to backend")
 
 	}
 
-	return cs.Login(ctx, nil)
 
-
 
+	err = cs.Login(ctx, nil)
 
+	if errors.Is(err, context.Canceled) {
 
+		return errors.New("login canceled")
 
+	}
 
+	if err != nil {
 
+		return err
 
+	}
 
+	fmt.Println("login successful")
 
+	return nil
 
 }

+ 1 - 1
tests/e2e/e2e_test.go
Файл харах 

@@ -90,7 +90,7 @@ func (s *E2eSuite) TestClassicLogin() {
 
 
 func (s *E2eSuite) TestCloudLogin() {
 
 	output, err := s.NewDockerCommand("login", "mycloudbackend").Exec()
 
-	Expect(output).To(ContainSubstring("Unknown backend type for cloud login : mycloudbackend"))
 
+	Expect(output).To(ContainSubstring("unknown backend type for cloud login: mycloudbackend"))
 
 	Expect(err).NotTo(BeNil())
 
 }