[Linux] 研究 c-icap modules 與 Squid 相關設定 @ Ubuntu 12.04

前鎮子剛用 pyicap 完成簡單的 ICAP 實作，但 pyicap 還是有一點不順，所以就來試試 c-icap 吧！盡管在 wikipeida 上查閱了幾種 icap server 的實作，但不少已經說不繼續維護，然後就叫大家去看 c-icap 啦，再加上 c-icap 也可以在 apt-get 上方便取得，所以，就來摸摸 so 吧！(據說中國那邊還很盛行，ISP還是會幫忙把網頁加上自家廣告)

先聊一下 c-icap 的部分，它是一隻用 C 實作 ICAP server 的角色，而 Squid 本身就內建 ICAP client 的角色了。使用 c-icap 的理由，則是他提供模組的方式，將你想做的事寫成 module ，設定後可變成 c-icap 的一個 service ，僅需依照 c-icap 的框架實作必要的函式，可省去實作 ICAP 協定。

此篇記錄著重在如何實作 c-icap module ，而網路資料不多，最佳解就是看程式碼 :P

$ apt-get source c-icap libc-icap-mod-urlcheck

此過程會產生兩個目錄：c-icap-0.1.6 和 c-icap-modules-0.1.6，其中 c-icap-modules-0.1.6 環境可以專門拿來編 c-icap modules，但其實最簡單的 c-icap-module 是在 c-icap-0.1.6/services/echo/srv_echo.c，如其名，echo 這只是個範例，但註解非常豐富，看他就夠啦。

其中比較特別的，就是查看 c-icap-module 框架，請參考這段：

CI_DECLARE_MOD_DATA ci_service_module_t service =
{
"echo", /* mod_name, The module name */
"Echo demo service", /* mod_short_descr,  Module short description */
ICAP_RESPMOD | ICAP_REQMOD, /* mod_type, The service type is responce or request modification */
echo_init_service, /* mod_init_service. Service initialization */
NULL, /* post_init_service. Service initialization after c-icap configured. Not used here */                                            
echo_close_service, /* mod_close_service. Called when service shutdowns. */
echo_init_request_data, /* mod_init_request_data */
echo_release_request_data, /* mod_release_request_data */
echo_check_preview_handler, /* mod_check_preview_handler */
echo_end_of_data_handler, /* mod_end_of_data_handler */
echo_io, /* mod_service_io */
NULL,
NULL
};

各項簡介：

• 此 c-icap module service 啓動與關閉：echo_init_service, echo_close_service
• 當 request 進來：echo_init_request_data
• 取得 request preview：echo_check_preview_handler
• 當 request 處理中：echo_io
• 當 request 處理完：echo_release_request_data

舉個例來說，如果要用 PCRE 去做處理，一開始要初始化 PCRE 的項目可以擺在 echo_init_service ，而釋放 PCRE 的資源可以擺在 echo_close_service，而每次處理 request 前需要初始化資源則擺在 echo_init_request_data，釋放在 echo_release_request_data。

至於更深的應用就要去 c-icap-modules-0.1.6/service 翻 clamav 和 url_check，這兩項都跟資安相關，前者是掃毒軟體，後者則是可以拿來過濾惡意網站。有興趣可以翻一輪，比較特別的是處理 request 進來的資料，有用到 ci_simple_file_* 和 ci_membuf_* 系列的函式庫，簡言之就是記憶體擺不下就放檔案，或是有些函式只支援掃檔，那就先擺在檔案去進行。這邊便就不多講了。

設定 c-icap：

$ sudo cp output/changyy.so /usr/lib/c_icap/
$ sudo vim /etc/c-icap/c-icap.conf
Service changyy changyy.so
$ sudo /etc/init.d/c-icap restart

設定 squid：

icap_enable on
icap_send_client_ip on
icap_send_client_username on
icap_client_username_encode off
icap_client_username_header X-Authenticated-User
icap_preview_enable on
icap_preview_size 1024

icap_service service_req reqmod_precache bypass=1 icap://localhost:1344/changyy
adaptation_access service_req allow all
icap_service service_resp respmod_precache bypass=1 icap://localhost:1344/changyy
adaptation_access service_resp allow all

其中 icap://localhost:1344/changyy 在此的意義就是 c-icap 中的 Service changyy 啦，最後一提的是 c-icap.conf 有 DebugLevel ，這個數字攸關 debug 訊息，在 c-icap-modules 中許多實作都會用 ci_debug_printf 來印訊息，其中第一個數字若小於等於 DebugLevel 才會被印出來。而輸出的 log 可以在 /var/log/c-icap/server.log 查到。