Image Proxy supporting automatic content moderation for use with Tezos Wallets and other applications in the ecosystem.

A live deployment of the image proxy is available for use at https://imgproxy-prod.cryptonomic-infra.tech. To request an api key, please send an email to [email protected].

The proxy supports the following features:

1. Fetching images from either HTTP or IPFS urls.
2. The following image formats are supported: bmp, jpg, png, tiff, gif.
3. Automatic content moderation by hooking with a moderation provider.
   1. Automatic format conversion to a format supported by the moderation provider.
   2. Automatic image resizing to support file size limits set by the moderation provider.
4. Caching of moderation results to a database thus enabling quick responses to content fetch requests.
5. User reporting of content that slips by the automatic moderation.

The proxy currently support AWS Rekognition as its moderation provider. There are plans for introducing other providers such as Azure in the future.

See the API section for working examples. These examples will work against the above listed live server. If you are looking to integrate with javscript/typescript, see our library available through npm here

See the Endpoints section for information about prometheus metrics and the internal ui dashboard.

Here are some of things we are considering for future releases:

1. Moderation policy for handling user reports.
2. Enhanced administration dashboard
3. Image caching support (S3)
4. Ability to customize list of categories which should be blocked by the proxy.
5. Azure Moderation service

A docker compose file is provided with this repository. The following steps will allow you to setup your own proxy service:

1. Create an AWS account if you don't have one. Moderation features only work if you connect the proxy to AWS.

2. Create an IAM user with read permissions for Rekognition. Screenshots are provided below as guide. We strongly recommend that you read the AWS IAM documentation to understand the security implications. See AWS documentation for more information.

3. Create and download a AWS Access Keys from the IAM for the user you created in the previous step. Keep this information safe!

4. Create an .env file in the project root with the following contents:

   AWS_ACCESS_KEY_ID=<YOUR AWS ACCESS KEY ID>
   AWS_SECRET_ACCESS_KEY=<YOUR AWS ACCESS KEY>
   

5. Modify the configuration files proxy.conf to suit your needs. Pay attention to the AWS region setting. Ideally this should be set to the same region as where your proxy server is hosted. See AWS documentation on all possible values.

6. Start the containers docker-compose up

7. Test if the service is up by visiting http:https://localhost:3000/info on your browser.

Note that POSTGRES_USER in docker-compose.yml cannot be changed for the time being. This restriction will be removed in an upcoming release. We still encourage changing the default password for the database.

Also note that native CORS support is not baked in yet, but is upcoming very soon in a future PR. For the time being we recommend that you place a nginx reverse proxy in front of the service to handle CORS.

This is a JSON rpc based API. A typescript wrapper library is available here Every request made to the rpc endpoint must have the following set:

1. The request method should be POST.
2. A JSON request object in the body.
3. The content type header must be set to application/json.
4. A header called apikey must be set and a valid key must be provided. In case an invalid api key is provided the api will respond with a 403 FORBIDDEN error.

The following methods are supported by the proxy:

1. img_proxy_fetch : Fetch images from a remote location.
2. img_proxy_describe : Describe any moderation results stored in the database for a given url. This is particularly helpful when one wishes to obtain bulk moderation results before rendering many images, such as in a Gallery.
3. img_proxy_report : Allows users to report a url as having objectionable content.
4. img_proxy_report_describe : Dumps all prior user reports

Responses in general will all have 200 OK as their status along with the following json body in the response if the RPC was successful:

{
  "jsonrpc": "1.0.0",
  "code": "<Enumerated Status Code>",
  "results": {
    // Optional property
    // Method specific results
  }
}

In the event of a failure, an error is instead returned with the following json body:

{
  "jsonrpc": "1.0.0",
  "rpc_status": "Err",
  "error": {
    "code": 100, // Codes are currently all 10X
    "reason": "<reason string>",
    "request_id": "<request id>"
  }
}

This method is used for fetching an image and for applying content moderation on it. A client must provide three parameters with each request:

1. A response_type. If this is set to Json, the proxy will respond with a JSON repsonse which, among other things, will have a data field containing the image data url should it be allowed. If it is set to Raw the proxy will respond directly with the raw bytes of the image if the image is allowed and a JSON response if it is blocked or on error.
2. The url of the image. This must either use the HTTP or IPFS scheme.
3. A force flag, indicating whether they want moderation or not. If this flag is set, the image is returned as is regardless of what moderation may say.

Note that the resource being fetched must be of an image type otherwise the proxy will return a UnsupportedImageType code.

The response from this method depends on the results of moderation:

1. Image is deemed safe - The original image is returned as is, with the header type set to what the remote server returned e.g. image/png.
2. Image is deemed not safe - A JSON response potentially explaining why the image was blocked.

The following request will fetch and save the image as reef.jpg.

curl -o reef.jpg --location --request POST 'https://imgproxy-prod.cryptonomic-infra.tech' \
--header 'apikey: 134472c4dd9118dbff1ed4e5fc7f1d056a0d690c9b6cc47c5c2453a011f57127' \
--header 'Content-Type: application/json' \
--data-raw '{
    "jsonrpc": "1.0.0",
    "method": "img_proxy_fetch",
    "params": {
        "response_type": "Raw",
        "url": "https://upload.wikimedia.org/wikipedia/commons/1/1b/GreatBarrierReef-EO.JPG",
        "force": false
    }
}'

The following request will fetch produce a JSON response:

