Добавление проверки подлинности пользователей в приложения Go для Microsoft Graph

В этой статье описано, как добавить проверку подлинности пользователей в приложение, созданное в разделе Сборка приложений Go с помощью Microsoft Graph. Затем вы используете API пользователя Microsoft Graph для получения пользователя, прошедшего проверку подлинности.

Добавление проверки подлинности пользователя

Клиентский модуль удостоверений Azure для Go предоставляет множество TokenCredential классов, реализующих потоки маркеров OAuth2. Пакет SDK Microsoft Graph для Go использует эти классы для проверки подлинности вызовов Microsoft Graph.

Настройка клиента Graph для проверки подлинности пользователей

Начните с использования DeviceCodeCredential класса , чтобы запросить маркер доступа с помощью потока кода устройства.

1. Добавьте следующую функцию в ./graphhelper/graphhelper.go.

   func (g *GraphHelper) InitializeGraphForUserAuth() error {
       clientId := os.Getenv("CLIENT_ID")
       tenantId := os.Getenv("TENANT_ID")
       scopes := os.Getenv("GRAPH_USER_SCOPES")
       g.graphUserScopes = strings.Split(scopes, ",")
   
       // Create the device code credential
       credential, err := azidentity.NewDeviceCodeCredential(&azidentity.DeviceCodeCredentialOptions{
           ClientID: clientId,
           TenantID: tenantId,
           UserPrompt: func(ctx context.Context, message azidentity.DeviceCodeMessage) error {
               fmt.Println(message.Message)
               return nil
           },
       })
       if err != nil {
           return err
       }
   
       g.deviceCodeCredential = credential
   
       // Create an auth provider using the credential
       authProvider, err := auth.NewAzureIdentityAuthenticationProviderWithScopes(credential, g.graphUserScopes)
       if err != nil {
           return err
       }
   
       // Create a request adapter using the auth provider
       adapter, err := msgraphsdk.NewGraphRequestAdapter(authProvider)
       if err != nil {
           return err
       }
   
       // Create a Graph client using request adapter
       client := msgraphsdk.NewGraphServiceClient(adapter)
       g.userClient = client
   
       return nil
   }
   

   Совет

   Если вы используете goimports, некоторые модули могут быть удалены из инструкции import в graphhelper.go при сохранении. Для сборки может потребоваться снова добавить модули.

2. Замените пустую initializeGraph функцию в graphtutorial.go следующим кодом.

   func initializeGraph(graphHelper *graphhelper.GraphHelper) {
       err := graphHelper.InitializeGraphForUserAuth()
       if err != nil {
           log.Panicf("Error initializing Graph for user auth: %v\n", err)
       }
   }
   

Этот код инициализирует два свойства: DeviceCodeCredential объект и GraphServiceClient объект . Функция InitializeGraphForUserAuth создает новый экземпляр DeviceCodeCredential, а затем использует его для создания нового экземпляра GraphServiceClient. Каждый раз, когда вызов API выполняется к Microsoft Graph через userClient, он использует предоставленные учетные данные для получения маркера доступа.

Тестирование DeviceCodeCredential

Затем добавьте код для получения маркера доступа из DeviceCodeCredential.

1. Добавьте следующую функцию в ./graphhelper/graphhelper.go.

   func (g *GraphHelper) GetUserToken() (*string, error) {
       token, err := g.deviceCodeCredential.GetToken(context.Background(), policy.TokenRequestOptions{
           Scopes: g.graphUserScopes,
       })
       if err != nil {
           return nil, err
       }
   
       return &token.Token, nil
   }
   

2. Замените пустую displayAccessToken функцию в graphtutorial.go следующим кодом.

   func displayAccessToken(graphHelper *graphhelper.GraphHelper) {
       token, err := graphHelper.GetUserToken()
       if err != nil {
           log.Panicf("Error getting user token: %v\n", err)
       }
   
       fmt.Printf("User token: %s", *token)
       fmt.Println()
   }
   

