Získání přístupového tokenu (Python)

Článek
02/12/2024

Tento příklad ukazuje, jak volat externí skript Pythonu pro získání tokenu OAuth2. Implementace delegáta ověřování vyžaduje platný přístupový token OAuth2.

Požadavky

Spuštění ukázky:

Nainstalujte Python 3.10 nebo novější.
Implementujte v projektu nástroj utils.h/cpp.
Auth.py by se měly přidat do projektu a existovat ve stejném adresáři jako binární soubory v sestavení.
Dokončete nastavení a konfiguraci sady Microsoft Information Protection (MIP) SDK. Mimo jiné si zaregistrujete klientskou aplikaci v tenantovi Microsoft Entra. Microsoft Entra ID poskytuje ID aplikace, označované také jako ID klienta, které se používá v logice získání tokenu.

Tento kód není určený pro produkční použití. Dá se použít jenom pro vývoj a pochopení konceptů ověřování. Ukázka je multiplatformní.

sample::auth::AcquireToken()

V příkladu jednoduchého ověřování jsme ukázali jednoduchou AcquireToken() funkci, která nepřebrala žádné parametry a vrátila pevně zakódovanou hodnotu tokenu. V tomto příkladu přetížíme AcquireToken() tak, aby přijímal parametry ověřování a volali externí skript Pythonu, který token vrátí.

auth.h

V auth.h AcquireToken() je přetížena a přetížená funkce a aktualizované parametry jsou následující:

//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.
    }
}

První tři parametry jsou poskytovány uživatelským vstupem nebo pevně zakódovanými ve vaší aplikaci. Poslední dva parametry poskytuje sada SDK delegátu ověřování.

auth.cpp

V auth.cpp přidáme definici přetížené funkce a pak definujeme kód potřebný k volání skriptu Pythonu. Funkce přijme všechny zadané parametry a předá je do skriptu Pythonu. Skript se spustí a vrátí token ve formátu řetězce.

#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;
    }
    }
}

Skript Pythonu

Tento skript získává ověřovací tokeny přímo prostřednictvím knihovny MSAL (Microsoft Authentication Library) pro Python. Tento kód je zahrnutý pouze jako prostředek k získání ověřovacích tokenů pro použití ukázkovými aplikacemi a není určený pro použití v produkčním prostředí. Skript funguje jenom u tenantů, kteří podporují ověřování pomocí prostého starého uživatelského jména a hesla. Tento skript nepodporuje vícefaktorové ověřování ani ověřování na základě certifikátů.

Poznámka:

Před spuštěním této ukázky musíte nainstalovat MSAL pro Python spuštěním jednoho z následujících příkazů:

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:])

Aktualizace AcquireOAuth2Token

Nakonec aktualizujte AcquireOAuth2Token funkci AuthDelegateImpl tak, aby volala přetíženou AcquireToken funkci. Adresy URL prostředků a autorit se získávají čtením challenge.GetResource() a challenge.GetAuthority(). Při OAuth2Challenge přidání modulu se předá delegátu ověřování. Tuto práci provádí sada SDK a nevyžaduje žádnou další práci na straně vývojáře.

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 Po přidání sada SDK zavolá funkci AcquireOAuth2Token, která předá výzvu, spustí skript Pythonu, přijme token a pak token předá službě.

Sdílet prostřednictvím