如何配置调用 Web API 的守护程序应用

下面是在 appsettings.json 示例配置文件中定义配置的示例。 此示例摘自 GitHub 上的 .NET 控制台守护程序代码示例。

{
    "AzureAd": {
        "Instance": "https://login.partner.microsoftonline.cn/",
        "TenantId": "[Enter here the tenantID or domain name for your Azure AD tenant]",
        "ClientId": "[Enter here the ClientId for your application]",
        "ClientCredentials": [
            {
                "SourceType": "ClientSecret",
                "ClientSecret": "[Enter here a client secret for your application]"
            }
        ]
    }
}

请提供证书而不是客户端密码或工作负载联合身份验证凭据。

以下示例显示了守护程序应用的Java配置常量：

 private final static String CLIENT_ID = "";
 private final static String AUTHORITY = "https://login.partner.microsoftonline.cn/<tenant>/";
 private final static String CLIENT_SECRET = "";
 private final static Set<String> SCOPE = Collections.singleton("https://microsoftgraph.chinacloudapi.cn/.default");

Node.js 守护程序示例的配置参数位于 .env 文件中：

# Credentials
TENANT_ID=Enter_the_Tenant_Info_Here
CLIENT_ID=Enter_the_Application_Id_Here

// You provide either a ClientSecret or a CertificateConfiguration, or a ClientAssertion. These settings are exclusive
CLIENT_SECRET=Enter_the_Client_Secret_Here
CERTIFICATE_THUMBPRINT=Enter_the_certificate_thumbprint_Here
CERTIFICATE_PRIVATE_KEY=Enter_the_certificate_private_key_Here
CLIENT_ASSERTION=Enter_the_Assertion_String_Here

# Endpoints
// the Azure AD endpoint is the authority endpoint for token issuance
AAD_ENDPOINT=Enter_the_Cloud_Instance_Id_Here // https://login.partner.microsoftonline.cn/
// the graph endpoint is the application ID URI of Microsoft Graph
GRAPH_ENDPOINT=Enter_the_Graph_Endpoint_Here // https://microsoftgraph.chinacloudapi.cn/

当你使用客户端密码创建机密客户端时，Python 守护程序示例中用于客户端密码流的 parameters.json 示例配置文件如下所示：

{
  "authority": "https://login.partner.microsoftonline.cn/<your_tenant_id>",
  "client_id": "your_client_id",
  "scope": [ "https://microsoftgraph.chinacloudapi.cn/.default" ],
  "secret": "The secret generated by Azure AD during your confidential app registration",
  "endpoint": "https://microsoftgraph.chinacloudapi.cn/v1.0/users"
}

使用证书生成机密客户端时，Python守护程序示例中证书流配置文件parameters.json 示例如下所示：

{
  "authority": "https://login.partner.microsoftonline.cn/<your_tenant_id>",
  "client_id": "your_client_id",
  "scope": [ "https://microsoftgraph.chinacloudapi.cn/.default" ],
  "thumbprint": "790E... The thumbprint generated by Azure AD when you upload your public cert",
  "private_key_file": "server.pem",
  "endpoint": "https://microsoftgraph.chinacloudapi.cn/v1.0/users"
}

下面是在 appsettings.json 守护程序控制台配置文件中定义配置的示例。 此示例摘自 GitHub 上的 .NET 控制台守护程序代码示例。

{
  "Instance": "https://login.partner.microsoftonline.cn/{0}",
  "Tenant": "[Enter here the tenantID or domain name for your Azure AD tenant]",
  "ClientId": "[Enter here the ClientId for your application]",
  "ClientSecret": "[Enter here a client secret for your application]",
  "CertificateName": "[Or instead of client secret: Enter here the name of a certificate (from the user cert store) as registered with your application]"
}

请提供 ClientSecret 或 CertificateName。 这些设置是互斥的。

向应用程序添加 Microsoft.Identity.Web.TokenAcquisition NuGet 包。 或者，如果要调用 Microsoft Graph，请添加 Microsoft.Identity.Web.GraphServiceClient 包。 你的项目可能如下所示。 需要将 appsettings.json 文件复制到输出目录。

<Project Sdk="Microsoft.NET.Sdk">

  <PropertyGroup>
    <OutputType>Exe</OutputType>
    <TargetFramework>net7.0</TargetFramework>
    <RootNamespace>daemon_console</RootNamespace>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="Microsoft.Identity.Web.GraphServiceClient" Version="2.12.2" />
  </ItemGroup>

  <ItemGroup>
    <None Update="appsettings.json">
      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
    </None>
  </ItemGroup>
</Project>

在 Program.cs 文件中，在代码中添加 using 指令以引用 Microsoft.Identity.Web。

using Microsoft.Identity.Abstractions;
using Microsoft.Identity.Web;

import com.microsoft.aad.msal4j.ClientCredentialFactory;
import com.microsoft.aad.msal4j.ClientCredentialParameters;
import com.microsoft.aad.msal4j.ConfidentialClientApplication;
import com.microsoft.aad.msal4j.IAuthenticationResult;
import com.microsoft.aad.msal4j.IClientCredential;
import com.microsoft.aad.msal4j.MsalException;
import com.microsoft.aad.msal4j.SilentParameters;

