Получение маркера доступа (Python)

Статья
02/09/2024

В этом примере показано, как вызвать внешний скрипт Python для получения маркера OAuth2. Допустимый маркер доступа OAuth2 требуется реализацией делегата проверки подлинности.

Необходимые компоненты

Запуск примера:

Установите Python 3.10 или более поздней версии.
Реализуйте utils.h/cpp в проекте.
Auth.py следует добавить в проект и существовать в том же каталоге, что и двоичные файлы во время сборки.
Завершите настройку и настройку пакета SDK Microsoft Information Protection (MIP). Среди других задач вы регистрируете клиентское приложение в клиенте Microsoft Entra. Идентификатор Microsoft Entra предоставляет идентификатор приложения, также известный как идентификатор клиента, который используется в логике приобретения маркера.

Этот код не предназначен для использования в рабочей среде. Его можно использовать только для разработки и понимания концепций проверки подлинности. Пример является кроссплатформенным.

sample::auth::AcquireToken()

В простом примере проверки подлинности мы продемонстрировали простую AcquireToken() функцию, которая не принимала параметров и возвращала жестко закодированное значение маркера. В этом примере мы перегружаем AcquireToken(), чтобы принять параметры проверки подлинности и вызвать внешний скрипт Python для возврата маркера.

auth.h

В auth.h AcquireToken() перегружена и перегруженная функция и обновленные параметры приведены следующим образом:

//auth.h
#include <string>

namespace sample {
  namespace auth {
    std::string AcquireToken(
        const std::string& userName, //A string value containing the user's UPN.
        const std::string& password, //The user's password in plaintext
        const std::string& clientId, //The Azure AD client ID (also known as Application ID) of your application.
        const std::string& resource, //The resource URL for which an OAuth2 token is required. Provided by challenge object.
        const std::string& authority); //The authentication authority endpoint. Provided by challenge object.
    }
}

Первые три параметра предоставляются пользовательскими входными данными или жестко закодированных в приложении. Последние два параметра предоставляются пакетом SDK делегату проверки подлинности.

auth.cpp

В auth.cpp мы добавим перегруженное определение функции, а затем определите код, необходимый для вызова скрипта Python. Функция принимает все предоставленные параметры и передает их в скрипт Python. Скрипт выполняется и возвращает маркер в строковом формате.

#include "auth.h"
#include "utils.h"

#include <fstream>
#include <functional>
#include <memory>
#include <string>

using std::string;
using std::runtime_error;

namespace sample {
    namespace auth {

    //This function implements token acquisition in the application by calling an external Python script.
    //The Python script requires username, password, clientId, resource, and authority.
    //Username, Password, and ClientId are provided by the user/developer
    //Resource and Authority are provided as part of the OAuth2Challenge object that is passed in by the SDK to the AuthDelegate.
    string AcquireToken(
        const string& userName,
        const string& password,
        const string& clientId,
        const string& resource,
        const string& authority) {

    string cmd = "python";
    if (sample::FileExists("auth.py"))
        cmd += " auth.py -u ";

    else
        throw runtime_error("Unable to find auth script.");

    cmd += userName;
    cmd += " -p ";
    cmd += password;
    cmd += " -a ";
    cmd += authority;
    cmd += " -r ";
    cmd += resource;
    cmd += " -c ";
    // Replace <application-id> with the Application ID provided during your Azure AD application registration.
    cmd += (!clientId.empty() ? clientId : "<application-id>");

    string result = sample::Execute(cmd.c_str());
    if (result.empty())
        throw runtime_error("Failed to acquire token. Ensure Python is installed correctly.");

    return result;
    }
    }
}

Скрипт Python

Этот скрипт получает маркеры проверки подлинности непосредственно через библиотеку проверки подлинности Майкрософт (MSAL) для Python. Этот код включается только в качестве средства получения маркеров проверки подлинности для использования примерами приложений и не предназначен для использования в рабочей среде. Сценарий работает только с клиентами, поддерживающими обычную проверку подлинности имени пользователя или пароля. Проверка подлинности на основе сертификатов или многофакторная проверка подлинности не поддерживается с помощью этого скрипта.

Примечание.

Перед выполнением этого примера необходимо установить MSAL для Python, выполнив одну из следующих команд:

pip install msal
pip3 install msal

import getopt
import sys
import json
import re
from msal import PublicClientApplication

def printUsage():
  print('auth.py -u <username> -p <password> -a <authority> -r <resource> -c <clientId>')

def main(argv):
  try:
    options, args = getopt.getopt(argv, 'hu:p:a:r:c:')
  except getopt.GetoptError:
    printUsage()
    sys.exit(-1)

  username = ''
  password = ''
  authority = ''
  resource = ''

  clientId = ''
    
  for option, arg in options:
    if option == '-h':
      printUsage()
      sys.exit()
    elif option == '-u':
      username = arg
    elif option == '-p':
      password = arg
    elif option == '-a':
      authority = arg
    elif option == '-r':
      resource = arg
    elif option == '-c':
      clientId = arg

  if username == '' or password == '' or authority == '' or resource == '' or clientId == '':
    printUsage()
    sys.exit(-1)

  # ONLY FOR DEMO PURPOSES AND MSAL FOR PYTHON
  # This shouldn't be required when using proper auth flows in production.  
  if authority.find('common') > 1:
    authority = authority.split('/common')[0] + "/organizations"
   
  app = PublicClientApplication(client_id=clientId, authority=authority)  
  
  result = None  

  if resource.endswith('/'):
    resource += ".default"    
  else:
    resource += "/.default"
  
  # *DO NOT* use username/password authentication in production system.
  # Instead, consider auth code flow and using a browser to fetch the token.
  result = app.acquire_token_by_username_password(username=username, password=password, scopes=[resource])  
  print(result['access_token'])

if __name__ == '__main__':  
  main(sys.argv[1:])

Обновление AcquireOAuth2Token

Наконец, обновите AcquireOAuth2Token функцию AuthDelegateImpl , чтобы вызвать перегруженную AcquireToken функцию. URL-адреса ресурсов и центра получаются с помощью чтения challenge.GetResource() и challenge.GetAuthority(). Передается OAuth2Challenge делегату проверки подлинности при добавлении обработчика. Эта работа выполняется пакетом SDK и не требует дополнительной работы со стороны разработчика.

bool AuthDelegateImpl::AcquireOAuth2Token(
    const mip::Identity& /*identity*/,
    const OAuth2Challenge& challenge,
    OAuth2Token& token) {

    //call our AcquireToken function, passing in username, password, clientId, and getting the resource/authority from the OAuth2Challenge object
    string accessToken = sample::auth::AcquireToken(mUserName, mPassword, mClientId, challenge.GetResource(), challenge.GetAuthority());
    token.SetAccessToken(accessToken);
    return true;
}

engine При добавлении пакет SDK вызывает функцию AcquireOAuth2Token, передавая вызов, выполняя скрипт Python, получая маркер, а затем представляя маркер в службу.

Поделиться через