Adquirir um token de acesso (Python)

Este exemplo demonstra como chamar um script Python externo para obter um token OAuth 2.0. A implementação do delegado de autenticação requer um token de acesso OAuth 2.0 válido.

Pré-requisitos

Para executar o exemplo:

• Instala Python 3.10 ou mais recente.
• Implementa utils.h/cpp no teu projeto.
• Adicione auth.py ao seu projeto, no mesmo diretório que os binários, aquando da compilação.
• Configuração completa do SDK Microsoft Information Protection (MIP). Entre outras tarefas, regista a sua aplicação cliente no seu tenant Microsoft Entra. O Microsoft Entra ID fornece um ID de aplicação, também conhecido como ID do cliente, para a lógica de aquisição de tokens.

Este código não é destinado a uso em produção. Usa-o apenas para desenvolvimento e para compreender conceitos de autenticação. A amostra é multiplataforma.

sample::auth::AcquireToken()

O exemplo simples de autenticação demonstra uma função simples AcquireToken() que não aceita parâmetros e devolve um valor de token codificado fixamente. Este exemplo sobrecarrega AcquireToken() para aceitar parâmetros de autenticação e chamar um script Python externo para devolver o token.

auth.h

No ficheiro auth.h, AcquireToken() está sobrecarregado. A função sobrecarregada e os parâmetros atualizados são os seguintes:

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

A entrada do utilizador ou a sua aplicação fornece os três primeiros parâmetros. O SDK fornece os dois últimos parâmetros ao delegado de autenticação.

auth.cpp

O ficheiro auth.cpp adiciona a definição da função sobrecarregada e depois define o código que chama o script Python. A função aceita todos os parâmetros fornecidos e passa-os para o script Python. O script executa-se e devolve o token em formato de string.

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

Script em Python

Este script adquire tokens de autenticação diretamente utilizando a Biblioteca de Autenticação da Microsoft (MSAL) para Python. Este código está incluído apenas para adquirir tokens de autenticação para uso pelas aplicações de exemplo e não é destinado a ser usado em produção. O script funciona apenas contra inquilinos que suportam autenticação por nome de utilizador/palavra-passe. O script não suporta autenticação multifator (MFA) nem autenticação baseada em certificados.

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

Atualização de AcquireOAuth2Token

Finalmente, atualize a função AcquireOAuth2Token em AuthDelegateImpl para chamar a função sobrecarregada AcquireToken. Leia challenge.GetResource() e challenge.GetAuthority() para obter os URLs do recurso e da autoridade. O SDK passa o OAuth2Challenge ao delegado de autenticação ao adicionar o motor. Este comportamento do SDK não requer trabalho extra por parte do programador.

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

Quando o SDK adiciona o engine, chama a AcquireOAuth2Token função. A função passa o desafio, executa o script Python, recebe um token e apresenta o token ao serviço.