| 1 |
Communicating with the E2G ICAP Server - Brief notes for ICAP |
| 2 |
Client developers. |
| 3 |
|
| 4 |
Developers should comply with RFC 3507. |
| 5 |
|
| 6 |
Allow 204 is implimented in E2G. |
| 7 |
|
| 8 |
However, as of version v5.5, Preview and Allow 206 are not yet implimented. |
| 9 |
(These are likely to be implimented in a future version) |
| 10 |
|
| 11 |
In addition to the standard ICAP headers, clients must |
| 12 |
supply the following ICAP headers: |
| 13 |
|
| 14 |
x-client-ip: (The ip of the browser making the request) |
| 15 |
x-client-username: (the username of the user) |
| 16 |
|
| 17 |
These are used by E2G to determine the filter group (see notes/icap) |
| 18 |
|
| 19 |
When E2G receives a REQMOD request it will respond with an ICAP x-icap-e2g: |
| 20 |
header which should be included in any associated RESPMOD request. |
| 21 |
|
| 22 |
It consists of six comma-delimited fields, which provides context information |
| 23 |
to the E2G respmod process. |
| 24 |
|
| 25 |
The fields are: username, |
| 26 |
flag, - letter denoting current classification of filtering |
| 27 |
Filter_group_number, |
| 28 |
message_no, |
| 29 |
log_message_no, |
| 30 |
message_string |
| 31 |
|
| 32 |
If E2G reqmod responds with 204 then the client request should be passed to the |
| 33 |
target host without modification and the target host response sent directly to |
| 34 |
the client. (Note squid does not seem able to do this and so with squid |
| 35 |
implimentation every request and response has to be sent to E2G). |
| 36 |
|
| 37 |
Wher E2G reqmod responds with 200 and a response header/body (a block or |
| 38 |
status message) this should be sent to client to complete the request. |
| 39 |
|
| 40 |
If there is not a response header this should leave those requests which need |
| 41 |
content-scanning (indicated by 'G' in the second field of the x-icap-e2g) then |
| 42 |
any revised header should be used in the request to the target host and |
| 43 |
the target host response submitted to E2G respmod. |
| 44 |
|
| 45 |
Philip Pearce 13 Nov 2023 |