展开菜单
首页 精品内容 本月促销 装机必备 Windows PDF教程 macOS软件 IOS软件 Android AI 专题
全部分类

当前位置:

首页 > 编程开发 > .NET中使用AssemblyKeyFileAttribute指定密钥文件的方式是通过在程序集的属性中添加该特性,并传入密钥文件的路径。以下是详细步骤和示例:1

.NET中使用AssemblyKeyFileAttribute指定密钥文件的方式是通过在程序集的属性中添加该特性,并传入密钥文件的路径。以下是详细步骤和示例:1

强名称签名通过唯一标识、防篡改、支持GAC和并行执行保障程序集安全与兼容,使用AssemblyKeyFileAttribute时需注意路径、权限及CI/CD适配,推荐在csproj中配置并结合延迟签名提升安全性。

本文目录

    强名称签名通过唯一标识、防篡改、支持GAC和并行执行保障程序集安全与兼容,使用AssemblyKeyFileAttribute时需注意路径、权限及CI/CD适配,推荐在csproj中配置并结合延迟签名提升安全性。

    .NET的AssemblyKeyFileAttribute类如何指定密钥文件?

    .NET的AssemblyKeyFileAttribute类通过在程序集元数据中嵌入密钥文件的路径,为程序集提供了强名称签名。这通常是在项目的AssemblyInfo.cs或AssemblyAttributes.cs`文件中通过一个特性(Attribute)来指定的。简单来说,它告诉编译器去哪里找到那个用于签名的私钥文件。

    解决方案

    要使用AssemblyKeyFileAttribute指定密钥文件,核心步骤是:

    1. 生成强名称密钥对: 如果你还没有,需要使用.NET SDK自带的sn.exe工具来生成一个强名称密钥对文件(.snk文件)。在命令行中运行:

      sn.exe -k MyKey.snk

      这会在当前目录下生成一个名为MyKey.snk的文件。

    2. 在项目代码中引用: 打开你的项目中的AssemblyInfo.cs(对于较新的SDK风格项目,可能是在csproj文件中通过或直接在代码中通过AssemblyKeyFileAttribute)。找到或添加以下一行代码:

      using System.Reflection;
      // ... 其他Assembly属性
      
      [assembly: AssemblyKeyFile("MyKey.snk")]
      // 如果你的.snk文件不在项目根目录,需要提供相对路径
      // [assembly: AssemblyKeyFile("Keys\\MyKey.snk")]

      这个路径可以是相对于项目文件(.csproj)的相对路径,也可以是绝对路径。我个人更推荐使用相对路径,这样项目在不同开发环境或构建服务器上移动时,路径问题会少很多。

    3. 确保密钥文件可访问: 密钥文件(.snk)需要放置在编译器能够找到的位置。通常,我会把它放在项目根目录,或者创建一个专门的Keys文件夹来存放。在Visual Studio中,你可能需要确保这个文件被包含在项目中,但它的“生成操作”(Build Action)通常设置为“无”(None),因为编译器只是需要读取它,而不是将其编译到程序集内部。

    当项目构建时,.NET编译器会读取这个MyKey.snk文件,并使用其中的私钥来为生成的程序集进行数字签名。这样,你的程序集就拥有了强名称。

    强名称签名在.NET程序集中的核心价值体现在哪里?

    我个人觉得,强名称签名这东西,在现代.NET开发里,虽然不像以前那么被强制要求,但它的基础价值是没变的,甚至在某些场景下依然是不可或缺的。

    首先,它提供了一个全局唯一的身份标识。两个同名但来自不同源的程序集,如果它们都经过了强名称签名,它们的强名称是唯一的,这就能有效避免命名冲突。这对于大型系统或者共享组件来说,至关重要。你总不希望你的MyComponent.dll和别人家的MyComponent.dll混淆吧?

    其次,强名称签名能够确保程序集的完整性和防篡改。签名过程实际上是生成了一个哈希值,并用私钥加密。当程序集被加载时,运行时会验证这个签名。如果程序集在签名后被修改过,签名验证就会失败,运行时会拒绝加载它。这就像给你的代码盖了个章,证明“这是我发的,没被动过手脚”。这在安全敏感的应用中尤其重要。

    再来,它使得程序集可以被安装到全局程序集缓存(GAC)中。如果你有一些需要在多应用之间共享的组件,或者系统级别的库,GAC是个不错的选择。而要进入GAC,强名称签名是硬性要求。

    还有一点,虽然现在用得少了,但以前的代码访问安全性(Code Access Security, CAS)机制,就是基于强名称来判断程序集的信任级别的。现在虽然有了新的安全模型,但强名称背后那种“可信来源”的思想,依然渗透在很多地方。

    最后,强名称签名还支持并行执行(Side-by-Side Execution)。这意味着你可以在同一台机器上,同时安装和运行同一个程序集的不同版本,只要它们有不同的强名称。这对于解决DLL Hell问题,或者在复杂的部署环境中,提供了很大的灵活性。

    最头疼的,可能就是你自己的程序集强签名了,结果引用的第三方库没签,那可就麻烦了。强签名的程序集只能引用强签名的程序集,这是一个很强的约束。

    指定AssemblyKeyFileAttribute时,有哪些常见的“坑”和注意事项?

    说实话,我遇到过不少同事,或者我自己也踩过坑,就是这个AssemblyKeyFileAttribute的路径问题和一些相关细节。

    1. 相对路径与绝对路径的陷阱:

      • 相对路径: 编译器会相对于项目文件(.csproj)来解析这个路径。这通常是最佳实践,因为它使得项目在不同机器上移动时,路径依然有效。但如果你不小心把.snk文件放到了一个奇怪的地方,或者项目结构发生了变化,就可能导致编译失败。
      • 绝对路径: 虽然可以指定绝对路径,但强烈不推荐。你的同事、构建服务器或者其他环境,很可能没有相同的路径结构,这会直接导致编译错误。我见过有人把C:\Keys\MyKey.snk写进去,然后代码一提交,别人就没法编译了。
    2. 密钥文件的存在与访问权限:

      • 文件不存在: 这是最常见的错误,编译器找不到MyKey.snk文件。检查路径是否正确,文件是否真的在那里。
      • 权限问题: 在某些严格的构建环境中,构建用户可能没有读取.snk文件的权限。尤其是在CI/CD环境里,本地好好的,一到Jenkins或者Azure DevOps上就报错,那多半是密钥文件路径或者权限的问题。确保构建代理有权访问该文件。
    3. 版本控制中的.snk文件: 关于密钥文件要不要进版本控制,这事儿也挺有争议的。

      • 如果包含私钥: 理论上,包含私钥的.snk文件不应该直接提交到公共版本控制系统,因为它涉及到私钥安全。但对于内部项目,为了方便团队协作和CI/CD,通常会将其提交。在这种情况下,要确保你的版本控制系统是安全的,并且只有授权人员才能访问。
      • 如果只包含公钥(延迟签名): 如果你使用的是延迟签名(AssemblyDelaySignAttribute),那么.snk文件只包含公钥,可以安全地提交到版本控制。
    4. 构建服务器/CI/CD环境的适配: 这是个大头。本地开发环境可能一切顺利,但到了自动化构建流程中,各种问题就来了。确保:

      • .snk文件已经存在于构建服务器的正确路径。
      • 构建代理(Agent)有足够的权限读取该文件。
      • 如果使用了延迟签名,最终的完全签名步骤需要在受控且安全的环境中执行。
    5. 与SDK风格项目(.csproj)的交互: 对于新的SDK风格项目,你可能不再需要显式地在AssemblyInfo.cs中写AssemblyKeyFileAttribute。相反,可以在.csproj文件中通过SignAssembly和AssemblyOriginatorKeyFile MSBuild属性来配置:

      
        true
        MyKey.snk
      

      这种方式更简洁,也更符合现代.NET的配置习惯。我个人更倾向于这种方式。

    除了直接指定文件,.NET中还有哪些处理强名称签名的替代或辅助方式?

    其实除了直接在代码里写AssemblyKeyFileAttribute,我们还有不少更灵活或者说更工程化的办法来处理强名称签名,尤其是在自动化构建和团队协作场景下。

    1. 通过Visual Studio项目属性页: 这是最直观的方式。在Visual Studio中,右键点击项目 -> 属性 -> 签名(Signing)选项卡。在这里你可以勾选“为程序集签名”,然后选择一个现有的强名称密钥文件,或者新建一个。Visual Studio会在幕后帮你处理好AssemblyKeyFileAttribute或者相应的MSBuild属性。对于不熟悉代码配置的开发者来说,这是个很友好的入口。

    2. 通过MSBuild属性在.csproj文件中配置: 正如我前面提到的,对于SDK风格的项目,这是我个人更倾向的方式。你可以在.csproj文件中直接设置SignAssembly为true,并通过AssemblyOriginatorKeyFile指定密钥文件路径。这种方式的优点是配置集中、版本控制友好,并且方便CI/CD脚本进行自动化处理。

      
        true
        $(MSBuildProjectDirectory)\Keys\MyKey.snk
      

      这里我用了$(MSBuildProjectDirectory)这个MSBuild内置变量,它代表当前项目文件的目录,这样路径解析会更清晰可靠。

    3. 延迟签名(Delay Signing)与AssemblyDelaySignAttribute: 延迟签名是一个非常巧妙且实用的机制,尤其是在大型团队协作或开源项目中。它的思路是:在开发阶段,程序集只用公钥进行签名(AssemblyDelaySignAttribute(true)),这样开发者无需访问私钥就能编译和测试。等到发布前,再在一个安全的环境中,用私钥进行完整的签名。

      [assembly: AssemblyDelaySign(true)] // 告诉编译器只用公钥签名
      [assembly: AssemblyKeyFile("MyPublicKey.snk")] // 这里MyPublicKey.snk只包含公钥

      在发布时,你需要用sn.exe工具的-R或-Rc参数对程序集进行重新签名:

      sn.exe -R MyAssembly.dll MyPrivateKey.snk

      延迟签名这东西,我觉得挺巧妙的,尤其是在开源项目或者大型团队协作的时候,能解决不少实际问题,避免私钥泄露的风险。

    4. 使用sn.exe命令行工具进行辅助操作:sn.exe(Strong Name Utility)不仅仅用于生成密钥对,它还可以用于:

      • 查看程序集的公钥或公钥令牌:sn.exe -Tp MyAssembly.dll
      • 验证程序集的强名称:sn.exe -Vf MyAssembly.dll
      • 重新签名延迟签名的程序集:sn.exe -R MyAssembly.dll MyPrivateKey.snk 这个工具是强名称签名的瑞士军刀,对于调试和自动化脚本非常有用。

    需要注意的是,这里讨论的是.NET程序集的强名称签名。别把程序集签名和NuGet包签名混为一谈,虽然都叫签名,但目的是不一样的。NuGet包签名是针对包本身的完整性和来源验证,而程序集签名是针对单个DLL或EXE文件的完整性和唯一性。

    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系bd@zhengruan.com
    作者最新文章
    编程开发
    相关文章 更多
    精品专题 更多
    装机必备

    正软商城装机必备专区,精选办公、浏览器、安全防护、影音播放、压缩解压、设计创作和系统工具等电脑常用正版软件,帮助用户快速完成新电脑软件配置。

    Windows

    正软商城Windows软件专区,汇集适用于Windows电脑的办公、设计、安全防护、影音播放、开发工具和系统优化软件,提供软件介绍、系统要求、正版授权及购买下载服务。

    PDF教程

    正软商城PDF教程频道提供PDF编辑、转换、合并、拆分、压缩及格式处理方法,同时介绍常用PDF软件和工具的使用技巧。

    macOS软件

    正软商城macOS软件专区,精选适用于Mac电脑的办公、设计、影音、效率、开发和系统工具,提供软件功能介绍、macOS兼容版本、正版授权及购买下载服务。

    IOS软件

    正软商城iOS软件专区,精选适用于iPhone和iPad的办公、学习、影音、设计、效率及AI应用,提供功能介绍、适用设备、系统要求和正版获取方式等信息。

    AI

    正软商城AI软件专区,汇集AI写作、AI绘画、AI视频、AI办公、AI编程、AI翻译、智能客服和数据分析等人工智能工具,提供功能介绍、适用平台、收费方式及正版购买信息。

    Mac软件 更多
    Postman macOS版
    Postman macOS版

    Postman是一套面向API全生命周期的开发与测试平台,可在Mac上发送和调试多种协议请求,管理集合、环境及认证信息,并完成脚本测试、模拟服务、监控、文档发布和团队协作。它适合开发、测试及运维人员使用,提供个人免费方案。

    Docker Desktop macOS版
    Docker Desktop macOS版

    Docker Desktop 是 Docker 官方为 Mac 提供的容器开发环境,集成 Docker Engine、命令行工具、Compose、Build、Kubernetes 与图形化管理界面。

    Android Studio macOS版
    Android Studio macOS版

    Android Studio 是 Google 面向安卓应用开发提供的官方集成开发环境,基于 IntelliJ IDEA 构建。它整合智能代码编辑、Gradle 构建、界面预览、设备模拟、性能分析、调试测试及 APK 分析等工具。

    Xcode macOS版
    Xcode macOS版

    Xcode 是苹果面向 Mac 提供的官方集成开发环境,将代码编辑、项目构建、SwiftUI 实时预览、设备模拟、自动化测试、断点调试、性能分析和应用分发整合在同一套工作流中,适合开发与维护 iPhone、iPad、Mac、Apple Wa

    JetBrains WebStorm macOS版
    JetBrains WebStorm macOS版

    JetBrains WebStorm 是面向 JavaScript、TypeScript 和现代 Web 技术的专业集成开发环境,可智能理解项目结构,提供代码补全、重构、错误检查、运行调试、测试及 Git 工具。

    PhpStorm macOS版
    PhpStorm macOS版

    PhpStorm 是 JetBrains 推出的专业 PHP 集成开发环境,可在 Mac 上完成代码编写、智能检查、重构、调试、测试和数据库管理。它支持主流 PHP 框架、Composer、Git、Docker 与远程解释器。

    JetBrains PyCharm macOS版
    JetBrains PyCharm macOS版

    JetBrains PyCharm 是面向 Python 开发者的集成开发环境,提供智能补全、代码检查、重构、调试、测试、版本控制及虚拟环境管理功能。Mac 版兼容 Intel 与 Apple 芯片,核心功能可免费使用。

    JetBrains IntelliJ IDEA macOS版
    JetBrains IntelliJ IDEA macOS版

    IntelliJ IDEA 是 JetBrains 推出的专业集成开发环境,重点服务于 Java、Kotlin 与 JVM 项目开发。软件集成代码补全、静态检查、重构、调试、测试、版本控制及构建工具,并可借助插件扩展语言和框架支持。

    Visual Studio Code macOS版
    Visual Studio Code macOS版

    Visual Studio Code 是微软提供的免费代码编辑器,支持 macOS,并为 Intel 与 Apple 芯片 Mac 提供适配版本。软件集代码编辑、调试、Git 源代码管理、集成终端和扩展市场于一体。

    REAPER macOS版
    REAPER macOS版

    REAPER是Cockos开发的数字音频工作站,提供多轨音频与MIDI录制、剪辑、处理、混音和母带制作工具。Mac版兼容Intel与Apple芯片,支持AU、VST、VST3、CLAP等插件格式,并提供高度可定制的工作流程。

    Adobe Audition macOS版
    Adobe Audition macOS版

    Adobe Audition 是面向播客、影视后期、音乐制作及内容创作者的专业音频工作站,提供波形精修、多轨录制与混音、频谱编辑、降噪修复、响度匹配和效果处理工具,并可与 Adobe Premiere 协同完成视频声音制作。

    Pro Tools macOS版
    Pro Tools macOS版

    Pro Tools 是 Avid 推出的专业数字音频工作站,覆盖多轨录音、无损剪辑、MIDI 编曲、插件处理、自动化混音及声音与画面同步等工作。它拥有 Intro、Artist、Studio 和 Ultimate 等方案。

    WINDOWS 更多
    PixPix 网页版
    PixPix 网页版

    PixPix 是面向品牌、卖家和内容团队的在线 AI 图片视频创作平台,提供图视频 Agent、无限画布、图片生成、视频生成、自然语言编辑及商品套图、产品精修和带货视频等电商工具。

    Postman Windows版
    Postman Windows版

    Postman 是面向 API 全生命周期的开发与协作平台。Windows 桌面版可用于构建和发送 HTTP、GraphQL、gRPC、WebSocket、MQTT 等请求,并提供环境变量、集合、脚本测试、模拟服务、监控、文档及团队工作区等

    Docker Desktop Windows版
    Docker Desktop Windows版

    Docker Desktop 为 Windows 开发者提供集成式容器环境,内置 Docker Engine、命令行工具、Compose、Build 与 Kubernetes 等组件,可在本机完成镜像构建、容器运行、日志查看和资源管理。

    Android Studio Windows版
    Android Studio Windows版

    Android Studio 是 Google 面向 Android 应用开发提供的官方集成开发环境,以 IntelliJ IDEA 为基础,集成智能代码编辑、Gradle 构建、设备模拟、界面预览、调试测试及性能分析工具,

    JetBrains WebStorm Windows版
    JetBrains WebStorm Windows版

    WebStorm 是 JetBrains 面向 JavaScript、TypeScript 和现代 Web 技术打造的集成开发环境。它提供项目级代码分析、智能补全、安全重构、导航搜索,并集成调试、测试、终端、Git 与常用前端工具,

    JetBrains PhpStorm Windows版
    JetBrains PhpStorm Windows版

    PhpStorm 是 JetBrains 面向 PHP 与现代 Web 开发打造的专业集成开发环境,提供代码补全、静态检查、重构、调试、测试、数据库、版本控制及前端语言支持。Windows 用户可直接下载安装程序,

    JetBrains PyCharm Windows版
    JetBrains PyCharm Windows版

    PyCharm 是 JetBrains 推出的 Python 集成开发环境,提供智能代码补全、错误检查、重构、调试、测试、Git、终端及 Jupyter Notebook 支持。统一版安装后可体验 30 天 Pro 功能,

    JetBrains IntelliJ IDEA Windows版
    JetBrains IntelliJ IDEA Windows版

    JetBrains IntelliJ IDEA 是以 Java、Kotlin 和 JVM 项目为核心的专业集成开发环境,提供智能补全、代码检查、安全重构、调试、测试、版本控制及构建工具集成。统一发行版的核心功能可免费用于商业和非商业项目,

    Visual Studio Code Windows版
    Visual Studio Code Windows版

    Visual Studio Code 是微软推出的免费代码编辑器,Windows 版集成智能补全、代码导航、调试、终端和版本控制,并可通过扩展添加语言、格式化及远程开发能力。它启动较快、配置灵活,

    REAPER Windows版
    REAPER Windows版

    REAPER 是 Cockos 推出的数字音频工作站,适用于录音、MIDI 编曲、音频编辑、混音、母带制作及声音设计。软件安装包小巧,支持多轨录制、灵活路由、自动化、第三方插件和脚本扩展,并提供完整功能的 60 天免费评估期。

    Adobe Audition Windows版
    Adobe Audition Windows版

    Adobe Audition 是面向播客、影视后期、广播与音乐制作的专业音频工作站,提供波形编辑、多轨混音、频谱分析、录音、降噪修复和效果处理等功能。Windows 版通过 Adobe Creative Cloud 安装和管理,

    Pro Tools Windows版
    Pro Tools Windows版

    Pro Tools 是 Avid 推出的专业数字音频工作站,提供多轨录音、音频剪辑、MIDI编曲、插件处理、自动化混音及影视声音制作能力。它适合音乐人、录音师、制作人和音频后期团队使用,并提供免费入门版、订阅方案及永久授权选择。