Nacos配置中心支持加密配置项动态刷新

已于 2022-07-29 00:34:50 修改
阅读量3.9k 收藏 10
点赞数 1
分类专栏： Java学习 文章标签： java spring boot spring cloud
于 2022-05-31 02:21:39 首次发布
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_41599977/article/details/125050973
版权

问题描述

通过jasypt对Nacos中的敏感配置项经行加密处理后，首次通过Nacos配置中心获取配置，可以正常解密ENC(XXXX)，修改配置中心中的任意配置，触发配置刷新后，无法正常解密，配置内容变为ENC(XXXX)。
注：在实现功能的时候，查阅了很多资料，最终参考了https://www.cnblogs.com/flying607/p/12520009.html中的方法，但是在实际应用过程中，按照他的方法并未达到预期的效果，可能是版本原因....吧，未深究，所以自己debug一遍，在合适的位子进行配置文件解密，最终达到自己期待的效果。

解决办法

重写NacosPropertySourceLocator类方法，在加载配置项的过程中经行解密，具体操作：
1、新建一个package，命名为：com.alibaba.cloud.nacos.client，一定不能错，否者无法覆盖原NacosPropertySourceLocator类
2、新建一个NacosPropertySourceLocator class类，粘贴一下内容即可。

使用到的一些主要依赖，如下：
SpringBoot：2.1.18.RELEASE
jasypt-spring-boot-starter：3.0.2
jasypt-spring-boot：1.18
spring-cloud-starter-alibaba-nacos-config：2.1.2.RELEASE
如果遇到问题，可以先排除一下版本问题，有的nacos版本中没有NacosPropertySourceLocator 这个类，如果真是，那就自己再想想办法吧…

相关依赖配置如下

<dependency>
    <groupId>com.github.ulisesbocchio</groupId>
    <artifactId>jasypt-spring-boot-starter</artifactId>
    <version>3.0.2</version>
</dependency>
<dependency>
    <groupId>com.github.ulisesbocchio</groupId>
    <artifactId>jasypt-spring-boot</artifactId>
    <version>1.18</version>
</dependency>

<dependency>
    <groupId>com.alibaba.cloud</groupId>
    <artifactId>spring-cloud-starter-alibaba-nacos-config</artifactId>
    <version>2.1.2.RELEASE</version>
</dependency>

在这里插入图片描述
NacosPropertySourceLocator 类

package com.alibaba.cloud.nacos.client;

import com.alibaba.cloud.nacos.NacosConfigManager;
import com.alibaba.cloud.nacos.NacosConfigProperties;
import com.alibaba.cloud.nacos.NacosConfigProperties.Config;
import com.alibaba.cloud.nacos.NacosPropertySourceRepository;
import com.alibaba.cloud.nacos.parser.NacosDataParserHandler;
import com.alibaba.cloud.nacos.refresh.NacosContextRefresher;
import com.alibaba.nacos.api.config.ConfigService;
import com.ulisesbocchio.jasyptspringboot.EncryptablePropertyResolver;
import com.ulisesbocchio.jasyptspringboot.EncryptablePropertySourceConverter;
import com.ulisesbocchio.jasyptspringboot.InterceptionMode;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
import org.springframework.cloud.bootstrap.config.PropertySourceLocator;
import org.springframework.core.annotation.Order;
import org.springframework.core.env.CompositePropertySource;
import org.springframework.core.env.Environment;
import org.springframework.core.env.PropertySource;
import org.springframework.util.CollectionUtils;
import org.springframework.util.StringUtils;

import java.util.Iterator;
import java.util.List;
import java.util.Map;

import static com.ulisesbocchio.jasyptspringboot.configuration.EncryptablePropertyResolverConfiguration.RESOLVER_BEAN_NAME;


/**
 * @author Littlexu
 * @Description 【覆盖第三方包里的文件，后期版本升级可能会有影响】
 *              解决nacos配置中心敏感信息加密问题：第二次修改配置文件后，ENC(****)无法解密，需要重启服务
 * @date 2022/5/31
 */
@Order(0)
public class NacosPropertySourceLocator implements PropertySourceLocator {
    private static final Logger log = LoggerFactory.getLogger(NacosPropertySourceLocator.class);
    private static final String NACOS_PROPERTY_SOURCE_NAME = "NACOS";
    private static final String SEP1 = "-";
    private static final String DOT = ".";
    private NacosPropertySourceBuilder nacosPropertySourceBuilder;
    private NacosConfigProperties nacosConfigProperties;
    private NacosConfigManager nacosConfigManager;