在 package.json 文件所在的文件夹中运行 npm install 以安装这些包。 然后，导入 msal-node 包：

const msal = require('@azure/msal-node');

在Python应用程序中导入所需的 MSAL 和帮助程序模块：

import msal
import json
import sys
import logging

将 Microsoft.Identity.Client NuGet 包添加到应用程序，然后在代码中添加一个 using 指令以引用它。

在 MSAL.NET 中，机密客户端应用程序通过 IConfidentialClientApplication 接口表示。

using Microsoft.Identity.Client;
IConfidentialClientApplication app;

以下示例演示如何使用 Microsoft.Identity.Web 和客户端机密创建机密客户端应用程序：

   class Program
    {
        static async Task Main(string[] _)
        {
            // Get the Token acquirer factory instance. By default it reads an appsettings.json
            // file if it exists in the same folder as the app (make sure that the 
            // "Copy to Output Directory" property of the appsettings.json file is "Copy if newer").
            TokenAcquirerFactory tokenAcquirerFactory = TokenAcquirerFactory.GetDefaultInstance();

            // Configure the application options to be read from the configuration
            // and add the services you need (Graph, token cache)
            IServiceCollection services = tokenAcquirerFactory.Services;
            services.AddMicrosoftGraph();
            // By default, you get an in-memory token cache.
            // For more token cache serialization options, see https://aka.ms/msal-net-token-cache-serialization

            // Resolve the dependency injection.
            var serviceProvider = tokenAcquirerFactory.Build();

            // ...
        }
    }

配置从 appsettings.json 中读取：

使用以下Java代码创建具有客户端机密的客户端应用程序：

IClientCredential credential = ClientCredentialFactory.createFromSecret(CLIENT_SECRET);

ConfidentialClientApplication cca =
        ConfidentialClientApplication
                .builder(CLIENT_ID, credential)
                .authority(AUTHORITY)
                .build();

使用以下 Node.js 配置，使用客户端密码实例化机密客户端应用程序：

const msalConfig = {
  auth: {
    clientId: process.env.CLIENT_ID,
    authority: process.env.AAD_ENDPOINT + process.env.TENANT_ID,
    clientSecret: process.env.CLIENT_SECRET,
  }
};

const apiConfig = {
  uri: process.env.GRAPH_ENDPOINT + 'v1.0/users',
};

const tokenRequest = {
  scopes: [process.env.GRAPH_ENDPOINT + '.default'],
};

const cca = new msal.ConfidentialClientApplication(msalConfig);

# Pass the parameters.json file as an argument to this Python script. E.g.: python your_py_file.py parameters.json
config = json.load(open(sys.argv[1]))

# Create a preferably long-lived app instance that maintains a token cache.
app = msal.ConfidentialClientApplication(
    config["client_id"], authority=config["authority"],
    client_credential=config["secret"],
    # 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
    )

以下 MSAL.NET 示例使用配置的客户端密码创建机密客户端应用程序：

app = ConfidentialClientApplicationBuilder.Create(config.ClientId)
           .WithClientSecret(config.ClientSecret)
           .WithAuthority(new Uri(config.Authority))
           .Build();

Authority 是云实例和租户 ID 的串联，例如 https://login.partner.microsoftonline.cn/contoso.partner.onmschina.cn 或 https://login.partner.microsoftonline.cn/aaaabbbb-0000-cccc-1111-dddd2222eeee。 在配置文件部分中显示的 appsettings.json 文件中，实例和租户分别由 和 Instance 值表示。

在上一片段源自的代码示例中，Authority 是 AuthenticationConfig 类上的一个属性，其定义如下：

/// <summary>
/// URL of the authority
/// </summary>
public string Authority
{
    get
    {
        return String.Format(CultureInfo.InvariantCulture, Instance, Tenant);
    }
}

