fiware-ambassador-auth

README

fiware-ambassador-auth

This REST API service works with Ambassador on Kubernetes in order to authorize and authanticate the client.

Description

This REST API service accepts any path and any methods, and checks the Authorization Header of HTTP Request. In this version, Bearer Token Authorization and Basic Authorization are acceptable.

The authrization and authentication flow is like below:

1. If request host does not match any hosts, this service responds 403 Forbidden.
2. If request path contains no_auths.allowed_paths associated with the host, this service responds 200 OK.
3. If request host matches but Authorization Header does not exist, this service always responds with 401 Unauhtorized.
4. If Bearer Token does not exist in bearer_tokens associated with the host, this service responds with 401 Unauthorized.
5. If Bearer Token exists but requested path does not exist in bearer_tokens[?].allowed_paths associated with the host and Token, this service responds 403 Forbidden.
6. If a set of username and password does not exist in basic_auths associated with the host, this service responds with 401 Unauthorized.
7. If valid username and password exists but requested path does not exist in basic_auths[?].allowed_paths associated with the host and user, this service responds 403 Forbidden.
8. otherwise, this service responds 200 OK.

This REST API service is assumed to work with Ambassador on Kubernetes.

JSON template

• set your tokens as the json like below.
• host and allowed_paths can accept "rgular expression".

[
  {
    "host": "<<1st_FQDN_regex>>",
    "settings": {
      "bearer_tokens": [
        {
          "token": "<<token1>>",
          "allowed_paths": ["<<allowed_path1_regex>>", "<<allowed_path2_regex>>", ...]
        }, {
          ...
        }
      ],
      "basic_auths": [
        {
          "username": "<<user1>>",
          "password": "<<password_of_user1>>",
          "allowed_paths": ["<<allowed_path1_regex>>", "<<allowed_path2_regex>>", ...]
        }, {
          ...
        }
      ],
      "no_auths": {
        "allowed_paths": ["<<allowed_path1_regex>>", "<<allowed_path2_regex>>", ...]
      }
    }
  },
  {
    "host": "<<2nd_FQDN_regex>>",
    "settings": {
      ...
    }
  }
]

example:

[
  {
    "host": "^api\\..+$",
    "settings": {
      "bearer_tokens": [
        {
          "token": "cTHMfPsSDbPd8y4TcsiNg2CnI0Y5mpfl",
          "allowed_paths": ["^/path1/.*$", "^/path2/\\d+/.*.*$"]
        }, {
          "token": "Q0H83rnkIUVPSnoQb9UpZkEXIb42b5x9",
          "allowed_paths": ["^/path1/.*$"]
        }
      ],
      "basic_auths": [],
      "no_auths": {}
    }
  },
  {
    "host": "^web\\..+$",
    "settings": {
      "bearer_tokens": [],
      "basic_auths": [
        {
          "username": "admin",
          "password": "0YziWgALc6PCXgwt4rn8qVxX6iANBRvl",
          "allowed_paths": ["^/management/users/$", "^/management/pages/.*$"]
        }, {
          "username": "user1",
          "password": "0YziWgALc6PCXgwt4rn8qVxX6iANBRvl",
          "allowed_paths": ["^/management/pages/.*$"]
        }
      ],
      "no_auths": {
        "allowed_paths": ["^.*/static/.*$"]
      }
    }
  }
]

An envrionment variable vs. a JSON file

• You can set your tokens as an environment variable (AUTH_TOKENS) or json file path (AUTH_TOKENS_PATH).

set tokens as an environment variable

• When you use the environment variable, you have to set your json string as AUTH_TOKENS.
• After this program starts, your changes will not be applied even if you change your environment variable.

set tokens as a JSON file

• When you use the JSON file, you have to set your json file path as AUTH_TOKENS_PATH.
• When you change your json file, your change will be applied even if this program has already started.

Run as Docker container

1. Pull container roboticbase/fiware-ambassador-auth from DockerHub.

   $ docker pull roboticbase/fiware-ambassador-auth
   

2. Run Container.

   • If you want to change exposed port, set the LISTEN_PORT environment variable.

   • run container using an environment variable.

     $ docker run -d -e AUTH_TOKENS="$(cat auth-tokens.json)" -e LISTEN_PORT=3000 -p 3000:3000 roboticbase/fiware-ambassador-auth:0.3.0
     

   • run container using a json file.

     $ docker run -d -e AUTH_TOKENS_PATH="$(pwd)/auth-tokens.json" -e LISTEN_PORT=3000 -p 3000:3000 roboticbase/fiware-ambassador-auth:0.3.0
     

Build from source code

1. go get

   $ go get -u github.com/RoboticBase/fiware-ambassador-auth
   $ cd ${GOPATH}/src/github.com/RoboticBase/fiware-ambassador-auth
   

2. install dependencies

   $ go get -u github.com/golang/dep/cmd/dep
   $ dep ensure
   

3. go install

   $ go install github.com/RoboticBase/fiware-ambassador-auth
   

4. run service

   $ env LISTEN_PORT=3000 ${GOPATH}/bin/fiware-ambassador-auth
   

License

Apache License 2.0

Copyright

Copyright (c) 2018-2019 TIS Inc.

Documentation

Overview

Package main : entry point of fiware-ambassador-auth.

license: Apache license 2.0
copyright: Nobuyuki Matsui <nobuyuki.matsui@gmail.com>