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

当前位置:

首页 > 编程开发 > SpringBoot/SpringCloud使用jasypt-spring-boot实现配置文件加密

SpringBoot/SpringCloud使用jasypt-spring-boot实现配置文件加密

使用Jasypt库可对SpringBoot及Cloud配置文件中的敏感信息(如密码、密钥)进行加密。通过ENC()标记加密值,应用启动时自动解密。加密密钥需通过环境变量等安全方式传递,避免硬编码,确保系统安全。

本文目录

    一、引言:为什么需要配置文件加密?

    在现代软件开发和部署中,应用程序的配置文件(如 application.properties 或 application.yml)常常包含敏感信息,例如:

    SpringBoot/SpringCloud使用jasypt-spring-boot实现配置文件加密

    • 数据库用户名和密码
    • 第三方服务的 API Key 或 Secret
    • 消息队列的连接凭证
    • Redis、MongoDB 等中间件的访问密码
    • 加密密钥或证书路径

    这些敏感信息如果以明文形式存储在配置文件中,无论是在代码仓库、服务器文件系统还是容器镜像里,都存在极大的安全风险。一旦泄露,可能导致数据被窃取、服务被滥用或系统被攻击。因此,对配置文件中的敏感信息进行加密处理是保障应用安全的重要环节。

    本文将详细介绍如何使用 jasypt-spring-boot 库,在 Spring Boot 和 Spring Cloud 项目中实现配置文件内容的加密与解密。

    二、核心工具:jasypt-spring-boot

    jasypt-spring-boot 是一个集成 Jasypt (Ja va Simplified Encryption) 的 Spring Boot Starter,它极大地简化了在 Spring Boot 应用中进行属性加密和解密的过程。

    • Jasypt: 一个强大的 Ja va 加密库,提供简单的 API 来加密、解密密码、文本、数字等。
    • jasypt-spring-boot: 将 Jasypt 无缝集成到 Spring Boot 的 Environment 抽象层中,允许开发者使用特定的格式(如 ENC(encrypted_value))来标记加密后的属性值。Spring Boot 在启动时会自动识别并解密这些值,使应用代码无需关心解密过程。

    三、安装与依赖

    首先,需要在你的 Spring Boot 项目的 pom.xml(Ma ven)或 build.gradle(Gradle)文件中添加 jasypt-spring-boot-starter 依赖。

    Ma ven (pom.xml)

    
        com.github.ulisesbocchio
        jasypt-spring-boot-starter
        3.0.5 
    

    Gradle (build.gradle)

    dependencies {
        implementation 'com.github.ulisesbocchio:jasypt-spring-boot-starter:3.0.5'
        // ... 其他依赖
    }
    

    注意:jasypt-spring-boot 的版本通常需要与你的 Spring Boot 版本兼容。建议查阅 GitHub Releases 页面选择正确的版本。

    四、加密密钥(Password)管理

    Jasypt 加密和解密都需要一个共享的加密密钥(Password)。这个密钥必须被安全地传递给应用。常见的设置方式有:

    1. 命令行参数: ja va -jar myapp.jar --jasypt.encryptor.password=myStrongPassword
    2. 环境变量: export JASYPT_ENCRYPTOR_PASSWORD=myStrongPassword && ja va -jar myapp.jar
    3. 配置文件: 在 application.properties 或 application.yml 中设置(强烈不推荐,因为这样失去了加密的意义,但可用于测试)。例如:
    # application.properties
    jasypt.encryptor.password=myStrongPassword
    # application.yml
    jasypt:
      encryptor:
        password: myStrongPassword

    最佳实践:将 jasypt.encryptor.password 通过环境变量或命令行参数的方式传入,避免将其硬编码在配置文件中。

    五、执行加密

    加密操作可以通过多种方式进行,最常用的是使用命令行工具或编写一个简单的 Ja va 工具类。

    方法一:命令行工具(使用 jasypt CLI)

    下载 Jasypt 的发行包,解压后在 bin 目录下有各种脚本(encrypt.bat, encrypt.sh 等)。

    执行命令:

    ./encrypt.sh input="your-sensitive-value" password="myStrongPassword"

    (Windows 用户使用 encrypt.bat)

    输出示例:

    ----ENVIRONMENT-----------------
    Runtime: Oracle Corporation Ja va HotSpot(TM) 64-Bit Server VM 25.201-b09
    ... (其他环境信息)
    ----ARGUMENTS-------------------
    input: your-sensitive-value
    password: myStrongPassword
    ...
    ----OUTPUT----------------------
    UyBtaXNzaW5nIHlvdSB0aGVyZQ== # 这是加密后的值

    方法二:Ja va 工具类

    创建一个简单的 Ja va 类来执行加密:

    import org.jasypt.encryption.StringEncryptor;
    import org.jasypt.encryption.pbe.StandardPBEStringEncryptor;
    import org.jasypt.encryption.pbe.config.EnvironmentStringPBEConfig;
    
    public class JasyptEncryptionUtil {
    
        public static void main(String[] args) {
            if (args.length != 1) {
                System.err.println("Usage: ja va JasyptEncryptionUtil ");
                System.exit(1);
            }
            String valueToEncrypt = args[0];
            String password = System.getenv("JASYPT_ENCRYPTOR_PASSWORD"); // 从环境变量读取密码
            if (password == null || password.isEmpty()) {
                 System.err.println("Error: JASYPT_ENCRYPTOR_PASSWORD environment variable is not set.");
                 System.exit(2);
            }
    
            StandardPBEStringEncryptor encryptor = new StandardPBEStringEncryptor();
            EnvironmentStringPBEConfig config = new EnvironmentStringPBEConfig();
            config.setPassword(password); // 设置加密密码
            // 可选:设置算法、迭代次数等
            // config.setAlgorithm("PBEWithMD5AndDES");
            encryptor.setConfig(config);
    
            String encryptedValue = encryptor.encrypt(valueToEncrypt);
            System.out.println("Encrypted Value: " + encryptedValue);
        }
    }
    

    编译并运行:

    ja vac -cp "path/to/jasypt-*.jar" JasyptEncryptionUtil.ja va
    export JASYPT_ENCRYPTOR_PASSWORD=myStrongPassword
    ja va -cp ".:path/to/jasypt-*.jar" JasyptEncryptionUtil "your-sensitive-value"
    

    方法三:使用 jasypt-spring-boot 提供的工具(需要将库引入到测试或单独的工具模块)

    如果你的应用已经包含了 jasypt-spring-boot-starter,你可以利用其内部的 StringEncryptor bean 来加密,但这通常不如前两种方法直接。

    六、在配置文件中使用加密值

    获得加密后的字符串后,你需要将其放入你的 Spring Boot 配置文件中。jasypt-spring-boot 会自动识别 ENC(encrypted_value) 格式的属性值并进行解密。

    application.yml 示例:

    spring:
      datasource:
        url: jdbc:mysql://localhost:3306/mydb
        username: ENC(U2FsdGVkX1+...) # 加密后的用户名
        password: ENC(U2FsdGVkX1+...) # 加密后的密码
        driver-class-name: com.mysql.cj.jdbc.Driver
    myapp:
      api:
        key: ENC(V2FsdGVkX1+...) # 加密后的API Key

    application.properties 示例:

    spring.datasource.url=jdbc:mysql://localhost:3306/mydb
    spring.datasource.username=ENC(U2FsdGVkX1+...)
    spring.datasource.password=ENC(U2FsdEVkX1+...)
    spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
    myapp.api.key=ENC(V2FsdGVkX1+...)

    当 Spring Boot 应用启动时,jasypt-spring-boot 会拦截这些属性的读取请求,检测到 ENC(...) 标记,然后使用配置的密码对其进行解密,并将解密后的原始值注入到相应的 Bean 属性或通过 @Value 注解注入到变量中。

    七、EncryptablePropertyResolver

    EncryptablePropertyResolver 是 jasypt-spring-boot 内部使用的一个关键接口,用于解析包含 ENC() 标记的属性值。它扩展了 Spring 的 org.springframework.core.env.PropertyResolver 接口。

    • 当 Environment 尝试解析一个属性时(例如 environment.getProperty("spring.datasource.password")),
    • jasypt-spring-boot 会提供一个实现了 EncryptablePropertyResolver 的包装器。
    • 这个包装器检查属性值是否以 ENC( 开头且以 ) 结尾。
    • 如果是,则提取括号内的加密字符串,使用 StringEncryptor 解密,并返回解密后的结果。
    • 如果不是,则直接返回原始值。

    开发者通常不需要直接与 EncryptablePropertyResolver 交互,jasypt-spring-boot-starter 会自动完成这一过程。

    八、进阶配置与注意事项

    • 自定义加密器: 可以通过配置 jasypt.encryptor.* 属性来自定义加密算法、迭代次数、盐值生成器等。
    jasypt:
      encryptor:
        algorithm: PBEWITHHMACSHA512ANDAES_256 # 更强的算法
        iv-generator-classname: org.jasypt.iv.RandomIvGenerator # 使用随机IV
        # ... 其他配置
    • 性能: 加密/解密操作在应用启动时发生,对于运行时性能影响很小。但如果需要频繁读取大量加密属性,可能会有微小开销。
    • 安全性: 确保加密密钥 jasypt.encryptor.password 的安全性至关重要。不要将其硬编码在代码或配置文件中。使用环境变量、Kubernetes Secrets、HashiCorp Vault 等外部化、安全的密钥管理方案是更好的选择。
    • Spring Cloud Config: 如果你使用 Spring Cloud Config 作为配置中心,同样可以在 Config Server 端或 Client 端启用 jasypt-spring-boot 来加密和解密从 Config Server 获取的配置。

    九、总结

    通过 jasypt-spring-boot,可以非常方便地在 Spring Boot 和 Spring Cloud 项目中实现配置文件的加密。其核心在于使用 ENC() 标记加密后的值,并通过 jasypt.encryptor.password 来解密。EncryptablePropertyResolver 在后台自动完成了识别、解密和替换的过程。正确管理和保护加密密钥是确保此安全措施有效性的关键。

    本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系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软件 更多
    讯飞智作 网页版
    讯飞智作 网页版

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    Aperty macOS版
    Aperty macOS版

    Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

    立刻MV 网页版
    立刻MV 网页版

    立刻MV 面向音乐人、内容创作者和品牌团队,帮助用户低成本完成歌曲 MV、歌词视频、AI 分镜、图生视频与最终合成。

    蛙蛙写作 网页版
    蛙蛙写作 网页版

    蛙蛙写作 AI 创作工具,覆盖小说、剧本、文案,一键生成文稿,打通文字转视频全流程,高效解决创作难题。

    超级简历WonderCV 网页版
    超级简历WonderCV 网页版

    超级简历WonderCV是面向应届生和AI小白的智能求职平台,覆盖简历、面试与职业规划。

    音述AI 网页版
    音述AI 网页版

    音述AI,是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区。

    AionClaw macOS版
    AionClaw macOS版

    AionClaw 是可在桌面端运行的任务型 AI 助手,通过数字专家与技能市场组合办公、创作、数据和开发能力。

    Loomy macOS版
    Loomy macOS版

    Loomy 是科大讯飞推出的桌面 AI 助手,可通过对话、任务与工作目录协助处理办公、内容创作和资料整理。

    AirBuddy 3 macOS版
    AirBuddy 3 macOS版

    AirBuddy 3 是面向 macOS 的蓝牙外设增强工具,可集中查看 AirPods、Beats 与苹果设备电量,提供快速连接、播放控制、电量提醒、桌面小组件和多台 Mac 外设接力等功能。

    AirServer macOS版
    AirServer macOS版

    AirServer macOS版可把 Mac 转换为无线投屏接收端,通过 AirPlay 或 Google Cast 接收手机、平板和电脑画面,并支持多设备同时连接、高清镜像及会话录制,适合家庭娱乐、课堂教学、会议演示和应用展示。

    AnyDesk macOS版
    AnyDesk macOS版

    AnyDesk macOS版是一款适用于远程办公、设备维护和客户支持的远程桌面工具,可连接并操作异地计算机,支持文件传输、无人值守访问、会话权限控制及跨平台协作。

    WINDOWS 更多
    讯飞智作 网页版
    讯飞智作 网页版

    讯飞智作是一款基于语音合成技术、虚拟人驱动技术与数字人形象声音构建能力的 AI 数字人音视频创作平台。

    火山引擎 网页版
    火山引擎 网页版

    火山引擎是字节跳动旗下企业级云与AI服务平台。聚焦大模型核心能力,依托字节自研豆包多模态大模型,凭借火山方舟一站式平台,提供模型精调、推理部署、智能应用搭建等全链路服务,结合高性能AI算力,助力各行业快速落地大模型数字化与智能化应用。

    PixTV 网页版
    PixTV 网页版

    PixTV 是一款在浏览器中使用的 AI 视觉内容创作平台,提供图片、视频、音频、文字生成、AI 分镜、局部重绘、提示词反推和无限画布等工具,适合短剧、漫剧、广告及社交媒体内容制作。

    讯飞绘文 网页版
    讯飞绘文 网页版

    讯飞绘文网页版是科大讯飞推出的AI图文创作与内容运营工具,覆盖热点选题、文章生成、稿件校对、智能配图、排版发布和数据复盘等环节,适合自媒体创作者及内容团队在线使用。

    Maya(Autodesk Maya) Windows版
    Maya(Autodesk Maya) Windows版

    Autodesk Maya 是面向影视、电视、动画和游戏行业的专业三维制作软件,集多边形与 NURBS 建模、角色绑定、关键帧和动作捕捉动画、Bifrost 特效模拟、材质开发及 Arnold 渲染于一体,

    Aperty Windows版
    Aperty Windows版

    Aperty 是 Skylum 推出的 AI 人像修图软件,支持自然肤质修饰、瑕疵处理、面部与身体调整、预设及批量同步。

    立刻MV 网页版
    立刻MV 网页版

    立刻MV 面向音乐人、内容创作者和品牌团队,帮助用户低成本完成歌曲 MV、歌词视频、AI 分镜、图生视频与最终合成。

    蛙蛙写作 网页版
    蛙蛙写作 网页版

    蛙蛙写作 AI 创作工具,覆盖小说、剧本、文案,一键生成文稿,打通文字转视频全流程,高效解决创作难题。

    超级简历WonderCV 网页版
    超级简历WonderCV 网页版

    超级简历WonderCV是面向应届生和AI小白的智能求职平台,覆盖简历、面试与职业规划。

    音述AI 网页版
    音述AI 网页版

    音述AI,是一个以“用声音述说故事”为核心的 AI 音乐创作与声音分享社区。

    AionClaw Windows版
    AionClaw Windows版

    AionClaw 是可在桌面端运行的任务型 AI 助手,通过数字专家与技能市场组合办公、创作、数据和开发能力。

    Loomy Windows版
    Loomy Windows版

    Loomy 是科大讯飞推出的桌面 AI 助手,可通过对话、任务与工作目录协助处理办公、内容创作和资料整理。