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://stackoverflow.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)
Java SQL註入學習筆記