cloudflash-uproxy
List of uproxy APIs
Verb | URI | Description |
POST | /uproxy | Create uproxy system configuration |
GET | /uproxy | list uproxy system configuration |
GET | /uproxy/nova | list uproxy XFH configuration |
PUT | /uproxy/nova/nova-id | Update uproxy XFH configuration |
Create uproxy system config
Verb URI Description
POST /uproxy Create uproxy system configuration.
Request
{
"core": {
"filename": "/config/uproxy/uproxy.ini",
"params": {
"debug_level": 2
},
"sections": [
{
"name": "DataProcessor",
"params": {
"exec_queue_timeout": 1000,
"exec_timeout": "180s",
"feeder_queue_timeout": 1,
"load_delay": 250,
"max_load": 200,
"max_threads": 150,
"min_threads": 50,
"module": "corenova.data.processor.transformation",
"prefork": 1,
"transformation": {
"filename": "/config/uproxy/uproxy.xfc",
"encoding": "base64",
"include": "/config/uproxy/uproxy.xfh",
"data": "base64 encoded data of uproxy.xfc master file"
},
"use_atomic": true,
"use_cache": true
}
}
]
},
"nova": {
"filename": "/config/uproxy/uproxy.xfh",
"global": {
"HAVE_NFQUEUE": false,
"HAVE_CATDNS": false,
"HAVE_FFPROXY": true,
"HAVE_COMMTOUCH": true,
"HAVE_KASPERSKY": true,
"HAVE_SAFESEARCH": true,
"UPROXY_CONFIG_DIR": "/config/uproxy",
"UPROXY_LISTEN_PORT": 12345,
"PROTOCOL_ANALYSIS_TIMEOUT": 10000,
"PROTOCOL_ANALYSIS_MODULES": "cpn.net.analysis.ssl,cpn.net.analysis.http,cpn.net.analysis.smtp,cpn.net.analysis.pop3"
},
"params": {
"PROXY_FILTER_SSL": false,
"SSL_FILTER_SUBALTNAMES": false,
"SSL_FILTER_RESTRICT_ACC_BLOCKED": false,
"SSL_FILTER_RESTRICT_ACC_SELFCERT": false,
"PROXY_INSPECT_SSL": false,
"SSL_INSPECT_WEBWARNING": true,
"SSL_INSPECT_SUBALTNAMES": false,
"SSL_INSPECT_CABUNDLE": {
"filename": "ca-cert.pem",
"encoding": "base64",
"data": "base64 encoded data"
},
"SSL_INSPECT_CACERT": {
"filename": "rootcert.pem",
"encoding": "base64",
"data": "base64 encoded data"
},
"SSL_INSPECT_CAKEY": {
"filename": "rootkey.pem",
"encoding": "base64",
"data": "base64 encoded data"
},
"PROXY_HTTP": true,
"KASPERSKY_HTTP_UPLOAD": true,
"KASPERSKY_HTTP_DOWNLOAD": true,
"HTTP_CUSTOM_FILTER": false,
"COMMTOUCH_CATEGORY": false,
"SAFESEARCH": true,
"SAFESEARCH_RESPONSE": false,
"PROXY_SMTP": true,
"KASPERSKY_SMTP": true,
"PROXY_POP3": true,
"KASPERSKY_POP3": true,
"PROXY_IMAP": false,
"KASPERSKY_IMAP": false
}
}
}
Response
[
{
"core":
{
"filename": "/config/uproxy/uproxy.ini",
"params":
{
"debug_level": 2
},
"sections":
[
{
"name": "DataProcessor",
"params":
{
"exec_queue_timeout": 1000,
"exec_timeout": "180s",
"feeder_queue_timeout": 1,
"load_delay": 250,
"max_load": 200,
"max_threads": 150,
"min_threads": 50,
"module": "corenova.data.processor.transformation",
"prefork": 1,
"transformation":
{
"data": "WNrLT5uZXQ6cHJveHk6dHJhbnNhY3Rpb246OipdCgoKOztsb2dnaW5nIC0gVE9ETywgZG9lcyBub3Qgd29yayByaWdodCBub3cKWyhhY2Nlc3NfZmlsdGVyKS0+ZGF0YTpsb2c6bWVzc2FnZS0+KGxvZyldCgpbKGxvZyktPmRhdGE6bG9nOmZpbGVdCmxvZ2ZpbGUgPSAvdmFyL2xvZy9hY2Nlc3MubG9nIAoK",
"encoding": "base64",
"filename": "/config/uproxy/uproxy.xfc",
"include": "/config/uproxy/uproxy.xfc"
},
"use_atomic": true,
"use_cache": true
}
}
]
},
"nova":
{
"filename": "/config/uproxy/uproxy.xfh",
"global":
{
"COMMTOUCH_CATEGORY_MAP": "/config/ffproxy/data/db/commtouch.map",
"COMMTOUCH_IP": "127.0.0.1",
"COMMTOUCH_POLICY": "/config/ffproxy/data/db/filter.category.match",
"COMMTOUCH_PORT": 5678,
"HAVE_CATDNS": false,
"HAVE_COMMTOUCH": true,
"HAVE_FFPROXY": true,
"HAVE_KASPERSKY": true,
"HAVE_NFQUEUE": false,
"HAVE_SAFESEARCH": true,
"HTTP_DATASCAN_MAXSIZE": "1M",
"HTTP_FFPROXY_DIR": "/config/ffproxy/data/db",
"HTTP_FILTER_TEMPLATE": "/config/ffproxy/data/html/filtered_category",
"HTTP_VIRUS_TEMPLATE": "/config/uproxy/template.virus",
"IMAP_DATASCAN_MAXSIZE": "6M",
"KASPERSKY_MAX_SESSIONS": 4,
"KASPERSKY_SCAN_TIMEOUT": 2000,
"POP3_DATASCAN_MAXSIZE": "3M",
"PROTOCOL_ANALYSIS_MODULES": "cpn.net.analysis.http,cpn.net.analysis.smtp,cpn.net.analysis.pop3,cpn.net.analysis.imap,cpn.net.analysis.ssl",
"PROTOCOL_ANALYSIS_TIMEOUT": 10000,
"SAFESEARCH_POLICY": "/config/safesearch/safesearch.conf",
"SMTP_DATASCAN_MAXSIZE": "3M",
"SSL_FFPROXY_DIR": "/config/ssl/data/db",
"UPROXY_CONFIG_DIR": "/config/uproxy",
"UPROXY_LISTEN_PORT": 12345
},
"params":
{
"COMMTOUCH_CATEGORY": false,
"CONTENT_FILTERING": false,
"HTTP_AV_SCAN": true,
"HTTP_CUSTOM_FILTER": false,
"KASPERSKY_HTTP_DOWNLOAD": true,
"KASPERSKY_HTTP_UPLOAD": true,
"KASPERSKY_IMAP": true,
"KASPERSKY_POP3": true,
"KASPERSKY_SMTP": true,
"MAIL_AV_SCAN": true,
"PROXY_FILTER_SSL": false,
"PROXY_HTTP": true,
"PROXY_IMAP": true,
"PROXY_INSPECT_SSL": false,
"PROXY_POP3": true,
"PROXY_SMTP": true,
"SAFESEARCH": false,
"SAFESEARCH_RESPONSE": false,
"SSL_FILTER_RESTRICT_ACC_BLOCKED": false,
"SSL_FILTER_RESTRICT_ACC_SELFCERT": false,
"SSL_FILTER_SUBALTNAMES": false,
"SSL_INSPECT_CABUNDLE":
{
"data": "base64 encoded data",
"encoding": "base64",
"filename": "ca-cert.pem"
},
"SSL_INSPECT_CACERT":
{
"data": "base64 encoded data",
"encoding": "base64",
"filename": "rootcert.pem"
},
"SSL_INSPECT_CAKEY":
{
"data": "base64 encoded data",
"encoding": "base64",
"filename": "rootkey.pem"
},
"SSL_INSPECT_SUBALTNAMES": true,
"SSL_INSPECT_WEBWARNING": true
}
},
"id": "17c283c6-bb2a-462c-9cb7-40c23e99838e"
}
]
List uproxy system config
Verb URI Description
GET /uproxy Create uproxy system configuration.
Response
[
{
"core": {
"filename": "/config/uproxy/uproxy.ini",
"params": {
"debug_level": 2
},
"sections": [
{
"name": "DataProcessor",
"params": {
"exec_queue_timeout": 1000,
"exec_timeout": "180s",
"feeder_queue_timeout": 1,
"load_delay": 250,
"max_load": 200,
"max_threads": 150,
"min_threads": 50,
"module": "corenova.data.processor.transformation",
"prefork": 1,
"transformation": {
"filename": "/config/uproxy/uproxy.xfc",
"encoding": "base64",
"include": "/config/uproxy/uproxy.xfh",
"data": "base64 encoded data of uproxy.xfc master file"
},
"use_atomic": true,
"use_cache": true
}
}
]
},
"nova": {
"filename": "/config/uproxy/uproxy.xfh",
"global": {
"HAVE_NFQUEUE": false,
"HAVE_CATDNS": false,
"HAVE_FFPROXY": true,
"HAVE_COMMTOUCH": true,
"HAVE_KASPERSKY": true,
"HAVE_SAFESEARCH": true,
"UPROXY_CONFIG_DIR": "/config/uproxy",
"UPROXY_LISTEN_PORT": 12345,
"PROTOCOL_ANALYSIS_TIMEOUT": 10000,
"PROTOCOL_ANALYSIS_MODULES": "cpn.net.analysis.ssl,cpn.net.analysis.http,cpn.net.analysis.smtp,cpn.net.analysis.pop3,cpn.net.analysis.imap"
},
"params": {
"PROXY_SSL": false,
"SSL_FILTER_SUBALTNAMES": true,
"SSL_FILTER_RESTRICT_ACC_BLOCKED": true,
"SSL_FILTER_RESTRICT_ACC_SELFCERT": true,
"SSL_INSPECT_WEBWARNING": true,
"SSL_INSPECT_SUBALTNAMES": true,
"SSL_INSPECT_CABUNDLE": {
"filename": "ca-cert.pem",
"encoding": "base64",
"data": "base64 encoded data"
},
"SSL_INSPECT_CACERT": {
"filename": "rootkey.pem",
"encoding": "base64",
"data": "base64 encoded data"
},
"SSL_INSPECT_CAKEY": {
"filename": "rootcert.pem",
"encoding": "base64",
"data": "base64 encoded data"
},
"PROXY_HTTP": true,
"KASPERSKY_HTTP_UPLOAD": true,
"KASPERSKY_HTTP_DOWNLOAD": true,
"HTTP_CUSTOM_FILTER": false,
"COMMTOUCH_CATEGORY": false,
"SAFESEARCH": true,
"SAFESEARCH_RESPONSE": false,
"PROXY_SMTP": true,
"KASPERSKY_SMTP": true,
"PROXY_POP3": true,
"KASPERSKY_POP3": true,
"PROXY_IMAP": true,
"KASPERSKY_IMAP": true
}
},
"id": "f9a77f46-cf6f-44aa-a9ba-4df700d04784"
}
]
List uproxy XFH configuration
Verb URI Description
GET /uproxy/nova list uproxy system XFH configuration.
Response
[
{
"params":
{
"CONTENT_FILTERING": true,
"KASPERSKY_HTTP_DOWNLOAD": true,
"HTTP_CUSTOM_FILTER": false,
"HTTP_AV_SCAN": true,
"SAFESEARCH_RESPONSE": false,
"PROXY_HTTP": true,
"PROXY_INSPECT_SSL": false,
"SSL_INSPECT_WEBWARNING": true,
"PROXY_SMTP": true,
"SSL_FILTER_RESTRICT_ACC_SELFCERT": false,
"SSL_INSPECT_SUBALTNAMES": true,
"KASPERSKY_IMAP": true,
"PROXY_IMAP": true,
"KASPERSKY_POP3": true,
"MAIL_AV_SCAN": true,
"SSL_FILTER_SUBALTNAMES": false,
"KASPERSKY_HTTP_UPLOAD": true,
"SAFESEARCH": false,
"COMMTOUCH_CATEGORY": false,
"PROXY_POP3": true,
"SSL_FILTER_RESTRICT_ACC_BLOCKED": false,
"PROXY_FILTER_SSL": false,
"KASPERSKY_SMTP": true
},
"id": "17c283c6-bb2a-462c-9cb7-40c23e99838e"
}
]
Update uproxy XFH configuration
Verb URI Description
PUT /uproxy/nova/:id Update uproxy system XFH configuration.
Request
{
"params":
{
"CONTENT_FILTERING": true,
"KASPERSKY_HTTP_DOWNLOAD": true,
"HTTP_CUSTOM_FILTER": false,
"HTTP_AV_SCAN": true,
"SAFESEARCH_RESPONSE": false,
"PROXY_HTTP": true,
"PROXY_INSPECT_SSL": false,
"SSL_INSPECT_WEBWARNING": true,
"PROXY_SMTP": true,
"SSL_FILTER_RESTRICT_ACC_SELFCERT": false,
"SSL_INSPECT_SUBALTNAMES": true,
"KASPERSKY_IMAP": true,
"PROXY_IMAP": true,
"KASPERSKY_POP3": true,
"MAIL_AV_SCAN": true,
"SSL_FILTER_SUBALTNAMES": false,
"KASPERSKY_HTTP_UPLOAD": true,
"SAFESEARCH": false,
"COMMTOUCH_CATEGORY": false,
"PROXY_POP3": true,
"SSL_FILTER_RESTRICT_ACC_BLOCKED": false,
"PROXY_FILTER_SSL": false,
"KASPERSKY_SMTP": true
},
"id": "17c283c6-bb2a-462c-9cb7-40c23e99838e"
}
Response
{
"params":
{
"CONTENT_FILTERING": true,
"KASPERSKY_HTTP_DOWNLOAD": true,
"HTTP_CUSTOM_FILTER": false,
"HTTP_AV_SCAN": true,
"SAFESEARCH_RESPONSE": false,
"PROXY_HTTP": true,
"PROXY_INSPECT_SSL": false,
"SSL_INSPECT_WEBWARNING": true,
"PROXY_SMTP": true,
"SSL_FILTER_RESTRICT_ACC_SELFCERT": false,
"SSL_INSPECT_SUBALTNAMES": true,
"KASPERSKY_IMAP": true,
"PROXY_IMAP": true,
"KASPERSKY_POP3": true,
"MAIL_AV_SCAN": true,
"SSL_FILTER_SUBALTNAMES": false,
"KASPERSKY_HTTP_UPLOAD": true,
"SAFESEARCH": false,
"COMMTOUCH_CATEGORY": false,
"PROXY_POP3": true,
"SSL_FILTER_RESTRICT_ACC_BLOCKED": false,
"PROXY_FILTER_SSL": false,
"KASPERSKY_SMTP": true
},
"id": "17c283c6-bb2a-462c-9cb7-40c23e99838e"
}