Java SQL注入学习笔记
1 简介
文章主要内容包括:
- java 持久层技术/框架简单介绍
- 不同场景/框架下易导致 sql 注入的写法
- 如何避免和修复 sql 注入
2 jdbc
介绍
jdbc:
-
全称 java database connectivity
-
是 java 访问数据库的 api,不依赖于特定数据库 ( database-independent )
-
所有 java 持久层技术都基于 jdbc
更多请参考 http://www.oracle.com/technetwork/java/javase/jdbc/index.html
说明
直接使用 jdbc 的场景,如果代码中存在拼接 sql 语句,那么很有可能会产生注入,如
// concat sql
string sql = "select * from users where name ='"+ name + "'";
statement stmt = connection.createstatement();
resultset rs = stmt.executequery(sql);
安全的写法是使用 参数化查询 ( parameterized queries ),即 sql 语句中使用参数绑定( ? 占位符 ) 和 preparedstatement
,如
// use ? to bind variables
string sql = "select * from users where name= ? ";
preparedstatement ps = connection.preparestatement(sql);
// 参数 index 从 1 开始
ps.setstring(1, name);
还有一些情况,比如 order by、column name,不能使用参数绑定,此时需要手工过滤,如通常 order by 的字段名是有限的,因此可以使用白名单的方式来限制参数值
这里需要注意的是,使用了 preparedstatement
并不意味着不会产生注入,如果在使用 preparedstatement
之前,存在拼接 sql 语句,那么仍然会导致注入,如
// 拼接 sql
string sql = "select * from users where name ='"+ name + "'";
preparedstatement ps = connection.preparestatement(sql);
看到这里,大家肯定会好奇 preparedstatement
是如何防止 sql 注入的,来了解一下
正常情况下,用户的输入是作为参数值的,而在 sql 注入中,用户的输入是作为 sql 指令的一部分,会被数据库进行编译/解释执行。当使用了 preparedstatement
,带占位符 ( ? ) 的 sql 语句只会被编译一次,之后执行只是将占位符替换为用户输入,并不会再次编译/解释,因此从根本上防止了 sql 注入问题。
更详细和准确的回答,请参考:
-
how does a preparedstatement avoid or prevent sql injection?
-
how to fix sql injection using java preparedstatement & callablestatement
3 mybatis
介绍
- 首个 class persistence framework
- 介于 jdbc (raw sql) 和 hibernate (orm)
- 简化绝大部分 jdbc 代码、手工设置参数和获取结果
- 灵活,使用者能够完全控制 sql,支持高级映射
更多请参考 http://www.mybatis.org/
说明
在 mybatis 中,使用 xml 文件 或 annotation 来进行配置和映射,将 interfaces 和 java pojos (plain old java objects) 映射到 database records
xml 例子
mapper interface
@mapper
public interface usermapper {
user getbyid(int id);
}
xml 配置文件
<select id="getbyid" resulttype="org.example.user">
select * from user where id = #{id}
</select>
annotation 例子
@mapper
public interface usermapper {
@select("select * from user where id= #{id}")
user getbyid(@param("id") int id);
}
可以看到,使用者需要自己编写 sql 语句,因此当使用不当时,会导致注入问题
与使用 jdbc 不同的是,mybatis 使用 #{}
和 ${}
来进行参数值替换
使用 #{}
语法时,mybatis 会自动生成 preparedstatement
,使用参数绑定 (?
) 的方式来设置值,上述两个例子等价的 jdbc 查询代码如下:
string sql = "select * from users where id = ?";
preparedstatement ps = connection.preparestatement(sql);
ps.setint(1, id);
因此 #{}
可以有效防止 sql 注入,详细可参考 http://www.mybatis.org/mybatis-3/sqlmap-xml.html string substitution 部分
而使用 ${}
语法时,mybatis 会直接注入原始字符串,即相当于拼接字符串,因而会导致 sql 注入,如
<select id="getbyname" resulttype="org.example.user">
select * from user where name = '${name}' limit 1
</select>
name 值为 ' or '1'='1
,实际执行的语句为
select * from user where name = '' or '1'='1' limit 1
因此建议尽量使用 #{}
,但有些时候,如 order by 语句,使用 #{}
会导致出错,如
order by #{sortby}
sortby 参数值为 name
,替换后会成为
order by "name"
即以字符串 “name” 来排序,而非按照 name 字段排序,详细可参考 https://*.com/a/32996866/6467552。
这种情况就需要使用 ${}
order by ${sortby}
使用了 ${}
后,使用者需要自行过滤输入,方法有:
-
代码层使用白名单的方式,限制
sortby
允许的值,如只能为name
,email
字段,异常情况则设置为默认值name
-
在 xml 配置文件中,使用
if
标签来进行判断mapper 接口方法
list<user> getuserlistsortby(@param("sortby") string sortby);
xml 配置文件
<select id="getuserlistsortby" resulttype="org.example.user"> select * from user <if test="sortby == 'name' or sortby == 'email'"> order by ${sortby} </if> </select>
因为 mybatis 不支持 else,需要默认值的情况,可以使用
choose (when, otherwise)
<select id="getuserlistsortby" resulttype="org.example.user"> select * from user <choose> <when test="sortby == 'name' or sortby == 'email'"> order by ${sortby} </when> <otherwise> order by name </otherwise> </choose> </select>
更多场景
除了 order by
之外,还有一些可能会使用到 ${}
情况,可以使用其他方法避免,如
like 语句
如需要使用通配符 ( wildcard characters %
和 _
) ,可以
-
在代码层,在参数值两边加上
%
,然后再使用#{}
-
使用
bind
标签来构造新参数,然后再使用#{}
mapper 接口方法
list<user> getuserlistlike(@param("name") string name);
xml 配置文件
<select id="getuserlistlike" resulttype="org.example.user"> <bind name="pattern" value="'%' + name + '%'" /> select * from user where name like #{pattern} </select>
<bind>
语句内的 value 为 ognl expression,具体可参考 http://www.mybatis.org/mybatis-3/dynamic-sql.html bind 部分 -
使用 sql
concat()
函数<select id="getuserlistlikeconcat" resulttype="org.example.user"> select * from user where name like concat ('%', #{name}, '%') </select>
除了注入问题之外,这里还需要对用户的输入进行过滤,不允许有通配符,否则在表中数据量较多的时候,假设用户输入为 %%
,会进行全表模糊查询,严重情况下可导致 dos,参考 http://www.tothenew.com/blog/sql-wildcards-is-your-application-safe/
in 条件
使用 <foreach>
和 #{}
mapper 接口方法
list<user> getuserlistin(@param("namelist") list<string> namelist);
xml 配置文件
<select id="selectuserin" resulttype="com.example.user">
select * from user where name in
<foreach item="name" collection="namelist"
open="(" separator="," close=")">
#{name}
</foreach>
</select>
具体可参考 http://www.mybatis.org/mybatis-3/dynamic-sql.html foreach 部分
limit 语句
直接使用 #{}
即可
mapper 接口方法
list<user> getuserlistlimit(@param("offset") int offset, @param("limit") int limit);
xml 配置文件
<select id="getuserlistlimit" resulttype="org.example.user">
select * from user limit #{offset}, #{limit}
</select>
4 jpa & hibernate
介绍
jpa:
-
全称 java persistence api
-
orm (object-relational mapping) 持久层 api,需要有具体的实现
更多请参考 https://en.wikipedia.org/wiki/java_persistence_api
hibernate:
- jpa orm 实现
更多请参考 http://hibernate.org/
说明
这里有一种错误的认识,使用了 orm 框架,就不会有 sql 注入。而实际上,在 hibernate 中,支持 hql (hibernate query language) 和 native sql 查询,前者存在 hql 注入,后者和之前 jdbc 存在相同的注入问题,来具体看一下
hql
hql 查询例子
query<user> query = session.createquery("from user where name = '" + name + "'", user.class);
user user = query.getsingleresult();
这里的 user
为类名,和原生 sql 类似,拼接会导致注入
正确的用法:
- 位置参数 (positional parameter)
query<user> query = session.createquery("from user where name = ?", user.class);
query.setparameter(0, name);
- 命名参数 (named parameter)
query<user> query = session.createquery("from user where name = :name", user.class);
query.setparameter("name", name);
- 命名参数 list (named parameter list)
query<user> query = session.createquery("from user where name in (:namelist)", user.class);
query.setparameterlist("namelist", arrays.aslist("lisi", "zhaowu"));
- 类实例 (javabean)
user user = new user();
user.setname("zhaowu");
query<user> query = session.createquery("from user where name = :name", user.class);
// user 类需要有 getname() 方法
query.setproperties(user);
native sql
存在 sql 注入
string sql = "select * from user where name = '" + name + "'";
// deprecated
// query query = session.createsqlquery(sql);
query query = session.createnativequery(sql);
使用参数绑定来设置参数值
string sql = "select * from user where name = :name";
// deprecated
// query query = session.createsqlquery(sql);
query query = session.createnativequery(sql);
query.setparameter("name", name);
jpa
jpa 中使用 jpql (java persistence query language),同时也支持 native sql,因此和 hibernate 存在类似的问题,这里就不再细说,感兴趣的可以参考 how to how to fix sql injection using the java persistence api (jpa)