面向开发人员梳理的代码安全指南,旨在梳理 API
层面的风险点并提供详实可行的安全编码方案。基于 DevSecOps
理念,我们希望用开发者更易懂的方式阐述安全编码方案,引导从源头规避漏洞。
Python代码安全指南
通用类
1. 代码实现
代码书写完毕之后的,后续工作,如加密代码之类的!
1.1 加密算法
- 【必须】避免使用不安全的对称加密算法
DES
和3DES
已经不再适用于现代应用程序,应改为使用AES
。
1.2 程序日志
- 【建议】对每个重要行为都记录日志
- 确保重要行为都记录日志,且可靠保存
6
个月以上
- 确保重要行为都记录日志,且可靠保存
- 【建议】禁止将未经验证的用户输入直接记录日志
- 当日志条目包含未经净化的用户输入时会引发记录注入漏洞
- 恶意用户会插入伪造的日志数据,从而让系统管理员以为是系统行为
- 【建议】避免在日志中保存敏感信息
- 不能在日志保存密码(包括明文密码和密文密码)、密钥和其它敏感信息
1.3 系统口令
- 【必须】禁止使用空口令、弱口令、已泄露口令
- 【必须】口令强度要求
bash
代码语言:javascript复制# 口令强度须同时满足
1.密码长度大于14位
2.必须包含下列元素:大小写英文字母、数字、特殊字符
3.不得使用各系统、程序的默认初始密码
4.不能与最近6次使用过的密码重复
5.不得与其他外部系统使用相同的密码
- 【必须】口令存储安全
- 禁止明文存储口令
- 禁止使用弱密码学算法(如
DES
和3DES
)加密存储口令 - 使用不可逆算法和随机
salt
对口令进行加密存储
- 【必须】禁止传递明文口令
- 【必须】禁止在不安全的信道中传输口令
2. 配置&环境
发布系统或者上线环境前,需要注意的问题!
2.1 版本选择
- 【建议】使用 Python 3.6 的版本
- 新增的项目应使用
Python 3.6
版本
- 新增的项目应使用
bash
代码语言:javascript复制# 为什么要这么做?
由于Python2在2020年停止维护,相关组件的漏洞不能得到及时修复与维护!
2.2 第三方包安全
- 【必须】禁止使用不安全的组件
2.3 配置信息
- 【必须】密钥存储安全
- 在使用对称密码算法时,需要保护好加密密钥。当算法涉及敏感、业务数据时,可通过非对称算法协商加密密钥
- 其他较为不敏感的数据加密,可以通过变换算法等方式保护密钥
- 【必须】禁止硬编码敏感配置
- 禁止在源码中硬编码
AK/SK
、IP
、数据库账密等配置信息 - 应使用配置系统或
KMS
密钥管理系统
- 禁止在源码中硬编码
后台类
这是一条华丽的分割线
1. 代码实现
编写代码是需要考虑和思考的问题!
1.1 输入验证
- 【必须】按类型进行数据校验
- 所有程序外部输入的参数值,应进行数据校验,校验不通过应拒绝
- 校验内容包括但不限于:数据长度、数据范围、数据类型与格式
- 推荐使用组件:Cerberus、jsonschema、Django-Validators
python
代码语言:javascript复制# Cerberus示例
v = Validator({'name': {'type': 'string'}})
v.validate({'name': 'john doe'})
# jsonschema示例
schema = {
"type" : "object",
"properties" : {
"price" : {"type" : "number"},
"name" : {"type" : "string"},
},
}
validate(instance={"name" : "Eggs", "price" : 34.99}, schema=schema)
1.2 SQL 操作
- 【必须】使用参数化查询
- 使用参数化
SQL
语句,强制区分数据和命令,避免产生SQL
注入漏洞。
- 使用参数化
python
代码语言:javascript复制# 错误示例
import mysql.connector
mydb = mysql.connector.connect(
... ...
)
cur = mydb.cursor()
userid = get_id_from_user()
# 使用%直接格式化字符串拼接SQL语句
cur.execute("SELECT `id`, `password` FROM `auth_user` WHERE `id`=%s " % (userid,))
myresult = cur.fetchall()
python
代码语言:javascript复制# 安全示例
import mysql.connector
mydb = mysql.connector.connect(
... ...
)
cur = mydb.cursor()
userid = get_id_from_user()
# 将元组以参数的形式传入
cur.execute("SELECT `id`, `password` FROM `auth_user` WHERE `id`=%s " , (userid,))
myresult = cur.fetchall()
- 【必须】使用参数化查询
- 推荐使用
ORM
框架来操作数据库,如:使用SQLAlchemy
。
- 推荐使用
python
代码语言:javascript复制# 安装sqlalchemy并初始化数据库连接
# pip install sqlalchemy
from sqlalchemy import create_engine
# 初始化数据库连接,修改为你的数据库用户名和密码
engine = create_engine('mysql mysqlconnector://user:password@host:port/DATABASE')
python
代码语言:javascript复制# 引用数据类型
from sqlalchemy import Column, String, Integer, Float
from sqlalchemy.ext.declarative import declarative_base
Base = declarative_base()
# 定义 Player 对象:
class Player(Base):
# 表的名字:
__tablename__ = 'player'
# 表的结构:
player_id = Column(Integer, primary_key=True, autoincrement=True)
team_id = Column(Integer)
player_name = Column(String(255))
height = Column(Float(3, 2))
python
代码语言:javascript复制# 增删改查
from sqlalchemy.orm import sessionmaker
# 创建 DBSession 类型:
DBSession = sessionmaker(bind=engine)
# 创建 session 对象:
session = DBSession()
# 增:
new_player = Player(team_id=101, player_name="Tom", height=1.98)
session.add(new_player)
# 删:
row = session.query(Player).filter(Player.player_name=="Tom").first()
session.delete(row)
# 改:
row = session.query(Player).filter(Player.player_name=="Tom").first()
row.height = 1.99
# 查:
rows = session.query(Player).filter(Player.height >= 1.88).all()
# 提交即保存到数据库:
session.commit()
# 关闭 session:
session.close()
- 【必须】对参数进行过滤
- 将接受到的外部参数动态拼接到
SQL
语句时,必须对参数进行安全过滤。
- 将接受到的外部参数动态拼接到
python
代码语言:javascript复制def sql_filter(sql, max_length=20):
dirty_stuff = [""", "\", "/", "*", "'", "=", "-", "#", ";", "<", ">", " ",
"&", "$", "(", ")", "%", "@", ","]
for stuff in dirty_stuff:
sql = sql.replace(stuff, "x")
return sql[:max_length]
1.3 执行命令
- 【建议】避免直接调用函数执行系统命令
- 相关功能的实现应避免直接调用系统命令,如
os.system()
、os.popen()
、subprocess.call()
等。 - 优先使用其他同类操作进行代替,比如:通过文件系统
API
进行文件操作而非直接调用操作系统命令。 - 如评估无法避免,执行命令应避免拼接外部数据,同时进行执行命令的白名单限制。
- 相关功能的实现应避免直接调用系统命令,如
- 【必须】过滤传入命令执行函数的字符
- 程序调用各类函数执行系统命令时,如果涉及的命令由外部传入,过滤传入命令执行函数的字符。
python
代码语言:javascript复制import os
import sys
import shlex
domain = sys.argv[1]
# 替换可以用来注入命令的字符为空
badchars = "n&;|'"$()`-"
for char in badchars:
domain = domain.replace(char, " ")
result = os.system("nslookup " shlex.quote(domain))
1.4 XML 读写
- 【必须】禁用外部实体的方法
- 禁用外部实体的方法,来预防
XXE
攻击。
- 禁用外部实体的方法,来预防
python
代码语言:javascript复制from lxml import etree
xmlData = etree.parse(xmlSource,etree.XMLParser(resolve_entities=False))
1.5 文件操作
- 【必须】文件类型限制
- 通过白名单对上传或者下载的文件类型、大小进行严格校验。
- 仅允许业务所需文件类型上传,避免上传木马、
WebShell
等文件。
python
代码语言:javascript复制import os
ALLOWED_EXTENSIONS = ['txt','jpg','png']
def allowed_file(filename):
if ('.' in filename and
'..' not in filename and
os.path.splitext(filename)[1].lower() in ALLOWED_EXTENSIONS):
return filename
return None
- 【必须】禁止外部文件存储于可执行目录
- 禁止外部文件存储于
WEB
容器的可执行目录(appBase
)。 - 建议使用 tempfile 库处理临时文件和临时目录。
- 禁止外部文件存储于
- 【必须】避免路径穿越
- 保存在本地文件系统时,必须对路径进行合法校验,避免目录穿越漏洞。
python
代码语言:javascript复制import os
upload_dir = '/tmp/upload/' # 预期的上传目录
file_name = '../../etc/hosts' # 用户传入的文件名
absolute_path = os.path.join(upload_dir, file_name) # /tmp/upload/../../etc/hosts
normalized_path = os.path.normpath(absolute_path) # /etc/hosts
if not normalized_path.startswith(upload_dir): # 检查最终路径是否在预期的上传目录中
raise IOError()
- 【建议】避免路径拼接
- 文件目录避免外部参数拼接。保存文件目录建议后台写死并对文件名进行校验(字符类型、长度)。
- 【建议】文件名 hash 化处理
- 建议文件保存时,将文件名替换为随机字符串。
python
代码语言:javascript复制import uuid
def random_filename(filename):
ext = os.path.splitext(filename)[1]
new_filename = uuid.uuid4().hex ext
return new_filename
1.6 网络请求
- 【必须】限定访问网络资源地址范围
bash
代码语言:javascript复制# 当程序需要从用户提供的URL地址获取信息时
# 如指定的URL地址获取网页文本内容、加载指定地址的图片、进行下载等操作时,需对URL地址进行安全校验
1.只允许HTTP或HTTPS协议
2.解析目标URL,获取其host
3.解析host,获取host指向的IP地址转换成long型
4.检查IP地址是否为内网IP
# 以RFC定义的专有网络为例
# 如有自定义私有网段亦应加入禁止访问列表
10.0.0.0/8
172.16.0.0/12
192.168.0.0/16
127.0.0.0/8
5.请求URL
6.如果有跳转,跳转后执行1,否则对URL发起请求
1.7 响应输出
- 【必须】设置正确的 HTTP 响应包类型
- 响应包的 HTTP 头“Content-Type”必须正确配置响应包的类型,禁止非 HTML 类型的响应包设置为“text/html”。
- 【必须】设置安全的 HTTP 响应头
bash
代码语言:javascript复制# X-Content-Type-Options
添加“X-Content-Type-Options”响应头并将其值设置为“nosniff”。
# HttpOnly
控制用户登鉴权的Cookie字段应当设置HttpOnly属性以防止被XSS漏洞/JavaScript 操纵泄漏。
# X-Frame-Options
置X-Frame-Options响应头,并根据需求合理设置其允许范围。
该头用于指示浏览器禁止当前页面在 frame、 iframe、embed 等标签中展现,从而避免点击劫持问题。
它有三个可选的值:
DENY: 浏览器会拒绝当前页面加载任何frame页面;
SAMEORIGIN: 则frame页面的地址只能为同源域名下的页面
ALLOW-FROM origin: 可以定 义允许frame加载的页面地址。
- 【必须】对外输出页面包含第三方数据时须进行编码处理
- 当响应“Content-Type”为“text/html”类型时,需要对响应体进行编码处理
python
代码语言:javascript复制# 推荐使用mozilla维护的bleach库来进行过滤
import bleach
bleach.clean('an <script>evil()</script> example')
# u'an <script>evil()</script> example'
1.8 数据输出
- 【必须】敏感数据加密存储
- 敏感数据应使用
SHA2
、RSA
等算法进行加密存储 - 敏感数据应使用独立的存储层,并在访问层开启访问控制
- 包含敏感信息的临时文件或缓存一旦不再需要应立刻删除
- 敏感数据应使用
- 【必须】敏感信息必须由后台进行脱敏处理
- 敏感信息须再后台进行脱敏后返回,禁止接口返回敏感信息交由前端/客户端进行脱敏处理。
- 【必须】高敏感信息禁止存储、展示
- 口令、密保答案、生理标识等鉴权信息禁止展示
- 非金融类业务,信用卡
cvv
码及日志禁止存储
- 【必须】个人敏感信息脱敏展示
在满足业务需求的情况下,个人敏感信息需脱敏展示,如:
- 身份证只显示第一位和最后一位字符,如
3***************1
- 移动电话号码隐藏中间
6
位字符,如134******48
- 工作地址/家庭地址最多显示到“区”一级
- 银行卡号仅显示最后
4
位字符,如************8639
- 身份证只显示第一位和最后一位字符,如
- 【必须】隐藏后台地址
- 若程序对外提供了登录后台地址,应使用随机字符串隐藏地址
python
代码语言:javascript复制# 不要采取这种方式
admin_login_url = "xxxx/login"
# 安全示例
admin_login_url = "xxxx/ranD0Str"
1.9 权限管理
- 【必须】默认鉴权
- 除非资源完全可对外开放,否则系统默认进行身份认证(使用白名单的方式放开不需要认证的接口或页面)。
- 【必须】授权遵循最小权限原则
- 程序默认用户应不具备任何操作权限。
- 【必须】避免越权访问
- 对于非公共操作,应当校验当前访问账号进行操作权限(常见于
CMS
)和数据权限校验。
- 对于非公共操作,应当校验当前访问账号进行操作权限(常见于
bash
代码语言:javascript复制1. 验证当前用户的登录态
2. 从可信结构中获取经过校验的当前请求账号的身份信息(如session),禁止从用户请求参数或Cookie中获取外部传入不可信用户身份直接进行查询
3. 校验当前用户是否具备该操作权限
4. 校验当前用户是否具备所操作数据的权限
5. 校验当前操作是否账户是否预期账户
- 【建议】及时清理不需要的权限
- 程序应定期清理非必需用户的权限。
1.10 异常处理
- 【必须】不向对外错误提示
- 应合理使用
try/except/finally
处理系统异常,避免出错信息输出到前端。 - 对外环境禁止开启
debug
模式,或将程序运行日志输出到前端。
- 应合理使用
- 【必须】禁止异常抛出敏感信息
2. Flask 安全
使用 Flask 框架编写代码是需要考虑和思考的问题!
- 【必须】生产环境关闭调试模式
- 【建议】遵循 Flask 安全规范
- 参考
Flask
文档中的安全注意事项 https://flask.palletsprojects.com/en/latest/security/
- 参考
3. Django 安全
使用 Django 框架编写代码是需要考虑和思考的问题!
- 【必须】生产环境关闭调试模式
- 【建议】保持 Django 自带的安全特性开启
- 保持
Django
自带的安全特性开启 https://docs.djangoproject.com/en/3.0/topics/security/ - 在默认配置下,
Django
自带的安全特性对XSS
、CSRF
、SQL
注入、点击劫持等类型漏洞可以起到较好防护效果。应尽量避免关闭这些安全特性。
- 保持