应用程序构造代码与客户端机密示例相同。 唯一的区别在于，证书是在配置中描述的，而不是机密。 获取证书有多种方式。 有关详细信息，请参阅在 Microsoft Identity Web 中使用证书。 以下配置示例演示如何从Azure 密钥保管库检索证书。 Microsoft 标识库使用 Azure Identity 的 DefaultAzureCredential，并在可用时使用托管标识来访问 Key Vault 中的证书。 你可以在本地调试应用程序，因为此时 DefaultAzureCredential 会使用你的开发人员凭据。

  "ClientCredentials": [
      {
        "SourceType": "KeyVault",
        "KeyVaultUrl": "https://yourKeyVaultUrl.vault.azure.cn",
        "KeyVaultCertificateName": "NameOfYourCertificate"
      }

在 MSAL Java 中，可以通过两个生成器使用证书来实例化机密客户端应用程序：

InputStream pkcs12Certificate = ... ; /* Containing PCKS12-formatted certificate*/
string certificatePassword = ... ;    /* Contains the password to access the certificate */

IClientCredential credential = ClientCredentialFactory.createFromCertificate(pkcs12Certificate, certificatePassword);

ConfidentialClientApplication cca =
        ConfidentialClientApplication
                .builder(CLIENT_ID, credential)
                .authority(AUTHORITY)
                .build();

或

PrivateKey key = getPrivateKey(); /* RSA private key to sign the assertion */
X509Certificate publicCertificate = getPublicCertificate(); /* x509 public certificate used as a thumbprint */

IClientCredential credential = ClientCredentialFactory.createFromCertificate(key, publicCertificate);

ConfidentialClientApplication cca =
        ConfidentialClientApplication
                .builder(CLIENT_ID, credential)
                .authority(AUTHORITY)
                .build();

以下 Node.js 示例将机密客户端应用程序配置为使用证书：

const config = {
    auth: {
        clientId: process.env.CLIENT_ID,
        authority: process.env.AAD_ENDPOINT + process.env.TENANT_ID,
        clientCertificate: {
            thumbprint:  process.env.CERTIFICATE_THUMBPRINT, // a 40-digit hexadecimal string
            privateKey:  process.env.CERTIFICATE_PRIVATE_KEY,
        }
    }
};

// Create an MSAL application object
const cca = new msal.ConfidentialClientApplication(config);

有关详细信息，请参阅在 MSAL Node 中使用证书凭据。

# Pass the parameters.json file as an argument to this Python script. E.g.: python your_py_file.py parameters.json
config = json.load(open(sys.argv[1]))

# Create a preferably long-lived app instance that maintains a token cache.
app = msal.ConfidentialClientApplication(
    config["client_id"], authority=config["authority"],
    client_credential={"thumbprint": config["thumbprint"], "private_key": open(config['private_key_file']).read()},
    # 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
    )

使用以下 MSAL.NET 代码加载证书并生成机密客户端应用程序：

X509Certificate2 certificate = ReadCertificate(config.CertificateName);
app = ConfidentialClientApplicationBuilder.Create(config.ClientId)
    .WithCertificate(certificate)
    .WithAuthority(new Uri(config.Authority))
    .Build();

除了使用客户端密码或证书，机密客户端应用程序还可以使用客户端断言来证明其身份。 请参阅 CredentialDescription 了解详细信息。

以下Java示例使用客户端断言创建机密客户端应用程序：

IClientCredential credential = ClientCredentialFactory.createFromClientAssertion(assertion);

ConfidentialClientApplication cca =
        ConfidentialClientApplication
                .builder(CLIENT_ID, credential)
                .authority(AUTHORITY)
                .build();

使用以下 Node.js 配置通过客户端断言初始化机密客户端应用程序：

const clientConfig = {
    auth: {
        clientId: process.env.CLIENT_ID,
        authority: process.env.AAD_ENDPOINT + process.env.TENANT_ID,
        clientAssertion:  process.env.CLIENT_ASSERTION
    }
};
const cca = new msal.ConfidentialClientApplication(clientConfig);

有关详细信息，请参阅初始化 ConfidentialClientApplication 对象。

在 MSAL Python 中，可以使用将要由此 ConfidentialClientApplication 的私钥签名的声明来提供客户端声明。

# Pass the parameters.json file as an argument to this Python script. E.g.: python your_py_file.py parameters.json
config = json.load(open(sys.argv[1]))

# Create a preferably long-lived app instance that maintains a token cache.
app = msal.ConfidentialClientApplication(
    config["client_id"], authority=config["authority"],
    client_credential={"thumbprint": config["thumbprint"], "private_key": open(config['private_key_file']).read()},
    client_claims = {"client_ip": "x.x.x.x"}
    # 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
    )

如需详细信息，请参阅 MSAL Python 的 ConfidentialClientApplication 参考文档。

机密客户端应用程序还可以使用客户端断言（而不是客户端密码或证书）来证明其身份。

MSAL.NET 可以通过两种方法将签名的断言提供给机密客户端应用：

• .WithClientAssertion()
• .WithClientClaims()

使用 WithClientAssertion 时，请提供签名的 JWT。 客户端断言详细介绍了这一高级方案。

string signedClientAssertion = ComputeAssertion();
app = ConfidentialClientApplicationBuilder.Create(config.ClientId)
                                          .WithClientAssertion(signedClientAssertion)
                                          .Build();

使用 WithClientClaims 时，MSAL.NET 会生成一个已签名断言，其中包含 Microsoft Entra ID 预期的声明，以及你想要发送的其他客户端声明。 此代码展示了如何执行该操作：

string ipAddress = "192.168.1.2";
var claims = new Dictionary<string, string> { { "client_ip", ipAddress } };
X509Certificate2 certificate = ReadCertificate(config.CertificateName);
app = ConfidentialClientApplicationBuilder.Create(config.ClientId)
                                          .WithAuthority(new Uri(config.Authority))
                                          .WithClientClaims(certificate, claims)
                                          .Build();

有关详细信息，请参阅 客户端断言。

转到此方案中的下一篇文章：获取应用的令牌。

转到此方案中的下一篇文章：获取应用的令牌。

转到此方案中的下一篇文章：获取应用的令牌。

转到此方案中的下一篇文章：获取应用的令牌。

转到此方案中的下一篇文章：获取应用的令牌。