TykTechnologies / tyk / 7416 / 2

Ran 24 Sep 2019 03:08PM UTC

Files 87

Run time 5s

Badge

Embed ▾

Committed 24 Sep 2019 02:56PM UTC coverage: 57.478% (+0.1%) from 57.372%

Job # LATEST_GO=true

Build Type

push

travis-ci

Committed by

buger

Commit Message

Add support for whitelisting ports (#2533)

Add support for whitelisting ports

This change introduces `ports_whitelist` configuration option to `tyk.conf`, which
defines which ports should the gateway allow services to be bind to.

example configuration is like this

```json
{
  "ports_whitelist": {
    "http": {
      "ranges": [
        {
          "from": 8000,
          "to": 9000
        }
      ]
    },
    "tcp": {
      "ranges": [
        {
          "from": 7001,
          "to": 7900
        }
      ]
    },
    "tls": {
      "ports": [
        6000,
        6015
      ]
    }
  }
}
```

You define the protocol `http`, `https`, `tcp` or `tls` which maps to an object 
with schema

```json
{
    "type": [
        "object"
    ],
    "additionalProperties": false,
    "properties": {
        "ranges": {
            "type": "array",
            "items": {
                "type": "object",
                "additionalProperties": false,
                "properties": {
                    "from": {
                        "type": "integer"
                    },
                    "to": {
                        "type": "integer"
                    }
                }
            }
        }
    },
    "ports": {
        "type": "array",
        "items": {
            "type": "integer"
        }
    }
}
```


# Defining specific ports

You can  configure a specific port to be available like this.

```json
{
    "ports_whitelist": {
        "http": {
            "ports": [
                8089,
                8090
            ]
        }
    }
}
```

This configuration tells the gateway to allow `http` services only on port `8089`
and `8090`

# Defining port ranges

port ranges is the boundary of allowed ports inclusively. This helps to avoid 
tedious specifying each possible ports.

Example

```json
{
    "ports_whitelist": {
        "http": {... (continued)

Run Details

9846 of 17130 relevant lines covered (57.48%)

129.56 hits per line

TykTechnologies / tyk / 7416 / 2

README BADGES
x

Markdown

Textile

RDoc

HTML

Rst

Source Files on job 7416.2 (LATEST_GO=true)

TykTechnologies / tyk / 7416 / 2

README BADGES x

Markdown

Textile

RDoc

HTML

Rst

Source Files on job 7416.2 (LATEST_GO=true)

README BADGES
x