conneqt/gatekeeper repository overview

⁠Gatekeeper - Authorization Checker for CONNEQT

Gatekeeper Docker image includes the Gatekeeper software. The version of the Gatekeeper is the same as the Docker image tag. conneqt/gatekeeper:2.0.2-1 has the Gatekeeper version 2.0.2-1, installed on Alpine OS.

⁠What is Gatekeeper

Gatekeeper is a middleware to add user level authorization idea into X-Road.

X-Road has organization based access control. X-Road members initially after registration cannot use any other organization's X-Road service. Only after organization A explicitly gives organization B access to organization A's service, organization B can use it.

Gatekeeper gives this control to users.

Gatekeeper is setup between Security Servers and information systems.

                                    +------------+
                                    | Consent    |
                                    | Management |
                                    | System     |
                                    +------------+
                                        ^    |
                                        |    C
                                        B    |
                                        |    v
          +---------------+         +------------+         +-----------+
    ----->|               |----A--->|            |----D--->|Information|
Internet  |Security Server|         | Gatekeeper |         |           | 
    <-----|               |<---F----|            |<---E----|  System   |
          +---------------+         +------------+         +-----------+

Fig.1 Components around Gatekeeper

For every request Security Servers sends to Gatekeeper (A in Fig.1), Gatekeeper checks (B in Fig.1) if the request is authorized by the user whom this request is about.

When Gatekeeper confirms based on the response (C in Fig.1) that the user's authorization is valid, Gatekeeper forwards the request from Security Server (A in Fig.1) to information systems (D in Fig.1), and replies back to Security Server.

Gatekeeper is NOT involved in the process to GIVE authorization. Gatekeeper only checks if user already gave authorization.

Gatekeeper is a SOAP proxy that forwards only if Gatekeeper confirms that the user gave authorization.

⁠Usage

Gatekeeper requires configuration files and a private key and certificates to work.

We recommend 2 approaches to use the Gatekeeper Docker image.

⁠1. Base image

You can write a Dockerfile that looks like follows.

FROM conneqt/gatekeeper:2.0.2-1

ADD gatekeeper.yml /gatekeeper.yml
ADD services.yml /services.yml
ADD certs /certs

CMD ["--config", "/gatekeeper.yml"]

⁠2. Mount volume

You can put the necessary files on the host and mount it as follows.

% tree
.
├── certs
│   ├── cacert.pem
│   ├── user.crt
│   └── user.key
├── services.yml
└── gatekeeper.yml

% docker run -it --rm -v $PWD:/mnt conneqt/gatekeeper:latest --config /mnt/gatekeeper.yml

⁠Documentation and technical support

Contact us for the documentation and technical support.

• Using this Form https://planetway.com/contact/⁠
• In CONNEQT Community https://join.slack.com/t/conneqt-community/shared_invite/zt-ng88s0jn-UiXAIJz~XBxIn1xaF8pFNw⁠

⁠License, Terms of Use

By downloading the Docker image, you represent that you have read, understood and agreed to be bound by the Terms of Use⁠.

The files in this repository are licensed under MIT License⁠.