3. Выполните сборку и запуск приложения, запустив go run graphtutorial. Введите 1 при появлении запроса на выбор параметра. Приложение отображает URL-адрес и код устройства.

   Go Graph Tutorial
   
   Please choose one of the following options:
   0. Exit
   1. Display access token
   2. List my inbox
   3. Send mail
   4. Make a Graph call
   1
   To sign in, use a web browser to open the page https://microsoft.com/devicelogin and
   enter the code RB2RUD56D to authenticate.
   

4. Откройте браузер и перейдите по url-адресу. Введите предоставленный код и войдите в систему.

   Важно!

   Помните о всех существующих учетных записях Microsoft 365, которые вошли в браузер при просмотре страницы https://microsoft.com/devicelogin. Используйте функции браузера, такие как профили, гостевой режим или частный режим, чтобы проверить подлинность в качестве учетной записи, которую вы планируете использовать для тестирования.

5. После завершения вернитесь к приложению, чтобы увидеть маркер доступа.

   Совет

   Только для проверки и отладки можно декодировать маркеры доступа пользователей (только для рабочих или учебных учетных записей) с помощью средства синтаксического анализа токенов Майкрософт в сети по адресу https://jwt.ms. Анализ маркера может оказаться полезным, если при вызове Microsoft Graph возникают ошибки маркера. Например, убедитесь, что scp утверждение в маркере содержит ожидаемые области разрешений Microsoft Graph.

Получение пользователя

Теперь, когда проверка подлинности настроена, вы можете выполнить первый вызов Microsoft API Graph. Добавьте код для получения имени и адреса электронной почты пользователя, прошедшего проверку подлинности.

1. Добавьте следующую функцию в ./graphhelper/graphhelper.go.

   func (g *GraphHelper) GetUser() (models.Userable, error) {
       query := users.UserItemRequestBuilderGetQueryParameters{
           // Only request specific properties
           Select: []string{"displayName", "mail", "userPrincipalName"},
       }
   
       return g.userClient.Me().Get(context.Background(),
           &users.UserItemRequestBuilderGetRequestConfiguration{
               QueryParameters: &query,
           })
   }
   

2. Замените пустую greetUser функцию в graphtutorial.go следующим кодом.

   func greetUser(graphHelper *graphhelper.GraphHelper) {
       user, err := graphHelper.GetUser()
       if err != nil {
           log.Panicf("Error getting user: %v\n", err)
       }
   
       fmt.Printf("Hello, %s!\n", *user.GetDisplayName())
   
       // For Work/school accounts, email is in Mail property
       // Personal accounts, email is in UserPrincipalName
       email := user.GetMail()
       if email == nil {
           email = user.GetUserPrincipalName()
       }
   
       fmt.Printf("Email: %s\n", *email)
       fmt.Println()
   }
   

Если вы запускаете приложение сейчас, после входа приложение приветствует вас по имени.

Hello, Megan Bowen!
Email: MeganB@contoso.com

Описание кода

Рассмотрим код в getUser функции. Это всего несколько строк, но есть некоторые ключевые детали, которые следует обратить внимание.

Доступ к "мне"

Функция использует построитель userClient.Me запросов, который создает запрос к API get user . Этот API доступен двумя способами:

GET /me
GET /users/{user-id}

В этом случае код вызывает конечную точку GET /me API. Эта конечная точка является ярлыком для получения пользователя, прошедшего проверку подлинности, не зная его идентификатора пользователя.

Запрос определенных свойств

Функция использует Select свойство в параметрах запроса для указания набора необходимых ей свойств. Это свойство добавляет параметр запроса $select в вызов API.

Строго типизированный тип возвращаемого значения

Функция возвращает объект, Userable десериализованный из ответа JSON из API. Так как код использует Select, только запрошенные свойства имеют значения в возвращаемом объекте Userable . Все остальные свойства имеют значения по умолчанию.

Следующее действие