    @Autowired
    private ConfigurableListableBeanFactory beanFactory;

    public NacosPropertySourceLocator(NacosConfigManager nacosConfigManager) {
        this.nacosConfigManager = nacosConfigManager;
        this.nacosConfigProperties = nacosConfigManager.getNacosConfigProperties();
    }

    @Override
    public PropertySource<?> locate(Environment env) {
        this.nacosConfigProperties.setEnvironment(env);
        ConfigService configService = this.nacosConfigManager.getConfigService();
        if (null == configService) {
            log.warn("no instance of config service found, can't load config from nacos");
            return null;
        } else {
            long timeout = (long) this.nacosConfigProperties.getTimeout();
            this.nacosPropertySourceBuilder = new NacosPropertySourceBuilder(configService, timeout);
            String name = this.nacosConfigProperties.getName();
            String dataIdPrefix = this.nacosConfigProperties.getPrefix();
            if (StringUtils.isEmpty(dataIdPrefix)) {
                dataIdPrefix = name;
            }

            if (StringUtils.isEmpty(dataIdPrefix)) {
                dataIdPrefix = env.getProperty("spring.application.name");
            }

            CompositePropertySource composite = new CompositePropertySource("NACOS");
            this.loadSharedConfiguration(composite);
            this.loadExtConfiguration(composite);
            this.loadApplicationConfiguration(composite, dataIdPrefix, this.nacosConfigProperties, env);
            return composite;
        }
    }

    private void loadSharedConfiguration(CompositePropertySource compositePropertySource) {
        List<Config> sharedConfigs = this.nacosConfigProperties.getSharedConfigs();
        if (!CollectionUtils.isEmpty(sharedConfigs)) {
            this.checkConfiguration(sharedConfigs, "shared-configs");
            this.loadNacosConfiguration(compositePropertySource, sharedConfigs);
        }

    }

    private void loadExtConfiguration(CompositePropertySource compositePropertySource) {
        List<Config> extConfigs = this.nacosConfigProperties.getExtensionConfigs();
        if (!CollectionUtils.isEmpty(extConfigs)) {
            this.checkConfiguration(extConfigs, "extension-configs");
            this.loadNacosConfiguration(compositePropertySource, extConfigs);
        }

    }

    private void loadApplicationConfiguration(CompositePropertySource compositePropertySource, String dataIdPrefix, NacosConfigProperties properties, Environment environment) {
        String fileExtension = properties.getFileExtension();
        String nacosGroup = properties.getGroup();
        this.loadNacosDataIfPresent(compositePropertySource, dataIdPrefix, nacosGroup, fileExtension, true);
        this.loadNacosDataIfPresent(compositePropertySource, dataIdPrefix + "." + fileExtension, nacosGroup, fileExtension, true);
        String[] var7 = environment.getActiveProfiles();
        int var8 = var7.length;

        for (int var9 = 0; var9 < var8; ++var9) {
            String profile = var7[var9];
            String dataId = dataIdPrefix + "-" + profile + "." + fileExtension;
            this.loadNacosDataIfPresent(compositePropertySource, dataId, nacosGroup, fileExtension, true);
        }

    }

    private void loadNacosConfiguration(final CompositePropertySource composite, List<Config> configs) {
        Iterator var3 = configs.iterator();

        while (var3.hasNext()) {
            Config config = (Config) var3.next();
            String dataId = config.getDataId();
            String fileExtension = dataId.substring(dataId.lastIndexOf(".") + 1);
            this.loadNacosDataIfPresent(composite, dataId, config.getGroup(), fileExtension, config.isRefresh());
        }

    }

    private void checkConfiguration(List<Config> configs, String tips) {
        String[] dataIds = new String[configs.size()];

        for (int i = 0; i < configs.size(); ++i) {
            String dataId = ((Config) configs.get(i)).getDataId();
            if (dataId == null || dataId.trim().length() == 0) {
                throw new IllegalStateException(String.format("the [ spring.cloud.nacos.config.%s[%s] ] must give a dataId", tips, i));
            }

            dataIds[i] = dataId;
        }

        NacosDataParserHandler.getInstance().checkDataId(dataIds);
    }

