Классическое приложение, которое вызывает веб-API. Настройка кода

Вы создали приложение, и теперь узнаете, как настроить код с помощью координат приложения.

Библиотеки Майкрософт, поддерживающие классические приложения

Перечисленные ниже библиотеки Майкрософт поддерживают классические приложения.

Язык или платформа	Проект на сайте GitHub	Пакет	Получение из этих вариантов	Выполнение входа пользователей	Доступ к веб-API	Общедоступная версия (GA) или Общедоступная предварительная версия1
Electron	MSAL Node.js	msal-node	—			Общедоступная предварительная версия
Java	MSAL4J	msal4j	—			Общедоступная версия
macOS (Swift/Obj-C)	MSAL для iOS и macOS	MSAL	Руководство			Общедоступная версия
UWP	MSAL для .NET	Microsoft.Identity.Client	Руководство			Общедоступная версия
WPF	MSAL для .NET	Microsoft.Identity.Client	Руководство			Общедоступная версия

¹ Универсальные условия лицензионного соглашения для веб-служб применяются к библиотекам в общедоступной предварительной версии.

Общедоступное клиентское приложение

С точки зрения кода, классические приложения являются общедоступными клиентскими приложениями. Их конфигурация будет немного отличаться в зависимости от того, используется ли интерактивная проверка подлинности.

.NET

Нужно будет создать и управлять MSAL.NET IPublicClientApplication.

Исключительно по коду

С помощью следующего кода создается экземпляр общедоступного клиентского приложения и обеспечивается вход пользователей в общедоступное облако Microsoft Azure с рабочей или учебной учетной записью либо с личной учетной записью Майкрософт.

IPublicClientApplication app = PublicClientApplicationBuilder.Create(clientId)
    .Build();

Если вы планируете использовать интерактивную проверку подлинности или поток кода устройства, как показано ранее, используйте модификатор .WithRedirectUri.

IPublicClientApplication app;
app = PublicClientApplicationBuilder.Create(clientId)
        .WithDefaultRedirectUri()
        .Build();

Использование файлов конфигурации

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

PublicClientApplicationOptions options = GetOptions(); // your own method
IPublicClientApplication app = PublicClientApplicationBuilder.CreateWithApplicationOptions(options)
        .WithDefaultRedirectUri()
        .Build();

Более сложная конфигурация

Вы можете доработать процесс построения приложений, добавив несколько модификаторов. Так, если вы хотите, чтобы приложение было мультитенантным и развертывалось в национальном облаке, к примеру, в облаке правительства США, можно написать следующее:

IPublicClientApplication app;
app = PublicClientApplicationBuilder.Create(clientId)
        .WithDefaultRedirectUri()
        .WithAadAuthority(AzureCloudInstance.AzureUsGovernment,
                         AadAuthorityAudience.AzureAdMultipleOrgs)
        .Build();

MSAL.NET также содержит модификатор для службы федерации Active Directory (AD FS) 2019:

IPublicClientApplication app;
app = PublicClientApplicationBuilder.Create(clientId)
        .WithAdfsAuthority("https://consoso.com/adfs")
        .Build();

Наконец, если вы хотите получить маркеры для клиента B2C в Azure Active Directory (Azure AD), укажите клиент, как показано в следующем фрагменте кода:

IPublicClientApplication app;
app = PublicClientApplicationBuilder.Create(clientId)
        .WithB2CAuthority("https://fabrikamb2c.b2clogin.com/tfp/{tenant}/{PolicySignInSignUp}")
        .Build();

Подробнее

Дополнительные сведения о настройке классического приложения MSAL.NET:

• Список всех модификаторов, доступных в PublicClientApplicationBuilder, см. в справочной документации по PublicClientApplicationBuilder.
• Описание всех параметров, предоставленных в PublicClientApplicationOptions, см. в справочной документации по PublicClientApplicationBuilder.

Готовый пример с параметрами конфигурации

Представьте консольное приложение .NET с следующим appsettings.json файлом конфигурации:

{
  "Authentication": {
    "AzureCloudInstance": "AzurePublic",
    "AadAuthorityAudience": "AzureAdMultipleOrgs",
    "ClientId": "00001111-aaaa-2222-bbbb-3333cccc4444"
  },

  "WebAPI": {
    "MicrosoftGraphBaseEndpoint": "https://graph.microsoft.com"
  }
}

В этом файле не так много кода для чтения с помощью платформы конфигурации на базе .NET:

public class SampleConfiguration
{
 /// <summary>
 /// Authentication options
 /// </summary>
 public PublicClientApplicationOptions PublicClientApplicationOptions { get; set; }

 /// <summary>
 /// Base URL for Microsoft Graph (it varies depending on whether the application runs
 /// in Microsoft Azure public clouds or national or sovereign clouds)
 /// </summary>
 public string MicrosoftGraphBaseEndpoint { get; set; }

 /// <summary>
 /// Reads the configuration from a JSON file
 /// </summary>
 /// <param name="path">Path to the configuration json file</param>
 /// <returns>SampleConfiguration as read from the json file</returns>
 public static SampleConfiguration ReadFromJsonFile(string path)
 {
  // .NET configuration
  IConfigurationRoot Configuration;
  var builder = new ConfigurationBuilder()
                    .SetBasePath(Directory.GetCurrentDirectory())
                    .AddJsonFile(path);
  Configuration = builder.Build();

  // Read the auth and graph endpoint configuration
  SampleConfiguration config = new SampleConfiguration()
  {
   PublicClientApplicationOptions = new PublicClientApplicationOptions()
  };
  Configuration.Bind("Authentication", config.PublicClientApplicationOptions);
  config.MicrosoftGraphBaseEndpoint =
  Configuration.GetValue<string>("WebAPI:MicrosoftGraphBaseEndpoint");
  return config;
 }
}