curl -o reef.jpg --location --request POST 'https://imgproxy-prod.cryptonomic-infra.tech' \
--header 'apikey: 134472c4dd9118dbff1ed4e5fc7f1d056a0d690c9b6cc47c5c2453a011f57127' \
--header 'Content-Type: application/json' \
--data-raw '{
    "jsonrpc": "1.0.0",
    "method": "img_proxy_fetch",
    "params": {
        "response_type": "Json",
        "url": "https://upload.wikimedia.org/wikipedia/commons/1/1b/GreatBarrierReef-EO.JPG",
        "force": false
    }
}'

The response should look like:

{
  "jsonrpc": "1.0.0",
  "rpc_status": "Ok",
  "result": {
    "moderation_status": "Allowed",
    "categories": [],
    "data": "data:image/jpeg;base64,/9j/4RVu...."
  }
}

The following request should produce a JSON response:

curl --location --request POST 'https://imgproxy-prod.cryptonomic-infra.tech' \
--header 'apikey: 134472c4dd9118dbff1ed4e5fc7f1d056a0d690c9b6cc47c5c2453a011f57127' \
--header 'Content-Type: application/json' \
--data-raw '{
    "jsonrpc": "1.0.0",
    "method": "img_proxy_fetch",
    "params": {
        "response_type": "Json",
        "url": "https://upload.wikimedia.org/wikipedia/commons/8/84/Michelangelo%27s_David_2015.jpg",
        "force": false
    }
}'

The response should look like:

{
  "jsonrpc": "1.0.0",
  "rpc_status": "Ok",
  "result": {
    "moderation_status": "Blocked",
    "categories": ["Suggestive", "ExplicitNudity"],
    "data": ""
  }
}

This method is used to fetch cached moderation results from the service. The results will indicate whether the provided urls are Allowed, Blocked or NeverSeen by the proxy.

An example request is as thus:

curl --location --request POST 'https://imgproxy-preview.cryptonomic-infra.tech' \
--header 'apikey: 134472c4dd9118dbff1ed4e5fc7f1d056a0d690c9b6cc47c5c2453a011f57127' \
--header 'Content-Type: application/json' \
--data-raw '{
    "jsonrpc": "1.0.0",
    "method": "img_proxy_describe",
    "params": {
        "urls":[ "https://upload.wikimedia.org/wikipedia/commons/1/1b/GreatBarrierReef-EO.JPG", "https://upload.wikimedia.org/wikipedia/commons/8/84/Michelangelo%27s_David_2015.jpg",  "https://localhost:3000/island.gif" ]
    }
}'

The following response is expected:

{
  "jsonrpc": "1.0.0",
  "code": "Ok",
  "result": [
    {
      "url": "https://upload.wikimedia.org/wikipedia/commons/1/1b/GreatBarrierReef-EO.JPG",
      "status": "Allowed",
      "categories": [],
      "provider": "Aws"
    },
    {
      "url": "https://upload.wikimedia.org/wikipedia/commons/8/84/Michelangelo%27s_David_2015.jpg",
      "status": "Blocked",
      "categories": ["ExplicitNudity", "Suggestive"],
      "provider": "Aws"
    },
    {
      "url": "https://localhost:3000/island.gif",
      "status": "NeverSeen",
      "categories": [],
      "provider": "None"
    }
  ]
}

This method allows users to report objectional content to the proxy. Once a report is successfully registered a report Id will be made available to the user.

An example request is thus:

curl --location --request POST 'https://imgproxy-preview.cryptonomic-infra.tech' \
--header 'apikey: 134472c4dd9118dbff1ed4e5fc7f1d056a0d690c9b6cc47c5c2453a011f57127' \
--header 'Content-Type: application/json' \
--data-raw '{
    "jsonrpc": "1.0.0",
    "method": "img_proxy_report",
    "params": {
        "url": "https://localhost:3000/Plata_O_Plomo.gif",
        "categories": ["Drugs"]
    }
}'

And the typical expected response should look like:

{
  "jsonrpc": "1.0.0",
  "code": "Ok",
  "result": {
    "url": "https://localhost:3000/Plata_O_Plomo.gif",
    "id": "e82b99b4-4d72-45d8-9f39-4aef10d89e3e"
  }
}

This method is used to fetch all reports filed by users. This is typically useful for an UI or an proxy operator who wishes to inspect the internals.

Note that in the future this method may be made administrator only.

The request looks like this:

curl --location --request POST 'https://imgproxy-preview.cryptonomic-infra.tech' \
--header 'apikey: 134472c4dd9118dbff1ed4e5fc7f1d056a0d690c9b6cc47c5c2453a011f57127' \
--header 'Content-Type: application/json' \
--data-raw '{
    "jsonrpc": "1.0.0",
    "method": "img_proxy_describe_report"
}'

A typical response should look like this:

{
    "jsonrpc": "1.0.0",
    "code": "Ok",
    "result": [
        {
            "url": "https://localhost:3000/Plata_O_Plomo.gif",
            "categories": [
                "Drugs"
            ],
            "id": "e82b99b4-4d72-45d8-9f39-4aef10d89e3e",
            "updated_at": "2021-06-03 12:57:59.346193 UTC"
        },
        {
            "url": "https://localhost:3000/Plata_O_Plomo.gif",
            "categories": [
                "Drugs"
            ],
            "id": "bde3d2a6-ea46-48c6-9a24-4cb956e98010",
            "updated_at": "2021-06-03 13:17:45.630878 UTC"
        }
    ]
}

The service supports two endpoints:

1. /metrics - Prometheus metrics, must be enabled via configuration.
2. /admin - Coming soon