    private void loadNacosDataIfPresent(final CompositePropertySource composite, final String dataId, final String group, String fileExtension, boolean isRefreshable) {
        if (null != dataId && dataId.trim().length() >= 1) {
            if (null != group && group.trim().length() >= 1) {
                NacosPropertySource propertySource = this.loadNacosPropertySource(dataId, group, fileExtension, isRefreshable);
                // 对配置文件的加密内容进行解密
                EncryptablePropertyResolver propertyResolver = beanFactory.getBean(RESOLVER_BEAN_NAME, EncryptablePropertyResolver.class);
                propertySource = (NacosPropertySource) EncryptablePropertySourceConverter.makeEncryptable(InterceptionMode.PROXY, propertyResolver, propertySource);

                this.addFirstPropertySource(composite, propertySource, false);
            }
        }
    }

    private NacosPropertySource loadNacosPropertySource(final String dataId, final String group, String fileExtension, boolean isRefreshable) {
        return NacosContextRefresher.getRefreshCount() != 0L && !isRefreshable ? NacosPropertySourceRepository.getNacosPropertySource(dataId, group) : this.nacosPropertySourceBuilder.build(dataId, group, fileExtension, isRefreshable);
    }

    private void addFirstPropertySource(final CompositePropertySource composite, NacosPropertySource nacosPropertySource, boolean ignoreEmpty) {
        if (null != nacosPropertySource && null != composite) {
            if (!ignoreEmpty || !((Map) nacosPropertySource.getSource()).isEmpty()) {
                composite.addFirstPropertySource(nacosPropertySource);
            }
        }
    }

    public void setNacosConfigManager(NacosConfigManager nacosConfigManager) {
        this.nacosConfigManager = nacosConfigManager;
    }
}

说明：jasypt-spring-boot-starter：3.0.2主要的作用在我看来，就改变了bean的加载顺序吧，在实际应用的时候，项目启动时会执行NacosPropertySourceLocator里的public PropertySource<?> locate(Environment env){···}方法，如果不引入这个jar包，会导致lazyEncryptablePropertyResolver的bean对象无法获取。

***************************
APPLICATION FAILED TO START
***************************

Description:

A component required a bean named 'lazyEncryptablePropertyResolver' that could not be found.


Action:

Consider defining a bean named 'lazyEncryptablePropertyResolver' in your configuration.

测试

测试代码如下：
在这里插入图片描述

  • 第一次启动，nacos可以正常解密
    在这里插入图片描述
    在这里插入图片描述
  • 修改某个配置后，配置刷新后，解密失败
    在这里插入图片描述
    在这里插入图片描述

使用提供的解决方案：

  • 第一次启动：
    在这里插入图片描述
    在这里插入图片描述
  • 修改配置后
    在这里插入图片描述
    在这里插入图片描述
