首页
/ 微软认证库(MSAL)for iOS 和 macOS 使用指南

微软认证库(MSAL)for iOS 和 macOS 使用指南

2024-09-27 23:47:21作者:郜逊炳

项目目录结构及介绍

微软认证库(MSAL)的GitHub仓库提供了全面的开发资源,其主要目录结构布局如下:

  • [MSAL.xcworkspace]: Xcode的工作区文件,用于打开并管理整个项目和相关的依赖。
  • [Samples]: 包含示例代码,分为iOS和macOS两个部分,展示了如何在实际应用中集成MSAL。
  • [azure_pipelines]: 持续集成(CI)的配置文件,用于自动化测试和构建流程。
  • [docs]: 文档目录,包括SDK的使用说明和技术文档。
  • [gitignore]: 忽略特定文件或目录的Git配置。
  • [LICENSE]: 许可证文件,表明该库遵循MIT协议。
  • [MSAL.podspec]: CocoaPods的规格文件,用于定义MSAL库的版本信息和依赖关系。
  • [PULL_REQUEST_TEMPLATE.md]: 提交拉取请求时的模板,规范贡献者的行为。
  • [README.md]: 项目的概述性文档,是开发者首次访问项目时的重要入口点。
  • [ReleaseArchive.sh]: 脚本文件,可能用于自动化版本发布过程。
  • [swiftPackage.swift]: 如果存在,将是Swift包管理器的描述文件。

此外,还有一些脚本文件(*.sh), 用于特定的自动化任务,以及Python脚本(*.py)和JSON配置文件(*.json),这些通常是辅助工具或配置相关。

启动文件介绍

虽然MSAL作为一个库,并没有一个传统的“启动文件”,但当你在自己的应用中集成MSAL时,关键的起点通常是在你的应用delegate或初始化逻辑中设置公共客户端应用程序(MSALPublicClientApplication)。以下是一个简化的Swift示例,展示如何开始配置和获取认证令牌:

let config = MSALPublicClientApplicationConfig(clientId: "你的客户端ID")
if let application = try? MSALPublicClientApplication(configuration: config) {
    // 接下来的步骤涉及设置范围和发起身份验证请求
}
else {
    print("无法创建MSAL应用实例。")
}

项目的配置文件介绍

MSALPublicClientApplicationConfig

MSAL的配置主要是通过MSALPublicClientApplicationConfig类来设定的,它不是作为一个单独的配置文件存在,而是在代码中创建的实例。这个配置包含了诸如客户端ID、缓存策略、账户模式等基本信息。例如:

let config = MSALPublicClientApplicationConfig(clientId: "<你的客户端ID>",
                                                redirectUri: "你的重定向URI",
                                                authority: "https://login.microsoftonline.com/common")

除了主应用配置外,对于环境变量或者外部配置的管理,开发者通常会在自己的应用里维护相应的配置文件(如.env或自定义plist文件),但这些不在MSAL库本身提供,而是应用开发者需要自行组织的部分。

注意事项

在进行项目配置时,重要的是要在Microsoft Entra ID(之前称为Azure Active Directory)注册你的应用,并正确设置所需的权限和重定向URI。这一步骤不在MSAL的仓库直接体现,但它是成功集成MSAL到你的应用的前提条件之一。

通过以上内容,您可以开始理解和集成MSAL到您的iOS或macOS应用中,确保用户能够安全地登录并访问受保护的API。

登录后查看全文
热门项目推荐