Python如何读取YAML格式的配置文件_通过PyYAML库进行安全解析

夜萱小哥_9034

夜萱小哥_9034

2026-04-29

571人浏览

原创

PyYAML默认加载器存在反序列化风险,yaml.load()可能执行任意代码;必须改用yaml.safe_load()解析配置,它仅支持基础类型,拒绝Python特有标签,是安全标配。

python如何读取yaml格式的配置文件_通过pyyaml库进行安全解析

PyYAML默认加载器存在反序列化风险

直接用 yaml.load() 读取不受信的YAML文件可能执行任意代码,比如文件里藏了 !!python/object:os.system 这类标签。这不是理论漏洞,是真实被利用过的安全问题。

根本原因是 yaml.load() 默认使用 FullLoader(或更早版本的 Loader),它允许解析任意Python对象。生产环境必须禁用。

  • 永远不要在读取外部配置(如用户上传、CI/CD传入、第三方服务返回)时用 yaml.load(data)
  • 即使配置来自内部,也应默认按“不可信”处理——权限变更、路径污染、模板注入都可能让YAML内容失控
  • Python 5.4+ 的 PyYAML 已将 yaml.load() 的默认 loader 改为 SafeLoader,但旧版本或显式指定 Loader 仍会绕过保护

推荐用 yaml.safe_load() 解析纯配置数据

safe_load() 只支持基础 YAML 标签(str、int、list、dict、bool、null),不解析 Python 特有类型,是配置文件的标准解法。

示例:

import yaml
<p>with open("config.yaml", "r", encoding="utf-8") as f:
cfg = yaml.safe_load(f)</p><p>print(cfg["database"]["host"])  # 正常访问字典
</p>
  • 如果文件为空或只有注释,safe_load() 返回 None,记得判空再取键
  • 遇到语法错误(如缩进错、冒号漏写),抛出 yaml.YAMLError,建议包一层 try/catch 做友好提示
  • 不支持 !include、!env 等自定义标签——这是好事,说明你没引入额外解析逻辑,降低攻击面

需要扩展功能时,必须显式控制标签解析行为

有些项目依赖 !include 合并配置,或用 !float 强制类型。这时不能退回到 load(),而应继承 SafeLoader 并注册白名单标签。

python-code-analyz
python-code-analyz

专业Python代码分析与优化,支持语法检查、安全扫描、性能评估、复杂度分析及重构后优化代码生成。

下载

例如只允许 !include(读取同目录下的其他YAML):

import yaml
from pathlib import Path
<p>class ConfigLoader(yaml.SafeLoader):
def <strong>init</strong>(self, stream):
super().<strong>init</strong>(stream)
self._root = Path(stream.name).parent if hasattr(stream, "name") else Path(".")</p><pre class="brush:php;toolbar:false;">def include(self, node):
    filename = self.construct_scalar(node)
    filepath = self._root / filename
    with open(filepath, encoding="utf-8") as f:
        return yaml.load(f, ConfigLoader)

ConfigLoader.add_constructor("!include", ConfigLoader.include)

使用

with open("main.yaml") as f: cfg = yaml.load(f, ConfigLoader)

  • 所有自定义构造器必须从 SafeLoader 派生,不能基于 FullLoader 或 UnsafeLoader
  • 构造器内部避免执行 shell 命令、动态 import、或读取任意路径——self._root / filename 是必要约束
  • 若需支持环境变量插值(如 ${DB_HOST}),应在 safe_load() 后用 os.environ.get() 替换字符串,而非在 YAML 解析层做

Windows路径和编码容易引发 UnicodeDecodeError

YAML 文件若含中文或特殊符号,在 Windows 上用默认 open() 可能报错:「UnicodeDecodeError: 'gbk' codec can't decode byte...」。这不是 PyYAML 的问题,而是文件打开方式不对。

  • 始终显式指定 encoding="utf-8",哪怕你确定是英文配置——不同编辑器保存默认编码不一致
  • 路径中含反斜杠 \ 时,YAML 本身不识别转义,建议统一用正斜杠 / 或原始字符串 r"dir\sub",但最好在 YAML 里写成 path: "data/config.yaml"
  • 用 Path(__file__).parent / "config.yaml" 构造路径,比拼接字符串更可靠

PyYAML 的安全边界其实很清晰:只要不用 load()、不手动传入危险 loader、不盲目信任输入源,配置解析就不会成为突破口。真正麻烦的是那些“顺手加个 !eval 标签”的临时想法——它们往往出现在上线前最后一刻。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1651

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

4064

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1649

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

23497

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

2887

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

2907

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1143

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

596

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2263

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程