夜风晚凉
关注
专栏目录
SpringCloud集成nacos之jasypt配置中心的密码加密的自动解密
qq_36973384的博客
07-09 852
通过配置类的方式，实现数据库的连接，构建StringEncryptor 的bean对象，实现密码的加密解密，把加密解密串放到配置文件中，用ENC()包裹着，加载配置文件的时候，有ENC()就会自动解密，这样避免配置文件密码泄露的风险。ENC(N8VBWG5nOHvy5efX3/mlPAmdBykE7iDZFl362LyeaPRXMbLT0PzEIlB/KDXrNYz6)，配置了jasypt之后，使用password作为密钥进行加密解密。3.1 数据库连接配置。
Nacos配置中心的敏感数据加密处理
一只没有脚的鸟
03-27 1866
本文介绍了两种数据库配置加密方式，邮箱配置加密、Redis配置加密、阿里云短信配置加密及其他的配置加密方式。算是提供了一个思路，希望可以帮到大家，看到这里希望你给个大大的赞😊。
Nacos 中的配置文件如何实现加密传输
mxt51220的博客
11-21 3237
小伙伴们知道，Spring Cloud Config 很早就提供了配置文件的加解密功能，并且支持对称加密和非对称加密两种不同的模式。Nacos 作为分布式配置中心+服务注册中心的合体，在配置文件加密这块一直差点意思，不过好在，如果你使用的 Nacos 版本大于 2.0.4 这个版本，那么现在也可以通过插件的方式来实现配置文件加密了。
Nacos配置内容加密实现
最新发布
东皋长歌的专栏
08-13 848
因为项目中安全检查的要求，需要将nacos配置的内容进行加密，所以需要实现将配置内容加密处理，这里引入nacos-aes-encryption-plugin插件来完成这一需求。3.2 将项目的yml文件中的"spring.cloud.nacos.config.prefix"改为"cipher-aes-"开头，例：cipher-aes-user。-U参数表示强制更新依赖。进入Nacos控制台，配置内容正常处理，配置名以"cipher-aes-"开头，例：cipher-aes-user。
【Nacos配置中心】对配置文件内容进行加密
怪咖@的博客
09-11 1万+
加密主要是针对于配置文件当中的配置，存储到数据库的时候，加密成密文。然后Nacos展示出来的是明文。因为我们有时候会在配置文件存储很多敏感信息，例如数据库连接方式，或者第三方存储系统的相关信息。出于此考虑，`Nacos在2.1版本新发布了配置文件加密功能`，根本不需要我们自己来实现，很轻松的就能实现 配置内容AES加密 功能。
nacos配置敏感数据加密（使用jasypt）
weixin_43443921的博客
05-10 1254
nacos配置敏感数据加密（使用jasypt）
SpringBoot整合nacos配置中心 支持动态刷新
weixin_48692011的博客
05-18 898
自己搜了好多相关的文章发现好多都是springcloud的居多 关于springboot的很少 如果你也跟我一样不是微服务的项目话那么或许会帮到你。这里我们不能新建bootstrap.yml来进行配置 我们得使用原始的配置文件进行配置就可以了。到此关于nacos服务端的配置完毕 以上跟微服务的操作基本一致 所以在此就不贴图详细赘述了。在命名空间内新建一个新的命名空间 方便后期的维护 避免和其他项目混在一起。3.在配置列表内选择自己的命名空间建立新的配置。auto-refresh改为 true。
nacos动态配置数据源_配置中心 ------- Nacos
weixin_39562089的博客
12-18 2455
一、配置中心nacos有两大功能：注册中心和配置中心nacos的中文文档：https://nacos.io/zh-cn/docs/open-api.html1、配置文件的缺点(1)生产环境的数据库的用户名和密码都配置在配置文件中，所有开发人员都能看到密码，这就造成了一定的安全隐患；(2)配置文件修改之后服务必须重启才可以生效，若生产环境上有一个开关需要打开，修改完配置文件再重启服务，那风险太大了；...
nacos 怎么配置 里的配置ip_2.nacos服务配置中心
weixin_35696071的博客
01-28 5825
下面将研究以下几个问题:nacos的角色: nacos是如何工作的? 在集群中扮演什么样的角色?修改nacos配置数据库: 我们在控制台配置的信息, 默认是写到nacos的默认数据库中, 不方便管理, 因此我们设置一个自己的数据库, 进行管理操作在控制台配置nacos配置nacos配置管理的模型: 基本概念,namespace, group, data id及其用法命名空间的管理, namespa...
Nacos配置中心
qq_66924116的博客
11-30 106
配置文件相对分散。在一个微服务架构下，配置文件会随着微服务的增多变的越来越多，而且分散 在各个微服务中，不好统一配置和管理。配置文件无法区分环境。微服务项目可能会有多个环境，例如：测试环境、预发布环境、生产环 境。每一个环境所使用的配置理论上都是不同的，一旦需要修改，就需要我们去各个微服务下手动 维护，这比较困难。配置文件无法实时更新。我们修改了配置文件之后，必须重新启动微服务才能使配置生效，这对一 个正在运行的项目来说是非常不友好的。基于上面这些问题，我们就需要配置中心的加入来解决这些问题。
nacos2.0.4版本使用RSA算法加密之后的源码，可以直接使用。
04-05
内容概要：nacos2.0.4版本使用RSA算法加密之后的源码，可以直接使用。下载nacos源码之后进行代码编写，修改了前端用户名和密码加密传输，后端使用RSA算法将收到的信息进行解码判断。内容包含源代码、打包之后的zip文件以及tar.gz文件，可以直接使用。 适用人群：项目使用nacos作为注册中心，但是要求用户名和密码加密传输的人员。 使用方法：直接下载本资源，将打包之后的文件上传到Linux服务器上，进入bin目录执行启动命令：sh startup.sh -m standalone 访问：http://ip:8848/nacos/#/login 输入默认账号密码：nacos，nacos 建议登陆之后及时修改密码，注意密码强度。
SpringCloudAlibaba，Nacos 配置管理
10-21
Nacos 支持配置的历史版本记录，可以方便地回滚到某个历史版本，防止因误操作导致的问题。 7. **健康检查** 虽然这不是配置管理的主要功能，但Nacos 还提供了服务健康检查的能力，可以监控服务的状态，确保配置的...
nacos 怎么配置 里的配置ip_Nacos配置管理
weixin_32323455的博客
01-14 7996
之前的帖子介绍了安装，这次主要说一下Nacos的功能之一(配置管理)Nacos之发布配置：在浏览器访问自己的nacos后台，默认为IP:8848/nacos，点击配置管理->配置列表，添加配置。需要设置Data ID ，Group，配置格式和配置内容。Data ID默认是使用properties为扩展名的，如果需要使用yml，需要在加上后缀，如：Data ID:nacos-test.ymlN...
nacos配置加密简单实现Jaspyt
m0_46577241的博客
01-26 2708
快速Nacos上实现配置加密，可以使用Jaspyt库来简化实现。Jaspyt是一个Java库，可以用来实现简单的加密和解密操作。以下是在Nacos配置中使用Jaspyt进行加密的简单实现步骤：步骤1：添加依赖项 在项目的构建文件pom.xml中添加Jaspyt库的依赖项。如果是有公共服务模块可以直接引入公共服务总任意模块的pom文件中Maven： 步骤2：创建密钥 创建一个密钥，在应用程序中使用该密钥对配置进行加密和解密操作。设置配置配置必须在其他配置之前生效执行 bootstrap.yml 比conf
nacos配置文件中敏感信息加密
goldenminers的博客
09-26 8254
nacos配置文件中敏感信息加密 文章目录前言一、前提二、使用步骤1.引入jasypt依赖2.修改配置文件3.自定义加解密类4.测试使用总结 前言 springCloud项目使用nacos作为配置中心，在配置文件中，部分配置数据需要进行加密。搜索nacos官网发现目前没有提供数据加密的功能【2021.9.26】需要自己实现。nacos官网 网上搜索整理后，使用jasypt实现配置文件加解密。 一、前提 默认已经成功搭建springcloud并使用ncos作为配置中心 二、使用步骤 1.引入jasypt依
springBoot配置文件账号密码加密存储（springCloud nacos）_nacos配置文件配置账号密码(1)
2401_84183033的博客
04-10 2815
在Application启动主类中加入启动注解 @EnableEncryptablePropertiesjasypt: encryptor:password: 06d698b3d86f519ealgorithm: PBEWithHmacSHA512AndAES_128注：加密因子password配置在配置文件中也会涉及到安全问题，更安全的做法是：将其作为系统环境变量的方式来带入。修改如下：本地启动可按下图配置：找到jasypt.jar包，在此文件夹下执行以下命令行：java -cp jasypt-1.9.3
Nacos鉴权和配置加密—官方原版
热门推荐
深圳市多克创新科技有限公司
02-08 1万+
Nacos鉴权和配置加密
如何实现Nacos配置文件动态刷新【四种方式】
怀着一颗学徒的心
08-21 1万+
在Nacos中，动态刷新配置文件的实现方式可以总结如下：使用Spring Cloud Config + Nacos：结合Spring Cloud Config和Nacos作为配置中心，在应用程序中添加注解，并使用@Value注解绑定配置属性。通过发送POST请求到端点来触发配置的刷新。使用Nacos的ConfigListener接口：实现ConfigListener接口，并注册为Nacos的监听器。当配置发生变化时，回调相应方法进行处理。
nacos配置中心动态刷新
04-30
Nacos配置中心是一个开源的服务发现和配置管理平台，可以通过Nacos配置中心来管理应用的配置。在应用中使用Nacos配置中心，可以实现配置的动态刷新。动态刷新就是在运行过程中对应用的配置进行修改，并及时将修改后的配置生效的过程。在使用Nacos配置中心的动态刷新时，需要完成以下几个步骤： 1. 在应用中引入nacos-client依赖，并配置nacos-client的地址。 2. 在应用的配置文件中，设置Nacos配置中心的命名空间、应用名称以及Nacos配置中心的地址。 3. 在应用启动后，使用Nacos的API从Nacos配置中心获取配置信息，并加载到应用中。 4. 在应用运行过程中，可以通过Nacos的API来动态修改配置信息。当配置发生变化时，Nacos配置中心会触发一个监听器，通知应用更新配置信息。 5. 应用接收到配置变化的通知后，可以通过刷新配置的方式，重新加载最新的配置信息。 配置动态刷新可以使应用的配置信息更加灵活和易于管理，同时也可以提高应用的稳定性和可维护性。因此， Nacos配置中心动态刷新是一个非常值得掌握的技能。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值