Чтобы создать приложение, напишите следующий код:

SampleConfiguration config = SampleConfiguration.ReadFromJsonFile("appsettings.json");
var app = PublicClientApplicationBuilder.CreateWithApplicationOptions(config.PublicClientApplicationOptions)
           .WithDefaultRedirectUri()
           .Build();

Прежде чем вызывать метод .Build() можно переопределить конфигурацию с помощью вызовов методов .WithXXX, как показано выше.

Java

Ниже показан класс, используемый в примерах разработки на Java MSAL для настройки примеров: TestData.

PublicClientApplication pca = PublicClientApplication.builder(CLIENT_ID)
        .authority(AUTHORITY)
        .build();

MacOS

С помощью следующего кода создается экземпляр общедоступного клиентского приложения и обеспечивается вход пользователей в общедоступное облако Microsoft Azure с рабочей или учебной учетной записью либо с личной учетной записью Майкрософт.

Быстрая настройка

Objective-C.

NSError *msalError = nil;

MSALPublicClientApplicationConfig *config = [[MSALPublicClientApplicationConfig alloc] initWithClientId:@"<your-client-id-here>"];
MSALPublicClientApplication *application = [[MSALPublicClientApplication alloc] initWithConfiguration:config error:&msalError];

Swift:

let config = MSALPublicClientApplicationConfig(clientId: "<your-client-id-here>")
if let application = try? MSALPublicClientApplication(configuration: config){ /* Use application */}

Более сложная конфигурация

Вы можете доработать процесс построения приложений, добавив несколько модификаторов. Так, если вы хотите, чтобы приложение было мультитенантным и развертывалось в национальном облаке, к примеру, в облаке правительства США, можно написать следующее:

Objective-C.

MSALAADAuthority *aadAuthority =
                [[MSALAADAuthority alloc] initWithCloudInstance:MSALAzureUsGovernmentCloudInstance
                                                   audienceType:MSALAzureADMultipleOrgsAudience
                                                      rawTenant:nil
                                                          error:nil];

MSALPublicClientApplicationConfig *config =
                [[MSALPublicClientApplicationConfig alloc] initWithClientId:@"<your-client-id-here>"
                                                                redirectUri:@"<your-redirect-uri-here>"
                                                                  authority:aadAuthority];

NSError *applicationError = nil;
MSALPublicClientApplication *application =
                [[MSALPublicClientApplication alloc] initWithConfiguration:config error:&applicationError];

Swift:

let authority = try? MSALAADAuthority(cloudInstance: .usGovernmentCloudInstance, audienceType: .azureADMultipleOrgsAudience, rawTenant: nil)

let config = MSALPublicClientApplicationConfig(clientId: "<your-client-id-here>", redirectUri: "<your-redirect-uri-here>", authority: authority)
if let application = try? MSALPublicClientApplication(configuration: config) { /* Use application */}

Node.js

Параметры конфигурации можно загрузить из разных источников, например, из файла JavaScript или переменных среды. Ниже используется файл authConfig.js.

/*
 * Copyright (c) Microsoft Corporation. All rights reserved.
 * Licensed under the MIT License.
 */

const { LogLevel } = require("@azure/msal-node");

/**
 * Configuration object to be passed to MSAL instance on creation.
 * For a full list of MSAL.js configuration parameters, visit:
 * https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-node/docs/configuration.md
 */
const AAD_ENDPOINT_HOST = "Enter_the_Cloud_Instance_Id_Here"; // include the trailing slash

const msalConfig = {
    auth: {
        clientId: "Enter_the_Application_Id_Here",
        authority: `${AAD_ENDPOINT_HOST}Enter_the_Tenant_Info_Here`,
    },
    system: {
        loggerOptions: {
            loggerCallback(loglevel, message, containsPii) {
                console.log(message);
            },
            piiLoggingEnabled: false,
            logLevel: LogLevel.Verbose,
        },
    },
};

/**
 * Add here the endpoints and scopes when obtaining an access token for protected web APIs. For more information, see:
 * https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-browser/docs/resources-and-scopes.md
 */
const GRAPH_ENDPOINT_HOST = "Enter_the_Graph_Endpoint_Here"; // include the trailing slash

const protectedResources = {
    graphMe: {
        endpoint: `${GRAPH_ENDPOINT_HOST}v1.0/me`,
        scopes: ["User.Read"],
    }
};


module.exports = {
    msalConfig: msalConfig,
    protectedResources: protectedResources,
};

Импортируйте объект конфигурации из файла authConfig.js. Узел MSAL можно инициализировать минимальным образом, как показано ниже. См. доступные параметры конфигурации.

const { PublicClientApplication } = require('@azure/msal-node');
const { msalConfig } = require('./authConfig')

/**
* Initialize a public client application. For more information, visit:
* https://github.com/AzureAD/microsoft-authentication-library-for-js/blob/dev/lib/msal-node/docs/initialize-public-client-application.md
*/
clientApplication = new PublicClientApplication(msalConfig);

Python

config = json.load(open(sys.argv[1]))

app = msal.PublicClientApplication(
    config["client_id"], authority=config["authority"],
    # token_cache=...  # Default cache is in memory only.
                       # You can learn how to use SerializableTokenCache from
                       # https://msal-python.rtfd.io/en/latest/#msal.SerializableTokenCache
    )

Следующие шаги

Перейдите к следующей статье в этом сценарии, чтобы получить маркер для классического приложения.