Gluu Gateway 4.0.x#
This documentation is currently being restructured. There may be temporary broken links or formatting errors. Thank you for your patience while we improve our docs!
Gluu Gateway (GG) is an authentication and authorization solution for APIs and websites. GG is built on top of the open source Kong Gateway, and includes plugins to enable access management policy enforcement using OAuth, UMA, OpenID Connect and Open Policy Agent (OPA). In addition, GG supports the broader ecosystem of Kong plugins to enable API rate limiting, logging, and many other capabilities.
Primary use cases supported by Gluu Gateway include:
- Authentication by OAuth2 / UMA bearer tokens and JWT
- Authorization by OAuth2 / UMA scopes
- Proxy websites, acting as an OpenID Connect Relying Party (RP)
- Control access to API's by delegating policy decisions to an Open Policy Agent (OPA) server
- Rate limiting, logging, and many other capabilities enabled via the ecosystem of Kong plugins
Upstream Service/Application: The upstream application can be a REST API or Web Application. This is the application secured by Gluu Gateway.
Gateway or Proxy: The gateway is proxy software that acts as middleware between client applications and upstream applications. It provides very the powerful ability to add and execute code to filter requests and and add a layer of security. If the request is approved, the gateway takes the response from the upstream application and returns it to the client applications. Gluu Gateway uses Kong for this purpose.
Kong Services: The Kong Admin API entity that represents an upstream application.
Kong Routes: The Kong Admin API entity that represents a way to map downstream requests to upstream services. It's used to filter the request and send it to the appropriate service at the upstream application.
Request --> Routes --> Service --> Upstream Application
Consumer: The Admin API entity that represents a developer or machine using the API. The consumer only communicates with Kong, which then proxies every call to the appropriate upstream API. In both the
gluu-uma-authplugins, the OP client is validated by checking with consumer entity.
In Gluu Gateway, a
OpenID Connect Client's client_idis associated with a
Consumerin Kong. This is useful where access control is restricted to certain clients. All other default Kong client authentication plugins are disabled in the Gluu Gateway Admin GUI -- we just want to use an OAuth Authorization Server like the Gluu Server for client authentication. The Gluu Server plugins verify the
client_idfor which a token was issued by looking at the JSON equivalent (either the JWT or the introspection response).
- GG requires an installation of the Gluu Server for OAuth2, UMA and OpenID Connect use cases.
Gluu Gateway includes the following components.
Kong CE v1.3.x: An open source API Gateway and Microservices Management Layer, delivering high performance and reliability. We are using Kong Community edition version 1.3 here.
Gluu Gateway plugins: Plugins that leverage the Gluu Server for central client management and to control access to upstream APIs using OAuth 2.0 and UMA 2.0.
oxd Server v4.0: Middleware server for OpenID, OAuth, and UMA client communication with an associated OAuth Authorization Server, typically an instance of the Gluu Server. Gluu-gateway uses oxd server endpoints to communicate with OP Server.
Others: The following runtime environment is required by the Gluu Gateway package:
- OpenJDK v8
- Python v2.x
- Postgres v10
- Node v8.9.4
- NPM v5.6.0
Gluu Gateway functions as a policy enforcement point ("PEP"), relying on an external policy decision point ("PDP"). Gluu Gateway has two primary jobs:
- Validate tokens (both value and reference tokens)
- Make sure a request is authorized
Gluu Gateway supports both UMA and OAuth tokens. While mechanically the same, scopes have different meanings in UMA and OAuth.
UMA Authentication and scopes security#
UMA scopes represent centralized policy evaluation. For example, in the Gluu Server, administrators can map UMA scopes to policies, expressed as UMA RPT Authorization interception scripts.
OAuth Authentication and scopes security#
OAuth scopes normally represent a user's authorization, for example authorization to access a user's calendar. How scopes are granted is ultimately up to the Authorization Server that issues it.
Open Policy Agent based policies#
In the Gluu Server, additional claims can be included in an access token. Gluu Gateway can forward this access token to an Open Policy Agent server for a policy decision.
OIDC and UMA with Claim gathering Security#
OpenID is an identity layer. The Gluu Gateway can act as an OpenID Relying Party, redirecting the subject's browser to the OpenID Provider, and obtaining user information. At that point, the Gluu Gateway can attempt to obtain an UMA access token, pushing the OpenID Connect id_token to the UMA RPT endpoint as input to the policy decision. If user interaction is required, the Gluu Gateway may redirect the subject to the UMA Authorization endpoint.
An API that uses OAuth for security can only be called by OAuth clients, and likewise, an API that uses UMA for security can only be called by an UMA client.
Clients vs. Consumers#
In Gluu Gateway, a
client_id is associated with a "Consumer" in Kong. This is useful where access control is restricted to certain clients. All other forms of client authentication are disabled in the Gluu Gateway Admin GUI -- we just want to use an OAuth Authorization Server like the Gluu Server for client authentication. The Gluu Server plugins verify the
client_id for which a token was issued by looking at the JSON equivalent (either the JWT or the introspection response).
This diagram illustrates the architecture of Gluu Gateway and some of its components:
The following sections explain the numbered points in the diagram:
Admin UI The first step is setting up configuration and adding security plugins. Gluu Gateway (GG) will provide its
Admin UIon port
:1338. Use this UI to add your API or Web application (such as Upstream Service/API/Web) with
kong service object,
kong route object,
create OpenID Connect client,
kong consumer objectand configure the
plugins. The Upstream Service should be registered with the Kong Service. See the Services and Routes sections.
Security configuration using UI The GG UI uses the Kong Admin APIs to configure Kong's Services, Routes, Consumers and Plugins.
Security configuration using Kong API Instead, you can directly use the Kong Admin APIs to configure the Kong's Services, Routes, Consumers and Plugins. You can find API descriptions in the Kong Docs and GG plugins docs for Gluu plugins configuration API.
The UI uses the oxd server to manage the OP Client The UI uses the oxd server endpoint during plugin configuration to create and manage the OpenID Connect Client.
Upstream API/Web Application registration The Upstream Service is the Rest API/Web application to protect using Kong and the plugins, as discussed in point 1, above. The Kong Service is the object where the Upstream Application is registered. You can register multiple upstream applications. As shown in diagram, there are three different upstream applications registered in Kong. Upstream Apps should be locally hosted and not publically accessible. However, the Kong proxy endpoint should be opened for end-users or client applications. Check the Services and Routes docs for upstream application registration in Kong. After registering an upstream app as a service or route in Kong, the next step is to add security plugins. Check the plugins and tutorial docs for plugin details and configuration.
OpenID Connect Server configuration This is the last configuration step. The UI creates the OP Client, which can be managed using oxTrust, the Gluu Server UI. Do not update the client using the OP server, always use the oxd server's
/update-siteendpoint to update the client, since GG uses the oxd server with both the client and OP server.
Client Application requests a token using the oxd server The client application sends a request to the application endpoint (i.e. the Kong proxy endpoint :443). The admin has to provide the OP Client's
client_secretto the client application for it to use these credentials to get the OAuth token and send a request to access registered resources in GG. The client application can use the oxd server endpoint to get the token. In this case, it needs to use the oxd server endpoints.
Client Application request for Token directly to OP server endpoints This is same as the previous step, but this time the client application directly communicates with the OP server using
client_secretto get tokens.
Client Application request to protected resources Now the token is with the client application. It will send a request to the Kong proxy endpoint with the token in the
Kong executes the configured plugins At this point, Kong executes all configured plugins and uses the oxd server to validate the token with the OP Server. Using the
OAuth Plugin, for example, the plugin uses the
/introspect-access-tokenendpoint to validate the token.
The oxd server sends a request to the OP Server The oxd server sends a request to the OP server for authentication and authorization. Using the
OAuth Plugin, for example, the oxd server sends a request to the OP server's introspection endpoint to validate the token.
Send Upstream response to Client Application After successful client authentication and authentication, Kong sends an upstream response to the client application.
Gluu Gateway is available under the GLUU SUPPORT license.